summaryrefslogtreecommitdiff
path: root/doc/pkgsrc.txt
diff options
context:
space:
mode:
authorhubertf <hubertf>2005-01-10 21:03:04 +0000
committerhubertf <hubertf>2005-01-10 21:03:04 +0000
commitcaba330d485731856e3a2282e18216cd1b2ea598 (patch)
tree7df4a78dc62f1d13f271cb3b66b59539747cb290 /doc/pkgsrc.txt
parent9adec9180ee39564a691ba857d7b9a760216ac99 (diff)
downloadpkgsrc-caba330d485731856e3a2282e18216cd1b2ea598.tar.gz
re-generate
Diffstat (limited to 'doc/pkgsrc.txt')
-rw-r--r--doc/pkgsrc.txt1443
1 files changed, 756 insertions, 687 deletions
diff --git a/doc/pkgsrc.txt b/doc/pkgsrc.txt
index fe3c186478e..6bae26c4ca0 100644
--- a/doc/pkgsrc.txt
+++ b/doc/pkgsrc.txt
@@ -27,53 +27,53 @@ creating new packages.
Table of Contents
1. Introduction
-
+
1.1. Introduction
1.2. Overview
1.3. Terminology
1.4. Typography
-
+
I. The pkgsrc user's guide
-
+
2. Where to get pkgsrc
-
+
2.1. As tar file
2.2. Via SUP
2.3. Via CVS
-
+
3. Using pkgsrc on systems other than NetBSD
-
+
3.1. Bootstrapping pkgsrc
3.2. Platform specific notes
-
+
3.2.1. Darwin (Mac OS X)
3.2.2. FreeBSD
3.2.3. Interix
3.2.4. IRIX
3.2.5. OpenBSD
3.2.6. Solaris
-
+
4. Using pkgsrc
-
+
4.1. Working with binary packages
-
+
4.1.1. Where to get binary packages
4.1.2. How to use binary packages
4.1.3. A word of warning
-
+
4.2. Building packages from source
-
+
4.2.1. Requirements
4.2.2. Fetching distfiles
4.2.3. How to build and install
4.2.4. Selecting the compiler
-
+
5. Creating binary packages
-
+
5.1. Building a single binary package
5.2. Settings for creation of binary packages
5.3. Doing a bulk build of all packages
-
+
5.3.1. Configuration
5.3.2. Other environmental considerations
5.3.3. Operation
@@ -81,13 +81,14 @@ I. The pkgsrc user's guide
5.3.5. Disk space requirements
5.3.6. Setting up a sandbox for chroot'ed builds
5.3.7. Building a partial set of packages
-
+ 5.3.8. Uploading results of a bulk build
+
5.4. Creating a multiple CD-ROM packages collection
-
+
5.4.1. Example of cdpack
-
+
6. Frequently Asked Questions
-
+
6.1. Is there a mailing list for pkg-related discussion?
6.2. Where's the pkgviews documentation?
6.3. Utilities for package management (pkgtools)
@@ -97,17 +98,16 @@ I. The pkgsrc user's guide
6.7. How to fetch files from behind a firewall
6.8. How do I tell make fetch to do passive FTP?
6.9. How to fetch all distfiles at once
- 6.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc"
- mean?
- 6.11. What does "Could not find bsd.own.mk" mean?
+ 6.10. What does Don't know how to make /usr/share/tmac/tmac.andoc mean?
+ 6.11. What does Could not find bsd.own.mk mean?
6.12. Using 'sudo' with pkgsrc
6.13. Configuration files handling and placement
6.14. Automated security checks
-
+
II. The pkgsrc developer's guide
-
+
7. Package components - files, directories and contents
-
+
7.1. Makefile
7.2. distinfo
7.3. patches/*
@@ -115,9 +115,9 @@ II. The pkgsrc developer's guide
7.5. Optional files
7.6. work*
7.7. files/*
-
+
8. PLIST issues
-
+
8.1. RCS ID
8.2. Semi-automatic PLIST generation
8.3. Tweaking output of make print-PLIST
@@ -126,35 +126,35 @@ II. The pkgsrc developer's guide
8.6. Changing PLIST source with PLIST_SRC
8.7. Platform specific and differing PLISTs
8.8. Sharing directories between packages
-
+
9. Buildlink methodology
-
+
9.1. Converting packages to use buildlink3
9.2. Writing buildlink3.mk files
-
+
9.2.1. Anatomy of a buildlink3.mk file
9.2.2. Updating BUILDLINK_DEPENDS.pkg in buildlink3.mk files
-
+
9.3. Writing builtin.mk files
-
+
9.3.1. Anatomy of a builtin.mk file
9.3.2. Global preferences for native or pkgsrc software
-
+
10. Options handling
-
+
10.1. Global default options
10.2. Converting packages to use bsd.options.mk
-
+
11. The build process
-
+
11.1. Program location
11.2. Main targets
11.3. Other helpful targets
-
+
12. Notes on fixes for packages
-
+
12.1. General operation
-
+
12.1.1. How to pull in variables from /etc/mk.conf
12.1.2. Restricted packages
12.1.3. Handling dependencies
@@ -166,25 +166,25 @@ II. The pkgsrc developer's guide
12.1.9. How to handle incrementing versions when fixing an existing
package
12.1.10. Portability of packages
-
+
12.2. Possible downloading issues
-
+
12.2.1. Packages whose distfiles aren't available for plain
downloading
12.2.2. How to handle modified distfiles with the 'old' name
-
+
12.3. Configuration gotchas
-
+
12.3.1. Shared libraries - libtool
12.3.2. Using libtool on GNU packages that already support libtool
12.3.3. GNU Autoconf/Automake
-
+
12.4. Building considerations
-
+
12.4.1. CPP defines
-
+
12.5. Package specific actions
-
+
12.5.1. Package configuration files
12.5.2. User interaction
12.5.3. Handling licenses
@@ -202,39 +202,39 @@ II. The pkgsrc developer's guide
12.5.15. Packages installing SGML or XML data
12.5.16. Packages installing extensions to the MIME database
12.5.17. Packages using intltool
-
+
12.6. Feedback to the author
-
+
13. Debugging
14. Submitting and Committing
-
+
14.1. Submitting your packages
14.2. Committing: Importing a package into CVS
14.3. Updating a package to a newer version
14.4. Moving a package in pkgsrc
-
+
A. A simple example package: bison
-
+
A.1. files
-
+
A.1.1. Makefile
A.1.2. DESCR
A.1.3. PLIST
A.1.4. Checking a package with pkglint
-
+
A.2. Steps for building, installing, packaging
-
+
B. Build logs
-
+
B.1. Building figlet
B.2. Packaging figlet
-
+
C. Layout of the FTP server's package archive
D. Editing guidelines for the pkgsrc guide
-
+
D.1. Targets
D.2. Procedure
-
+
Chapter 1. Introduction
Table of Contents
@@ -261,13 +261,13 @@ descriptions are all simple.
pkgsrc currently contains several thousand packages, including:
* www/apache - The Apache web server
-
+
* www/mozilla - The Mozilla web browser
-
+
* meta-pkgs/gnome - The GNOME Desktop Environment
-
+
* meta-pkgs/kde3 - The K Desktop Environment
-
+
...just to name a few.
pkgsrc has built-in support for handling varying dependencies, such as pthreads
@@ -278,23 +278,23 @@ NetBSD only. Since then, pkgsrc has grown a lot, and now supports the following
platforms:
* Darwin (Mac OS X)
-
+
* DragonFlyBSD
-
+
* FreeBSD
-
+
* Microsoft Windows, via Interix
-
+
* IRIX
-
+
* Linux
-
+
* NetBSD (of course)
-
+
* OpenBSD
-
+
* Solaris
-
+
1.2. Overview
This document is divided into two parts. The first, The pkgsrc user's guide,
@@ -307,59 +307,59 @@ users without knowing about the package's building details.
This document is available in various formats:
* HTML
-
+
* PDF
-
+
* PS
-
+
* TXT
-
+
1.3. Terminology
There has been a lot of talk about "ports", "packages", etc. so far. Here is a
description of all the terminology used within this document.
Package
-
+
A set of files and building instructions that describe what's necessary to
build a certain piece of software using pkgsrc. Packages are traditionally
stored under /usr/pkgsrc.
-
+
The NetBSD package system
-
+
This is the former name of "pkgsrc". It is part of the NetBSD operating
system and can be bootstrap to run on non-NetBSD operating systems as well.
It handles building (compiling), installing, and removing of packages.
-
+
Distfile
-
+
This term describes the file or files that are provided by the author of
the piece of software to distribute his work. All the changes necessary to
build on NetBSD are reflected in the corresponding package. Usually the
distfile is in the form of a compressed tar-archive, but other types are
possible, too. Distfiles are usually stored below /usr/pkgsrc/distfiles.
-
+
Port
-
+
This is the term used by FreeBSD and OpenBSD people for what we call a
package. In NetBSD terminology, "port" refers to a different architecture.
-
+
Precompiled/binary package
-
+
A set of binaries built with pkgsrc from a distfile and stuffed together in
a single .tgz file so it can be installed on machines of the same machine
architecture without the need to recompile. Packages are usually generated
in /usr/pkgsrc/packages; there is also an archive on ftp.NetBSD.org.
-
+
Sometimes, this is referred to by the term "package" too, especially in the
context of precompiled packages.
-
+
Program
-
+
The piece of software to be installed which will be constructed from all
the files in the Distfile by the actions defined in the corresponding
package.
-
+
1.4. Typography
When giving examples for commands, shell prompts are used to show if the
@@ -372,44 +372,44 @@ The pkgsrc user's guide
Table of Contents
2. Where to get pkgsrc
-
+
2.1. As tar file
2.2. Via SUP
2.3. Via CVS
-
+
3. Using pkgsrc on systems other than NetBSD
-
+
3.1. Bootstrapping pkgsrc
3.2. Platform specific notes
-
+
3.2.1. Darwin (Mac OS X)
3.2.2. FreeBSD
3.2.3. Interix
3.2.4. IRIX
3.2.5. OpenBSD
3.2.6. Solaris
-
+
4. Using pkgsrc
-
+
4.1. Working with binary packages
-
+
4.1.1. Where to get binary packages
4.1.2. How to use binary packages
4.1.3. A word of warning
-
+
4.2. Building packages from source
-
+
4.2.1. Requirements
4.2.2. Fetching distfiles
4.2.3. How to build and install
4.2.4. Selecting the compiler
-
+
5. Creating binary packages
-
+
5.1. Building a single binary package
5.2. Settings for creation of binary packages
5.3. Doing a bulk build of all packages
-
+
5.3.1. Configuration
5.3.2. Other environmental considerations
5.3.3. Operation
@@ -417,13 +417,14 @@ Table of Contents
5.3.5. Disk space requirements
5.3.6. Setting up a sandbox for chroot'ed builds
5.3.7. Building a partial set of packages
-
+ 5.3.8. Uploading results of a bulk build
+
5.4. Creating a multiple CD-ROM packages collection
-
+
5.4.1. Example of cdpack
-
+
6. Frequently Asked Questions
-
+
6.1. Is there a mailing list for pkg-related discussion?
6.2. Where's the pkgviews documentation?
6.3. Utilities for package management (pkgtools)
@@ -433,12 +434,12 @@ Table of Contents
6.7. How to fetch files from behind a firewall
6.8. How do I tell make fetch to do passive FTP?
6.9. How to fetch all distfiles at once
- 6.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean?
- 6.11. What does "Could not find bsd.own.mk" mean?
+ 6.10. What does Don't know how to make /usr/share/tmac/tmac.andoc mean?
+ 6.11. What does Could not find bsd.own.mk mean?
6.12. Using 'sudo' with pkgsrc
6.13. Configuration files handling and placement
6.14. Automated security checks
-
+
Chapter 2. Where to get pkgsrc
Table of Contents
@@ -493,14 +494,14 @@ Table of Contents
3.1. Bootstrapping pkgsrc
3.2. Platform specific notes
-
+
3.2.1. Darwin (Mac OS X)
3.2.2. FreeBSD
3.2.3. Interix
3.2.4. IRIX
3.2.5. OpenBSD
3.2.6. Solaris
-
+
3.1. Bootstrapping pkgsrc
For Operating Systems other than NetBSD, we provide a bootstrap kit to build
@@ -509,19 +510,19 @@ NetBSD, pkgsrc and the bootstrap kit have support for the following operating
systems:
* Darwin (Mac OS X)
-
+
* FreeBSD
-
+
* Interix (Windows 2000, XP, 2003)
-
+
* IRIX
-
+
* Linux
-
+
* OpenBSD
-
+
* Solaris
-
+
Support for other platforms is under development.
Installing the bootstrap kit should be as simple as:
@@ -537,7 +538,7 @@ package database directory where pkgsrc will do it's internal bookkeeping.
However, these can also be set using command-line parameters.
Binary packages for the pkgsrc tools and an initial set of packages is
-available for supported platforms. An up-to-date list of these can be found on
+available for supported platforms. An up-to-date list of these can be found on
www.pkgsrc.org.
3.2. Platform specific notes
@@ -551,7 +552,7 @@ OS X, by using a disk image, or a UFS partition.
Before you start, you will need to download and install the Mac OS X Developer
Tools from Apple's Developer Connection. See http://developer.apple.com/macosx/
-for details. Also, make sure you install X11 for Mac OS X and the X11 SDK from
+for details. Also, make sure you install X11 for Mac OS X and the X11 SDK from
http://www.apple.com/macosx/x11/download/ if you intend to build packages that
use the X11 Window System.
@@ -619,25 +620,25 @@ with the FreeBSD userland tools. There are several steps:
1. FreeBSD stores its ports pkg database in /var/db/pkg. It is therefore
recommended that you choose a different location (e.g. /usr/pkgdb) by using
the --pkgdbdir option to the bootstrap script.
-
+
2. If you do not intend to use the FreeBSD ports tools, it's probably a good
idea to move them out of the way to avoid confusion, e.g.
-
+
# cd /usr/sbin
# mv pkg_add pkg_add.orig
# mv pkg_create pkg_create.orig
# mv pkg_delete pkg_delete.orig
# mv pkg_info pkg_info.orig
-
+
3. An example /etc/mk.conf file will be placed in /etc/mk.conf.example file
when you use the bootstrap script.
-
+
3.2.3. Interix
Interix is a POSIX compatible subsystem for the Windows NT kernel, providing a
Unix-like environment with a tighter kernel integration than available with
Cygwin. It is part of the Windows Services for Unix package, available for free
-for any licensed copy of Windows 2000, XP, or 2003. SFU can be downloaded from
+for any licensed copy of Windows 2000, XP, or 2003. SFU can be downloaded from
http://www.microsoft.com/windows/sfu/.
Services for Unix 3.5, current as of this writing, has been tested. 3.0 or 3.1
@@ -650,13 +651,13 @@ At an absolute minimum, the following packages must be installed from the
Windows Services for Unix 3.5 distribution in order to use pkgsrc:
* Utilities -> Base Utilities
-
+
* Interix GNU Components -> (all)
-
+
* Remote Connectivity
-
+
* Interix SDK
-
+
When using pkgsrc on Interix, DO NOT install the Utilities subcomponent "UNIX
Perl". That is Perl 5.6 without shared module support, installed to /usr/local,
and will only cause confusion. Instead, install Perl 5.8 from pkgsrc (or from a
@@ -679,21 +680,21 @@ pkgsrc, note the following things.
* To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft Windows
Services for UNIX, then click Change. In the installer, choose Add or
Remove, then uncheck Utilities->UNIX Perl.
-
+
* To enable case-sensitivity for the filesystem, run REGEDIT.EXE, and change
the following registry key:
-
+
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel
-
+
Set the DWORD value "obcaseinsensitive" to 0; then reboot.
-
+
* To enable setuid binaries (optional), run REGEDIT.EXE, and change the
following registry key:
-
+
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX
-
+
Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.
-
+
3.2.3.3. Important notes for using pkgsrc
The package imanager (either the pkgsrc "su" user, or the user running
@@ -752,27 +753,27 @@ with the OpenBSD userland tools. There are several steps:
1. OpenBSD stores its ports pkg database in /var/db/pkg. It is therefore
recommended that you choose a different location (e.g. /usr/pkgdb) by using
the --pkgdbdir option to the bootstrap script.
-
+
2. If you do not intend to use the OpenBSD ports tools, it's probably a good
idea to move them out of the way to avoid confusion, e.g.
-
+
# cd /usr/sbin
# mv pkg_add pkg_add.orig
# mv pkg_create pkg_create.orig
# mv pkg_delete pkg_delete.orig
# mv pkg_info pkg_info.orig
-
+
3. An example /etc/mk.conf file will be placed in /etc/mk.conf.example file
when you use the bootstrap script. OpenBSD's make program uses /etc/mk.conf
as well. You can work around this by enclosing all the pkgsrc specific
parts of the file with:
-
+
.ifdef BSD_PKG_MK
# pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
.else
# OpenBSD stuff
.endif
-
+
3.2.6. Solaris
@@ -783,15 +784,15 @@ The following packages are required on Solaris 8 for the bootstrap process and
to build packages.
* SUNWsprot
-
+
* SUNWarc
-
+
* SUNWbtool
-
+
* SUNWtoo
-
+
* SUNWlibm
-
+
Please note the use of GNU binutils on Solaris is not supported.
3.2.6.1. If you are using gcc
@@ -811,13 +812,13 @@ freewareSearch.html.
You will need at least the following packages installed (from WorkShop 5.0)
* SPROcc - Sun WorkShop Compiler C 5.0
-
+
* SPROcpl - Sun WorkShop Compiler C++ 5.0
-
+
* SPROild - Sun WorkShop Incremental Linker
-
+
* SPROlang - Sun WorkShop Compilers common components
-
+
You should set CC, CXX and optionally, CPP in /etc/mk.conf, eg.
CC= cc
@@ -836,18 +837,18 @@ Chapter 4. Using pkgsrc
Table of Contents
4.1. Working with binary packages
-
+
4.1.1. Where to get binary packages
4.1.2. How to use binary packages
4.1.3. A word of warning
-
+
4.2. Building packages from source
-
+
4.2.1. Requirements
4.2.2. Fetching distfiles
4.2.3. How to build and install
4.2.4. Selecting the compiler
-
+
4.1. Working with binary packages
This section describes how to find, retrieve and install a precompiled binary
@@ -909,7 +910,7 @@ the "xbase" and "xcomp" distribution sets are required, too.
4.2.2. Fetching distfiles
The distfile (i.e. the unmodified source) must exist on your system for the
-packages system to be able to build it. If it does not exist, pkgsrc will use
+packages system to be able to build it. If it does not exist, pkgsrc will use
ftp(1) to fetch it automatically.
You can overwrite some of the major distribution sites to fit to sites that are
@@ -969,21 +970,21 @@ added to help with this.
1. If you invoke the make(1) command with PKG_DEBUG_LEVEL=2, then a huge
amount of information will be displayed. For example,
-
+
make patch PKG_DEBUG_LEVEL=2
-
+
will show all the commands that are invoked, up to and including the
"patch" stage.
-
+
2. If you want to know the value of a certain make(1) definition, then the
VARNAME definition should be used, in conjunction with the show-var target.
e.g. to show the expansion of the make(1) variable DISTFILES:
-
+
% make show-var VARNAME=LOCALBASE
/usr/pkg
%
-
-
+
+
If you want to install a binary package that you've either created yourself
(see next section), that you put into pkgsrc/packages manually or that is
@@ -1008,32 +1009,32 @@ By default, pkgsrc will use GCC to build packages. This may be overridden by
setting the following variables in /etc/mk.conf:
PKGSRC_COMPILER:
-
+
This is a list of values specifying the chain of compilers to invoke when
building packages. Valid values are:
-
+
* distcc: distributed C/C++ (chainable)
-
+
* ccache: compiler cache (chainable)
-
+
* gcc: GNU C/C++ Compiler
-
+
* mipspro: Silicon Graphics, Inc. MIPSpro (n32/n64)
-
+
* mipspro: Silicon Graphics, Inc. MIPSpro (o32)
-
+
* sunpro: Microsystems, Inc. WorkShip/Forte/Sun ONE Studio
-
+
The default is "gcc". You can use ccache and/or distcc with an appropriate
PKGSRC_COMPILER setting, e.g. "ccache gcc". This variable should always be
terminated with a value for a real compiler.
-
+
GCC_REQD:
-
+
This specifies the minimum version of GCC to use when building packages. If
the system GCC doesn't satisfy this requirement, then pkgsrc will build and
install one of the GCC packages to use instead.
-
+
Chapter 5. Creating binary packages
Table of Contents
@@ -1041,7 +1042,7 @@ Table of Contents
5.1. Building a single binary package
5.2. Settings for creation of binary packages
5.3. Doing a bulk build of all packages
-
+
5.3.1. Configuration
5.3.2. Other environmental considerations
5.3.3. Operation
@@ -1049,11 +1050,12 @@ Table of Contents
5.3.5. Disk space requirements
5.3.6. Setting up a sandbox for chroot'ed builds
5.3.7. Building a partial set of packages
-
+ 5.3.8. Uploading results of a bulk build
+
5.4. Creating a multiple CD-ROM packages collection
-
+
5.4.1. Example of cdpack
-
+
5.1. Building a single binary package
Once you have built and installed a package, you can create a binary package
@@ -1133,7 +1135,7 @@ nearly 3 GB of disk space.
As /usr/pkg will be completely deleted at the start of bulk builds, make sure
your login shell is placed somewhere else. Either drop it into /usr/local/bin
-(and adjust your login shell in the passwd file), or (re-)install it via
+(and adjust your login shell in the passwd file), or (re-)install it via
pkg_add(1) from /etc/rc.local, so you can login after a reboot (remember that
your current process won't die if the package is removed, you just can't start
any new instances of the shell any more). Also, if you use NetBSD earlier than
@@ -1176,22 +1178,22 @@ logs in the directory specified by FTP in the build.conf file.
The bulk builds consist of three steps:
1. pre-build
-
+
The script updates your pkgsrc tree via (anon)cvs, then cleans out any
broken distfiles, and removes all packages installed.
-
+
2. the bulk build
-
+
This is basically "make bulk-package" with an optimised order in which
packages will be built. Packages that don't require other packages will be
built first, and packages with many dependencies will be built later.
-
+
3. post-build
-
+
Generates a report that's placed in the directory specified in the
build.conf file named broken.html, a short version of that report will also
be mailed to the build's admin.
-
+
During the build, a list of broken packages will be compiled in /usr/pkgsrc
/.broken (or .../.broken.${MACHINE} if OBJMACHINE is set), individual build
logs of broken builds can be found in the package's directory. These files are
@@ -1203,11 +1205,11 @@ rebuild them, and they can be used to debug these broken package builds later.
Currently, roughly the following requirements are valid for NetBSD 2.0/i386:
* 10 GB - distfiles (NFS ok)
-
+
* 8 GB - full set of all binaries (NFS ok)
-
+
* 5 GB - temp space for compiling (local disk recommended)
-
+
Note that all pkgs will be de-installed as soon as they are turned into a
binary package, and that sources are removed, so there is no excessively huge
demand to disk space. Afterwards, if the package is needed again, it will be
@@ -1234,56 +1236,56 @@ NetBSD installation or doing a make distribution DESTDIR=/usr/sandbox in /usr/
src/etc, be sure the following items are present and properly configured:
1. Kernel
-
+
# cp /netbsd /usr/sandbox
-
+
2. /dev/*
-
+
# cd /usr/sandbox/dev ; sh MAKEDEV all
-
+
3. /etc/resolv.conf (for security/smtpd and mail):
-
+
# cp /etc/resolv.conf /usr/sandbox/etc
-
+
4. Working(!) mail config (hostname, sendmail.cf):
-
+
# cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail
-
+
5. /etc/localtime (for security/smtpd):
-
+
# ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime
-
+
6. /usr/src (system sources, for sysutils/aperture, net/ppp-mppe):
-
+
# ln -s ../disk1/cvs .
# ln -s cvs/src-1.6 src
-
+
7. Create /var/db/pkg (not part of default install):
-
+
# mkdir /usr/sandbox/var/db/pkg
-
+
8. Create /usr/pkg (not part of default install):
-
+
# mkdir /usr/sandbox/usr/pkg
-
+
9. Checkout pkgsrc via cvs into /usr/sandbox/usr/pkgsrc:
-
+
# cd /usr/sandbox/usr
# cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc
-
+
Do not mount/link this to the copy of your pkgsrc tree you do development
in, as this will likely cause problems!
-
+
10. Make /usr/sandbox/usr/pkgsrc/packages and .../distfiles point somewhere
appropriate. NFS- and/or nullfs-mounts may come in handy!
-
+
11. Edit /etc/mk.conf, see Section 5.3.1.1, "/etc/mk.conf".
-
+
12. Adjust mk/bulk/build.conf to suit your needs.
-
+
13. If you have set CVS_USER in build.conf, make sure that account exists and
can do a cvs ${CVS_FLAGS} update properly!
-
+
When the chroot sandbox is setup, you can start the build with the following
steps:
@@ -1302,13 +1304,13 @@ In addition to building a complete set of all packages in pkgsrc, the pkgsrc/mk
pkgsrc. By setting defining SPECIFIC_PKGS in /etc/mk.conf, the variables
* SITE_SPECIFIC_PKGS
-
+
* HOST_SPECIFIC_PKGS
-
+
* GROUP_SPECIFIC_PKGS
-
+
* USER_SPECIFIC_PKGS
-
+
will define the set of packages which should be built. The bulk build code will
also include any packages which are needed as dependencies for the explicitly
listed packages.
@@ -1317,6 +1319,73 @@ One use of this is to do a bulk build with SPECIFIC_PKGS in a chroot sandbox
periodically to have a complete set of the binary packages needed for your site
available without the overhead of building extra packages that are not needed.
+5.3.8. Uploading results of a bulk build
+
+This section describes how pkgsrc developers can upload binary pkgs built by
+bulk builds to ftp.NetBSD.org.
+
+First, make sure that you have RSYNC_DST set properly in your mk/bulk/
+build.conf file, i.e. adjust it to something like one of the following:
+
+RSYNC_DST=$CVS_USER@ftp.NetBSD.org:/pub/NetBSD/packages/pkgsrc-200xQy/NetBSD-a.b.c/arch/upload
+
+Please use appropviate values for "pkgsrc-200xQ4", "NetBSD-a.b.c" and "arch"
+here. If your login on ftp.NetBSD.org is different from CVS_USER, write your
+login directly into the variable, e.g. my local account is "feyrer", but for my
+login "hubertf", I use:
+
+RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/NetBSD/packages/pkgsrc-200xQy/NetBSD-a.b.c/arch/upload
+
+A separate upload directory is used here to allow "closing" the directory
+during upload. To do so, run the following command on ftp.NetBSD.org next:
+
+nbftp% mkdir -p -m 750 /pub/NetBSD/packages/pkgsrc-200xQy/NetBSD-a.b.c/arch/upload
+
+Please note that /pub/NetBSD/packages is only appropriate for packages for the
+NetBSD operating system. Binary packages for other operating systems should go
+into /pub/pkgsrc.
+
+Before uploading the binary pkgs, ssh authentication needs to be setup next.
+This example shows how to setup temporary keys for the root account inside the
+sandbox (assuming that no keys should be present there usually):
+
+# chroot /usr/sandbox
+chroot-# rm $HOME/.ssh/id-dsa*
+chroot-# ssh-keygen -t dsa
+chroot-# cat $HOME/.ssh/id-dsa.pub
+
+Now take the output of id-dsa.pub and append it to your ~/.ssh/authorized_keys
+file on ftp.netBSD.org. You can remove the key after the upload is done!
+
+Next, test if your ssh connection really works:
+
+chroot-# ssh ftp.NetBSD.org date
+
+Use "-l yourNetBSDlogin" here as appropriate!
+
+Now after all this works, you can exit the sandbox and start the upload:
+
+chroot-# exit
+# cd /usr/sandbox/usr/pkgsrc
+# sh mk/bulk/do-sandbox-upload
+
+The upload process may take quite some time. Use "ls" or "du" on the FTP server
+to monitor progress of the upload.
+
+After the upload has ended, first thing is to revoke ssh access:
+
+nbftp% vi ~/.ssh/authorized_keys
+Gdd:x!
+
+Use whatever is needed to remove the key you've entered before! Last, move the
+uploaded packages out of the upload directory to have them accessible to
+everyone:
+
+nbftp% cd /pub/NetBSD/packages/pkgsrc-200xQy/NetBSD-a.b.c/arch
+nbftp% mv upload/* .
+nbftp% rmdir upload
+nbftp% chmod 755 .
+
5.4. Creating a multiple CD-ROM packages collection
After your pkgsrc bulk-build has completed, you may wish to create a CD-ROM set
@@ -1368,8 +1437,8 @@ Table of Contents
6.7. How to fetch files from behind a firewall
6.8. How do I tell make fetch to do passive FTP?
6.9. How to fetch all distfiles at once
-6.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean?
-6.11. What does "Could not find bsd.own.mk" mean?
+6.10. What does Don't know how to make /usr/share/tmac/tmac.andoc mean?
+6.11. What does Could not find bsd.own.mk mean?
6.12. Using 'sudo' with pkgsrc
6.13. Configuration files handling and placement
6.14. Automated security checks
@@ -1402,65 +1471,65 @@ duplicate the documentation that comes with each package.
Utilities used by pkgsrc (automatically installed when needed):
* pkgtools/x11-links: symlinks for use by buildlink
-
+
OS tool augmentation (automatically installed when needed):
* pkgtools/digest: calculates SHA1 checksums (and other kinds)
-
+
* pkgtools/libnbcompat: compat library for pkg tools
-
+
* pkgtools/mtree: installed on non-BSD systems due to lack of native mtree
-
+
* pkgtools/pkg_install: up-to-date replacement for /usr/sbin/pkg_install, or
for use on operating systems where pkg_install is not present
-
+
Utilities used by pkgsrc (not automatically installed):
* pkgtools/pkg_tarup: create a binary package from an already-installed
package. used by 'make replace' to save the old package
-
+
* pkgtools/dfdisk: adds extra functionality to pkgsrc, allowing it to fetch
distfiles from multiple locations. It currently supports the following
methods: multiple CD-ROMs and network FTP/HTTP connections.
-
+
* pkgtools/xpkgwedge: put X11 packages someplace else (enabled by default)
-
+
* devel/cpuflags: will determine the best compiler flags to optimise code for
your current CPU and compiler.
-
+
Utilities for keeping track of installed packages, being up to date, etc:
* pkgtools/pkg_chk: installs pkg_chk, which reports on packages whose
installed versions do not match the latest pkgsrc entries
-
+
* pkgtools/pkgdep: makes dependency graphs of packages, to aid in choosing a
strategy for updating
-
+
* pkgtools/pkgdepgraph: make graph from above (uses graphviz)
-
+
* pkgtools/pkglint: This provides two distinct abilities: check a pkgsrc
entry for correctness (pkglint) check for and remove out-of-date distfiles
and binary packages (lintpkgsrc)
-
+
* pkgtools/pkgsurvey: report what packages you have installed
-
+
Utilities for people maintaining or creating individual packages:
* pkgtools/pkgdiff: automate making and maintaining patches for a package
(includes pkgdiff, pkgvi, mkpatches, ...)
-
+
* pkgtools/rpm2pkg, pkgtools/url2pkg: aids in converting to pkgsrc
-
+
* pkgtools/gensolpkg: convert pkgsrc to a Solaris package
-
+
Utilities for people maintaining pkgsrc (or more obscure pkg utilities)
* pkgtools/pkgconflict: find packages that conflict but aren't marked as such
-
+
* pkgtools/pkg_comp: build packages in a chrooted area
-
+
* pkgtools/libkver: spoof kernel version for chrooted cross builds
-
+
6.4. How to use pkgsrc as non-root
If you want to use pkgsrc as non-root user, you can set some variables to make
@@ -1473,7 +1542,7 @@ X11R6, /usr/openwin, ...), you will have to add the following lines into
mk.conf:
X11_TYPE=XFree86
-
+
6.6. How can I install/use X.org from pkgsrc?
@@ -1482,7 +1551,7 @@ X11R6, /usr/openwin, ...) you will have to add the following lines into
mk.conf:
X11_TYPE=xorg
-
+
6.7. How to fetch files from behind a firewall
@@ -1579,7 +1648,7 @@ binary package or from security/sudo) and then put the following into your /etc
.if exists(/usr/pkg/bin/sudo)
SU_CMD=/usr/pkg/bin/sudo /bin/sh -c
.endif
-
+
6.13. Configuration files handling and placement
@@ -1597,24 +1666,24 @@ customized in various ways:
1. PKG_SYSCONFBASE is the main config directory under which all package
configuration files are to be found. Users will typically want to set it to
/etc, or accept the default location of $PREFIX/etc.
-
+
2. PKG_SYSCONFSUBDIR is the subdirectory of PKG_SYSCONFBASE under which the
configuration files for a particular package may be found. Defaults to $
{SYSCONFBASE}.
-
+
3. PKG_SYSCONFVAR is the special suffix used to distinguish any overriding
values for a particular package (see next item). It defaults to ${PKGBASE},
but for a collection of related packages that should all have the same
PKG_SYSCONFDIR value, it can be set in each of the package Makefiles to a
common value.
-
+
4. PKG_SYSCONFDIR.${PKG_SYSCONFVAR} overrides the value of ${PKG_SYSCONFDIR}
for packages with the same value for PKG_SYSCONFVAR.
-
+
As an example, all the various KDE packages may want to set PKG_SYSCONFVAR
to "kde" so admins can set PKG_SYSCONFDIR.kde in /etc/mk.conf to define
where to install KDE config files.
-
+
Programs' configuration directory should be defined during the configure stage.
Packages that use GNU autoconf can usually do this by using the "--sysconfdir"
parameter, but this brings some problems as we will see now. When you change
@@ -1657,14 +1726,14 @@ packages installed on a system can take place. To do this, install the security
security vulnerabilities information. This list is kept up to date by the
NetBSD security officer and the NetBSD packages team, and is distributed
from the NetBSD ftp server:
-
+
ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/pkg-vulnerabilities
-
+
2. "audit-packages", an easy way to audit the current machine, checking each
vulnerability which is known. If a vulnerable package is installed, it will
be shown by output to stdout, including a description of the type of
vulnerability, and a URL containing more information.
-
+
Use of the audit-packages package is strongly recommended!
The following message is displayed as part of the audit-packages installation
@@ -1692,14 +1761,14 @@ if [ -x ${PREFIX}/sbin/audit-packages ]; then
fi
===========================================================================
-
+
The pkgsrc developer's guide
Table of Contents
7. Package components - files, directories and contents
-
+
7.1. Makefile
7.2. distinfo
7.3. patches/*
@@ -1707,9 +1776,9 @@ Table of Contents
7.5. Optional files
7.6. work*
7.7. files/*
-
+
8. PLIST issues
-
+
8.1. RCS ID
8.2. Semi-automatic PLIST generation
8.3. Tweaking output of make print-PLIST
@@ -1718,35 +1787,35 @@ Table of Contents
8.6. Changing PLIST source with PLIST_SRC
8.7. Platform specific and differing PLISTs
8.8. Sharing directories between packages
-
+
9. Buildlink methodology
-
+
9.1. Converting packages to use buildlink3
9.2. Writing buildlink3.mk files
-
+
9.2.1. Anatomy of a buildlink3.mk file
9.2.2. Updating BUILDLINK_DEPENDS.pkg in buildlink3.mk files
-
+
9.3. Writing builtin.mk files
-
+
9.3.1. Anatomy of a builtin.mk file
9.3.2. Global preferences for native or pkgsrc software
-
+
10. Options handling
-
+
10.1. Global default options
10.2. Converting packages to use bsd.options.mk
-
+
11. The build process
-
+
11.1. Program location
11.2. Main targets
11.3. Other helpful targets
-
+
12. Notes on fixes for packages
-
+
12.1. General operation
-
+
12.1.1. How to pull in variables from /etc/mk.conf
12.1.2. Restricted packages
12.1.3. Handling dependencies
@@ -1758,24 +1827,24 @@ Table of Contents
12.1.9. How to handle incrementing versions when fixing an existing
package
12.1.10. Portability of packages
-
+
12.2. Possible downloading issues
-
+
12.2.1. Packages whose distfiles aren't available for plain downloading
12.2.2. How to handle modified distfiles with the 'old' name
-
+
12.3. Configuration gotchas
-
+
12.3.1. Shared libraries - libtool
12.3.2. Using libtool on GNU packages that already support libtool
12.3.3. GNU Autoconf/Automake
-
+
12.4. Building considerations
-
+
12.4.1. CPP defines
-
+
12.5. Package specific actions
-
+
12.5.1. Package configuration files
12.5.2. User interaction
12.5.3. Handling licenses
@@ -1793,17 +1862,17 @@ Table of Contents
12.5.15. Packages installing SGML or XML data
12.5.16. Packages installing extensions to the MIME database
12.5.17. Packages using intltool
-
+
12.6. Feedback to the author
-
+
13. Debugging
14. Submitting and Committing
-
+
14.1. Submitting your packages
14.2. Committing: Importing a package into CVS
14.3. Updating a package to a newer version
14.4. Moving a package in pkgsrc
-
+
Chapter 7. Package components - files, directories and contents
Table of Contents
@@ -1854,7 +1923,7 @@ The MASTER_SITES may be set to one of the predefined sites:
${MASTER_SITE_SUSE}
${MASTER_SITE_TEX_CTAN}
${MASTER_SITE_XCONTRIB}
- ${MASTER_SITE_XEMACS}
+ ${MASTER_SITE_XEMACS}
If one of these predefined sites is chosen, you may require the ability to
specify a subdirectory of that site. Since these macros may expand to more than
@@ -1862,7 +1931,7 @@ one actual site, you must use the following construct to specify a
subdirectory:
${MASTER_SITE_GNU:=subdirectory/name/}
- ${MASTER_SITE_SOURCEFORGE:=project_name/}
+ ${MASTER_SITE_SOURCEFORGE:=project_name/}
Note the trailing slash after the subdirectory name.
@@ -1898,22 +1967,22 @@ Please pay attention to the following gotchas:
* Add MANCOMPRESSED if manpages are installed in compressed form by the
package; see comment in bsd.pkg.mk.
-
+
* Replace /usr/local with "${PREFIX}" in all files (see patches, below).
-
+
* If the package installs any info files, see Section 12.5.10, "Packages
installing info files".
-
+
* Set MAINTAINER to be yourself. If you really can't maintain the package for
future updates, set it to <tech-pkg@NetBSD.org>.
-
+
* If a home page for the software in question exists, add the variable
HOMEPAGE right after MAINTAINER. The value of this variable should be the
URL for the home page.
-
+
* Be sure to set the COMMENT variable to a short description of the package,
not containing the pkg's name.
-
+
7.2. distinfo
Most important, the mandatory message digest, or checksum, of all the distfiles
@@ -1925,7 +1994,7 @@ digest algorithm used was, at one stage, md5, but that was felt lacking
compared to sha1, and so sha1 is now the default algorithm. The distfile size
is also generated and stored in new distinfo files. The pkgtools/digest utility
calculates all of the digests in the distinfo file, and it provides various
-different algorithms. At the current time, the algorithms provided are: md5,
+different algorithms. At the current time, the algorithms provided are: md5,
rmd160, sha1, sha256, sha384 and sha512.
Some packages have different sets of distfiles on a per architecture basis, for
@@ -1964,9 +2033,9 @@ these problems.
For even more automation, we recommend using mkpatches from the same package to
make a whole set of patches. You just have to backup files before you edit them
-to filename.orig, e.g. with cp -p filename filename.orig or, easier, by using
+to filename.orig, e.g. with cp -p filename filename.orig or, easier, by using
pkgvi again from the same package. If you upgrade a package this way, you can
-easily compare the new set of patches with the previously existing one with
+easily compare the new set of patches with the previously existing one with
patchdiff.
When you have finished a package, remember to generate the checksums for the
@@ -1988,50 +2057,50 @@ after pkgsrc patches are applied.
7.4. Other mandatory files
DESCR
-
+
A multi-line description of the piece of software. This should include any
credits where they are due. Please bear in mind that others do not share
your sense of humour (or spelling idiosyncrasies), and that others will
read everything that you write here.
-
+
PLIST
-
+
This file governs the files that are installed on your system: all the
binaries, manual pages, etc. There are other directives which may be
entered in this file, to control the creation and deletion of directories,
and the location of inserted files. See Chapter 8, PLIST issues for more
information.
-
+
7.5. Optional files
INSTALL
-
+
This shell script is invoked twice by pkg_add(1). First time after package
extraction and before files are moved in place, the second time after the
files to install are moved in place. This can be used to do any custom
- procedures not possible with @exec commands in PLIST. See pkg_add(1) and
+ procedures not possible with @exec commands in PLIST. See pkg_add(1) and
pkg_create(1) for more information.
-
+
DEINSTALL
-
+
This script is executed before and after any files are removed. It is this
script's responsibility to clean up any additional messy details around the
package's installation, since all pkg_delete knows is how to delete the
- files created in the original distribution. See pkg_delete(1) and
+ files created in the original distribution. See pkg_delete(1) and
pkg_create(1) for more information.
-
+
MESSAGE
-
+
Display this file after installation of the package. Useful for things like
legal notices on almost-free software and hints for updating config files
after installing modules for apache, PHP etc. Please note that you can
modify variables in it easily by using MESSAGE_SUBST in the package's
Makefile:
-
+
MESSAGE_SUBST+= SOMEVAR="somevalue"
-
+
replaces "${SOMEVAR}" with "somevalue" in MESSAGE.
-
+
7.6. work*
When you type make the distribution files are unpacked into this directory. It
@@ -2112,13 +2181,13 @@ For example, to get all files inside the libdata/foo directory removed from the
resulting PLIST:
PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
-
+
And to get all the @dirrm lines referring to a specific (shared) directory
converted to @comments:
PRINT_PLIST_AWK+= /^@dirrm share\/specific/ { print "@comment " $$0; next; }
-
+
8.4. Variable substitution in PLIST
@@ -2126,7 +2195,7 @@ A number of variables are substituted automatically in PLISTs when a package is
installed on a system. This includes the following variables:
${MACHINE_ARCH}, ${MACHINE_GNU_ARCH}
-
+
Some packages like emacs and perl embed information about which
architecture they were built on into the pathnames where they install their
file. To handle this case, PLIST will be preprocessed before actually used,
@@ -2134,30 +2203,30 @@ ${MACHINE_ARCH}, ${MACHINE_GNU_ARCH}
The same is done if the string ${MACHINE_GNU_ARCH} is embedded in PLIST
somewhere - use this on packages that have GNU autoconf created configure
scripts.
-
+
Legacy note
-
+
There used to be a symbol "$ARCH" that was replaced by the output of uname
-m, but that's no longer supported and has been removed.
-
+
${OPSYS}, ${LOWER_OPSYS}, ${OS_VERSION}
-
+
Some packages want to embed the OS name and version into some paths. To do
this, use these variables in the PLIST:
-
+
* ${OPSYS} - output of "uname -s"
-
+
* ${LOWER_OPSYS} - lowercase common name (eg. "solaris")
-
+
* ${OS_VERSION} - "uname -r"
-
+
${PKGLOCALEDIR}
-
+
Packages that install locale files should list them in the PLIST as "$
{PKGLOCALEDIR}/locale/de/LC_MESSAGES/..." instead of "share/locale/de/
LC_MESSAGES/...". This properly handles the fact that different operating
systems expect locale files to be either in share or lib by default.
-
+
For a complete list of values which are replaced by default, please look in
bsd.pkg.mk (and search for PLIST_SUBST).
@@ -2190,11 +2259,11 @@ system being used. These differences can be automatically handled by using the
following files:
* PLIST.common
-
+
* PLIST.${OPSYS}
-
+
* PLIST.common_end
-
+
If PLIST.${OPSYS} exists, these files are used instead of PLIST. This allows
packages which behave in this way to be handled gracefully. Manually overriding
PLIST_SRC for other more exotic uses is also possible.
@@ -2211,7 +2280,7 @@ unrelated packages, it's often not worth to add an extra package to remove it.
Therefore, one simply does:
@unexec ${RMDIR} %D/path/to/shared/directory 2>/dev/null || ${TRUE}
-
+
in the PLISTs of all affected packages, instead of the regular "@dirrm" line.
@@ -2221,16 +2290,16 @@ solutions are available:
1. If the packages have a common dependency, the directory can be removed in
that. For example, see textproc/scrollkeeper, which removes the shared
directory share/omf.
-
+
2. If the packages using the directory are not related at all (they have no
common dependencies), a *-dirs package is used.
-
+
From now on, we'll discuss the second solution. To get an idea of the *-dirs
packages available, issue:
% cd .../pkgsrc
% ls -d */*-dirs
-
+
Their use from other packages is very simple. The USE_DIRS variable takes a
list of package names (without the "-dirs" part) together with the required
@@ -2240,7 +2309,7 @@ For example, if a package installs files under share/applications, it should
have the following line in it:
USE_DIRS+= xdg-1.1
-
+
After regenerating the PLIST using make print-PLIST, you should get the right
(commented out) lines.
@@ -2255,28 +2324,28 @@ Table of Contents
9.1. Converting packages to use buildlink3
9.2. Writing buildlink3.mk files
-
+
9.2.1. Anatomy of a buildlink3.mk file
9.2.2. Updating BUILDLINK_DEPENDS.pkg in buildlink3.mk files
-
+
9.3. Writing builtin.mk files
-
+
9.3.1. Anatomy of a builtin.mk file
9.3.2. Global preferences for native or pkgsrc software
-
+
Buildlink is a framework in pkgsrc that controls what headers and libraries are
seen by a package's configure and build processes. This is implemented in a two
step process:
1. Symlink headers and libraries for dependencies into BUILDLINK_DIR, which by
default is a subdirectory of WRKDIR.
-
+
2. Create wrapper scripts that are used in place of the normal compiler tools
that translate -I${LOCALBASE}/include and -L${LOCALBASE}/lib into
references to BUILDLINK_DIR. The wrapper scripts also make native compiler
on some operating systems look like GCC, so that packages that expect GCC
won't require modifications to build with those native compilers.
-
+
This normalizes the environment in which a package is built so that the package
may be built consistently despite what other software may be installed. Please
note that the normal system header and library paths, e.g. /usr/include, /usr/
@@ -2289,19 +2358,19 @@ The process of converting packages to use the buildlink3 framework
("bl3ifying") is fairly straightforward. The things to keep in mind are:
1. Set USE_BUILDLINK3 to "yes".
-
+
2. Ensure that the build always calls the wrapper scripts instead of the
actual toolchain. Some packages are tricky, and the only way to know for
sure is the check ${WRKDIR}/.work.log to see if the wrappers are being
invoked.
-
+
3. Don't override PREFIX from within the package Makefile, e.g. Java VMs,
standalone shells, etc., because the code to symlink files into $
{BUILDLINK_DIR} looks for files relative to "pkg_info -qp pkgname".
-
+
4. Remember that only the buildlink3.mk files that you list in a package's
Makefile are added as dependencies for that package.
-
+
If a dependency on a particular package is required for its libraries and
headers, then we replace:
@@ -2316,29 +2385,29 @@ issues:
* bdb.buildlink3.mk chooses either the native or a pkgsrc Berkeley DB
implementation based on the values of BDB_ACCEPTED and BDB_DEFAULT.
-
+
* curses.buildlink3.mk If the system comes with neither Curses nor NCurses,
this will take care to install the devel/ncurses package.
-
+
* krb5.buildlink3.mk uses the value of KRB5_ACCEPTED to choose between adding
a dependency on Heimdal or MIT-krb5 for packages that require a Kerberos 5
implementation.
-
+
* motif.buildlink3.mk checks for a system-provided Motif installation or adds
a dependency on x11/lesstif or x11/openmotif;
-
+
* ossaudio.buildlink3.mk defines several variables that may be used by
packages that use the Open Sound System (OSS) API;
-
+
* pgsql.buildlink3.mk will accept either Postgres 7.3 or 7.4, whichever is
found installed. See the file for more information.
-
+
* pthread.buildlink3.mk uses the value of PTHREAD_OPTS and checks for native
pthreads or adds a dependency on devel/pth as needed;
-
+
* xaw.buildlink3.mk uses the value of XAW_TYPE to choose a particular Athena
widgets library.
-
+
The comments in those buildlink3.mk files provide a more complete description
of how to use them properly.
@@ -2350,7 +2419,7 @@ buildlink3.mk file should always provide enough information to add the correct
type of dependency relationship and include any other buildlink3.mk files that
it needs to find headers and libraries that it needs in turn.
-To generate an initial buildlink3.mk file for further editing, Rene Hexel's
+To generate an initial buildlink3.mk file for further editing, Rene Hexel's
pkgtools/createbuildlink package is highly recommended. For most packages, the
following command will generate a good starting point for buildlink3.mk files:
@@ -2382,7 +2451,7 @@ BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
.include "../../devel/zlib/buildlink3.mk"
.include "../../graphics/jpeg/buildlink3.mk"
-BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH:S/+$//}
+BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH:S/+$//}
The header and footer manipulate BUILDLINK_DEPTH, which is common across all
buildlink3.mk files and is used to track at what depth we are including
@@ -2399,28 +2468,28 @@ within a buildlink3.mk file.
The third section is protected from multiple inclusion and controls how the
dependency on pkg is added. Several important variables are set in the section:
- * BUILDLINK_DEPENDS.pkg is the actual dependency recorded in the installed
+ * BUILDLINK_DEPENDS. pkg is the actual dependency recorded in the installed
package; this should always be set using += to ensure that we're appending
to any pre-existing list of values. This variable should be set to the
first version of the package that had the last change in the major number
of a shared library or that had a major API change.
-
+
* BUILDLINK_PKGSRCDIR.pkg is the location of the pkg pkgsrc directory;
-
+
* BUILDLINK_DEPMETHOD.pkg (not shown above) controls whether we use
BUILD_DEPENDS or DEPENDS to add the dependency on pkg. The build dependency
is selected by setting BUILDLINK_DEPMETHOD.pkg to "build". By default, the
full dependency is used.
-
- * BUILDLINK_INCDIRS.pkg and BUILDLINK_LIBDIRS. pkg (not shown above) are
+
+ * BUILDLINK_INCDIRS. pkg and BUILDLINK_LIBDIRS.pkg (not shown above) are
lists of subdirectories of ${BUILDLINK_PREFIX.pkg} to add to the header and
library search paths. These default to "include" and "lib" respectively.
-
+
* BUILDLINK_CPPFLAGS.pkg (not shown above) is the list of preprocessor flags
to add to CPPFLAGS, which are passed on to the configure and build phases.
The "-I" option should be avoided and instead be handled using
BUILDLINK_INCDIRS.pkg as above.
-
+
The following variables are all optionally defined within this second section
(protected against multiple inclusion) and control which package files are
symlinked into ${BUILDLINK_DIR} and how their names are transformed during the
@@ -2429,24 +2498,24 @@ symlinking:
* BUILDLINK_FILES.pkg (not shown above) is a shell glob pattern relative to $
{BUILDLINK_PREFIX.pkg} to be symlinked into ${BUILDLINK_DIR}, e.g. include/
*.h.
-
+
* BUILDLINK_FILES_CMD.pkg (not shown above) is a shell pipeline that outputs
to stdout a list of files relative to ${BUILDLINK_PREFIX.pkg}. The
resulting files are to be symlinked into ${BUILDLINK_DIR}. By default, this
takes the +CONTENTS of a pkg and filters it through $
{BUILDLINK_CONTENTS_FILTER.pkg}.
-
+
* BUILDLINK_CONTENTS_FILTER.pkg (not shown above) is a filter command that
filters +CONTENTS input into a list of files relative to $
{BUILDLINK_PREFIX.pkg} on stdout. By default for overwrite packages,
BUILDLINK_CONTENTS_FILTER.pkg outputs the contents of the include and lib
directories in the package +CONTENTS, and for pkgviews packages, it outputs
any libtool archives in lib directories.
-
+
* BUILDLINK_TRANSFORM.pkg (not shown above) is a list of sed arguments used
to transform the name of the source filename into a destination filename,
e.g. -e "s|/curses.h|/ncurses.h|g".
-
+
The last section includes any buildlink3.mk needed for pkg's library
dependencies. Including these buildlink3.mk files means that the headers and
libraries for these dependencies are also symlinked into ${BUILDLINK_DIR}
@@ -2459,16 +2528,15 @@ BUILDLINK_DEPENDS.pkg after a package update:
1. if the sonames (major number of the library version) of any installed
shared libraries change;
-
+
2. if the API or interface to the header files change.
-
+
In these cases, BUILDLINK_DEPENDS.pkg should be adjusted to require at least
the new package version. In some cases, the packages that depend on this new
version may need their PKGREVISIONs increased and, if they have buildlink3.mk
-files, their BUILDLINK_DEPENDS. pkg adjusted, too. This is needed so that
-binary packages made using it will require the correct package dependency and
-not settle for an older one which will not contain the necessary shared
-libraries.
+files, their BUILDLINK_DEPENDS.pkg adjusted, too. This is needed so that binary
+packages made using it will require the correct package dependency and not
+settle for an older one which will not contain the necessary shared libraries.
Please take careful consideration before adjusting BUILDLINK_DEPENDS.pkg as we
don't want to cause unneeded package deletions and rebuilds. In many cases, new
@@ -2488,13 +2556,13 @@ software is appropriate.
The only requirements of a builtin.mk file for pkg are:
1. It should set USE_BUILTIN.pkg to either "yes" or "no" after it is included.
-
+
2. It should not override any USE_BUILTIN.pkg which is already set before the
builtin.mk file is included.
-
+
3. It should be written to allow multiple inclusion. This is very important
and takes careful attention to Makefile coding.
-
+
9.3.1. Anatomy of a builtin.mk file
The following is the recommended template for builtin.mk files:
@@ -2537,7 +2605,7 @@ CHECK_BUILTIN.foo?= no
# "yes" or "no".
#
.endif # CHECK_BUILTIN.foo
-
+
The first section sets IS_BUILTIN.pkg depending on if pkg really exists in the
base system. This should not be a base system software with similar
@@ -2551,13 +2619,13 @@ internally within the builtin.mk file.
The third section sets USE_BUILTIN.pkg and is required in all builtin.mk files.
The code in this section must make the determination whether the built-in
-software is adequate to satisfy the dependencies listed in BUILDLINK_DEPENDS.
-pkg. This is typically done by comparing BUILTIN_PKG.pkg against each of the
-dependencies in BUILDLINK_DEPENDS.pkg. USE_BUILTIN.pkg must be set to the
-correct value by the end of the builtin.mk file. Note that USE_BUILTIN.pkg may
-be "yes" even if IS_BUILTIN.pkg is "no" because we may make the determination
-that the built-in version of the software is similar enough to be used as a
-replacement.
+software is adequate to satisfy the dependencies listed in
+BUILDLINK_DEPENDS.pkg. This is typically done by comparing BUILTIN_PKG.pkg
+against each of the dependencies in BUILDLINK_DEPENDS.pkg. USE_BUILTIN.pkg must
+be set to the correct value by the end of the builtin.mk file. Note that
+USE_BUILTIN.pkg may be "yes" even if IS_BUILTIN.pkg is "no" because we may make
+the determination that the built-in version of the software is similar enough
+to be used as a replacement.
The last section is guarded by CHECK_BUILTIN.pkg, and includes code that uses
the value of USE_BUILTIN.pkg set in the previous section. This typically
@@ -2580,7 +2648,7 @@ all but the most basic bits on a NetBSD system, you can set:
PREFER_PKGSRC= yes
PREFER_NATIVE= getopt skey tcp_wrappers
-
+
A package must have a builtin.mk file to be listed in PREFER_NATIVE, otherwise
it is simply ignored in that list.
@@ -2646,7 +2714,7 @@ CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap}
. include "../../security/cyrus-sasl2/buildlink3.mk"
CONFIGURE_ARGS+= --enable-sasl=${BUILDLINK_PREFIX.sasl}
.endif
-
+
The first section only exists if you are converting a package that had its own
ad-hoc options handling to use bsd.options.mk. It converts global or legacy
@@ -2660,35 +2728,35 @@ supported by the package, and any default options settings if needed.
the options the user wishes to select. The recommended value is
"PKG_OPTIONS.pkg" but any package-specific value may be used. This variable
should be set in a package Makefile.
-
+
2. PKG_SUPPORTED_OPTIONS is a list of build options supported by the package.
This variable should be set in a package Makefile.
-
+
3. ${PKG_OPTIONS_VAR} (the variables named in PKG_OPTIONS_VAR) are variables
that list the selected build options and override any default options given
in PKG_DEFAULT_OPTIONS. If any of the options begin with a "-", then that
option is always removed from the selected build options, e.g.
-
+
PKG_DEFAULT_OPTIONS= kerberos ldap sasl
PKG_OPTIONS_VAR= WIBBLE_OPTIONS
WIBBLE_OPTIONS= ${PKG_DEFAULT_OPTIONS} -sasl
# implies PKG_OPTIONS == "kerberos ldap"
-
-
+
+
or
-
+
PKG_OPTIONS_VAR= WIBBLE_OPTIONS
WIBBLE_OPTIONS= kerberos -ldap ldap
# implies PKG_OPTIONS == "kerberos"
-
-
+
+
This variable should be set in /etc/mk.conf.
-
+
After the inclusion of bsd.options.mk, the following variables are set:
* PKG_OPTIONS contains the list of the selected build options, properly
filtered to remove unsupported and duplicate options.
-
+
The remaining sections contain the logic that is specific to each option. There
should be a check for every option listed in PKG_SUPPORTED_OPTIONS, and there
should be clear documentation on what turning on the option will do in the
@@ -2729,102 +2797,102 @@ When choosing which of these variables to use, follow the following rules:
* PREFIX always points to the location where the current pkg will be
installed. When referring to a pkg's own installation path, use "${PREFIX}
".
-
+
* LOCALBASE is where all non-X11 pkgs are installed. If you need to construct
a -I or -L argument to the compiler to find includes and libraries
installed by another non-X11 pkg, use "${LOCALBASE}".
-
+
* X11BASE is where the actual X11 distribution (from xsrc, etc.) is
installed. When looking for standard X11 includes (not those installed by a
pkg), use "${X11BASE}".
-
+
* X11 based are special in that they may be installed in either X11BASE or
LOCALBASE.
-
+
Usually, X11 packages should be installed under LOCALBASE whenever
possible. Note that you will need to set USE_X11 in them to request the
presence of X11 and to get the right compilation flags.
-
+
Even though, there are some packages that cannot be installed under
LOCALBASE: those that come with app-defaults files. These packages are
special and they must be placed under X11BASE. To accomplish this, set
either USE_X11BASE or USE_IMAKE in your package.
-
+
Some notes: USE_X11 and USE_X11BASE are mutually exclusive. If you need to
find includes or libraries installed by a pkg that has USE_IMAKE or
USE_X11BASE in its pkg Makefile, you need to use both ${X11BASE} and $
- {LOCALBASE}. To force installation of all X11 packages in LOCALBASE, the
+ {LOCALBASE}. To force installation of all X11 packages in LOCALBASE, the
pkgtools/xpkgwedge is enabled by default.
-
+
* X11PREFIX should be used to refer to the installed location of an X11
package. X11PREFIX will be set to X11BASE if xpkgwedge is not installed,
and to LOCALBASE if xpkgwedge is installed.
-
+
* If xpkgwedge is installed, it is possible to have some packages installed
in X11BASE and some in LOCALBASE. To determine the prefix of an installed
package, the EVAL_PREFIX definition can be used. It takes pairs in the
format "DIRNAME=<package>", and the make(1) variable DIRNAME will be set to
the prefix of the installed package <package>, or "${X11PREFIX}" if the
package is not installed.
-
+
This is best illustrated by example.
-
+
The following lines are taken from pkgsrc/wm/scwm/Makefile:
-
- EVAL_PREFIX+= GTKDIR=gtk+
+
+ EVAL_PREFIX+= GTKDIR=gtk+
CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE} \
--with-gtk-prefix="${GTKDIR}" \
--enable-multibyte
-
+
Specific defaults can be defined for the packages evaluated using
EVAL_PREFIX, by using a definition of the form:
-
+
GTKDIR_DEFAULT= ${LOCALBASE}
-
+
where GTKDIR corresponds to the first definition in the EVAL_PREFIX pair.
-
+
* Within ${PREFIX}, packages should install files according to hier(7), with
the exception that manual pages go into ${PREFIX}/man, not ${PREFIX}/share/
man.
-
+
11.2. Main targets
The main targets used during the build process defined in bsd.pkg.mk are:
fetch
-
+
This will check if the file(s) given in the variables DISTFILES and
PATCHFILES (as defined in the package's Makefile) are present on the local
system in /usr/pkgsrc/distfiles. If they are not present, an attempt will
be made to fetch them using commands of the form:
-
+
${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
-
+
where ${site} varies through several possibilities in turn: first,
MASTER_SITE_OVERRIDE is tried, then the sites specified in either
SITES_file if defined, else MASTER_SITES or PATCH_SITES, as applies, then
finally the value of MASTER_SITE_BACKUP. The order of all except the first
can be optionally sorted by the user, via setting either MASTER_SORT_AWK or
MASTER_SORT_REGEX.
-
+
checksum
-
+
After the distfile(s) are fetched, their checksum is generated and compared
with the checksums stored in the distinfo file. If the checksums don't
match, the build is aborted. This is to ensure the same distfile is used
for building, and that the distfile wasn't changed, e.g. by some malign
force, deliberately changed distfiles on the master distribution site or
network lossage.
-
+
extract
-
+
When the distfiles are present on the local system, they need to be
extracted, as they are usually in the form of some compressed archive
format, most commonly .tar.gz.
-
+
If only some of the distfiles need to be uncompressed, the files to be
uncompressed should be put into EXTRACT_ONLY.
-
+
If the distfiles are not in .tar.gz format, they can be extracted by
setting either EXTRACT_SUFX, or EXTRACT_CMD, EXTRACT_BEFORE_ARGS and
EXTRACT_AFTER_ARGS. In the former case, pkgsrc knows how to extract a
@@ -2833,68 +2901,68 @@ extract
various DECOMPRESS_CMD variables bsd.pkg.mk for a complete list). Here's an
example on how to use the other variables for a program that comes with a
compressed shell archive whose name ends in .msg.gz:
-
+
EXTRACT_SUFX= .msg.gz
EXTRACT_CMD= zcat
EXTRACT_BEFORE_ARGS=
EXTRACT_AFTER_ARGS= |sh
-
+
patch
-
+
After extraction, all the patches named by the PATCHFILES, those present in
the patches subdirectory of the package as well as in $LOCALPATCHES/
$PKGPATH (e.g. /usr/local/patches/graphics/png) are applied. Patchfiles
ending in .Z or .gz are uncompressed before they are applied, files ending
in .orig or .rej are ignored. Any special options to patch(1) can be handed
in PATCH_DIST_ARGS. See Section 7.3, "patches/*" for more details.
-
+
By default patch(1) is given special args to make it fail if the patches
apply with some lines of fuzz. Please fix (regen) the patches so that they
apply cleanly. The rationale behind this is that patches that don't apply
cleanly may end up being applied in the wrong place, and cause severe harm
there.
-
+
configure
-
+
Most pieces of software need information on the header files, system calls,
and library routines which are available in NetBSD. This is the process
known as configuration, and is usually automated. In most cases, a script
is supplied with the source, and its invocation results in generation of
header files, Makefiles, etc.
-
+
If the program's distfile contains its own configure script, this can be
invoked by setting HAS_CONFIGURE. If the configure script is a GNU autoconf
script, GNU_CONFIGURE should be specified instead. In either case, any
arguments to the configure script can be specified in the CONFIGURE_ARGS
variable, and the configure script's name can be set in CONFIGURE_SCRIPT if
- it differs from the default "configure". Here's an example from the
+ it differs from the default "configure". Here's an example from the
sysutils/top package:
-
+
HAS_CONFIGURE= yes
CONFIGURE_SCRIPT= Configure
CONFIGURE_ARGS+= netbsd13
-
+
If the program uses an Imakefile for configuration, the appropriate steps
can be invoked by setting USE_IMAKE to "YES". (If you only want the package
installed in $X11PREFIX but xmkmf not being run, set USE_X11BASE instead!)
-
+
build
-
+
Once configuration has taken place, the software will be built by invoking
$MAKE_PROGRAM on $MAKEFILE with $BUILD_TARGET as the target to build. The
default MAKE_PROGRAM is "gmake" if USE_GNU_TOOLS contains "make", "make"
otherwise. MAKEFILE is set to "Makefile" by default, and BUILD_TARGET
defaults to "all". Any of these variables can be set in the package's
Makefile to change the default build process.
-
+
install
-
+
Once the build stage has completed, the final step is to install the
software in public directories, so users can access the programs and files.
As in the build-target, $MAKE_PROGRAM is invoked on $MAKEFILE here, but
with the $INSTALL_TARGET instead, the latter defaulting to "install" (plus
"install.man", if USE_IMAKE is set).
-
+
If no target is specified, the default is "build". If a subsequent stage is
requested, all prior stages are made: e.g. make build will also perform the
equivalent of:
@@ -2909,136 +2977,136 @@ make build
11.3. Other helpful targets
pre/post-*
-
+
For any of the main targets described in the previous section, two
auxiliary targets exist with "pre-" and "post-" used as a prefix for the
main target's name. These targets are invoked before and after the main
target is called, allowing extra configuration or installation steps be
performed from a package's Makefile, for example, which a program's
configure script or install target omitted.
-
+
do-*
-
+
Should one of the main targets do the wrong thing, and should there be no
variable to fix this, you can redefine it with the do-* target. (Note that
redefining the target itself instead of the do-* target is a bad idea, as
the pre-* and post-* targets won't be called anymore, etc.) You will not
usually need to do this.
-
+
reinstall
-
+
If you did a make install and you noticed some file was not installed
properly, you can repeat the installation with this target, which will
ignore the "already installed" flag.
-
+
deinstall
-
+
This target does a pkg_delete(1) in the current directory, effectively
de-installing the package. The following variables can be used to tune the
behaviour:
-
+
PKG_VERBOSE
-
+
Add a "-v" to the pkg_delete(1) command.
-
+
DEINSTALLDEPENDS
-
+
Remove all packages that require (depend on) the given package. This
can be used to remove any packages that may have been pulled in by a
given package, e.g. if make deinstall DEINSTALLDEPENDS=1 is done in
pkgsrc/x11/kde, this is likely to remove whole KDE. Works by adding
"-R" to the pkg_delete(1) command line.
-
+
update
-
+
This target causes the current package to be updated to the latest version.
The package and all depending packages first get de-installed, then current
versions of the corresponding packages get compiled and installed. This is
similar to manually noting which packages are currently installed, then
performing a series of make deinstall and make install (or whatever
UPDATE_TARGET is set to) for these packages.
-
+
You can use the "update" target to resume package updating in case a
previous make update was interrupted for some reason. However, in this
case, make sure you don't call make clean or otherwise remove the list of
dependent packages in WRKDIR. Otherwise you lose the ability to
automatically update the current package along with the dependent packages
you have installed.
-
+
Resuming an interrupted make update will only work as long as the package
tree remains unchanged. If the source code for one of the packages to be
updated has been changed, resuming make update will most certainly fail!
-
+
The following variables can be used either on the command line or in /etc/
mk.conf to alter the behaviour of make update:
-
+
UPDATE_TARGET
-
+
Install target to recursively use for the updated package and the
dependent packages. Defaults to DEPENDS_TARGET if set, "install"
otherwise for make update. e.g. make update UPDATE_TARGET=package
-
+
NOCLEAN
-
+
Don't clean up after updating. Useful if you want to leave the work
sources of the updated packages around for inspection or other
purposes. Be sure you eventually clean up the source tree (see the
"clean-update" target below) or you may run into troubles with old
source code still lying around on your next make or make update.
-
+
REINSTALL
-
+
Deinstall each package before installing (making DEPENDS_TARGET). This
may be necessary if the "clean-update" target (see below) was called
after interrupting a running make update.
-
+
DEPENDS_TARGET
-
+
Allows you to disable recursion and hardcode the target for packages.
The default is "update" for the update target, facilitating a recursive
update of prerequisite packages. Only set DEPENDS_TARGET if you want to
disable recursive updates. Use UPDATE_TARGET instead to just set a
specific target for each package to be installed during make update
(see above).
-
+
clean-update
-
+
Clean the source tree for all packages that would get updated if make
update was called from the current directory. This target should not be
used if the current package (or any of its depending packages) have already
been de-installed (e.g., after calling make update) or you may lose some
- packages you intended to update. As a rule of thumb: only use this target
+ packages you intended to update. As a rule of thumb: only use this target
before the first time you run make update and only if you have a dirty
package tree (e.g., if you used NOCLEAN).
-
- If you unsure about whether your tree is clean you can either perform a
+
+ If you unsure about whether your tree is clean you can either perform a
make clean at the top of the tree, or use the following sequence of
commands from the directory of the package you want to update (before
running make update for the first time, otherwise you lose all the packages
you wanted to update!):
-
+
# make clean-update
# make clean CLEANDEPENDS=YES
# make update
-
+
The following variables can be used either on the command line or in /etc/
mk.conf to alter the behaviour of make clean-update:
-
+
CLEAR_DIRLIST
-
+
After make clean, do not reconstruct the list of directories to update
for this package. Only use this if make update successfully installed
all packages you wanted to update. Normally, this is done automatically
on make update, but may have been suppressed by the NOCLEAN variable
(see above).
-
+
info
-
+
This target invokes pkg_info(1) for the current package. You can use this
to check which version of a package is installed.
-
+
readme
-
+
This target generates a README.html file, which can be viewed using a
browser such as www/mozilla or www/links. The generated files contain
references to any packages which are in the PACKAGES directory on the local
@@ -3048,106 +3116,106 @@ readme
the directory /usr/packages, set FTP_PKG_URL_HOST=file://localhost and
FTP_PKG_URL_DIR=/usr/packages. The ${PACKAGES} directory and its
subdirectories will be searched for all the binary packages.
-
+
readme-all
-
+
Use this target to create a file README-all.html which contains a list of
all packages currently available in the NetBSD Packages Collection,
together with the category they belong to and a short description. This
file is compiled from the pkgsrc/*/README.html files, so be sure to run
this after a make readme.
-
+
cdrom-readme
-
+
This is very much the same as the "readme" target (see above), but is to be
used when generating a pkgsrc tree to be written to a CD-ROM. This target
also produces README.html files, and can be made to refer to URLs based on
CDROM_PKG_URL_HOST and CDROM_PKG_URL_DIR.
-
+
show-distfiles
-
+
This target shows which distfiles and patchfiles are needed to build the
package. (DISTFILES and PATCHFILES, but not patches/*)
-
+
show-downlevel
-
+
This target shows nothing if the package is not installed. If a version of
this package is installed, but is not the version provided in this version
of pkgsrc, then a warning message is displayed. This target can be used to
show which of your installed packages are downlevel, and so the old
versions can be deleted, and the current ones added.
-
+
show-pkgsrc-dir
-
+
This target shows the directory in the pkgsrc hierarchy from which the
package can be built and installed. This may not be the same directory as
the one from which the package was installed. This target is intended to be
used by people who may wish to upgrade many packages on a single host, and
can be invoked from the top-level pkgsrc Makefile by using the
"show-host-specific-pkgs" target.
-
+
show-installed-depends
-
+
This target shows which installed packages match the current package's
DEPENDS. Useful if out of date dependencies are causing build problems.
-
+
check-shlibs
-
+
After a package is installed, check all its binaries and (on ELF platforms)
shared libraries to see if they find the shared libs they need. Run by
default if PKG_DEVELOPER is set in /etc/mk.conf.
-
+
print-PLIST
-
+
After a "make install" from a new or upgraded pkg, this prints out an
attempt to generate a new PLIST from a find -newer work/.extract_done. An
attempt is made to care for shared libs etc., but it is strongly
recommended to review the result before putting it into PLIST. On upgrades,
it's useful to diff the output of this command against an already existing
PLIST file.
-
+
If the package installs files via tar(1) or other methods that don't update
file access times, be sure to add these files manually to your PLIST, as
the "find -newer" command used by this target won't catch them!
-
+
See Section 8.3, "Tweaking output of make print-PLIST" for more information
on this target.
-
+
bulk-package
-
+
Used to do bulk builds. If an appropriate binary package already exists, no
action is taken. If not, this target will compile, install and package it
(and it's depends, if PKG_DEPENDS is set properly. See Section 5.3.1,
"Configuration". After creating the binary package, the sources, the
just-installed package and it's required packages are removed, preserving
free disk space.
-
+
Beware that this target may deinstall all packages installed on a system!
-
+
bulk-install
-
+
Used during bulk-installs to install required packages. If an upto-date
- binary package is available, it will be installed via pkg_add(1). If not,
+ binary package is available, it will be installed via pkg_add(1). If not,
make bulk-package will be executed, but the installed binary not be
removed.
-
+
A binary package is considered "upto-date" to be installed via pkg_add(1)
if:
-
+
* None of the package's files (Makefile, ...) were modified since it was
built.
-
+
* None of the package's required (binary) packages were modified since it
was built.
-
+
Beware that this target may deinstall all packages installed on a system!
-
+
Chapter 12. Notes on fixes for packages
Table of Contents
12.1. General operation
-
+
12.1.1. How to pull in variables from /etc/mk.conf
12.1.2. Restricted packages
12.1.3. Handling dependencies
@@ -3158,24 +3226,24 @@ Table of Contents
12.1.8. How to handle compiler bugs
12.1.9. How to handle incrementing versions when fixing an existing package
12.1.10. Portability of packages
-
+
12.2. Possible downloading issues
-
+
12.2.1. Packages whose distfiles aren't available for plain downloading
12.2.2. How to handle modified distfiles with the 'old' name
-
+
12.3. Configuration gotchas
-
+
12.3.1. Shared libraries - libtool
12.3.2. Using libtool on GNU packages that already support libtool
12.3.3. GNU Autoconf/Automake
-
+
12.4. Building considerations
-
+
12.4.1. CPP defines
-
+
12.5. Package specific actions
-
+
12.5.1. Package configuration files
12.5.2. User interaction
12.5.3. Handling licenses
@@ -3193,7 +3261,7 @@ Table of Contents
12.5.15. Packages installing SGML or XML data
12.5.16. Packages installing extensions to the MIME database
12.5.17. Packages using intltool
-
+
12.6. Feedback to the author
12.1. General operation
@@ -3212,7 +3280,7 @@ the package Makefile before any preprocessor-like .if, .ifdef, or .ifndef
statements:
.include "../../mk/bsd.prefs.mk"
-
+
.if defined(USE_MENUS)
...
.endif
@@ -3232,34 +3300,34 @@ these restrictions, the package system defines five make variables that can be
set to note these restrictions:
* RESTRICTED
-
+
This variable should be set whenever a restriction exists (regardless of
its kind). Set this variable to a string containing the reason for the
restriction.
-
+
* NO_BIN_ON_CDROM
-
+
Binaries may not be placed on CD-ROM. Set this variable to ${RESTRICTED}
whenever a binary package may not be included on a CD-ROM.
-
+
* NO_BIN_ON_FTP
-
+
Binaries may not be placed on an FTP server. Set this variable to $
{RESTRICTED} whenever a binary package may not not be made available on the
Internet.
-
+
* NO_SRC_ON_CDROM
-
+
Distfiles may not be placed on CD-ROM. Set this variable to ${RESTRICTED}
if re-distribution of the source code or other distfile(s) is not allowed
on CD-ROMs.
-
+
* NO_SRC_ON_FTP
-
+
Distfiles may not be placed on FTP. Set this variable to ${RESTRICTED} if
re-distribution of the source code or other distfile(s) via the Internet is
not allowed.
-
+
Please note that the use of NO_PACKAGE, IGNORE, NO_CDROM, or other generic make
variables to denote restrictions is deprecated, because they unconditionally
prevent users from generating binary packages!
@@ -3290,51 +3358,51 @@ version numbers recognised by pkg_info(1).
1. If your package needs another package's binaries or libraries to build or
run, and if that package has a buildlink3.mk file available, use it:
-
+
.include "../../graphics/jpeg/buildlink3.mk"
-
-
+
+
2. If your package needs to use another package to build itself and there is
no buildlink3.mk file available, use the BUILD_DEPENDS definition:
-
+
BUILD_DEPENDS+= autoconf-2.13:../../devel/autoconf
-
+
3. If your package needs a library with which to link and again there is no
buildlink3.mk file available, this is specified using the DEPENDS
definition. An example of this is the print/lyx package, which uses the xpm
library, version 3.4j to build:
-
+
DEPENDS+= xpm-3.4j:../../graphics/xpm
-
+
You can also use wildcards in package dependences:
-
+
DEPENDS+= xpm-[0-9]*:../../graphics/xpm
-
+
Note that such wildcard dependencies are retained when creating binary
packages. The dependency is checked when installing the binary package and
any package which matches the pattern will be used. Wildcard dependencies
should be used with care.
-
+
The "-[0-9]*" should be used instead of "-*" to avoid potentially ambiguous
matches such as "tk-postgresql" matching a "tk-*" DEPENDS.
-
+
Wildcards can also be used to specify that a package will only build
against a certain minimum version of a pre-requisite:
-
+
DEPENDS+= tiff>=3.5.4:../../graphics/tiff
-
+
This means that the package will build against version 3.5.4 of the tiff
library or newer. Such a dependency may be warranted if, for example, the
API of the library has changed with version 3.5.4 and a package would not
compile against an earlier version of tiff.
-
+
Please note that such dependencies should only be updated if a package
requires a newer pre-requisite, but not to denote recommendations such as
security updates or ABI changes that do not prevent a package from building
correctly. Such recommendations can be expressed using RECOMMENDED:
-
+
RECOMMENDED+= tiff>=3.6.1:../../graphics/tiff
-
+
In addition to the above DEPENDS line, this denotes that while a package
will build against tiff>=3.5.4, at least version 3.6.1 is recommended.
RECOMMENDED entries will be turned into dependencies unless explicitly
@@ -3342,21 +3410,21 @@ version numbers recognised by pkg_info(1).
with recommendations ignored may not be uploaded to ftp.NetBSD.org by
developers and should not be used across different systems that may have
different versions of binary packages installed.
-
+
For security fixes, please update the package vulnerabilities file as well
as setting RECOMMENDED, see Section 12.1.7, "Handling packages with
security problems" for more information.
-
+
4. If your package needs some executable to be able to run correctly and if
there's agail no buildlink3.mk file, this is specified using the DEPENDS
variable. The print/lyx package needs to be able to execute the latex
binary from the teTeX package when it runs, and that is specified:
-
+
DEPENDS+= teTeX-[0-9]*:../../print/teTeX
-
+
The comment about wildcard dependencies from previous paragraph applies
here, too.
-
+
If your package needs files from another package to build, see the first part
of the "do-configure" target print/ghostscript5 package (it relies on the jpeg
sources being present in source form during the build):
@@ -3522,7 +3590,7 @@ pkgsrc supports many different machines, with different object formats like
a.out and ELF, and varying abilities to do shared library and dynamic loading
at all. To accompany this, varying commands and options have to be passed to
the compiler, linker, etc. to get the Right Thing, which can be pretty annoying
-especially if you don't have all the machines at your hand to test things. The
+especially if you don't have all the machines at your hand to test things. The
devel/libtool pkg can help here, as it just "knows" how to build both static
and dynamic libraries from a set of source files, thus being platform
independent.
@@ -3530,86 +3598,86 @@ independent.
Here's how to use libtool in a pkg in seven simple steps:
1. Add USE_LIBTOOL=yes to the package Makefile.
-
+
2. For library objects, use "${LIBTOOL} --mode=compile ${CC}" in place of "$
{CC}". You could even add it to the definition of CC, if only libraries are
being built in a given Makefile. This one command will build both PIC and
non-PIC library objects, so you need not have separate shared and
non-shared library rules.
-
+
3. For the linking of the library, remove any "ar", "ranlib", and "ld
-Bshareable" commands, and instead use:
-
+
${LIBTOOL} --mode=link ${CC} -o ${.TARGET:.a=.la} ${OBJS:.o=.lo} -rpath ${PREFIX}/lib -version-info major:minor
-
+
Note that the library is changed to have a .la extension, and the objects
are changed to have a .lo extension. Change OBJS as necessary. This
automatically creates all of the .a, .so.major.minor, and ELF symlinks (if
necessary) in the build directory. Be sure to include "-version-info",
especially when major and minor are zero, as libtool will otherwise strip
off the shared library version.
-
+
From the libtool manual:
-
+
So, libtool library versions are described by three integers:
-
+
CURRENT
The most recent interface number that this library implements.
-
+
REVISION
The implementation number of the CURRENT interface.
-
+
AGE
The difference between the newest and oldest interfaces that this
library implements. In other words, the library implements all the
interface numbers in the range from number `CURRENT - AGE' to
`CURRENT'.
-
+
If two libraries have identical CURRENT and AGE numbers, then the
- dynamic linker chooses the library with the greater REVISION number.
-
+ dynamic linker chooses the library with the greater REVISION number.
+
The "-release" option will produce different results for a.out and ELF
(excluding symlinks) in only one case. An ELF library of the form
"libfoo-release.so.x.y" will have a symlink of "libfoo.so.x.y" on an a.out
platform. This is handled automatically.
-
+
The "-rpath argument" is the install directory of the library being built.
-
- In the PLIST, include all of the .a, .la, and .so, .so.major and .so.major.
- minor files.
-
+
+ In the PLIST, include all of the .a, .la, and .so, .so.major and
+ .so.major.minor files.
+
4. When linking shared object (.so) files, i.e. files that are loaded via
dlopen(3), NOT shared libraries, use "-module -avoid-version" to prevent
them getting version tacked on.
-
+
The PLIST file gets the foo.so entry.
-
+
5. When linking programs that depend on these libraries before they are
installed, preface the cc(1) or ld(1) line with "${LIBTOOL} --mode=link",
and it will find the correct libraries (static or shared), but please be
aware that libtool will not allow you to specify a relative path in -L
(such as "-L../somelib"), because it expects you to change that argument to
be the .la file. e.g.
-
+
${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
-
+
should be changed to:
-
+
${LIBTOOL} --mode=link ${CC} -o someprog ../somelib/somelib.la
-
+
and it will do the right thing with the libraries.
-
+
6. When installing libraries, preface the install(1) or cp(1) command with "$
{LIBTOOL} --mode=install", and change the library name to .la. e.g.
-
+
${LIBTOOL} --mode=install ${BSD_INSTALL_DATA} ${SOMELIB:.a=.la} ${PREFIX}/lib
-
+
This will install the static .a, shared library, any needed symlinks, and
run ldconfig(8).
-
+
7. In your PLIST, include all of the .a, .la, and .so, .so.CURRENT and
.so.CURRENT.REVISION files (this is a change from the previous behaviour).
-
+
12.3.2. Using libtool on GNU packages that already support libtool
Add USE_LIBTOOL=yes to the package Makefile. This will override the package's
@@ -3635,15 +3703,15 @@ in some circumstances. Some of the more common errors are:
* The inclusion of a shared object (-module) as a dependent library in an
executable or library. This in itself isn't a problem if one of two things
has been done:
-
+
1. The shared object is named correctly, i.e. libfoo.la, not foo.la
-
+
2. The -dlopen option is used when linking an executable.
-
+
* The use of libltdl without the correct calls to initialisation routines.
The function lt_dlinit() should be called and the macro
LTDL_SET_PRELOADED_SYMBOLS included in executables.
-
+
12.3.3. GNU Autoconf/Automake
If a package needs GNU autoconf or automake to be executed to regenerate the
@@ -3722,19 +3790,19 @@ variables:
* PKG_SYSCONFBASE is the main config directory under which all package
configuration files are to be found. This defaults to ${PREFIX}/etc, but
may be overridden in /etc/mk.conf.
-
+
* PKG_SYSCONFSUBDIR is the subdirectory of PKG_SYSCONFBASE under which the
configuration files for a particular package may be found, e.g. the Apache
configuration files may all be found under the httpd/ subdirectory of $
{PKG_SYSCONFBASE}. This should be set in the package Makefile.
-
+
* By default, PKG_SYSCONFDIR is set to ${PKG_SYSCONFBASE}/$
{PKG_SYSCONFSUBDIR}, but this may be overridden by setting PKG_SYSCONFDIR.$
{PKG_SYSCONFVAR} for a particular package, where PKG_SYSCONFVAR defaults to
${PKGBASE}. This is not meant to be set by a package Makefile, but is
reserved for users who wish to override the PKG_SYSCONFDIR setting for a
particular package with a special location.
-
+
The only variables that users should customize are PKG_SYSCONFBASE and
PKG_SYSCONFDIR.${PKG_SYSCONFVAR}. Users will typically want to set
PKG_SYSCONFBASE to /etc, or to accept the default location of ${PREFIX}/etc.
@@ -3745,13 +3813,13 @@ Occasionally, packages require interaction from the user, and this can be in a
number of ways:
* help in fetching the distfiles
-
+
* help to configure the package before it is built
-
+
* help during the build process
-
+
* help during the installation of a package
-
+
The INTERACTIVE_STAGE definition is provided to notify the pkgsrc mechanism of
an interactive stage which will be needed, and this should be set in the
package's Makefile. e.g.
@@ -3909,12 +3977,12 @@ Some packages install info files or use the "makeinfo" or "install-info"
commands. Each of the info files:
* is considered to be installed in the directory ${PREFIX}/${INFO_DIR},
-
+
* is registered in the Info directory file ${PREFIX}/${INFO_DIR}/dir,
-
+
* and must be listed as a filename in the INFO_FILES variable in the package
Makefile.
-
+
INFO_DIR defaults to "info" and can be overridden in the package Makefile.
INSTALL and DEINSTALL scripts will be generated to handle registration of the
info files in the Info directory file. The "install-info" command used for the
@@ -3931,7 +3999,7 @@ automatically.
The build and installation process of the software provided by the package
should not use the install-info command as the registration of info files is
-the task of the package INSTALL script, and it must use the appropriate
+the task of the package INSTALL script, and it must use the appropriate
makeinfo command.
To achieve this goal the pkgsrc infrastructure creates overriding scripts for
@@ -3952,23 +4020,23 @@ take some extra steps to make sure they get registered in the database:
deinstallation time, and tells the package where to install GConf2 data
files using some standard configure arguments. It also disallows any access
to the database directly from the package.
-
+
2. Ensure that the package installs its .schemas files under ${PREFIX}/share/
gconf/schemas. If they get installed under ${PREFIX}/etc, you will need to
manually patch the package.
-
+
3. Check the PLIST and remove any entries under the etc/gconf directory, as
they will be handled automatically. See Section 6.13, "Configuration files
handling and placement" for more information.
-
+
4. Define the GCONF2_SCHEMAS variable in your Makefile with a list of all
.schemas files installed by the package, if any. Names must not contain any
directories in them.
-
+
5. Define the GCONF2_ENTRIES variable in your Makefile with a list of all
.entries files installed by the package, if any. Names must not contain any
directories in them.
-
+
12.5.12. Packages installing scrollkeeper data files
If a package installs .omf files, used by scrollkeeper, you need to take some
@@ -3978,13 +4046,13 @@ extra steps to make sure they get registered in the database:
file. This takes care of rebuilding the scrollkeeper database at
installation and deinstallation time, and disallows any access to it
directly from the package.
-
+
2. Check the PLIST and remove any entries under the libdata/scrollkeeper
directory, as they will be handled automatically.
-
+
3. Remove the share/omf directory from the PLIST. It will be handled by
scrollkeeper.
-
+
12.5.13. Packages installing X11 fonts
If a package installs font files, you will need to rebuild the fonts database
@@ -4009,21 +4077,21 @@ steps to get them registered in the GTK2 database properly:
1. Include ../../x11/gtk2/modules.mk instead of its buildlink3.mk file. This
takes care of rebuilding the database at installation and deinstallation
time.
-
+
2. Set GTK2_IMMODULES=YES if your package installs GTK2 immodules.
-
+
3. Set GTK2_LOADERS=YES if your package installs GTK2 loaders.
-
+
4. Patch the package to not touch any of the gtk2 databases directly. These
are:
-
+
* libdata/gtk-2.0/gdk-pixbuf.loaders
-
+
* libdata/gtk-2.0/gtk.immodules
-
+
5. Check the PLIST and remove any entries under the libdata/gtk-2.0 directory,
as they will be handled automatically.
-
+
12.5.15. Packages installing SGML or XML data
If a package installs SGML or XML data files that need to be registered in
@@ -4033,23 +4101,23 @@ extra steps:
1. Include ../../textproc/xmlcatmgr/catalogs.mk in your Makefile, which takes
care of registering those files in system-wide catalogs at installation and
deinstallation time.
-
+
2. Set SGML_CATALOGS to the full path of any SGML catalogs installed by the
package.
-
+
3. Set XML_CATALOGS to the full path of any XML catalogs installed by the
package.
-
+
4. Set SGML_ENTRIES to individual entries to be added to the SGML catalog.
These come in groups of three strings; see xmlcatmgr(1) for more
information (specifically, arguments recognized by the 'add' action). Note
that you will normally not use this variable.
-
+
5. Set XML_ENTRIES to individual entries to be added to the XML catalog. These
come in groups of three strings; see xmlcatmgr(1) for more information
(specifically, arguments recognized by the 'add' action). Note that you
will normally not use this variable.
-
+
12.5.16. Packages installing extensions to the MIME database
If a package provides extensions to the MIME database by installing .xml files
@@ -4061,16 +4129,16 @@ ensure that the database is kept consistent with respect to these new files:
inclusion from other buildlink3.mk files). It takes care of rebuilding the
MIME database at installation and deinstallation time, and disallows any
access to it directly from the package.
-
- 2. Check the PLIST and remove any entries under the share/mime directory,
+
+ 2. Check the PLIST and remove any entries under the share/mime directory,
except for files saved under share/mime/packages. The former are handled
automatically by the update-mime-database program, but the later are
package-dependent and must be removed by the package that installed them in
the first place.
-
+
3. Remove any share/mime/* directories from the PLIST. They will be handled by
the shared-mime-info package.
-
+
12.5.17. Packages using intltool
If a package uses intltool during its build, include the ../../textproc/
@@ -4099,25 +4167,25 @@ do in order to get a package working. Please note this is basically the same as
what was explained in the previous sections, only with some debugging aids.
* Be sure to set PKG_DEVELOPER=1 in /etc/mk.conf
-
+
* Install pkgtools/url2pkg, create a directory for a new package, change into
it, then run url2pkg:
-
+
% mkdir /usr/pkgsrc/category/examplepkg
% cd /usr/pkgsrc/category/examplepkg
% url2pkg http://www.example.com/path/to/distfile.tar.gz
-
+
* Edit the Makefile as requested.
-
+
* Fill in the DESCR file
-
+
* Run make configure
-
+
* Add any dependencies glimpsed from documentation and the configure step to
the package's Makefile.
-
+
* Make the package compile, doing multiple rounds of
-
+
% make
% pkgvi ${WRKSRC}/some/file/that/does/not/compile
% mkpatches
@@ -4125,55 +4193,55 @@ what was explained in the previous sections, only with some debugging aids.
% mv ${WRKDIR}/.newpatches/* patches
% make mps
% make clean
-
+
Doing as non-root user will ensure that no files are modified that
- shouldn't be, especially during the build phase. mkpatches, patchdiff and
+ shouldn't be, especially during the build phase. mkpatches, patchdiff and
pkgvi are from the pkgtools/pkgdiff package.
-
+
* Look at the Makefile, fix if necessary; see Section 7.1, "Makefile".
-
+
* Generate a PLIST:
-
+
# make install
# make print-PLIST >PLIST
# make deinstall
# make install
# make deinstall
-
+
You usually need to be root to do this. Look if there are any files left:
-
+
# make print-PLIST
-
+
If this reveals any files that are missing in PLIST, add them.
-
+
* Now that the PLIST is OK, install the package again and make a binary
package:
-
+
# make reinstall
# make package
-
+
* Delete the installed package:
-
+
# pkg_delete blub
-
+
* Repeat the above make print-PLIST command, which shouldn't find anything
now:
-
+
# make print-PLIST
-
+
* Reinstall the binary package:
-
+
# pkgadd .../blub.tgz
-
+
* Play with it. Make sure everything works.
-
+
* Run pkglint from pkgtools/pkglint, and fix the problems it reports:
-
+
# pkglint
-
+
* Submit (or commit, if you have cvs access); see Chapter 14, Submitting and
Committing.
-
+
Chapter 14. Submitting and Committing
Table of Contents
@@ -4188,30 +4256,31 @@ Table of Contents
You have to separate between binary and "normal" (source) packages here:
* precompiled binary packages
-
+
Our policy is that we accept binaries only from pkgsrc developers to
guarantee that the packages don't contain any trojan horses etc. This is
- not to piss anyone off but rather to protect our users! You're still free
- to put up your home-made binary packages and tell the world where to get
- them.
-
+ not to annoy anyone but rather to protect our users! You're still free to
+ put up your home-made binary packages and tell the world where to get them.
+ NetBSD developers doing bulk builds and wanting to upload them please see
+ Section 5.3.8, "Uploading results of a bulk build".
+
* packages
-
- First, check that your package is complete, compiles and runs well; see
+
+ First, check that your package is complete, compiles and runs well; see
Chapter 13, Debugging and the rest of this document. Next, generate an
uuencoded gzipped tar(1) archive, preferably with all files in a single
directory. Finally, send-pr with category "pkg", a synopsis which includes
the package name and version number, a short description of your package
(contents of the COMMENT variable or DESCR file are OK) and attach the
archive to your PR.
-
+
If you want to submit several packages, please send a separate PR for each
one, it's easier for us to track things that way.
-
+
Alternatively, you can also import new packages into pkgsrc-wip ("pkgsrc
work-in-progress"); see the homepage at http://pkgsrc-wip.sourceforge.net/
for details.
-
+
14.2. Committing: Importing a package into CVS
This section is only of interest for pkgsrc developers with write access to the
@@ -4233,7 +4302,7 @@ so people reading the mailing lists know what the package is/does.
Please note all package updates/additions in pkgsrc/doc/CHANGES. It's very
important to keep this file up to date and conforming to the existing format,
-because it will be used by scripts to automatically update pages on
+because it will be used by scripts to automatically update pages on
www.NetBSD.org and other sites. Additionally, check the pkgsrc/doc/TODO file
and remove the entry for the package you updated, in case it was mentioned
there.
@@ -4249,15 +4318,15 @@ are various reasons for this:
* A URL is volatile, and can change over time. It may go away completely or
its information may be overwritten by newer information.
-
+
* Having the change information between old and new versions in our CVS
repository is very useful for people who use either cvs or anoncvs.
-
+
* Having the change information between old and new versions in our CVS
repository is very useful for people who read the pkgsrc-changes mailing
list, so that they can make tactical decisions about when to upgrade the
package.
-
+
Please also recognise that, just because a new version of a package has been
released, it should not automatically be upgraded in the CVS repository. We
prefer to be conservative in the packages that are included in pkgsrc -
@@ -4269,54 +4338,54 @@ possibly untested features.
14.4. Moving a package in pkgsrc
1. Make a copy of the directory somewhere else.
-
+
2. Remove all CVS dirs.
-
+
Alternatively to the first two steps you can also do:
-
+
% cvs -d user@cvs.NetBSD.org:/cvsroot export -D today pkgsrc/category/package
-
+
and use that for further work.
-
+
3. Fix CATEGORIES and any DEPENDS paths that just did "../package" instead of
"../../category/package".
-
+
4. cvs import the modified package in the new place.
-
+
5. Check if any package depends on it:
-
+
% cd /usr/pkgsrc
% grep /package */*/Makefile* */*/buildlink*
-
+
6. Fix paths in packages from step 5 to point to new location.
-
+
7. cvs rm (-f) the package at the old location.
-
+
8. Remove from oldcategory/Makefile.
-
+
9. Add to newcategory/Makefile.
-
+
10. Commit the changed and removed files:
-
+
% cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile
-
+
(and any packages from step 5, of course).
-
+
Appendix A. A simple example package: bison
Table of Contents
A.1. files
-
+
A.1.1. Makefile
A.1.2. DESCR
A.1.3. PLIST
A.1.4. Checking a package with pkglint
-
+
A.2. Steps for building, installing, packaging
We checked to find a piece of software that wasn't in the packages collection,
-and picked GNU bison. Quite why someone would want to have bison when Berkeley
+and picked GNU bison. Quite why someone would want to have bison when Berkeley
yacc is already present in the tree is beyond us, but it's useful for the
purposes of this exercise.
@@ -4433,7 +4502,7 @@ cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DH
cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g closure.c
cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g conflicts.c
cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g derives.c
-cc -c -DXPFILE=\"/usr/pkg/share/bison.simple\" -DXPFILE1=\"/usr/pkg/share/bison.hairy\" -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -g ./files.c
+cc -c -DXPFILE=\"/usr/pkg/share/bison.simple\" -DXPFILE1=\"/usr/pkg/share/bison.hairy\" -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -g ./files.c
cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g getargs.c
cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g gram.c
cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g lalr.c
@@ -4504,8 +4573,8 @@ Connected to ftp.plig.net.
331 Guest login ok, send your complete e-mail address as password.
230-You are user #5 of 500 simultaneous users allowed.
230-
-230- ___ _ _ _
-230- | _| |_ ___ ___| |_|___ ___ ___ ___
+230- ___ _ _ _
+230- | _| |_ ___ ___| |_|___ ___ ___ ___
230- | _| _| . |_| . | | | . |_| . | _| . |
230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
230- |_| |_| |___| |___|
@@ -4522,7 +4591,7 @@ Connected to ftp.plig.net.
230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
230-
230-Please email comments, bug reports and requests for packages to be
-230-mirrored to ftp-admin@plig.org.
+230-mirrored to ftp-admin@plig.org.
230-
230-
230 Logged in anonymously.
@@ -4533,7 +4602,7 @@ Using binary mode to transfer files.
250-"/pub/figlet" is new cwd.
250-
250-Welcome to the figlet archive at ftp.figlet.org
-250-
+250-
250- ftp://ftp.figlet.org/pub/figlet/
250-
250-The official FIGlet web page is:
@@ -4541,7 +4610,7 @@ Using binary mode to transfer files.
250-
250-If you have questions, please mailto:info@figlet.org. If you want to
250-contribute a font or something else, you can email us.
-250
+250
250 "/pub/figlet/program" is new cwd.
250 "/pub/figlet/program/unix" is new cwd.
local: figlet221.tar.gz remote: figlet221.tar.gz
@@ -4591,7 +4660,7 @@ B.2. Packaging figlet
===> Building binary package for figlet-2.2.1nb2
Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
Using SrcDir value of /usr/pkg
-Registering depends:.
+Registering depends:.
#
Appendix C. Layout of the FTP server's package archive
@@ -4655,23 +4724,23 @@ Layout for precompiled binary packages on ftp.NetBSD.org:
SunOS-5.9/
sparc -> ../pkgsrc-2004Q1/SunOS-5.9/sparc
x86 -> ../pkgsrc-2004Q1/SunOS-5.9/x86
-
+
To create:
1. Run bulk build, see Section 5.3, "Doing a bulk build of all packages"
-
+
2. Upload /usr/pkgsrc/packages to
-
+
ftp://ftp.NetBSD.org/pub/NetBSD/packages/\
- pkgsrc-2004Q3/\ # pkgsrc-branch
+ pkgsrc-2004Q4/\ # pkgsrc-branch
`uname -s`-`uname -r`/ # OS & version
`uname -p` # architecture
-
-
+
+
3. If necessary, create a symlink ln -s `uname -m` `uname -p` (amiga -> m68k,
...)
-
+
Appendix D. Editing guidelines for the pkgsrc guide
Table of Contents
@@ -4687,20 +4756,20 @@ The pkgsrc guide's source code is stored in pkgsrc/doc/guide/files, and several
files are created from it:
* pkgsrc/doc/pkgsrc.txt, which replaces pkgsrc/Packages.txt
-
+
* pkgsrc/doc/pkgsrc.html
-
+
* http://www.NetBSD.org/Documentation/pkgsrc/: the documentation on the
NetBSD website will be built from pkgsrc and kept up to date on the web
server itself. This means you must make sure that your changes haven't
broken the build!
-
+
* http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.pdf: PDF version of the
pkgsrc guide.
-
+
* http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.ps: PostScript version of
the pkgsrc guide.
-
+
D.2. Procedure
The procedure to edit the pkgsrc guide is:
@@ -4711,24 +4780,24 @@ The procedure to edit the pkgsrc guide is:
PostScript- and PDF version. You will need both packages installed, to make
sure documentation is consistent across all formats. The packages can be
found in pkgsrc/meta-pkgs/netbsd-doc and pkgsrc/meta-pkgs/netbsd-doc-print.
-
+
* Edit the XML file(s) in pkgsrc/doc/guide/files.
-
+
* Run make extract && make do-lint in pkgsrc/doc/guide to check the XML
syntax, and fix it if needed.
-
+
* Run make in pkgsrc/doc/guide to build the HTML and ASCII version.
-
+
* If all is well, run make install-doc to put the generated files into pkgsrc
/doc.
-
+
* cvs commit pkgsrc/doc/guide/files
-
+
* cvs commit -m re-generate pkgsrc/doc/pkgsrc.{html,txt}
-
+
* Until the webserver on www.NetBSD.org is really updated automatically to
pick up changes to the pkgsrc guide automatically, also run make
install-htdoc HTDOCSDIR=../../../htdocs (or similar, adjust HTDOCSDIR!).
-
+
* cvs commit htdocs/Documentation/pkgsrc
-
+