1 # $NetBSD: Packages.txt,v 1.81 2000/02/10 02:09:17 abs Exp $
2 ###########################################################################
4 ==========================
7 ==========================
9 Hubert Feyrer, Alistair Crooks
15 grep -B1 '^.====' Packages.txt | egrep -v '^.[-=]'
21 There is a lot of software freely available for Unix based systems, which
22 usually runs on NetBSD, too, sometimes with some modifications. The NetBSD
23 packages collection incorporates any such changes necessary to make that
24 software run on NetBSD, and makes the installation (and reinstallation) of
25 the software package easy by means of a single command.
27 The NetBSD package system is used to enable such freely available
28 third-party software to be built easily on NetBSD hosts. Once the software
29 has been built, it is manipulated with the pkg_* tools so that installation
30 and de-installation, printing of an inventory of all installed packages and
31 retrieval of one-line comments or more verbose descriptions are all simple.
33 Both the NetBSD packages collection and the NetBSD package system are
40 This document is divided into two parts. The first, "User's Guide",
41 describes how one can use one of the packages in the Package
42 Collection, either by installing a precompiled binary package, or by
43 building your own copy using the NetBSD package system. The second
44 part, "Package Constructor's Guide", explains how to prepare a package so
45 it can be easily built by other NetBSD users without knowing about the
46 package's building details.
52 There has been a lot of talk about "ports", "packages", etc. so far. Here
53 is a description of all the terminology used within this document:
56 A set of files and building instructions that describe what's necessary
57 to build a certain piece of software using the NetBSD package
58 system. Packages are traditionally stored under /usr/pkgsrc.
60 * The NetBSD package system:
61 This is the part of the NetBSD operating system handling building
62 (compiling), installing, and removing of packages.
65 This term describes the file or files that are provided by the author
66 of the piece of freely available software to distribute his work. All
67 the changes necessary to build on NetBSD are reflected in the
68 corresponding package. Usually the distfile is in the form of a
69 compressed tar-archive, but other types are possible, too. Distfiles
70 are stored below /usr/pkgsrc/distfiles.
73 This is the term used by FreeBSD people for what we call a package.
74 In NetBSD terminology, "port" refers to a different architecture.
76 * Precompiled (binary) package:
77 A set of binaries built by the NetBSD package system from a distfile
78 using the NetBSD package system and stuffed together in a single .tgz
79 file so it can be installed on machines of the same machine architecture
80 without the need to recompile. Packages are generated in
81 /usr/pkgsrc/packages by the NetBSD package system; there is also an
82 archive on ftp.netbsd.org.
84 Sometimes, this is referred to by the term "package" too,
85 especially in the context of precompiled packages.
88 The piece of software to be installed which will be constructed from
89 all the files in the Distfile by the actions defined in the
90 corresponding package.
93 Some files in a package contain RCS IDs to reflect which version of
94 that file this is (inserted automatically by cvs). These IDs are used
95 in several examples within this document, but as this document itself
96 is managed by CVS, it can't list the RCS IDs in plaintext. Instead, the
97 $s are written as <$>, resulting in <$>NetBSD<$> and <$>Id<$>.
104 1 Installing a precompiled binary package
105 =========================================
107 This section describes how to find, retrieve and install a precompiled
108 binary package that someone else already prepared for your type of machine.
114 Precompiled packages are stored on ftp.netbsd.org and its mirrors in the
115 directory /pub/NetBSD/packages for anon FTP access. Please pick the right
116 subdirectory there as indicated by "sysctl hw.machine_arch". In that
117 directory, there is a subdirectory for each category plus a subdirectory
118 "All" which includes the actual binaries in .tgz-files. The category
119 subdirectories use symbolic links to those files. (This is the same
120 directory layout as in /usr/pkgsrc/packages).
122 This same directory layout applies for CDROM distributions, only that the
123 directory may be rooted somewhere else, probably somewhere below /cdrom.
124 Please consult your CDROM's documentation for the exact location!
130 If you have the files on a CDROM or downloaded them to your hard disk, you
131 can install them with the following command (be sure to su to root first):
133 pkg_add /path/to/package.tgz
135 If you have FTP access and you don't want to download the packages via FTP
136 prior to installation, you can do this automatically by giving pkg_add an
139 pkg_add ftp://ftp.netbsd.org/pub/NetBSD/packages/<OS Ver>/<arch>/All/package.tgz
141 If there is any doubt, the sysctl utility can be used to determine the
142 <OS Ver>, and <arch> by running "sysctl kern.osrelease hw.machine_arch".
144 Also note that any prerequisite packages needed to run the package in
145 question will be installed, too, assuming they are present where you install
148 After you've installed packages, be sure to have /usr/pkg in your $PATH so
149 you can actually start the just installed program.
152 1.3 A word of warning
153 =====================
155 Please pay very careful attention to the warnings expressed in that manual
156 page about the inherent dangers of installing binary packages which you did
157 not create yourself, and the security holes that can be introduced onto
158 your system by indiscriminate adding of such files.
161 2 Installing by Building
162 ========================
164 This assumes that the package is already part of the NetBSD package system.
165 If it is not, then you are advised to read part II of this document,
166 "Package Constructor's Guide".
169 2.1 Where to get pkgsrc
170 =======================
172 To get the package source going, you need to get the pkgsrc.tar.gz file
173 from ftp://ftp.netbsd.org/pub/NetBSD-current/tar_files/pkgsrc.tar.gz and
174 unpack it into /usr/pkgsrc.
176 As an alternative, you can get pkgsrc via the Software Update Protocol,
177 SUP. To do so, make sure your supfile has a line saying "release=pkgsrc" in
178 it, see the examples in /usr/share/examples/supfiles, and that the
179 directory /usr/pkgsrc does exist. Then, simply start "sup -v
180 /path/to/your/supfile".
183 2.2 Fetching distfiles
184 ======================
186 There is one gotcha: The distribution file (i.e. the unmodified source)
187 must exist on your system for the packages system to be able to build it.
188 If it does not, then ftp(1) is used to fetch the distribution files
191 You can overwrite some of the major distribution sites to fit to sites
192 that are close to your own. Have a look at /usr/pkgsrc/mk/mk.conf.example
193 to find some examples. This may save some of your bandwidth and time.
195 When you have selected your settings, install your configuration into
198 If you don't have a permanent Internet connection and you want to know
199 which files to download, "make fetch-list" will tell you what you'll need.
200 Put these distfiles into /usr/pkgsrc/distfiles.
203 2.3 How to build and install
204 ============================
206 Assuming that has been done, become root and change into the relevant
207 directory. Then you can type
211 at the shell prompt to build the various components of the package, and
215 at the shell prompt to install the various components into the correct
216 places on your system.
218 Taking the top system utility as an example, we can install it on our
219 system by building as shown in appendix A.1.
221 The program is installed under the default root of the packages tree -
222 /usr/pkg. Should this not conform to your tastes, simply set the LOCALBASE
223 variable in your environment, and it will use that value as the root of
224 your packages tree. So, to use /usr/local, set
228 in your environment. There is, of course, one exception to this - X11
229 packages are traditionally installed in the X11 tree. The environment
230 variable which governs an X11 package's location is X11BASE. So to
231 install an X11 package into /usr/local/X11R6, set
233 X11BASE=/usr/local/X11R6
237 However, beware that strange things may happen if you install X11
238 packages outside the X11 tree, in that libraries and header files may
239 not be found by other software, and Application Defaults may not be
240 found. For that reason, you are advised to leave X11 packages in the
241 X11 tree. We are looking at ways to change this.
243 Some packages look in /etc/mk.conf to alter some configuration options
244 at build time. Have a look at /usr/pkgsrc/mk/mk.conf.example to get an
245 overview of what you can set there. Environment variables such as
246 LOCALBASE, and X11BASE can also be set in /etc/mk.conf to save having
247 to remember to set them each time you want to use pkgsrc.
250 3 Making a precompiled package
251 ==============================
253 Once you have built and installed the package as mentioned above, you can
254 build it into a "binary package" - you might want to do this so that you
255 can use the binaries you have just built on another NetBSD system, or to
256 provide a simple means for others to use your binary package instead of
257 wasting CPU time - this is done by changing to the appropriate directory in
258 the pkgsrc tree, and typing the command
262 at the shell prompt. This will build and install your package (if not
263 already done), and then construct a binary package out of the results so
264 that you can use the pkg_* tools to manipulate this. The binary package is
265 stored under /usr/pkgsrc/packages, it's in the form of a gzipped file at
266 the present time. See appendix A.2 for a continuation of the above top
269 Please see the "submitting" section later in this document on how to submit
270 such a binary package.
273 ====================================
274 Part II: Package Constructor's Guide
275 ====================================
277 4 Package components - files, directories and contents
278 ======================================================
280 Whenever you're preparing a package from the FreeBSD ports collection or
281 doing it from scratch, there are a number of files involved which are
282 described in the following sections. Special directions are given for what
283 differs from FreeBSD ports for each file.
289 Building, installation and creation of a binary package are all controlled
290 by the package's Makefile.
292 There is a Makefile for each package. This file includes the standard
293 bsd.pkg.mk file (referenced as "../../mk/bsd.pkg.mk"), which sets all the
294 definitions and actions necessary for the package to compile and install
295 itself. The mandatory fields are the DISTNAME which specifies the base name
296 of the distribution file to be downloaded from the site on the Internet,
297 MASTER_SITES which specifies that site, CATEGORIES which denotes the
298 categories into which the package falls, PKGNAME which is the name of the
299 package and the MAINTAINER name. This is so that anyone who quibbles with
300 the (always completely correct) decisions taken by the guy who maintains
301 the port can complain vigorously.
303 The MASTER_SITES may be set to one of the predefined sites:
305 ${MASTER_SITE_XCONTRIB}
307 ${MASTER_SITE_PERL_CPAN}
308 ${MASTER_SITE_TEX_CTAN}
309 ${MASTER_SITE_SUNSITE}
311 If one of these predefined sites is chosen, you may require the ability to
312 specify a subdirectory of that site. Since these macros may expand to
313 more than one actual site, you MUST use the following construct to specify
316 ${MASTER_SITE_GNU:=subdirectory/name/}
318 (Note the trailing slash after the subdirectory name.) Use of the deprecated
319 MASTER_SITE_SUBDIR will not work.
321 Currently the following values are available for CATEGORIES. If more than
322 one is used, they need to be separated by spaces:
324 archivers corba graphics meta-pkgs print
325 audio cross ham misc security
326 benchmarks databases japanese net shells
327 biology devel lang news sysutils
328 cad editors mail parallel textproc
329 comms emulators math pkgtools www
330 converters games mbone plan9 x11
332 See the NetBSD packages(7) manual page for a description of all available
333 options and variables.
335 Please pay attention to the following gotchas, especially when preparing a
336 package from the FreeBSD ports collection:
338 - Remove all MANx and CATx definitions from the package Makefile -
339 NetBSD has implemented automatic manual page handling, and these
340 definitions are now obsolete.
341 - Add MANCOMPRESSED (if not already there) if manpages are installed in
342 compressed form by the package; see comment in bsd.pkg.mk
343 - Replace /usr/local by ${PREFIX} in all files (see patches below)
344 - Delete any ldconfig commands - this will be done automatically for you
345 if the NetBSD platform supports ldconfig, and other measures will be
346 taken on platforms which do not support ldconfig (e.g. NetBSD/Alpha)
347 - If modifying a package from the FreeBSD ports collection, preserve
348 their RCS ID: remove the '$'s around the FreeBSD RCS Id, and insert the
349 word FreeBSD, then add a <$>NetBSD<$> (Without the <>s, please remember
350 the Terminology section), i.e.:
353 # <$>Id: Makefile,v 1.17 1997/06/16 06:39:51 max Exp <$>
357 # FreeBSD Id: Makefile,v 1.17 1997/06/16 06:39:51 max Exp
358 - If the package installs any info files, the main info directory file
359 needs to be updated to reflect this fact. NetBSD now has an INFO_FILES
360 definition, which is used to do this. For example, to install the
361 indent.info entry into the info directory file, simply use the
363 INFO_FILES= indent.info
365 definition in the package Makefile. If the package does this insertion
366 for you, you should specify USE_GTEXINFO in the package Makefile, to
367 ensure that the pre-requisite GNU texinfo package is installed on your
369 - Adjust MAINTAINER to be either yourself, if you plan to maintain the
370 package for future updates, or set it to the default MAINTAINER
371 packages@netbsd.org, as it is unlikely that the FreeBSD people will
372 care about NetBSD packages.
373 - If there exists a home page for the software in question, please
374 add the variable HOMEPAGE right after MAINTAINER. The value of this
375 variable should be the URL for the home page.
381 Most important, the mandatory md5 checksum of all the distfiles needed for
382 the package to compile, confirming they match the original file any patches
383 were generated against. This ensures that the distfile retrieved from the
384 Internet has not been corrupted during transfer or altered by a malign force
385 to introduce a security hole. It can be generated by hand using the md5(1)
386 command or by invoking "make makesum".
389 The checksum file for all the official patches for the package, found in the
390 patches/ directory (see section 4.3). This checksum file includes an MD5
391 checksum of all lines in the patch file except the NetBSD RCS Id. This file
392 is generated by invoking "make makepatchsum".
394 Besides that, if you have any files that you wish to be placed in the
395 package prior to configuration or building, you could place these files
396 here and use a ${CP} command in the pre-configure target to achieve this.
397 Alternatively, you could simply diff the file against /dev/null and use the
398 patch mechanism to manage the creation of this file.
404 This directory contains files that are used by the patch(1) command to
405 modify the sources as distributed in the distribution file into a form that
406 will compile and run perfectly on NetBSD. The files are applied
407 successively in alphabetic order (as returned by a shell "patches/patch-*"
408 glob expansion), so patch-aa is applied before patch-ab etc.
410 The patch-?? files should be in diff -bu format. This is because (not only)
411 the FreeBSD ports tsar finds this format easier to read than context diffs,
412 and so you have more chance of getting your NetBSD package accepted as part
413 of the FreeBSD ports system if you format your diffs in a unified fashion.
415 Furthermore, do not put changes for more than one file into a single
416 patch-file, as this will make future modifications more difficult.
418 One important thing to mention is to pay attention that no RCS IDs get
419 stored in the patch files, as these will cause problems when later checked
420 into the NetBSD CVS tree. To avoid this, use the "-U 2" or -U 1" option to
423 When preparing a FreeBSD port for the NetBSD packages system, it's likely
424 that the FreeBSD port will work on NetBSD. However, check that the person
425 who ported the software to FreeBSD has not played fast and loose with the
426 __FreeBSD__ cpp definition without good cause - a simple way to do this is
429 grep -i freebsd patches/patch-??
431 in the package directory.
433 Besides taking care of any FreeBSDisms, be sure to provide patches to
434 replace any occurrence of /usr/local in any "Makefile"s in the original
435 package with ${PREFIX}.
437 When you have finished a package, remember to generate the checksums
438 for the patch files by using the "make makepatchsum" command, see
445 This directory contains several files used to manage the creation of binary
446 packages. Files from this directory are used in the binary package itself,
447 and will thus be installed on other machines, so you should be aware that
448 there is a wider audience than you might think for your comments and
451 4.4.1 Mandatory files
452 =====================
455 A one-line description of the piece of software. There is no need to
456 mention the package's name - this will automatically be added by the
457 pkg_* tools when they are invoked.
460 A multi-line description of the piece of software. This should include
461 any credits where they are due. Please bear in mind that others do not
462 share your sense of humour (or spelling idiosyncrasies), and that others
463 will read everything that you write here.
466 This file governs the files that are installed on your system: all the
467 binaries, manual pages, etc. There are other directives which may be
468 entered in this file, to control the creation and deletion of
469 directories, and the location of inserted files.
471 If you're updating a FreeBSD package to work for NetBSD, please pay special
472 attention to the following things in pkg/PLIST:
474 - If there are any "@exec ldconfig ..." statements, or any "@unexec
475 ldconfig ...", delete them. NetBSD works out automatically whether to
476 call ldconfig, since some NetBSD architectures do not have ldconfig.
477 - Add any missing @dirrm statements
478 - Remove any MANx= definitions in the package Makefile
480 You could also investigate the port2pkg package (pkgsrc/pkgtools/port2pkg),
481 which does a lot of the donkey work for you.
488 Shell script invoked twice during pkg_add. First time after package
489 extraction and before files are moved in place, the second time after
490 the files to install are moved in place. This can be used to do any
491 custom procedures not possible with @exec commands in PLIST. See
492 pkg_add(1) and pkg_create(1) for more information.
495 This script is executed before and after any files are removed. It is
496 this script's responsibility to clean up any additional messy details
497 around the package's installation, since all pkg_delete knows is how to
498 delete the files created in the original distribution. See pkg_delete(1)
499 and pkg_create(1) for more information.
502 Require-script that is invoked before installation and de-installation
503 to ensure things like certain accounts being available, user/sysadmin
504 agreeing with usage policy, etc.
507 Display this file after installation of the package.
508 Useful for things like legal notices on almost-free software,
515 This directory contains any files that are necessary for configuration of
516 your software, etc. If a script with any of the following names is present,
517 it will be executed at the appropriate time during the build process:
520 pre-extract post-extract
522 pre-configure post-configure configure
524 pre-install post-install
525 pre-package post-package
527 Note that you should NOT define a pre-* or post-* target in the Makefile
528 which executes the matching scripts/[pre|post]-* script. bsd.pkg.mk runs
529 any existing Makefile target first, then searches for scripts/* and runs
530 it using sh(1). Running the script from the Makefile would cause it to
533 See section 7 for a description of the build process.
539 When you type "make" the distribution files are unpacked into this
540 directory. It can be removed by typing
544 at the shell prompt. Also, this directory is used to keep various
548 4.7 importing the package into CVS
549 ==================================
551 Newly created packages should be imported with a vendor tag of "TNF" and
552 a release tag of "pkgsrc-base", e.g::
554 cvs import pkgsrc/<category>/frobnitz TNF pkgsrc-base
556 Packages derived from a FreeBSD port should be imported with a vendor tag
557 of "FREEBSD" and a release tag of "FreeBSD-current-YYYY-MM-DD" (YYYY-MM-DD
558 being the date when the snapshot of the port were taken form the FreeBSD
559 tree), and then doing the necessary modifications by normal CVS operations.
562 cvs import pkgsrc/<category>/mumbler FREEBSD FreeBSD-current-1998-04-01
563 cvs rm patches/patch-a
564 cvs add patches/patch-aa
567 Please note all package updates/additions in doc/pkg-CHANGES! Its very important
568 to keep this file up to date, because it will be used by scripts to
569 automatically update some pages on www.netbsd.org.
575 This section addresses some special issues that one needs to pay attention
576 to when dealing with the PLIST file (or files, see below!).
583 Be sure to add a RCS ID line as the first thing in any PLIST file you
586 @comment <$>NetBSD<$>
589 Don't put any ranlib commands into your PLIST files, as they will cause
590 troubles when the package is removed. Just make sure the build-process
591 does run ranlib - it usually does - and you can leave this out. This is
592 usually only a problem when using ports from FreeBSD.
595 Don't put any ldconfig commands into your PLIST files, as they will
596 cause problems. All shared object caching is done automatically in
597 NetBSD (this takes place when you see the "Automatic shared object
598 handling" message), and so you can leave this out. If any shared
599 objects are found in the package, they will be dealt with
600 automatically, running ldconfig on platforms which need it, and not
601 otherwise. This is usually only a problem when using ports from
604 * ${MACHINE_ARCH}, ${MACHINE_GNU_ARCH}:
605 Some packages like emacs and perl embed information about which
606 architecture they were built on into the pathnames where they install
607 their file. To handle this case, PLIST will be preprocessed before
608 actually used, and the symbol "${MACHINE_ARCH}" will be replaced by
609 what "sysctl -n hw.machine_arch" gives. The same is done if the string
610 ${MACHINE_GNU_ARCH} is embedded in PLIST somewhere - use this on
611 packages that use GNU autoconfigure.
613 Legacy note: There used to be a symbol "<$ARCH>" that was replaced by
614 the output of "uname -m", but that's no longer supported and has been
617 * ${OPSYS}, ${OS_VERSION}:
618 Some packages want to embed the OS name and version into some paths.
619 to do this, use these two variables in PLIST. ${OPSYS} will be replaced
620 by output from "uname -s", ${OS_VERSION} will be set to what "uname -r"
623 * Manpage-compression:
624 Manpages should be installed in compressed form if MANZ is set (in
625 bsd.own.mk), and uncompressed otherwise. To handle this in the PLIST
626 file, the suffix ".gz" is appended/removed automatically for manpages
627 according to MANZ and MANCOMPRESSED being set or not, see above for
628 details. This modification of the PLIST file is done on a copy of it,
629 not pkg/PLIST itself.
632 5.2 MD/MI vs. general PLIST
633 ===========================
635 Sometimes the packaging list in pkg/PLIST differs between platforms, e.g.
636 if one of them supports shared libs and the other does not. To address
637 this, a hook has been introduced into the NetBSD packages system to provide
638 a PLIST file defined on conditions set freely in the package's Makefile.
644 To use one or more files as source for the PLIST used in generating the
645 binary package, set the variable PLIST_SRC to the names of that file(s).
646 The files are later concatenated using cat(1), and order of things is an
647 important issue, see below.
650 5.2.2 PLIST-mi, PLIST-md.shared, PLIST-md.static
651 ================================================
653 If PLIST_SRC is not set (the usual case), and if there is no pkg/PLIST, the
654 packages system looks for pkg/PLIST-mi, and pkg/PLIST-md.shared or
655 pkg/PLIST-md.static to handle differences due to the platform being able to
656 handle shared libs or not. PLIST-mi contains machine independent files,
657 PLIST-md.* contain machine dependent files, which may differ between
658 architectures that don't support dynamic libs/shared loading. Currently,
659 this is only used in the perl-packages, and as perl5 on alpha doesn't
660 support dynamic loading of extensions like perl/Tk yet, PLIST.mi-static is
661 also used on the alpha (besides pmax and powerpc). Alpha will hopefully be
662 removed soon when perl's fixed for dynamic loading.
664 (This handling of MI/MD PLIST files is implemented by setting PLIST_SRC to
665 either "PLIST-mi PLIST-md.static" or "PLIST-mi PLIST-md.shared", see
666 /usr/pkgsrc/mk/bsd.pkg.mk).
669 5.2.3 Order in the PLIST* file(s)
670 =================================
672 There is one gotcha regarding the ordering of @dirrm statements: any MI
673 @dirrm directives that follow any MD @dirrm's *must* go into the PLIST.md-*
674 files, as the files PLIST-mi and PLIST.md-{shared/static} are concatenated
675 in exactly this order. If the MI directory would be listed in PLIST-mi, it
676 would be removed before the MD directory, which wouldn't work.
678 E.g. if you have the following dirs:
682 then PLIST-mi contains:
685 and PLIST-md.* contain:
689 This will lead to some @dirrm statements being duplicated, but it's the
690 only way to ensure everything is properly removed. The same care must be
691 taken when PLIST_SRC is set to some package-specific settings.
694 6 Notes on fixes for packages
695 =============================
700 To port an application to NetBSD, it's usually necessary for the compiler
701 to be able to judge the system on which it's compiling, and we use
702 definitions so that the C pre-processor can do this.
704 The really impatient should just note that a number of the FreeBSD ports
705 (which are called packages in the NetBSD world) rely on the CPP definition
706 __FreeBSD__. This should be used sparingly, for FreeBSD-specific features,
707 but unfortunately this is not always the case. A number also rely on the
708 fact that the CPU type is an Intel-based little-endian CPU.
710 To test whether you are working on a 4.4 BSD-derived system, you should use
711 the BSD definition, which is defined in <sys/param.h> on said systems.
713 #include <sys/param.h>
715 and then you can surround the BSD-specific parts of your port using the
718 #if (defined(BSD) && BSD >= 199306)
722 Please use the __NetBSD__ definition sparingly - it should only apply to
723 features of NetBSD that are not present in other 4.4-lite derived BSDs.
725 You should also avoid defining __FreeBSD__=1 and then simply using the
726 FreeBSD port, if only from an aesthetic viewpoint.
729 6.2 Shared libraries - libtool
730 ==============================
732 NetBSD supports many different machines, with different object formats
733 like a.out and ELF, and varying abilities to do shared library and
734 dynamic loading at all. To accompany this, varying commands and options
735 have to be passed to the compiler, linker etc. to get the Right Thing,
736 which can be pretty annoying especially if you don't have all the
737 machines at your hand to test things. The "libtool" pkg can help
738 here, as it just "knows" how to build both static and dynamic
739 libraries from a set our source files, thus being platform
742 To use "libtool", add a build-dependency on the libtool-pkg, then modify
743 the pkg's sources to use libtool for building it's libraries and add the
744 resulting patches to your pkg's patches-directory.
746 Here's how to use libtool in a pkg in seven simple steps:
748 1. Add USE_LIBTOOL= yes to the package Makefile.
750 2. For library objects, use "${LIBTOOL} --mode=compile ${CC}" in place of
751 ${CC}. You could even add it to the definition of CC, if only
752 libraries are being built in a given Makefile. This one command will
753 build both PIC and non-PIC library objects, so you need not have
754 separate shared and non-shared library rules.
756 3. For the linking of the library, remove any "ar", "ranlib", and "ld
757 -Bshareable" commands, and use instead:
759 ${LIBTOOL} --mode=link cc -o ${.TARGET:.a=.la} ${OBJS:.o=.lo} -rpath ${PREFIX}/lib -version-info major:minor
761 Note that the library is changed to have a .la extension, and the
762 objects are changed to have a .lo extension. Change OBJS as necessary.
763 This automatically creates all of the .a, .so.major.minor, and ELF
764 symlinks (if necessary) in the build directory.
766 4. When linking programs that depend on these libraries _before_ they are
767 installed, preface the cc or ld line with "${LIBTOOL} --mode=link", and
768 it will find the correct libraries (static or shared), but please be
769 aware that libtool will not allow you to specify a relative path in -L
770 (such as -L../somelib), because it is trying to force you to change
771 that argument to be the .la file. For example:
773 ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
775 won't work; it needs to be changed to:
777 ${LIBTOOL} --mode=link ${CC} -o someprog ../somelib/somelib.la
779 and it will DTRT with the libraries. If you *must* use a relative path
780 with -L, and you are not going to run this program before installing
781 it, you can omit the use of libtool during link and install of this
782 program if you add the subdirectory ".libs" in your -L command:
784 ${CC} -o someprog -L../somelib/.libs -lsomelib
786 5. When installing libraries, preface the install or cp command with
787 "${LIBTOOL} --mode=install", and change the library name to .la. For
790 ${LIBTOOL} --mode=install ${BSD_INSTALL_DATA} ${SOMELIB:.a=.la} ${PREFIX}/lib
792 This will install the static .a, shared library, any needed symlinks,
795 6. In your PLIST, include the .a, .la, and .so.major.minor files. Don't
796 include the ELF symlink files; those are automatic.
798 FOR GNU PKGS THAT ALREADY SUPPORT LIBTOOL:
799 Add USE_LIBTOOL=yes and LTCONFIG_OVERRIDE=${WRKSRC}/ltconfig to the
800 package Makefile as the quick way to bypass the pkg's own libtool.
801 The pkg's own libtool is made by ltconfig script at do-configure target.
802 If USE_LIBTOOL and LTCONFIG_OVERRIDE are defined, the specified ltconfig is
803 overridden, using the pkgtools/pkglibtool instead of the pkg's own libtool.
804 If the pkg already has an original "libtool" which we can replace with
805 pkgtools/pkglibtool you may have to specify LIBTOOL_OVERRIDE to the package
809 6.3 Gotchas of FreeBSD ports
810 ============================
812 See section 4.1 for Makefile issues (MANx, CATx, MANCOMPRESSED, ldconfig,
813 RCS IDs) and section 4.3 for gotchas on using patches from FreeBSD ports.
815 One of the biggest problems with FreeBSD ports is that too many of
816 them assume they will install into /usr/local, instead of honouring
817 any ${PREFIX} setting properly. To change this, add something like the
818 following into your package Makefile:
821 for f in `find ${WRKDIR} -type f -print|xargs grep -l '/usr/local'`; do
823 ${SED} -e 's:/usr/local:'${PREFIX}':g' < $$f > $$f.pdone && ${MV} $
827 This is taken from the sysutils/rtty package; be sure this works for your
828 package - it may actually make sense to look for some things in /usr/local,
829 for example. So don't blindly replace all occurrences of /usr/local!
831 FreeBSD has decided to list manual pages in the package Makefile, with
832 no corresponding entry in the PLIST. You will thus need to add any
833 MAN[1-8ln] files to the PLIST, before deleting the MAN[1-8ln]
834 definition. Similarly with MLINKS and CAT[1-8ln] entries.
836 Side note on manpages in PLIST: we don't take any notice of any .gz
837 suffix there, as many FreeBSD ports seem to have .gz pages in PLIST
838 even when they install manpages without compressing them; rather, we
839 add our own .gz suffix there according to MANZ. In short, it does not
840 matter whether the manual page name in the PLIST has a .gz suffix or
841 not - if it needs one which is not already there, it will be appended
842 automatically, and if there is a .gz suffix which is not needed, it
843 will be deleted automatically.
845 Some packages use bsd-style .mk files when building, and so any manual
846 pages that are installed will be gzip-compressed, if MANZ is set, or
847 not if MANZ is not set. If the package uses bsd-style .mk files, the
848 variable MANCOMPRESSED_IF_MANZ should be set to a value of "yes" in
849 the package Makefile.
852 6.4 Feedback to the author
853 ==========================
855 If you have found any bugs in the package you make available, if you had to
856 do special steps to make it run under NetBSD or if you enhanced the software
857 in various other ways, be sure to report these changes back to the original
858 author of the program! With that kind of support, the next release of the
859 program can incorporate these fixes, and people not using the NetBSD packages
860 system can win from your efforts.
862 Support the idea of free software!
868 The basic steps for building a program are always the same. First the
869 program's source (distfile) must be brought to the local system and
870 then extracted. After any patches to compile properly on NetBSD are
871 applied, the software can be configured, then built (usually by
872 compiling), and finally the generated binaries etc. can be put into
873 place on the system. These are exactly the steps performed by the
874 NetBSD package system, which is implemented as a series of targets in
875 a central Makefile, /usr/pkgsrc/mk/bsd.pkg.mk.
881 Before outlining the process performed by the NetBSD package system in the
882 next section, here's a brief discussion on where programs are installed,
883 and which variables influence this.
885 The automatic variable PREFIX indicates where all files of the final
886 program shall be installed. It is usually set to $LOCALBASE (/usr/pkg),
887 or $CROSSBASE for pkgs in the "cross" category, though its value becomes
888 that of $X11BASE if USE_IMAKE, USE_MOTIF, or USE_X11BASE is set. The value
889 ${PREFIX} needs to be put into the various places in the program's source
890 where paths to these files are encoded; see sections 4.3 and 6.2 for
893 When choosing which of these variables to use, follow the following rules:
895 * ${PREFIX} always points to the location where the current pkg will be
896 installed. When referring to a pkg's own installation path, use ${PREFIX}.
898 * ${LOCALBASE} is where all non-X11 pkgs are installed. If you need to
899 construct a -I or -L argument to the compiler to find includes and
900 libraries installed by another non-X11 pkg, use ${LOCALBASE}.
902 * ${X11BASE} is where the actual X11 distribution is installed. When looking
903 for _standard_ X11 includes (not those installed by a pkg), use ${X11BASE}.
905 * X11 based pkgs are special in that they may be installed in either
906 X11BASE or LOCALBASE depending on a configuration option in /etc/mk.conf.
907 If you need to find includes or libraries installed by a pkg that has
908 USE_IMAKE, USE_MOTIF, or USE_X11BASE in its pkg Makefile, you need to use
909 _both_ ${X11BASE} and ${LOCALBASE}.
915 The main targets used during the build process defined in bsd.pkg.mk are:
918 This will check if the file(s) given in the variables DISTFILES and
919 PATCHFILES (as defined in the package's Makefile) are present on the
920 local system in /usr/pkgsrc/distfiles. If they are not present, they
921 will be fetched using ftp(1) from the site(s) given in the variable
922 PATCH_SITES. The location(s) in PATCH_SITES are in the form of URLs
923 and can be ftp://- and http://-URLs, as ftp(1) understands both of
927 After the distfile(s) are fetched, their MD5 checksum is generated and
928 compared with the checksums stored in the files/md5 file. If the
929 checksums don't match, the build is aborted. This is to ensure the same
930 distfile is used for building, and that the distfile wasn't changed,
931 e.g. by some malign force, deliberately changed distfiles on the master
932 distribution site or network lossage.
935 When the distfiles are present on the local system, they need to be
936 extracted, as they are usually in the form of some compressed archive
937 format, most commonly .tar.gz. If only some of the distfiles need to be
938 uncompressed, the files to be uncompressed should be put into
939 EXTRACT_ONLY. If the distfiles are not in .tar.gz format, they can be
940 extracted by setting EXTRACT_CMD, EXTRACT_BEFORE_ARGS and/or
944 After extraction, all the patches named by the PATCHFILES and those
945 present in the patches subdirectory of the package are applied.
946 Patchfiles ending in .Z or .gz are uncompressed before they are
947 applied, files ending in .orig or .rej are ignored. Any special
948 options to patch(1) can be handed in PATCH_DIST_ARGS. See section
949 4.3 for more details.
952 Most pieces of software need information on the header files,
953 system calls, and library routines which are available in NetBSD.
954 This is the process known as configuration, and is usually
955 automated. In most cases, a script is supplied with the source,
956 and its invocation results in generation of header files,
959 If the program doesn't come with its own configure script, one can be
960 placed in the package's scripts directory, called "configure". If so, it
961 is executed using sh(1).
963 If the program's distfile contains its own configure script, this can
964 be invoked by setting HAS_CONFIGURE. If the configure script is a GNU
965 autoconf script, GNU_CONFIGURE should be specified instead. In either
966 case, any arguments to the configure script can be specified in the
967 CONFIGURE_ARGS variable, and the configure script's name can be set in
968 CONFIGURE_SCRIPT if it differs from the default "configure".
970 If the program uses an Imakefile for configuration, the appropriate
971 steps can be invoked by setting USE_IMAKE to YES. (If you only want the
972 package installed in $X11BASE but xmkmf not being run, set USE_X11BASE
976 Once configuration has taken place, the software can be built on
977 NetBSD by invoking $MAKE_PROGRAM on $MAKEFILE with $ALL_TARGET as
978 the target to build. The default MAKE_PROGRAM is "gmake" if
979 USE_GMAKE is set, "make" otherwise. MAKEFILE is set to "Makefile"
980 by default, and ALL_TARGET defaults to "all". Any of these
981 variables can be set to change the default build process.
984 Once the build stage has completed, the final step is to install
985 the software in public directories, for users. As in the
986 build-target, $MAKE_PROGRAM is invoked on $MAKEFILE here, but with
987 the $INSTALL_TARGET instead, the latter defaulting to "install"
988 (plus "install.man", if USE_IMAKE is set).
990 If no target is specified, the default is "build". If a subsequent stage
991 is requested, all prior stages are made: e.g. "make build" will also
992 perform the equivalent of:
1002 7.3 Other helpful targets
1003 =========================
1006 For any of the main targets described in the previous section, two
1007 auxiliary targets exist with "pre-" and "post-" used as a prefix
1008 for the main target's name. These targets are invoked before and
1009 after the main target is called, allowing extra configuration or
1010 installation steps, for example, which program's configure script
1011 or install target omitted. For any of these auxiliary targets,
1012 scripts of the same name can be placed in the package's
1013 scripts-subdirectory that will be executed at the given time, see
1017 Should one of the main targets do the wrong thing, and should there
1018 be no variable to fix this, you can redefine it with the do-*
1019 target. (Note that redefining the target itself instead of the
1020 do-* target is a bad idea, as the pre-* and post-* targets won't be
1021 called anymore, etc.) You will not usually need to do this.
1024 If you did a "make install" and you noticed some file was not installed
1025 properly, you can repeat the installation with this target, which will
1026 ignore the "already installed" flag.
1029 This target does a pkg_delete(1) in the current directory,
1030 effectively de-installing the package. The following variables can
1031 be used either on the command line or in /etc/mk.conf to tune the
1035 Add a "-v" to the pkg_delete(1) command.
1038 Remove all packages that require (depend on) the given package.
1039 This can be used to remove any packages that may have been pulled in
1040 by a given package, e.g. if "make deinstall DEINSTALLDEPENDS=1" is
1041 done in x11/kde, this is likely to remove whole KDE. Works by adding
1042 a "-R" to the pkg_delete command line.
1045 This target causes the current package to be updated to the latest
1046 version. The package and all depending packages first get deinstalled,
1047 then current versions of the corresponding packages get compiled and
1048 installed. This is similar to manually noting which packages are
1049 currently installed, then performing a series of "make deinstall" and
1050 and "make install" (or whatever DEPENDS_TARGET is set to) for these
1053 You can use the "update" target to resume package updating in case a
1054 previous "make update" was interrupted for some reason. However, in
1055 this case, make sure you don't call "make clean" or otherwise remove
1056 the list of dependent packages in ${WRKDIR}. Otherwise you lose the
1057 ability to automatically update the current package along with the
1058 dependent packages you have installed.
1060 Resuming an interrupted 'make update' will only work as long as the
1061 package tree remains unchanged. If the source code for one of the
1062 packages to be updated has been changed, resuming 'make update' will
1063 most certainly fail!
1065 The following variables can be used either on the command line or in
1066 /etc/mk.conf to alter the behaviour of "make update":
1069 Install target to use for the updated package and the
1070 dependent packages. Defaults to "install". E.g.
1071 "make update DEPENDS_TARGET=package"
1074 Don't clean up after updating. Useful if you want to leave the
1075 work sources of the updated packages around for inspection or
1076 other purposes. Be sure you eventually clean up the source
1077 tree (see the "clean-update" target below) or you may run into
1078 troubles with old source code still lying around on your next
1079 "make" or "make update".
1082 Use "reinstall" instead of ${DEPENDS_TARGET} for every package
1083 that gets updated. Be sure you know the implications of using
1084 the "reinstall" target when using this variable.
1087 Clean the source tree for all packages that would get updated if
1088 "make update" was called from the current directory. This target
1089 should not be used if the current package (or any of its depending
1090 packages) have already been deinstalled (e.g., after calling "make
1091 update") or you may lose some packages you intended to update.
1092 As a rule of thumb: only use this target _before_ the first time
1093 you call "make update" and only if you have a dirty package tree
1094 (e.g., if you used NOCLEAN). The following variables can be used
1095 either on the command line or in /etc/mk.conf to alter the behaviour
1096 of "make clean-update":
1099 After "make clean", do not reconstruct the list of directories to
1100 update for this package. Only use this if "make update" successfully
1101 installed all packages you wanted to update. Normally, this is done
1102 automatically on "make update", but may have been suppressed by the
1103 NOCLEAN variable (see above).
1106 This target generates a README.html file, which can be viewed using a
1107 browser such as netscape (pkgsrc/www/mozilla) or lynx (pkgsrc/www/lynx).
1108 The generated files contain references to any packages which are in the
1109 ${PACKAGES} directory on the local host. The generated files can
1110 be made to refer to URLs based on FTP_PKG_URL_HOST and
1111 FTP_PKG_URL_DIR. (For example, if I wanted to generate README.html
1112 files which pointed to binary packages on the local machine, in the
1113 directory /usr/packages, set FTP_PKG_URL_HOST=file://localhost and
1114 FTP_PKG_URL_DIR=/usr/packages. The ${PACKAGES} directory and its
1115 subdirectories will be searched for all the binary packages.)
1118 Use this target to create a file README-all.html which contains a
1119 list of all packages currently available in the NetBSD Packages
1120 Collection, together with the category they belong to and a short
1121 description. This file is compiled from the pkgsrc/*/README.html
1122 files, so be sure to run this _after_ a "make readme".
1125 This is very much the same as the readme: target (see above), but is
1126 to be used when generating a pkgsrc tree to be written to a CD-ROM.
1127 This target also produces README.html files, and can be made to refer
1128 to URLs based on CDROM_PKG_URL_HOST and CDROM_PKG_URL_DIR.
1131 This target shows which distfiles and patchfiles are needed to build
1132 the package. (DISTFILES and PATCHFILES, but not patches/*)
1135 This target shows nothing if the package is not installed. If a version
1136 of this package is installed, but is not the version provided in this
1137 version of pkgsrc, then a warning message is displayed. This target can
1138 be used to show which of your installed packages are downlevel, and so
1139 the old versions can be deleted, and the current ones added.
1145 To check out all the gotchas when building a package (wither from
1146 a FreeBSD port, or from scratch), here are the steps that I do in
1147 order to get a package working. Please note this is basically the
1148 same as what was explained in the previous sections, only with some
1151 - Retrieve port from FreeBSD collection
1152 - Fix RCS-ID in the package's Makefile, see section 4.1.
1153 - Import unchanged FreeBSD source (ONLY if you have cvs access, not needed
1155 (cd .../pkgsrc/category/pkgname ; cvs import pkgsrc/category/pkgname \
1156 FREEBSD FreeBSD-current-yyyy-mm-dd)
1157 - If you did a CVS import, check it out to apply the following fixes
1158 (not needed if you don't have CVS access!)
1159 - Look at Makefile, fix if necessary; see section 4.1.
1160 - Look at patches, remember if not appropriate
1161 - Have a look at pkg/PLIST, add a "@comment <$>NetBSD<$>" line at the
1162 beginning of any PLIST file (see section 5).
1164 - If something is not ok, fix; for patches: fix the file, then re-generate
1165 the diff: 'diff -bu foo.orig foo >../../patches/patch-xx' (mv patch-xx
1166 patch-xx.orig before); If there's no foo.orig from a previous patch, be
1167 sure to have an old version of the file somewhere; re-iterate :)
1168 - If all builds OK: touch /tmp/bla
1170 - find /usr/pkg/ /usr/X11R6/ -newer /tmp/bla >/tmp/x
1171 (or whatever you set LOCALBASE and X11BASE to)
1173 - find /usr/pkg/ /usr/X11R6/ -newer /tmp/bla: if this brings up any files,
1174 they are missing in pkg/PLIST*; add them.
1175 - Compare pkg/PLIST* against /tmp/x, fix the former one
1176 ( sort /tmp/x >/tmp/x2 ; sort pkg/PLIST >/tmp/P ; sdiff /tmp/x2 /tmp/P )
1177 - make reinstall && make package
1179 - "find /usr/pkg/ /usr/X11R6/ -type f -newer /tmp/bla" shouldn't find anything
1181 - pkg_add .../blub.tgz
1183 - pkg_delete - still no file should be left (re-run above find)
1184 - make clean && touch /tmp/bla && make install && make clean && make deinstall
1185 then run the find again. Yes, some software authors write Makefiles that
1186 install files during the build target. Sigh. Re-run the find, and fix the
1187 PLIST. Repeat until certain the software does not install any files that
1189 - submit (or commit, if you have cvs access); see section 10.
1192 9 FAQs & features of the package system
1193 =======================================
1195 9.1 Packages using GNU autoconfig
1196 9.2 Other distrib methods than .tar.gz
1197 9.3 Packages not creating their own subdirectory
1198 9.4 Custom configuration process
1199 9.5 Packages not building in their DISTNAME directory
1200 9.6 How to fetch all distfiles at once
1201 9.7 How to fetch files from behind a firewall
1202 9.8 If your patch contains an RCS ID
1203 9.9 How to pull in variables from /etc/mk.conf
1204 9.10 Is there a mailing list for pkg-related discussion?
1205 9.11 How do i tell "make fetch" to do passive FTP?
1206 9.12 Dependencies on other packages
1207 9.13 Conflicts with other packages
1208 9.14 Software which has a WWW Home Page
1209 9.15 How to handle modified distfiles with the 'old' name
1212 9.1 Packages using GNU autoconfig
1213 =================================
1215 If your package uses GNU autoconf, add the following to your package's
1218 > GNU_CONFIGURE= yes
1220 Note that this appends --prefix=${PREFIX} to CONFIGURE_ARGS, so you don't
1221 have to do that yourself, and this may not be what you want.
1224 9.2 Other distrib methods than .tar.gz
1225 ======================================
1227 If your package uses a different distribution method from .tar.gz, take a
1228 look at the package for plan9/sam, which uses a gzipped shell archive
1229 (shar), but the quick solution is to set EXTRACT_SUFX to the name after the
1230 DISTNAME field, and add the following to your package's Makefile:
1232 > EXTRACT_SUFX= .msg.gz
1234 > EXTRACT_BEFORE_ARGS=
1235 > EXTRACT_AFTER_ARGS= |sh
1238 9.3 Packages not creating their own subdirectory
1239 ================================================
1241 Your package doesn't create a subdirectory for itself (like GNU software
1242 does, for instance), but extracts itself in the current directory: see
1243 plan9/sam again, but the quick answer is:
1248 9.4 Custom configuration process
1249 ================================
1251 Your package uses a weird Configure script: See the top package, but the
1254 > HAS_CONFIGURE= yes
1255 > CONFIGURE_SCRIPT= Configure
1256 > CONFIGURE_ARGS+= netbsd13
1259 9.5 Packages not building in their DISTNAME directory
1260 ======================================================
1262 Your package builds in a different directory from its base DISTNAME - see
1263 tcl and tk packages:
1265 > WRKSRC= ${WRKDIR}/${DISTNAME}/unix
1268 9.6 How to fetch all distfiles at once
1269 ======================================
1271 You would like to download all the distfiles in a single batch from work or
1272 university, where you can't run a "make fetch". But there's no archive of
1273 the distfiles on ftp.netbsd.org and the one on ftp.freebsd.org contains
1274 many distfiles for which there are no ports (yet).
1276 The answer here is to do a "make fetch-list" in /usr/pkgsrc and use the
1280 9.7 How to fetch files from behind a firewall
1281 =============================================
1283 If you are sitting behind a firewall which does not allow direct connections
1284 to Internet hosts (i.e. non-NAT), you may specify the relevant proxy hosts.
1285 This is done using an environment variable in the form of a URL
1286 e.g. in Amdahl, the machine orpheus.amdahl.com is one of the firewalls, and
1287 it uses port 80 as the proxy port number. So the proxy environment
1288 variables look like:
1290 ftp_proxy=ftp://orpheus.amdahl.com:80/
1291 http_proxy=http://orpheus.amdahl.com:80/
1294 9.8 If your patch contains an RCS ID
1295 ====================================
1297 See section 4.3 on how to remove RCS IDs from patch files.
1300 9.9 How to pull in variables from /etc/mk.conf
1301 ==============================================
1303 The problem with package-defined variables that can be overridden via
1304 MAKECONF or /etc/mk.conf is that make(1) expands a variable as it is
1305 used, but evaluates preprocessor like statements (.if, .ifdef and
1306 .ifndef) as they are read. So, to use any variable (which may be set
1307 in /etc/mk.conf) in one of the .if* statements, the file /etc/mk.conf
1308 must be included before that .if* statement.
1310 Rather than have a number of ad-hoc ways of including /etc/mk.conf,
1311 should it exist, or MAKECONF, should it exist, include the
1312 pkgsrc/mk/bsd.prefs.mk file in the package Makefile before any
1313 preprocessor-like .if, .ifdef, or .ifndef statements:
1315 .include "../../mk/bsd.prefs.mk"
1317 .if defined(USE_MENUS)
1322 9.10 Is there a mailing list for pkg-related discussion?
1323 ========================================================
1325 Yes. We are using tech-pkg@netbsd.org for discussing package related
1326 issues. To subscribe do:
1328 echo subscribe tech-pkg | mail majordomo@netbsd.org
1331 9.11 How do i tell "make fetch" to do passive FTP?
1332 ==================================================
1334 This depends on which utility is used to retrieve distfiles. From
1335 bsd.pkg.mk, FETCH_CMD is assigned the first available command from the
1339 ${LOCALBASE}/bsd/bin/ftp
1342 On a default NetBSD install, this will be /usr/bin/ftp, which automatically
1343 tries passive connections first, and falls back to active connections if the
1344 server refuses to do passive. For the other tools, add the following to your
1345 /etc/mk.conf file: PASSIVE_FETCH=1
1347 Having that option present will prevent /usr/bin/ftp from falling back to
1351 9.12 Dependencies on other packages
1352 ===================================
1354 Your package may depend on some other package being present - and there are
1355 various ways of expressing this dependency. NetBSD supports the
1356 BUILD_DEPENDS and DEPENDS definitions (beware: the DEPENDS definition is
1357 not the same as FreeBSD's deprecated one, and NetBSD does not use the
1358 FreeBSD LIB_DEPENDS definition any more - it proved problematic on ELF
1361 [In the following examples, the BUILD_DEPENDS dependencies have the format:
1362 <file>:<directory containing package to build>[:<stage>] If the <stage>
1363 isn't specified, it defaults to ``install''. If the file contains a '/', it
1364 is interpreted as a regular file - otherwise, the name is taken to be an
1365 executable file, and the PATH is searched for <file>. If the regular file
1366 is not found, or the executable file is not in the path, then the
1367 pre-requisite package will be built from the sources in <directory
1368 containing the package to build>. The DEPENDS definition specifies a
1369 package name (which contains its version number), and the directory
1370 containing the package to build if this version of the package is not
1373 (a) If your package needs files from another package to build, see the
1374 print/ghostscript5 package (it relies on the jpeg sources being
1375 present in source form during the build):
1377 BUILD_DEPENDS+= ../../graphics/jpeg/${WRKDIR:T}/jpeg-6a:../../graphics/jpeg:extract
1379 (b) If your package needs to use another package to build itself, this
1380 is specified using the BUILD_DEPENDS definition, but without
1381 specifying the stage ``:extract'' in (a) above. An example is the
1382 print/lyx package, which uses the latex binary during its build
1385 BUILD_DEPENDS+= latex:../../print/teTeX
1387 (c) If your package needs a library with which to link, this is
1388 specified using the DEPENDS definition. An example of this is the
1389 print/lyx package, which uses the xpm library, version 3.4j to build.
1391 DEPENDS+= xpm-3.4j:../../graphics/xpm
1393 You can also use wildcards in package dependences:
1395 DEPENDS+= xpm-*:../../graphics/xpm
1397 Note that these wildcards will be expanded while creating binary packages.
1398 Thus binary package will depend on exactly the version which was installed
1399 when they were created.
1401 (d) If your package needs some executable to be able to run correctly, this
1402 is specified using the DEPENDS definition. The print/lyx package needs to
1403 be able to execute the latex binary from the teTex package when it runs,
1404 and that is specified:
1406 DEPENDS+= teTex-*:../../print/teTeX
1410 9.13 Conflicts with other packages
1411 ==================================
1413 Your package may conflict with other packages a user might already have
1414 installed on his system, e.g. if your package installs the same set of
1415 files like another package in our pkgsrc tree.
1417 In this case you can set CONFLICTS to a space separated list of packages
1418 (including version string) your package conflicts with.
1420 For example pkgsrc/x11/Xaw3d and pkgsrc/x11/Xaw-Xpm install provide the
1421 same shared library, thus you set in pkgsrc/x11/Xaw3d/Makefile:
1423 CONFLICTS= Xaw-Xpm-*
1425 and in pkgsrc/x11/Xaw-Xpm/Makefile:
1429 Packages will automatically conflict with other packages with the name prefix
1430 and a different version string. "Xaw3d-1.5" e.g. will automatically conflict
1431 with the older version "Xaw3d-1.3".
1433 9.14 Software which has a WWW Home Page
1434 =======================================
1436 The NetBSD packages system now supports a variable called HOMEPAGE.
1437 If the software being packaged has a home page, the Makefile should
1438 include the URL for that page in the HOMEPAGE variable. The definition
1439 of the variable should be placed immediately after the MAINTAINER
1442 9.15 How to handle modified distfiles with the 'old' name
1443 =========================================================
1445 Sometimes authors of a software package make some modifications after the
1446 software was released, and they put up a new distfile without changing the
1447 package's version number. If a package is already in pkgsrc at that time,
1448 the md5 checksum will no longer match. The correct way to work around this
1449 is to update the package's md5 checksum to match the package on the master
1450 site (beware, any mirrors may not be up to date yet!), and to remove the
1451 old distfile from ftp.netbsd.org's /pub/NetBSD/packages/distfiles directory.
1452 Furthermore, a mail to the package's author seems appropriate making sure
1453 the distfile was really updated on purpose, and that no trojan horse or so
1456 9.16 What does "Don't know how to make /usr/share/tmap/tmac.andoc" mean?
1457 ========================================================================
1459 When compiling the pkgsrc/pkgtools/pkg_install package, you get the error
1460 from make that it doesn't know how to make /usr/share/tmap/tmac.andoc? This
1461 indicates that you don't have installed the "text" set on your machine
1462 (nroff, ...). Please do that.
1464 9.17 How to handle incrementing versions when fixing an existing package
1465 ========================================================================
1467 When making fixes to an existing package it can be useful to change
1468 the version number in PKGNAME. To avoid conflicting with future versions
1469 by the original author, use a 'nb1' suffix (later versions should
1470 increment this to give 'nb2' and so on).
1475 * precompiled binary packages:
1476 Our policy is that we accept binaries from only NetBSD developers to
1477 guarantee that the packages don't contain any trojan horses etc.
1478 This is not to piss anyone off but rather to protect our users!
1479 You're still free to put up your home-made binary packages and tell
1480 the world where to get them.
1483 First, check that your package is complete, compiles and runs well; see
1484 section 8 and the rest of this document. Then, generate a gzipped
1485 tar-file of all the files needed for the package, preferably with all
1486 files in a single directory. Place this tar-file to a place where the
1487 package maintainers can fetch it using FTP or HTTP (WWW). Finally,
1488 send-pr with category "pkg", a synopsis which includes the package name
1489 and version number, a short description of your package
1490 (contents of pkg/COMMENT are OK) and the URL of your tar-file.
1492 You will be notified if your send-pr has been addressed so you can remove
1496 11 A simple example of a package: bison
1497 =======================================
1499 I checked to find a piece of software that isn't in the FreeBSD ports
1500 collection, and picked GNU bison. Quite why someone would want to have
1501 bison when Berkeley yacc is already present in the tree is beyond me, but
1502 it's useful for the purposes of this exercise.
1508 The file contents in this section must be used without the "> " prefix.
1516 > DISTNAME= bison-1.25
1518 > MASTER_SITES= ${MASTER_SITE_GNU}
1520 > MAINTAINER= thorpej@netbsd.org
1521 > HOMEPAGE= http://www.gnu.org/software/bison/bison.html
1523 > GNU_CONFIGURE= yes
1524 > INFO_FILES= bison.info
1526 > .include "../../mk/bsd.pkg.mk"
1538 > GNU version of yacc. Can make re-entrant parsers, and numerous other
1539 > improvements. Why you would want this when Berkeley yacc(1) is part
1540 > of the NetBSD source tree is beyond me.
1546 > @comment <$>NetBSD<$>
1548 > man/man1/bison.1.gz
1549 > @unexec install-info --delete %D/info/bison.info %D/info/dir
1556 > @exec install-info %D/info/bison.info %D/info/dir
1557 > share/bison.simple
1561 11.1.5 Checking a package "pkglint"
1562 ===================================
1564 The NetBSD package system comes with a tool called "pkglint" (located in the
1565 directory "pkgsrc/pkgtools/pkglint") which helps to check the contents of these
1566 files. After installation it is quite easy to use, just change to the
1567 directory of the package you which to examine and execute "pkglint":
1569 > tron@lyssa:/usr/pkgsrc/devel/bison>pkglint
1570 > OK: checking pkg/COMMENT.
1571 > OK: checking pkg/DESCR.
1572 > OK: checking Makefile.
1573 > OK: checking files/md5.
1574 > OK: checking patches/patch-aa.
1577 Depending on the supplied command line arguments (see "man pkglint") more
1578 intensive checks will be performed. Use e.g. "pkglint -a -v" for a very
1579 detailed and verbose check.
1582 11.2 Steps for building, installing, packaging
1583 ==============================================
1585 Create the directory where the package lives, plus any auxiliary directories:
1587 > root@pumpy:/u/pkgsrc/lang(1765)# cd /usr/pkgsrc/lang
1588 > root@pumpy:/u/pkgsrc/lang(1765)# mkdir bison
1589 > root@pumpy:/u/pkgsrc/lang(1766)# cd bison
1590 > root@pumpy:/u/pkgsrc/lang/bison(1768)# mkdir files patches pkg
1592 Create Makefile, pkg/COMMENT, pkg/DESCR and pkg/PLIST as in section 11.1,
1593 then continue with fetching the distfile:
1595 > root@pumpy:/u/pkgsrc/lang/bison(1769)# make fetch
1596 > >> bison-1.25.tar.gz doesn't seem to exist on this system.
1597 > >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
1598 > Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1599 > ftp: Error retrieving file: 500 Internal error
1601 > >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
1602 > Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1603 > ftp: Error retrieving file: 500 Internal error
1605 > >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
1606 > Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1607 > Successfully retrieved file.
1609 Generate the checksum of the distfile into files/md5:
1611 > root@pumpy:/u/pkgsrc/lang/bison(1770)# make makesum
1615 > root@pumpy:/u/pkgsrc/lang/bison(1777)# make
1616 > >> Checksum OK for bison-1.25.tar.gz.
1617 > ===> Extracting for bison-1.25
1618 > ===> Patching for bison-1.25
1619 > ===> Ignoring empty patch directory
1620 > ===> Configuring for bison-1.25
1621 > creating cache ./config.cache
1622 > checking for gcc... cc
1623 > checking whether we are using GNU C... yes
1624 > checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
1625 > checking how to run the C preprocessor... cc -E
1626 > checking for minix/config.h... no
1627 > checking for POSIXized ISC... no
1628 > checking whether cross-compiling... no
1629 > checking for ANSI C header files... yes
1630 > checking for string.h... yes
1631 > checking for stdlib.h... yes
1632 > checking for memory.h... yes
1633 > checking for working const... yes
1634 > checking for working alloca.h... no
1635 > checking for alloca... yes
1636 > checking for strerror... yes
1637 > updating cache ./config.cache
1638 > creating ./config.status
1640 > ===> Building for bison-1.25
1641 > 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 LR0.c
1642 > 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 allocate.c
1643 > 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
1644 > 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
1645 > 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
1646 > 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
1647 > 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
1648 > 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
1649 > 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
1650 > 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 lex.c
1651 > 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 main.c
1652 > 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 nullable.c
1653 > 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 output.c
1654 > 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 print.c
1655 > 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 reader.c
1656 > 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 reduce.c
1657 > 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 symtab.c
1658 > 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 warshall.c
1659 > 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 version.c
1660 > 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 getopt.c
1661 > 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 getopt1.c
1662 > cc -g -o bison LR0.o allocate.o closure.o conflicts.o derives.o files.o getargs.o gram.o lalr.o lex.o main.o nullable.o output.o print.o reader.o reduce.o symtab.o warshall.o version.o
1664 > ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
1666 > sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1
1668 Everything seems OK, so install the files:
1670 > root@pumpy:/u/pkgsrc/lang/bison(1785)# make install
1671 > >> Checksum OK for bison-1.25.tar.gz.
1672 > ===> Installing for bison-1.25
1673 > sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
1674 > rm -f /usr/pkg/bin/bison
1675 > cd /usr/pkg/share; rm -f bison.simple bison.hairy
1676 > rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
1677 > install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
1678 > /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
1679 > /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
1680 > cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
1681 > /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1682 > ===> Registering installation for bison-1.25
1684 You can now use bison, and also - if you decide so - remove it with
1685 "pkg_delete bison-1.25". Should you decide that you want a binary package,
1688 > root@pumpy:/u/pkgsrc/lang/bison(1786)# make package
1689 > >> Checksum OK for bison-1.25.tar.gz.
1690 > ===> Building package for bison-1.25
1691 > Creating package bison-1.25.tgz
1692 > Registering depends:.
1693 > Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'
1695 Now that you don't need the source and object files any more, clean up:
1697 > root@pumpy:/u/pkgsrc/lang/bison(1787)# make clean
1698 > ===> Cleaning for bison-1.25
1701 ======================
1702 Appendix A: build logs
1703 ======================
1708 > Script started on Fri Oct 3 13:22:31 1997
1709 > root@pumpy:/u/pkgsrc/sysutils/top(1342)# make
1710 > >> top-3.5beta5.tar.gz doesn't seem to exist on this system.
1711 > >> Attempting to fetch from ftp://ftp.groupsys.com/pub/top/.
1712 > Requesting ftp://ftp.groupsys.com/pub/top/top-3.5beta5.tar.gz (via ftp://orpheus.amdahl.com:80/)
1713 > Successfully retrieved file.
1714 > >> Checksum OK for top-3.5beta5.tar.gz.
1715 > ===> Extracting for top-3.5beta5
1716 > ===> Patching for top-3.5beta5
1717 > ===> Applying NetBSD patches for top-3.5beta5
1718 > ===> Configuring for top-3.5beta5
1719 > /bin/cp /u/pkgsrc/sysutils/top/files/defaults /u/pkgsrc/sysutils/top/work/top-3.5beta5/.defaults
1720 > chmod a-x /u/pkgsrc/sysutils/top/work/top-3.5beta5/install
1722 > Reading configuration from last time...
1724 > Using these settings:
1725 > Bourne Shell /bin/sh
1727 > Compiler options -DHAVE_GETOPT -O
1729 > Install command /usr/bin/install
1736 > Random passwd access yes
1741 > bin directory $(PREFIX)/bin
1742 > man directory $(PREFIX)/man/man1
1746 > Building Makefile...
1747 > Building top.local.h...
1749 > Doing a "make clean".
1750 > rm -f *.o top core core.* sigdesc.h
1751 > To create the executable, type "make".
1752 > To install the executable, type "make install".
1753 > ===> Building for top-3.5beta5
1754 > cc -DHAVE_GETOPT -DORDER -DHAVE_GETOPT -O -c top.c
1755 > awk -f sigconv.awk /usr/include/sys/signal.h >sigdesc.h
1756 > cc -DHAVE_GETOPT -DORDER -DHAVE_GETOPT -O -c commands.c
1757 > cc -DHAVE_GETOPT -DORDER -DHAVE_GETOPT -O -c display.c
1758 > cc -DHAVE_GETOPT -DORDER -DHAVE_GETOPT -O -c screen.c
1759 > cc -DHAVE_GETOPT -DORDER -DHAVE_GETOPT -O -c username.c
1760 > cc -DHAVE_GETOPT -DORDER -DHAVE_GETOPT -O -c utils.c
1761 > utils.c: In function `errmsg':
1762 > utils.c:348: warning: return discards `const' from pointer target type
1763 > cc -DHAVE_GETOPT -DORDER -DHAVE_GETOPT -O -c version.c
1764 > cc -DHAVE_GETOPT -DORDER -DHAVE_GETOPT -O -c getopt.c
1765 > cc "-DOSREV=12G" -DHAVE_GETOPT -DORDER -DHAVE_GETOPT -O -c machine.c
1767 > cc -o top top.o commands.o display.o screen.o username.o utils.o version.o getopt.o machine.o -ltermcap -lm -lkvm
1768 > root@pumpy:/u/pkgsrc/sysutils/top(1343)# make install
1769 > >> Checksum OK for top-3.5beta5.tar.gz.
1770 > ===> Installing for top-3.5beta5
1771 > /usr/bin/install -o root -m 2755 -g kmem top /usr/pkg/bin
1772 > /usr/bin/install top.1 /usr/pkg/man/man1/top.1
1773 > strip /usr/pkg/bin/top
1774 > ===> Registering installation for top-3.5beta5
1775 > root@pumpy:/u/pkgsrc/sysutils/top(1344)#
1781 > root@pumpy:/u/pkgsrc/sysutils/top(1344)# make package
1782 > >> Checksum OK for top-3.5beta5.tar.gz.
1783 > ===> Building package for top-3.5beta5
1784 > Creating package top-3.5beta5.tgz
1785 > Registering depends:.
1786 > Creating gzip'd tar ball in '/u/pkgsrc/sysutils/top/top-3.5beta5.tgz'
1787 > root@pumpy:/u/pkgsrc/sysutils/top(1345)#
1790 ======================================================
1791 Appendix B: Layout of the FTP server's package archive
1792 ======================================================
1794 Layout for precompiled binary packages on ftp.netbsd.org:
1796 /pub/NetBSD/packages/
1799 pkgsrc -> /pub/NetBSD/NetBSD-current/pkgsrc
1817 - cd /usr/pkgsrc ; make install ; make package
1818 - upload /usr/pkgsrc/packages to
1819 ftp://ftp.netbsd.org/pub/NetBSD/packages/`uname -r`/`sysctl -n hw.machine_arch`
1820 - if necessary ln -s `sysctl -n hw.machine` `sysctl -n hw.machine_arch`
1822 Disk space needed: unknown.
1825 ###########################################################################
1829 # sentence-end-double-space: nil