Merge from vendor branch TNF:
[pkgsrcv2.git] / Packages.txt
1 # $NetBSD: Packages.txt,v 1.94 2000/07/06 15:08:30 hubertf Exp $
2 ###########################################################################
3
4                         ==========================
5                            Documentation on the
6                            NetBSD Package System
7                         ==========================
8
9                       Hubert Feyrer, Alistair Crooks
10
11
12 Table of contents:
13 ==================
14
15  grep -B1 '^.====' Packages.txt | egrep -v '^.[-=]'
16
17
18  0 Intro
19  ========
20
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.
26
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.
32
33 Both the NetBSD packages collection and the NetBSD package system are
34 derived from FreeBSD.
35
36
37  0.1 Overview
38  =============
39
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.
47
48
49  0.2 Terminology
50  ===============
51
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:
54
55  * Package:
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.
59
60  * The NetBSD package system:
61    This is the part of the NetBSD operating system handling building
62    (compiling), installing, and removing of packages.
63
64  * Distfile:
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.
71
72  * Port:
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.
75
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.
83
84    Sometimes, this is referred to by the term "package" too,
85    especially in the context of precompiled packages.
86
87  * Program:
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. 
91
92  * NetBSD RCS IDs:
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<$>.
98
99
100 ====================
101 Part I: User's Guide
102 ====================
103
104  1 Installing a precompiled binary package
105  =========================================
106
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.
109
110
111  1.1 Where to get
112  ================
113
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).
121
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!
125
126
127  1.2 How to use
128  ==============
129
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):
132
133         pkg_add /path/to/package.tgz
134
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
137 ftp-URL:
138
139         pkg_add ftp://ftp.netbsd.org/pub/NetBSD/packages/<OS Ver>/<arch>/All/package.tgz
140
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".
143
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
146 from.
147
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.
150
151
152  1.3 A word of warning
153  =====================
154
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.
159
160
161  2 Installing by Building
162  ========================
163
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".
167
168
169  2.1 Where to get pkgsrc
170  =======================
171
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.
175
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".
181
182
183  2.2 Fetching distfiles
184  ======================
185
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
189 automatically.
190
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.
194
195 When you have selected your settings, install your configuration into
196 /etc/mk.conf
197
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.
201
202
203  2.3 How to build and install
204  ============================
205
206 Assuming that has been done, become root and change into the relevant
207 directory. Then you can type
208
209         make
210
211 at the shell prompt to build the various components of the package, and
212
213         make install
214
215 at the shell prompt to install the various components into the correct
216 places on your system.
217
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.
220
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
225
226         LOCALBASE=/usr/local
227
228 in your environment.  There is, of course, one exception to this - X11
229 packages are traditionally installed in the X11 tree. The definition
230 used to identify the root of the X11 tree is the X11BASE definition.
231
232 It is possible to install X11 packages in the LOCALBASE tree, for
233 which you must install the xpkgwedge package
234 (pkgsrc/pkgtools/xpkgwedge) - see section 7.1 for further details.
235
236 Some packages look in /etc/mk.conf to alter some configuration options
237 at build time.  Have a look at /usr/pkgsrc/mk/mk.conf.example to get
238 an overview of what you can set there.  Environment variables such as
239 LOCALBASE, and X11BASE can also be set in /etc/mk.conf to save having
240 to remember to set them each time you want to use pkgsrc.
241
242 If you want to deinstall and re-install a binary package that you've
243 created (see next section) or that you put into pkgsrc/packages
244 manually, you can use the the "bin-install" target, which will
245 install a binary package - if available - via pkg_add, and do a "make
246 package" else.
247
248
249  3 Making a precompiled package
250  ==============================
251
252 Once you have built and installed the package as mentioned above, you can
253 build it into a "binary package" - you might want to do this so that you
254 can use the binaries you have just built on another NetBSD system, or to
255 provide a simple means for others to use your binary package instead of
256 wasting CPU time - this is done by changing to the appropriate directory in
257 the pkgsrc tree, and typing the command
258
259         make package
260
261 at the shell prompt. This will build and install your package (if not
262 already done), and then construct a binary package out of the results so
263 that you can use the pkg_* tools to manipulate this. The binary package is
264 stored under /usr/pkgsrc/packages, it's in the form of a gzipped file at
265 the present time. See appendix A.2 for a continuation of the above top
266 example.
267
268 Please see the "submitting" section later in this document on how to submit
269 such a binary package.
270
271
272 ====================================
273 Part II: Package Constructor's Guide
274 ====================================
275
276  4 Package components - files, directories and contents
277  ======================================================
278
279 Whenever you're preparing a package from the FreeBSD ports collection or
280 doing it from scratch, there are a number of files involved which are
281 described in the following sections. Special directions are given for what
282 differs from FreeBSD ports for each file.
283
284
285  4.1 Makefile
286  ============
287
288 Building, installation and creation of a binary package are all controlled
289 by the package's Makefile.
290
291 There is a Makefile for each package. This file includes the standard
292 bsd.pkg.mk file (referenced as "../../mk/bsd.pkg.mk"), which sets all the
293 definitions and actions necessary for the package to compile and install
294 itself. The mandatory fields are the DISTNAME which specifies the base name
295 of the distribution file to be downloaded from the site on the Internet,
296 MASTER_SITES which specifies that site, CATEGORIES which denotes the
297 categories into which the package falls, PKGNAME which is the name of the
298 package and the MAINTAINER name. This is so that anyone who quibbles with
299 the (always completely correct) decisions taken by the guy who maintains
300 the port can complain vigorously.
301
302 The MASTER_SITES may be set to one of the predefined sites:
303
304         ${MASTER_SITE_XCONTRIB}
305         ${MASTER_SITE_GNU}
306         ${MASTER_SITE_PERL_CPAN}
307         ${MASTER_SITE_TEX_CTAN}
308         ${MASTER_SITE_SUNSITE}
309
310 If one of these predefined sites is chosen, you may require the ability to
311 specify a subdirectory of that site.  Since these macros may expand to
312 more than one actual site, you MUST use the following construct to specify
313 a subdirectory:
314
315         ${MASTER_SITE_GNU:=subdirectory/name/}
316
317 (Note the trailing slash after the subdirectory name.) Use of the deprecated
318 MASTER_SITE_SUBDIR will not work.
319
320 Currently the following values are available for CATEGORIES. If more than
321 one is used, they need to be separated by spaces:
322
323         archivers   databases   ham         net         security
324         audio       devel       japanese    news        shells
325         benchmarks  distfiles   lang        packages    sysutils
326         biology     editors     mail        parallel    templates
327         cad         emulators   math        pkglocate   textproc
328         comms       fonts       mbone       pkgtools    www
329         converters  games       meta-pkgs   plan9       x11
330         cross       graphics    misc        print
331
332 See the NetBSD packages(7) manual page for a description of all available
333 options and variables.
334
335 Please pay attention to the following gotchas, especially when preparing a
336 package from the FreeBSD ports collection:
337
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.:
351
352    before:
353         # <$>Id: Makefile,v 1.17 1997/06/16 06:39:51 max Exp <$>
354
355    after:
356         # <$>NetBSD<$>
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
362
363         INFO_FILES=     indent.info
364
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
368    system.
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.
376
377  4.2 files/*
378  ===========
379
380  * files/md5:
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".
387
388  * files/patch-sum:
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".
393
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.
399
400
401  4.3 patches/*
402  =============
403
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.
409
410 The patch-?? files should be in diff -bu format, and apply without
411 a fuzz to avoid problems. (The latter condition is ensured by
412 setting PKG_DEVELOPER in /etc/mk.conf - the build will fail if a
413 patch applies with fuzz only).  Furthermore, do not put changes
414 for more than one file into a single patch-file, as this will make
415 future modifications more difficult.
416
417 One important thing to mention is to pay attention that no RCS IDs get
418 stored in the patch files, as these will cause problems when later checked
419 into the NetBSD CVS tree. To avoid this, use the "-U 2" or -U 1" option to
420 diff.
421
422 If you don't want to worry about the problems in the last two paragraphs
423 yourself, use pkgdiff from the pkgtools/pkgdiff package, which takes care
424 of any RCS Ids by itself.
425
426 For even more automation, we recommend using mkpatches from the same
427 package to make a whole set of patches. You just have to backup files
428 before you edit them to "filename.orig", e.g. with "cp -p filename
429 filename.orig". If you upgrade a package this way, you can easily compare
430 the new set of patches with the previously existing one with patchdiff.
431
432 When preparing a FreeBSD port for the NetBSD packages system, it's likely
433 that the FreeBSD port will work on NetBSD. However, check that the person
434 who ported the software to FreeBSD has not played fast and loose with the
435 __FreeBSD__ cpp definition without good cause - a simple way to do this is
436 to do
437
438         grep -i freebsd patches/patch-??
439
440 in the package directory.
441
442 Besides taking care of any FreeBSDisms, be sure to provide patches to
443 replace any occurrence of /usr/local in any "Makefile"s in the original
444 package with ${PREFIX}.
445
446 When you have finished a package, remember to generate the checksums
447 for the patch files by using the "make makepatchsum" command, see
448 section 4.2.
449
450
451  4.4 pkg/*
452  =========
453
454 This directory contains several files used to manage the creation of binary
455 packages. Files from this directory are used in the binary package itself,
456 and will thus be installed on other machines, so you should be aware that
457 there is a wider audience than you might think for your comments and
458 witticisms.
459
460  4.4.1 Mandatory files
461  =====================
462
463  * pkg/COMMENT:
464    A one-line description of the piece of software. There is no need to
465    mention the package's name - this will automatically be added by the
466    pkg_* tools when they are invoked.
467
468  * pkg/DESCR:
469    A multi-line description of the piece of software.  This should include
470    any credits where they are due.  Please bear in mind that others do not
471    share your sense of humour (or spelling idiosyncrasies), and that others
472    will read everything that you write here.
473
474  * pkg/PLIST:
475    This file governs the files that are installed on your system: all the
476    binaries, manual pages, etc. There are other directives which may be
477    entered in this file, to control the creation and deletion of
478    directories, and the location of inserted files.
479
480 If you're updating a FreeBSD package to work for NetBSD, please pay special
481 attention to the following things in pkg/PLIST:
482
483  - If there are any "@exec ldconfig ..." statements, or any "@unexec
484    ldconfig ...", delete them. NetBSD works out automatically whether to
485    call ldconfig, since some NetBSD architectures do not have ldconfig.
486  - Add any missing @dirrm statements
487  - Remove any MANx= definitions in the package Makefile
488
489 You could also investigate the port2pkg package (pkgsrc/pkgtools/port2pkg),
490 which does a lot of the donkey work for you.
491
492
493  4.4.2 Optional files
494  ====================
495
496  * pkg/INSTALL:
497    Shell script invoked twice during pkg_add. First time after package
498    extraction and before files are moved in place, the second time after
499    the files to install are moved in place. This can be used to do any
500    custom procedures not possible with @exec commands in PLIST. See
501    pkg_add(1) and pkg_create(1) for more information.
502
503  * pkg/DEINSTALL:
504    This script is executed before and after any files are removed.  It is
505    this script's responsibility to clean up any additional messy details
506    around the package's installation, since all pkg_delete knows is how to
507    delete the files created in the original distribution. See pkg_delete(1)
508    and pkg_create(1) for more information.
509
510  * pkg/REQ:
511    Require-script that is invoked before installation and de-installation
512    to ensure things like certain accounts being available, user/sysadmin
513    agreeing with usage policy, etc.
514
515  * pkg/MESSAGE
516    Display this file after installation of the package.
517    Useful for things like legal notices on almost-free software,
518    etc.
519
520
521  4.5 scripts/*
522  =============
523
524 This directory contains any files that are necessary for configuration of
525 your software, etc. If a script with any of the following names is present,
526 it will be executed at the appropriate time during the build process:
527
528   pre-fetch          post-fetch
529   pre-extract        post-extract
530   pre-patch          post-patch
531   pre-configure      post-configure     configure
532   pre-build          post-build
533   pre-install        post-install
534   pre-package        post-package
535
536 Note that you should NOT define a pre-* or post-* target in the Makefile
537 which executes the matching scripts/[pre|post]-* script. bsd.pkg.mk runs
538 any existing Makefile target first, then searches for scripts/* and runs
539 it using sh(1). Running the script from the Makefile would cause it to
540 be run twice.
541
542 See section 7 for a description of the build process.
543
544
545  4.6 work/*
546  ==========
547
548 When you type "make" the distribution files are unpacked into this
549 directory.  It can be removed by typing
550
551         make clean
552
553 at the shell prompt. Also, this directory is used to keep various
554 timestamp files. 
555
556
557  4.7 importing the package into CVS
558  ==================================
559
560 Newly created packages should be imported with a vendor tag of "TNF" and
561 a release tag of "pkgsrc-base", e.g::
562
563         cvs import pkgsrc/<category>/frobnitz TNF pkgsrc-base
564
565 Packages derived from a FreeBSD port should be imported with a vendor tag
566 of "FREEBSD" and a release tag of "FreeBSD-current-YYYY-MM-DD" (YYYY-MM-DD
567 being the date when the snapshot of the port were taken form the FreeBSD
568 tree), and then doing the necessary modifications by normal CVS operations.
569 E.g:
570
571         cvs import pkgsrc/<category>/mumbler FREEBSD FreeBSD-current-1998-04-01
572         cvs rm patches/patch-a
573         cvs add patches/patch-aa
574         cvs ci
575
576 Please note all package updates/additions in doc/pkg-CHANGES! It's very
577 important to keep this file up to date and conforming to the existing
578 format, because it will be used by scripts to automatically update pages on
579 www.netbsd.org.
580
581
582  5 PLIST* issues
583  ===============
584
585 This section addresses some special issues that one needs to pay attention
586 to when dealing with the PLIST file (or files, see below!).
587
588
589  5.1 Miscellaneous
590  =================
591
592  * NetBSD RCS Id:
593    Be sure to add a RCS ID line as the first thing in any PLIST file you
594    write:
595
596         @comment <$>NetBSD<$>
597
598  * ranlib:
599    Don't put any ranlib commands into your PLIST files, as they will cause
600    troubles when the package is removed. Just make sure the build-process
601    does run ranlib - it usually does - and you can leave this out. This is
602    usually only a problem when using ports from FreeBSD.
603
604  * ldconfig:
605    Don't put any ldconfig commands into your PLIST files, as they will
606    cause problems.  All shared object caching is done automatically in
607    NetBSD (this takes place when you see the "Automatic shared object
608    handling" message), and so you can leave this out.  If any shared
609    objects are found in the package, they will be dealt with
610    automatically, running ldconfig on platforms which need it, and not
611    otherwise.  This is usually only a problem when using ports from
612    FreeBSD.
613
614  * ${MACHINE_ARCH}, ${MACHINE_GNU_ARCH}:
615    Some packages like emacs and perl embed information about which
616    architecture they were built on into the pathnames where they install
617    their file. To handle this case, PLIST will be preprocessed before
618    actually used, and the symbol "${MACHINE_ARCH}" will be replaced by
619    what "sysctl -n hw.machine_arch" gives. The same is done if the string
620    ${MACHINE_GNU_ARCH} is embedded in PLIST somewhere - use this on
621    packages that use GNU autoconfigure.
622
623    Legacy note: There used to be a symbol "<$ARCH>" that was replaced by
624    the output of "uname -m", but that's no longer supported and has been
625    removed.
626
627  * ${OPSYS}, ${OS_VERSION}:
628    Some packages want to embed the OS name and version into some paths.
629    to do this, use these two variables in PLIST. ${OPSYS} will be replaced
630    by output from "uname -s", ${OS_VERSION} will be set to what "uname -r"
631    gives.
632
633  * Manpage-compression:
634    Manpages should be installed in compressed form if MANZ is set (in
635    bsd.own.mk), and uncompressed otherwise. To handle this in the PLIST
636    file, the suffix ".gz" is appended/removed automatically for manpages
637    according to MANZ and MANCOMPRESSED being set or not, see above for
638    details. This modification of the PLIST file is done on a copy of it,
639    not pkg/PLIST itself.
640
641  * Semi-automatic PLIST generation:
642    You can use the "make print-PLIST" command to output a PLIST that matches
643    any new files since the package was extracted. If the package installs
644    files via tar(1) or other methods that don't update file access times, be
645    sure to add these files manually to your pkg/PLIST!
646
647
648  5.2 MD/MI vs. general PLIST
649  ===========================
650
651 Sometimes the packaging list in pkg/PLIST differs between platforms, e.g.
652 if one of them supports shared libs and the other does not. To address
653 this, a hook has been introduced into the NetBSD packages system to provide
654 a PLIST file defined on conditions set freely in the package's Makefile.
655
656
657  5.2.1 $PLIST_SRC
658  ================
659
660 To use one or more files as source for the PLIST used in generating the
661 binary package, set the variable PLIST_SRC to the names of that file(s).
662 The files are later concatenated using cat(1), and order of things is an
663 important issue, see below.
664
665
666  5.2.2 PLIST-mi, PLIST-md.shared, PLIST-md.static
667  ================================================
668
669 If PLIST_SRC is not set (the usual case), and if there is no pkg/PLIST, the
670 packages system looks for pkg/PLIST-mi, and pkg/PLIST-md.shared or
671 pkg/PLIST-md.static to handle differences due to the platform being able to
672 handle shared libs or not. PLIST-mi contains machine independent files,
673 PLIST-md.* contain machine dependent files, which may differ between
674 architectures that don't support dynamic libs/shared loading. Currently,
675 this is only used in the perl-packages, and as perl5 on alpha doesn't
676 support dynamic loading of extensions like perl/Tk yet, PLIST.mi-static is
677 also used on the alpha (besides pmax and powerpc). Alpha will hopefully be
678 removed soon when perl's fixed for dynamic loading.
679
680 (This handling of MI/MD PLIST files is implemented by setting PLIST_SRC to
681 either "PLIST-mi PLIST-md.static" or "PLIST-mi PLIST-md.shared", see
682 /usr/pkgsrc/mk/bsd.pkg.mk).
683
684
685  5.2.3 Order in the PLIST* file(s)
686  =================================
687
688 There is one gotcha regarding the ordering of @dirrm statements: any MI
689 @dirrm directives that follow any MD @dirrm's *must* go into the PLIST.md-*
690 files, as the files PLIST-mi and PLIST.md-{shared/static} are concatenated
691 in exactly this order. If the MI directory would be listed in PLIST-mi, it
692 would be removed before the MD directory, which wouldn't work.
693
694 E.g. if you have the following dirs:
695         foo/mi
696         foo/mi/md
697
698 then PLIST-mi contains:
699         <nothing>
700
701 and PLIST-md.* contain:
702         @dirrm foo/mi/md
703         @dirrm foo/mi
704
705 This will lead to some @dirrm statements being duplicated, but it's the
706 only way to ensure everything is properly removed. The same care must be
707 taken when PLIST_SRC is set to some package-specific settings.
708   
709
710  6 Notes on fixes for packages
711  =============================
712
713  6.1 CPP defines
714  ===============
715
716 To port an application to NetBSD, it's usually necessary for the compiler
717 to be able to judge the system on which it's compiling, and we use
718 definitions so that the C pre-processor can do this.
719
720 The really impatient should just note that a number of the FreeBSD ports
721 (which are called packages in the NetBSD world) rely on the CPP definition
722 __FreeBSD__. This should be used sparingly, for FreeBSD-specific features,
723 but unfortunately this is not always the case. A number also rely on the
724 fact that the CPU type is an Intel-based little-endian CPU.
725
726 To test whether you are working on a 4.4 BSD-derived system, you should use
727 the BSD definition, which is defined in <sys/param.h> on said systems.
728
729         #include <sys/param.h>
730
731 and then you can surround the BSD-specific parts of your port using the
732 conditional:
733
734         #if (defined(BSD) && BSD >= 199306)
735         ...
736         #endif
737
738 Please use the __NetBSD__ definition sparingly - it should only apply to
739 features of NetBSD that are not present in other 4.4-lite derived BSDs.
740
741 You should also avoid defining __FreeBSD__=1 and then simply using the
742 FreeBSD port, if only from an aesthetic viewpoint.
743
744
745  6.2 Shared libraries - libtool
746  ==============================
747
748 NetBSD supports many different machines, with different object formats
749 like a.out and ELF, and varying abilities to do shared library and
750 dynamic loading at all. To accompany this, varying commands and options
751 have to be passed to the compiler, linker etc. to get the Right Thing,
752 which can be pretty annoying especially if you don't have all the
753 machines at your hand to test things.  The "libtool" pkg can help
754 here, as it just "knows" how to build both static and dynamic
755 libraries from a set our source files, thus being platform
756 independent. 
757
758 Here's how to use libtool in a pkg in six simple steps:
759
760 1. Add USE_LIBTOOL= yes to the package Makefile.
761
762 2. For library objects, use "${LIBTOOL} --mode=compile ${CC}" in place of
763    ${CC}.  You could even add it to the definition of CC, if only
764    libraries are being built in a given Makefile.  This one command will
765    build both PIC and non-PIC library objects, so you need not have
766    separate shared and non-shared library rules.
767
768 3. For the linking of the library, remove any "ar", "ranlib", and "ld
769    -Bshareable" commands, and use instead:
770
771         ${LIBTOOL} --mode=link cc -o ${.TARGET:.a=.la} ${OBJS:.o=.lo} -rpath ${PREFIX}/lib -version-info major:minor
772
773    Note that the library is changed to have a .la extension, and the
774    objects are changed to have a .lo extension.  Change OBJS as necessary.
775    This automatically creates all of the .a, .so.major.minor, and ELF
776    symlinks (if necessary) in the build directory.
777
778 4. When linking programs that depend on these libraries _before_ they are
779    installed, preface the cc or ld line with "${LIBTOOL} --mode=link", and
780    it will find the correct libraries (static or shared), but please be
781    aware that libtool will not allow you to specify a relative path in -L
782    (such as -L../somelib), because it is trying to force you to change
783    that argument to be the .la file.  For example:
784
785         ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
786
787    won't work; it needs to be changed to:
788
789         ${LIBTOOL} --mode=link ${CC} -o someprog ../somelib/somelib.la
790
791    and it will DTRT with the libraries.  If you *must* use a relative path 
792    with -L, and you are not going to run this program before installing
793    it, you can omit the use of libtool during link and install of this
794    program if you add the subdirectory ".libs" in your -L command:
795
796         ${CC} -o someprog -L../somelib/.libs -lsomelib
797
798 5. When installing libraries, preface the install or cp command with
799    "${LIBTOOL} --mode=install", and change the library name to .la.  For
800    example:
801
802         ${LIBTOOL} --mode=install ${BSD_INSTALL_DATA} ${SOMELIB:.a=.la} ${PREFIX}/lib
803
804    This will install the static .a, shared library, any needed symlinks,
805    and run "ldconfig."
806
807 6. In your PLIST, include the .a, .la, and .so.major.minor files.  Don't
808    include the ELF symlink files; those are automatic. 
809
810 Do not use pkglibtool!  Previously, the package system used its
811 own version of libtool from pkgtools.  However, over time, this
812 version became outdated and is now deprecated.  You may see some
813 definitions of USE_PKGLIBTOOL in existing packages that still use
814 this outdated version of libtool.  Please do not use this definition
815 in new packages!
816
817  6.3 Using libtool on GNU packages that already support libtool
818  ==============================================================
819
820 Add USE_LIBTOOL=yes and LTCONFIG_OVERRIDE=${WRKSRC}/ltconfig to the
821 package Makefile as the quick way to bypass the pkg's own libtool.
822 The pkg's own libtool is made by ltconfig script at do-configure target.
823 If USE_LIBTOOL and LTCONFIG_OVERRIDE are defined, the specified ltconfig is
824 overridden, using the devel/libtool instead of the pkg's own libtool.
825 If the pkg already has an original "libtool" which we can replace with
826 devel/libtool you may have to specify LIBTOOL_OVERRIDE to the package
827 Makefile.
828
829  6.4 Gotchas of FreeBSD ports
830  ============================
831
832 See section 4.1 for Makefile issues (MANx, CATx, MANCOMPRESSED, ldconfig,
833 RCS IDs) and section 4.3 for gotchas on using patches from FreeBSD ports.
834
835 One of the biggest problems with FreeBSD ports is that too many of
836 them assume they will install into /usr/local, instead of honouring
837 any ${PREFIX} setting properly.  To change this, add something like the
838 following into your package Makefile:
839
840 pre-configure:
841         for f in `find ${WRKDIR} -type f -print|xargs grep -l '/usr/local'`; do
842 \
843                 ${SED} -e 's:/usr/local:'${PREFIX}':g' < $$f > $$f.pdone && ${MV} $
844 $f.pdone $$f; \
845         done
846
847 This is taken from the sysutils/rtty package; be sure this works for your
848 package - it may actually make sense to look for some things in /usr/local,
849 for example. So don't blindly replace all occurrences of /usr/local!
850
851 FreeBSD has decided to list manual pages in the package Makefile, with
852 no corresponding entry in the PLIST.  You will thus need to add any
853 MAN[1-8ln] files to the PLIST, before deleting the MAN[1-8ln]
854 definition.  Similarly with MLINKS and CAT[1-8ln] entries.
855
856 Side note on manpages in PLIST:  we don't take any notice of any .gz
857 suffix there, as many FreeBSD ports seem to have .gz pages in PLIST
858 even when they install manpages without compressing them; rather, we
859 add our own .gz suffix there according to MANZ.  In short, it does not
860 matter whether the manual page name in the PLIST has a .gz suffix or
861 not - if it needs one which is not already there, it will be appended
862 automatically, and if there is a .gz suffix which is not needed, it
863 will be deleted automatically.
864
865 Some packages use bsd-style .mk files when building, and so any manual
866 pages that are installed will be gzip-compressed, if MANZ is set, or
867 not if MANZ is not set.  If the package uses bsd-style .mk files, the
868 variable MANCOMPRESSED_IF_MANZ should be set to a value of "yes" in
869 the package Makefile.
870
871
872  6.5 Feedback to the author
873  ==========================
874
875 If you have found any bugs in the package you make available, if you had to
876 do special steps to make it run under NetBSD or if you enhanced the software
877 in various other ways, be sure to report these changes back to the original
878 author of the program! With that kind of support, the next release of the
879 program can incorporate these fixes, and people not using the NetBSD packages
880 system can win from your efforts.
881
882 Support the idea of free software!
883
884
885  7 The build process
886  ===================
887
888 The basic steps for building a program are always the same.  First the
889 program's source (distfile) must be brought to the local system and
890 then extracted.  After any patches to compile properly on NetBSD are
891 applied, the software can be configured, then built (usually by
892 compiling), and finally the generated binaries etc.  can be put into
893 place on the system.  These are exactly the steps performed by the
894 NetBSD package system, which is implemented as a series of targets in
895 a central Makefile, /usr/pkgsrc/mk/bsd.pkg.mk.
896
897
898  7.1 Program location
899  ====================
900
901 Before outlining the process performed by the NetBSD package system in the
902 next section, here's a brief discussion on where programs are installed,
903 and which variables influence this.
904
905 The automatic variable PREFIX indicates where all files of the final
906 program shall be installed.  It is usually set to $LOCALBASE (/usr/pkg),
907 or $CROSSBASE for pkgs in the "cross" category, though its value becomes
908 that of $X11BASE if USE_IMAKE, USE_MOTIF, or USE_X11BASE is set.  The value
909 ${PREFIX} needs to be put into the various places in the program's source
910 where paths to these files are encoded; see sections 4.3 and 6.2 for
911 details on this.
912
913 When choosing which of these variables to use, follow the following rules:
914
915  * ${PREFIX} always points to the location where the current pkg will be
916    installed.  When referring to a pkg's own installation path, use ${PREFIX}.
917
918  * ${LOCALBASE} is where all non-X11 pkgs are installed.  If you need to
919    construct a -I or -L argument to the compiler to find includes and
920    libraries installed by another non-X11 pkg, use ${LOCALBASE}.
921
922  * ${X11BASE} is where the actual X11 distribution is installed.  When looking
923    for _standard_ X11 includes (not those installed by a pkg), use ${X11BASE}.
924
925  * X11 based pkgs are special in that they may be installed in either
926    X11BASE or LOCALBASE. To install X11 packages in LOCALBASE, simply
927    install the xpkgwedge package (pkgsrc/pkgtools/xpkgwedge).
928    If you need to find includes or libraries installed by a pkg that has
929    USE_IMAKE, USE_MOTIF, or USE_X11BASE in its pkg Makefile, you need to use
930    _both_ ${X11BASE} and ${LOCALBASE}.
931
932  * ${X11BASE} points to the root of the installed X11 tree. To refer to the
933    installed location of an X11 package, use the ${X11PREFIX} definition (this
934    will be ${X11BASE} if xpkgwedge is not installed, and ${LOCALBASE} if
935    xpkgwedge is installed).
936
937
938  7.2 Main targets
939  ================
940
941 The main targets used during the build process defined in bsd.pkg.mk are:
942
943  * fetch:
944    This will check if the file(s) given in the variables DISTFILES and
945    PATCHFILES (as defined in the package's Makefile) are present on the
946    local system in /usr/pkgsrc/distfiles. If they are not present, they
947    will be fetched using ftp(1) from the site(s) given in the variable
948    PATCH_SITES. The location(s) in PATCH_SITES are in the form of URLs
949    and can be ftp://- and http://-URLs, as ftp(1) understands both of
950    them.
951
952  * checksum:
953    After the distfile(s) are fetched, their MD5 checksum is generated and
954    compared with the checksums stored in the files/md5 file. If the
955    checksums don't match, the build is aborted. This is to ensure the same
956    distfile is used for building, and that the distfile wasn't changed,
957    e.g. by some malign force, deliberately changed distfiles on the master
958    distribution site or network lossage. 
959
960  * extract:
961    When the distfiles are present on the local system, they need to be
962    extracted, as they are usually in the form of some compressed archive
963    format, most commonly .tar.gz. If only some of the distfiles need to be
964    uncompressed, the files to be uncompressed should be put into
965    EXTRACT_ONLY. If the distfiles are not in .tar.gz format, they can be
966    extracted by setting EXTRACT_CMD, EXTRACT_BEFORE_ARGS and/or
967    EXTRACT_AFTER_ARGS. 
968
969  * patch:
970    After extraction, all the patches named by the PATCHFILES and those
971    present in the patches subdirectory of the package are applied. 
972    Patchfiles ending in .Z or .gz are uncompressed before they are
973    applied, files ending in .orig or .rej are ignored.  Any special
974    options to patch(1) can be handed in PATCH_DIST_ARGS.  See section
975    4.3 for more details.
976    
977    If PKG_DEVELOPER is set in /etc/mk.conf, patch is given special args
978    to make it fail if the patches with some lines of fuzz. Please fix
979    (regen) the patches so that they apply cleanly. The rationale behind
980    this is that patches that apply cleanly may end up being applied in the
981    wrong place, and cause severe harm there.
982
983  * configure:
984    Most pieces of software need information on the header files,
985    system calls, and library routines which are available in NetBSD. 
986    This is the process known as configuration, and is usually
987    automated.  In most cases, a script is supplied with the source,
988    and its invocation results in generation of header files,
989    Makefiles, etc.
990
991    If the program doesn't come with its own configure script, one can be
992    placed in the package's scripts directory, called "configure". If so, it
993    is executed using sh(1).
994
995    If the program's distfile contains its own configure script, this can
996    be invoked by setting HAS_CONFIGURE. If the configure script is a GNU
997    autoconf script, GNU_CONFIGURE should be specified instead. In either
998    case, any arguments to the configure script can be specified in the
999    CONFIGURE_ARGS variable, and the configure script's name can be set in
1000    CONFIGURE_SCRIPT if it differs from the default "configure".
1001
1002    If the program uses an Imakefile for configuration, the appropriate
1003    steps can be invoked by setting USE_IMAKE to YES. (If you only want the
1004    package installed in $X11PREFIX but xmkmf not being run, set USE_X11BASE
1005    instead!)
1006
1007  * build:
1008    Once configuration has taken place, the software can be built on
1009    NetBSD by invoking $MAKE_PROGRAM on $MAKEFILE with $ALL_TARGET as
1010    the target to build.  The default MAKE_PROGRAM is "gmake" if
1011    USE_GMAKE is set, "make" otherwise.  MAKEFILE is set to "Makefile"
1012    by default, and ALL_TARGET defaults to "all".  Any of these
1013    variables can be set to change the default build process.
1014
1015  * install:
1016    Once the build stage has completed, the final step is to install
1017    the software in public directories, for users.  As in the
1018    build-target, $MAKE_PROGRAM is invoked on $MAKEFILE here, but with
1019    the $INSTALL_TARGET instead, the latter defaulting to "install"
1020    (plus "install.man", if USE_IMAKE is set). 
1021
1022 If no target is specified, the default is "build". If a subsequent stage
1023 is requested, all prior stages are made: e.g. "make build" will also
1024 perform the equivalent of:
1025
1026         make fetch
1027         make checksum
1028         make extract
1029         make patch
1030         make configure
1031         make build
1032
1033
1034  7.3 Other helpful targets
1035  =========================
1036
1037  * pre/post-*
1038    For any of the main targets described in the previous section, two
1039    auxiliary targets exist with "pre-" and "post-" used as a prefix
1040    for the main target's name.  These targets are invoked before and
1041    after the main target is called, allowing extra configuration or
1042    installation steps, for example, which program's configure script
1043    or install target omitted.  For any of these auxiliary targets,
1044    scripts of the same name can be placed in the package's
1045    scripts-subdirectory that will be executed at the given time, see
1046    section 4.5.
1047
1048  * do-*:
1049    Should one of the main targets do the wrong thing, and should there
1050    be no variable to fix this, you can redefine it with the do-*
1051    target.  (Note that redefining the target itself instead of the
1052    do-* target is a bad idea, as the pre-* and post-* targets won't be
1053    called anymore, etc.) You will not usually need to do this.
1054
1055  * reinstall:
1056    If you did a "make install" and you noticed some file was not installed
1057    properly, you can repeat the installation with this target, which will
1058    ignore the "already installed" flag. 
1059
1060  * deinstall:
1061    This target does a pkg_delete(1) in the current directory,
1062    effectively de-installing the package. The following variables can
1063    be used either on the command line or in /etc/mk.conf to tune the
1064    behaviour: 
1065
1066     - PKG_VERBOSE:
1067       Add a "-v" to the pkg_delete(1) command.
1068       
1069     - DEINSTALLDEPENDS:
1070       Remove all packages that require (depend on) the given package.
1071       This can be used to remove any packages that may have been pulled in
1072       by a given package, e.g. if "make deinstall DEINSTALLDEPENDS=1" is
1073       done in x11/kde, this is likely to remove whole KDE. Works by adding
1074       a "-R" to the pkg_delete command line.
1075
1076  * update:
1077    This target causes the current package to be updated to the latest
1078    version.  The package and all depending packages first get deinstalled,
1079    then current versions of the corresponding packages get compiled and
1080    installed.  This is similar to manually noting which packages are
1081    currently installed, then performing a series of "make deinstall" and
1082    and "make install" (or whatever DEPENDS_TARGET is set to) for these
1083    packages.
1084
1085    You can use the "update" target to resume package updating in case a
1086    previous "make update" was interrupted for some reason.  However, in
1087    this case, make sure you don't call "make clean" or otherwise remove
1088    the list of dependent packages in ${WRKDIR}.  Otherwise you lose the
1089    ability to automatically update the current package along with the
1090    dependent packages you have installed.
1091
1092    Resuming an interrupted 'make update' will only work as long as the
1093    package tree remains unchanged.  If the source code for one of the
1094    packages to be updated has been changed, resuming 'make update' will
1095    most certainly fail!
1096
1097    The following variables can be used either on the command line or in
1098    /etc/mk.conf to alter the behaviour of "make update":
1099
1100     - DEPENDS_TARGET:
1101       Install target to use for the updated package and the
1102       dependent packages.  Defaults to "install".  E.g.
1103       "make update DEPENDS_TARGET=package"
1104
1105     - NOCLEAN:
1106       Don't clean up after updating.  Useful if you want to leave the
1107       work sources of the updated packages around for inspection or
1108       other purposes.  Be sure you eventually clean up the source
1109       tree (see the "clean-update" target below) or you may run into
1110       troubles with old source code still lying around on your next
1111       "make" or "make update".
1112
1113     - REINSTALL:
1114       Use "reinstall" instead of ${DEPENDS_TARGET} for every package
1115       that gets updated.  Be sure you know the implications of using
1116       the "reinstall" target when using this variable.
1117
1118  * clean-update:
1119    Clean the source tree for all packages that would get updated if
1120    "make update" was called from the current directory.  This target
1121    should not be used if the current package (or any of its depending
1122    packages) have already been deinstalled (e.g., after calling "make
1123    update") or you may lose some packages you intended to update.
1124    As a rule of thumb: only use this target _before_ the first time
1125    you call "make update" and only if you have a dirty package tree
1126    (e.g., if you used NOCLEAN).  The following variables can be used
1127    either on the command line or in /etc/mk.conf to alter the behaviour
1128    of "make clean-update":
1129
1130     - CLEAR_DIRLIST:
1131       After "make clean", do not reconstruct the list of directories to
1132       update for this package.  Only use this if "make update" successfully
1133       installed all packages you wanted to update.  Normally, this is done
1134       automatically on "make update", but may have been suppressed by the
1135       NOCLEAN variable (see above).
1136
1137  * readme:
1138    This target generates a README.html file, which can be viewed using a
1139    browser such as netscape (pkgsrc/www/mozilla) or lynx (pkgsrc/www/lynx).
1140    The generated files contain references to any packages which are in the
1141    ${PACKAGES} directory on the local host.  The generated files can
1142    be made to refer to URLs based on FTP_PKG_URL_HOST and
1143    FTP_PKG_URL_DIR.  (For example, if I wanted to generate README.html
1144    files which pointed to binary packages on the local machine, in the
1145    directory /usr/packages, set FTP_PKG_URL_HOST=file://localhost and
1146    FTP_PKG_URL_DIR=/usr/packages. The ${PACKAGES} directory and its
1147    subdirectories will be searched for all the binary packages.)
1148
1149  * readme-all: 
1150    Use this target to create a file README-all.html which contains a
1151    list of all packages currently available in the NetBSD Packages
1152    Collection, together with the category they belong to and a short
1153    description. This file is compiled from the pkgsrc/*/README.html
1154    files, so be sure to run this _after_ a "make readme".
1155
1156  * cdrom-readme:
1157    This is very much the same as the readme: target (see above), but is
1158    to be used when generating a pkgsrc tree to be written to a CD-ROM.
1159    This target also produces README.html files, and can be made to refer
1160    to URLs based on CDROM_PKG_URL_HOST and CDROM_PKG_URL_DIR.
1161
1162  * show-distfiles:
1163    This target shows which distfiles and patchfiles are needed to build
1164    the package. (DISTFILES and PATCHFILES, but not patches/*)
1165
1166  * show-downlevel:
1167    This target shows nothing if the package is not installed. If a version
1168    of this package is installed, but is not the version provided in this
1169    version of pkgsrc, then a warning message is displayed. This target can
1170    be used to show which of your installed packages are downlevel, and so
1171    the old versions can be deleted, and the current ones added.
1172
1173  * show-pkgsrc-dir:
1174    This target shows the directory in the pkgsrc hierarchy from which the
1175    package can be built and installed. This may not be the same directory
1176    as the one from which the package was installed. This target is intended
1177    to be used by people who may wish to upgrade many packages on a single
1178    host, and can be invoked from the top-level pkgsrc Makefile by using the
1179    target "show-host-specific-pkgs"
1180
1181  * check-shlibs:
1182    After a package is installed, check all it's binaries and (on ELF 
1183    platforms) shared libraries if they find the shared libs they need.
1184    Run by default if PKG_DEVELOPER is set in /etc/mk.conf.
1185
1186
1187  8 Debugging
1188  ===========
1189
1190 To check out all the gotchas when building a package (wither from
1191 a FreeBSD port, or from scratch), here are the steps that I do in
1192 order to get a package working. Please note this is basically the
1193 same as what was explained in the previous sections, only with some
1194 debugging aids.
1195
1196  - Make sure PKG_DEVELOPER=1 is in /etc/mk.conf
1197  - Retrieve port from FreeBSD collection
1198  - Fix RCS-ID in the package's Makefile, see section 4.1. 
1199  - Import unchanged FreeBSD source (ONLY if you have cvs access, not needed
1200    otherwise):
1201    (cd .../pkgsrc/category/pkgname ; cvs import pkgsrc/category/pkgname \
1202         FREEBSD FreeBSD-current-yyyy-mm-dd)
1203  - If you did a CVS import, check it out to apply the following fixes
1204    (not needed if you don't have CVS access!)
1205  - Look at Makefile, fix if necessary; see section 4.1. 
1206  - Look at patches, remember if not appropriate
1207  - Have a look at pkg/PLIST, add a "@comment <$>NetBSD<$>" line at the
1208    beginning of any PLIST file (see section 5). 
1209  - make
1210  - If something is not ok, fix; for patches: fix the file, then re-generate
1211    the diff: 'diff -bu foo.orig foo >../../patches/patch-xx' (mv patch-xx
1212    patch-xx.orig before); If there's no foo.orig from a previous patch, be
1213    sure to have an old version of the file somewhere; re-iterate :)
1214  - If all builds OK: touch /tmp/bla
1215  - make install
1216  - find /usr/pkg/ /usr/X11R6/ -newer /tmp/bla >/tmp/x
1217    (or whatever you set LOCALBASE and X11BASE to)
1218  - pkg_delete blub
1219  - find /usr/pkg/ /usr/X11R6/ -newer /tmp/bla (or diff against output of
1220    'make print-PLIST'): if this brings up any files, that are missing in
1221    pkg/PLIST*; add them.
1222  - Compare pkg/PLIST* against /tmp/x, fix the former one
1223    ( sort /tmp/x >/tmp/x2 ; sort pkg/PLIST >/tmp/P ; sdiff /tmp/x2 /tmp/P )
1224  - make reinstall && make package
1225  - pkg_delete blub
1226  - "find /usr/pkg/ /usr/X11R6/ -type f -newer /tmp/bla" shouldn't find anything
1227    now
1228  - pkg_add .../blub.tgz
1229  - Play with it :)
1230  - pkg_delete - still no file should be left (re-run above find)
1231  - make clean && touch /tmp/bla && make install && make clean && make deinstall
1232    then run the find again. Yes, some software authors write Makefiles that
1233    install files during the build target. Sigh. Re-run the find, and fix the
1234    PLIST. Repeat until certain the software does not install any files that
1235    aren't in PLIST.
1236  - submit (or commit, if you have cvs access); see section 10.
1237
1238
1239  9 FAQs & features of the package system
1240  =======================================
1241
1242  9.1 Packages using GNU autoconfig
1243  9.2  Other distrib methods than .tar.gz
1244  9.3  Packages not creating their own subdirectory
1245  9.4  Custom configuration process
1246  9.5  Packages not building in their DISTNAME directory
1247  9.6  How to fetch all distfiles at once
1248  9.7  How to fetch files from behind a firewall
1249  9.8  If your patch contains an RCS ID
1250  9.9  How to pull in variables from /etc/mk.conf
1251  9.10 Is there a mailing list for pkg-related discussion?
1252  9.11 How do i tell "make fetch" to do passive FTP?
1253  9.12 Dependencies on other packages
1254  9.13 Conflicts with other packages
1255  9.14 Software which has a WWW Home Page
1256  9.15 How to handle modified distfiles with the 'old' name
1257
1258
1259  9.1 Packages using GNU autoconfig
1260  =================================
1261
1262 If your package uses GNU autoconf, add the following to your package's
1263 Makefile:
1264
1265 > GNU_CONFIGURE= yes
1266
1267 Note that this appends --prefix=${PREFIX} to CONFIGURE_ARGS, so you don't
1268 have to do that yourself, and this may not be what you want.
1269
1270
1271  9.2 Other distrib methods than .tar.gz
1272  ======================================
1273
1274 If your package uses a different distribution method from .tar.gz, take a
1275 look at the package for plan9/sam, which uses a gzipped shell archive
1276 (shar), but the quick solution is to set EXTRACT_SUFX to the name after the
1277 DISTNAME field, and add the following to your package's Makefile:
1278
1279 > EXTRACT_SUFX=   .msg.gz
1280 > EXTRACT_CMD=            zcat
1281 > EXTRACT_BEFORE_ARGS=
1282 > EXTRACT_AFTER_ARGS=     |sh
1283
1284
1285  9.3 Packages not creating their own subdirectory
1286  ================================================
1287
1288 Your package doesn't create a subdirectory for itself (like GNU software
1289 does, for instance), but extracts itself in the current directory: see
1290 plan9/sam again, but the quick answer is:
1291
1292 > NO_WRKSUBDIR=   yes
1293
1294
1295  9.4 Custom configuration process
1296  ================================
1297
1298 Your package uses a weird Configure script: See the top package, but the
1299 quick answer is:
1300
1301 > HAS_CONFIGURE=          yes
1302 > CONFIGURE_SCRIPT=       Configure
1303 > CONFIGURE_ARGS+=        netbsd13
1304
1305
1306  9.5 Packages not building in their DISTNAME directory
1307  ======================================================
1308
1309 Your package builds in a different directory from its base DISTNAME - see
1310 tcl and tk packages:
1311
1312 > WRKSRC=         ${WRKDIR}/${DISTNAME}/unix
1313
1314
1315  9.6 How to fetch all distfiles at once
1316  ======================================
1317
1318 You would like to download all the distfiles in a single batch from work or
1319 university, where you can't run a "make fetch". But there's no archive of
1320 the distfiles on ftp.netbsd.org and the one on ftp.freebsd.org contains
1321 many distfiles for which there are no ports (yet).
1322
1323 The answer here is to do a "make fetch-list" in /usr/pkgsrc and use the
1324 resulting list.
1325
1326
1327  9.7 How to fetch files from behind a firewall
1328  =============================================
1329
1330 If you are sitting behind a firewall which does not allow direct connections
1331 to Internet hosts (i.e. non-NAT), you may specify the relevant proxy hosts.
1332 This is done using an environment variable in the form of a URL
1333 e.g. in Amdahl, the machine orpheus.amdahl.com is one of the firewalls, and
1334 it uses port 80 as the proxy port number. So the proxy environment
1335 variables look like:
1336
1337         ftp_proxy=ftp://orpheus.amdahl.com:80/
1338         http_proxy=http://orpheus.amdahl.com:80/
1339
1340
1341  9.8 If your patch contains an RCS ID
1342  ====================================
1343
1344 See section 4.3 on how to remove RCS IDs from patch files. 
1345
1346
1347  9.9 How to pull in variables from /etc/mk.conf
1348  ==============================================
1349
1350 The problem with package-defined variables that can be overridden via
1351 MAKECONF or /etc/mk.conf is that make(1) expands a variable as it is
1352 used, but evaluates preprocessor like statements (.if, .ifdef and
1353 .ifndef) as they are read.  So, to use any variable (which may be set
1354 in /etc/mk.conf) in one of the .if* statements, the file /etc/mk.conf
1355 must be included before that .if* statement.
1356
1357 Rather than have a number of ad-hoc ways of including /etc/mk.conf,
1358 should it exist, or MAKECONF, should it exist, include the
1359 pkgsrc/mk/bsd.prefs.mk file in the package Makefile before any
1360 preprocessor-like .if, .ifdef, or .ifndef statements:
1361
1362         .include "../../mk/bsd.prefs.mk"
1363
1364         .if defined(USE_MENUS)
1365         ...
1366         .endif
1367
1368
1369  9.10 Is there a mailing list for pkg-related discussion?
1370  ========================================================
1371
1372 Yes. We are using tech-pkg@netbsd.org for discussing package related
1373 issues. To subscribe do:
1374
1375     echo subscribe tech-pkg | mail majordomo@netbsd.org
1376
1377
1378  9.11 How do i tell "make fetch" to do passive FTP?
1379  ==================================================
1380
1381 This depends on which utility is used to retrieve distfiles. From
1382 bsd.pkg.mk, FETCH_CMD is assigned the first available command from the
1383 following list:
1384
1385 /usr/bin/fetch
1386 ${LOCALBASE}/bsd/bin/ftp
1387 /usr/bin/ftp
1388
1389 On a default NetBSD install, this will be /usr/bin/ftp, which automatically
1390 tries passive connections first, and falls back to active connections if the
1391 server refuses to do passive. For the other tools, add the following to your
1392 /etc/mk.conf file: PASSIVE_FETCH=1
1393
1394 Having that option present will prevent /usr/bin/ftp from falling back to
1395 active transfers.
1396
1397
1398  9.12 Dependencies on other packages
1399  ===================================
1400
1401 Your package may depend on some other package being present - and there are
1402 various ways of expressing this dependency. NetBSD supports the
1403 BUILD_DEPENDS and DEPENDS definitions (beware: the DEPENDS definition is
1404 not the same as FreeBSD's deprecated one, and NetBSD does not use the
1405 FreeBSD LIB_DEPENDS definition any more - it proved problematic on ELF
1406 NetBSD platforms).
1407
1408 [In the following examples, the BUILD_DEPENDS dependencies have the format:
1409 <file>:<directory containing package to build>[:<stage>] If the <stage>
1410 isn't specified, it defaults to ``install''. If the file contains a '/', it
1411 is interpreted as a regular file - otherwise, the name is taken to be an
1412 executable file, and the PATH is searched for <file>. If the regular file
1413 is not found, or the executable file is not in the path, then the
1414 pre-requisite package will be built from the sources in <directory
1415 containing the package to build>. The DEPENDS definition specifies a
1416 package name (which contains its version number), and the directory
1417 containing the package to build if this version of the package is not
1418 installed.]
1419
1420 (a) If your package needs files from another package to build, see the
1421 print/ghostscript5 package (it relies on the jpeg sources being
1422 present in source form during the build):
1423
1424 BUILD_DEPENDS+=  ../../graphics/jpeg/${WRKDIR:T}/jpeg-6a:../../graphics/jpeg:extract
1425
1426 (b) If your package needs to use another package to build itself, this
1427 is specified using the BUILD_DEPENDS definition, but without
1428 specifying the stage ``:extract'' in (a) above.  An example is the
1429 print/lyx package, which uses the latex binary during its build
1430 process:
1431
1432 BUILD_DEPENDS+=  latex:../../print/teTeX
1433
1434 (c) If your package needs a library with which to link, this is
1435 specified using the DEPENDS definition.  An example of this is the
1436 print/lyx package, which uses the xpm library, version 3.4j to build.
1437
1438 DEPENDS+=       xpm-3.4j:../../graphics/xpm
1439
1440 You can also use wildcards in package dependences:
1441
1442 DEPENDS+=       xpm-*:../../graphics/xpm
1443
1444 Note that such wildcard dependencies are retained when creating
1445 binary package. The dependency is checked when installing the binary
1446 package and any package which matches the pattern would be used.
1447 Beware that wildard dependencies should be used with a bit of care.
1448 Simple example for package which needs some version of Tk installed,
1449 but doesn't care which exactly - dependency
1450
1451 DEPENDS+=       tk-*:../../x11/tk80
1452
1453 would also match e.g. tk-postgresql-6.5.3, which is not what was
1454 needed. ALWAYS ensure that the wildcard doesn't match more than it should.
1455
1456 (d) If your package needs some executable to be able to run correctly, this
1457 is specified using the DEPENDS definition. The print/lyx package needs to
1458 be able to execute the latex binary from the teTex package when it runs,
1459 and that is specified:
1460
1461 DEPENDS+=        teTex-*:../../print/teTeX 
1462
1463 The comment about wildcard dependencies from previous paragraph
1464 applies here, too.
1465
1466
1467  9.13 Conflicts with other packages
1468  ==================================
1469
1470 Your package may conflict with other packages a user might already have
1471 installed on his system, e.g. if your package installs the same set of
1472 files like another package in our pkgsrc tree.
1473
1474 In this case you can set CONFLICTS to a space separated list of packages
1475 (including version string) your package conflicts with.
1476
1477 For example pkgsrc/x11/Xaw3d and pkgsrc/x11/Xaw-Xpm install provide the
1478 same shared library, thus you set in pkgsrc/x11/Xaw3d/Makefile:
1479
1480 CONFLICTS=      Xaw-Xpm-*
1481
1482 and in pkgsrc/x11/Xaw-Xpm/Makefile:
1483
1484 CONFLICTS=      Xaw3d-*
1485
1486 Packages will automatically conflict with other packages with the name prefix
1487 and a different version string. "Xaw3d-1.5" e.g. will automatically conflict
1488 with the older version "Xaw3d-1.3".
1489
1490  9.14 Software which has a WWW Home Page
1491  =======================================
1492
1493 The NetBSD packages system now supports a variable called HOMEPAGE.
1494 If the software being packaged has a home page, the Makefile should
1495 include the URL for that page in the HOMEPAGE variable. The definition
1496 of the variable should be placed immediately after the MAINTAINER
1497 variable.
1498
1499  9.15 How to handle modified distfiles with the 'old' name
1500  =========================================================
1501
1502 Sometimes authors of a software package make some modifications after the
1503 software was released, and they put up a new distfile without changing the
1504 package's version number. If a package is already in pkgsrc at that time, 
1505 the md5 checksum will no longer match. The correct way to work around this
1506 is to update the package's md5 checksum to match the package on the master
1507 site (beware, any mirrors may not be up to date yet!), and to remove the 
1508 old distfile from ftp.netbsd.org's /pub/NetBSD/packages/distfiles directory.
1509 Furthermore, a mail to the package's author seems appropriate making sure
1510 the distfile was really updated on purpose, and that no trojan horse or so
1511 crept in.
1512
1513  9.16 What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean?
1514  ========================================================================
1515
1516 When compiling the pkgsrc/pkgtools/pkg_install package, you get the error
1517 from make that it doesn't know how to make /usr/share/tmac/tmac.andoc? This
1518 indicates that you don't have installed the "text" set on your machine
1519 (nroff, ...). Please do that.
1520
1521  9.17 How to handle incrementing versions when fixing an existing package
1522  ========================================================================
1523
1524 When making fixes to an existing package it can be useful to change
1525 the version number in PKGNAME. To avoid conflicting with future versions
1526 by the original author, use a 'nb1' suffix (later versions should
1527 increment this to give 'nb2' and so on).
1528
1529  9.18 "Could not find bsd.own.mk" - what's wrong?
1530  ================================================
1531
1532 You didn't install the compiler set, comp.tgz, when you installed your
1533 NetBSD machine. Please get it and install it, by extracting it in /:
1534
1535         tar --unlink -pvxf .../comp.tgz
1536
1537 comp.tgz is part of every NetBSD release, please get the one matching 
1538 the release you have installed (determine via "uname -r").
1539
1540
1541  10 Submitting
1542  =============
1543
1544  * precompiled binary packages:
1545    Our policy is that we accept binaries from only NetBSD developers to
1546    guarantee that the packages don't contain any trojan horses etc. 
1547    This is not to piss anyone off but rather to protect our users!
1548    You're still free to put up your home-made binary packages and tell
1549    the world where to get them. 
1550
1551  * packages:
1552    First, check that your package is complete, compiles and runs well; see
1553    section 8 and the rest of this document. Then, generate a gzipped
1554    tar-file of all the files needed for the package, preferably with all
1555    files in a single directory. Place this tar-file to a place where the
1556    package maintainers can fetch it using FTP or HTTP (WWW). Finally,
1557    send-pr with category "pkg", a synopsis which includes the package name
1558    and version number, a short description of your package
1559    (contents of pkg/COMMENT are OK) and the URL of your tar-file.
1560
1561    You will be notified if your send-pr has been addressed so you can remove
1562    the tar-file. 
1563
1564
1565  11 A simple example of a package: bison
1566  =======================================
1567
1568 I checked to find a piece of software that isn't in the FreeBSD ports
1569 collection, and picked GNU bison. Quite why someone would want to have
1570 bison when Berkeley yacc is already present in the tree is beyond me, but
1571 it's useful for the purposes of this exercise.
1572
1573
1574  11.1 files
1575  ==========
1576
1577 The file contents in this section must be used without the "> " prefix.
1578
1579
1580  11.1.1 Makefile
1581  ===============
1582
1583 > # <$>NetBSD<$>
1584 >  
1585 > DISTNAME=       bison-1.25
1586 > CATEGORIES=     devel
1587 > MASTER_SITES=   ${MASTER_SITE_GNU}
1588 >
1589 > MAINTAINER=     thorpej@netbsd.org
1590 > HOMEPAGE=       http://www.gnu.org/software/bison/bison.html
1591 >  
1592 > GNU_CONFIGURE=  yes
1593 > INFO_FILES=     bison.info
1594 >  
1595 > .include "../../mk/bsd.pkg.mk"
1596
1597
1598  11.1.2 pkg/COMMENT
1599  ==================
1600
1601 > GNU yacc clone.
1602
1603
1604  11.1.3 pkg/DESCR
1605  ================
1606
1607 > GNU version of yacc.  Can make re-entrant parsers, and numerous other
1608 > improvements.  Why you would want this when Berkeley yacc(1) is part
1609 > of the NetBSD source tree is beyond me.
1610
1611
1612  11.1.4 pkg/PLIST
1613  ================
1614
1615 > @comment <$>NetBSD<$>
1616 > bin/bison
1617 > man/man1/bison.1.gz
1618 > @unexec install-info --delete %D/info/bison.info %D/info/dir
1619 > info/bison.info
1620 > info/bison.info-1
1621 > info/bison.info-2
1622 > info/bison.info-3
1623 > info/bison.info-4
1624 > info/bison.info-5
1625 > @exec install-info %D/info/bison.info %D/info/dir
1626 > share/bison.simple
1627 > share/bison.hairy
1628
1629
1630  11.1.5 Checking a package "pkglint"
1631  ===================================
1632
1633 The NetBSD package system comes with a tool called "pkglint" (located in the
1634 directory "pkgsrc/pkgtools/pkglint") which helps to check the contents of these
1635 files. After installation it is quite easy to use, just change to the
1636 directory of the package you which to examine and execute "pkglint":
1637
1638 > tron@lyssa:/usr/pkgsrc/devel/bison>pkglint
1639 > OK: checking pkg/COMMENT.
1640 > OK: checking pkg/DESCR.
1641 > OK: checking Makefile.
1642 > OK: checking files/md5.
1643 > OK: checking patches/patch-aa.
1644 > looks fine.
1645
1646 Depending on the supplied command line arguments (see "man pkglint") more
1647 intensive checks will be performed. Use e.g. "pkglint -a -v" for a very
1648 detailed and verbose check.
1649
1650
1651  11.2 Steps for building, installing, packaging
1652  ==============================================
1653
1654 Create the directory where the package lives, plus any auxiliary directories:
1655
1656 > root@pumpy:/u/pkgsrc/lang(1765)# cd /usr/pkgsrc/lang
1657 > root@pumpy:/u/pkgsrc/lang(1765)# mkdir bison
1658 > root@pumpy:/u/pkgsrc/lang(1766)# cd bison
1659 > root@pumpy:/u/pkgsrc/lang/bison(1768)# mkdir files patches pkg
1660
1661 Create Makefile, pkg/COMMENT, pkg/DESCR and pkg/PLIST as in section 11.1,
1662 then continue with fetching the distfile:
1663
1664 > root@pumpy:/u/pkgsrc/lang/bison(1769)# make fetch
1665 > >> bison-1.25.tar.gz doesn't seem to exist on this system.
1666 > >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
1667 > Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1668 > ftp: Error retrieving file: 500 Internal error
1669 >  
1670 > >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
1671 > Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1672 > ftp: Error retrieving file: 500 Internal error
1673 >  
1674 > >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
1675 > Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1676 > Successfully retrieved file.
1677
1678 Generate the checksum of the distfile into files/md5:
1679
1680 > root@pumpy:/u/pkgsrc/lang/bison(1770)# make makesum
1681
1682 Now compile:
1683
1684 > root@pumpy:/u/pkgsrc/lang/bison(1777)# make
1685 > >> Checksum OK for bison-1.25.tar.gz.
1686 > ===>  Extracting for bison-1.25
1687 > ===>  Patching for bison-1.25
1688 > ===>   Ignoring empty patch directory
1689 > ===>  Configuring for bison-1.25
1690 > creating cache ./config.cache
1691 > checking for gcc... cc
1692 > checking whether we are using GNU C... yes
1693 > checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
1694 > checking how to run the C preprocessor... cc -E
1695 > checking for minix/config.h... no
1696 > checking for POSIXized ISC... no
1697 > checking whether cross-compiling... no
1698 > checking for ANSI C header files... yes
1699 > checking for string.h... yes
1700 > checking for stdlib.h... yes
1701 > checking for memory.h... yes
1702 > checking for working const... yes
1703 > checking for working alloca.h... no
1704 > checking for alloca... yes
1705 > checking for strerror... yes
1706 > updating cache ./config.cache
1707 > creating ./config.status
1708 > creating Makefile
1709 > ===>  Building for bison-1.25
1710 > 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
1711 > 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
1712 > 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
1713 > 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
1714 > 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
1715 > 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 
1716 > 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
1717 > 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
1718 > 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
1719 > 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
1720 > 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
1721 > 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
1722 > 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
1723 > 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
1724 > 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
1725 > 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
1726 > 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
1727 > 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
1728 > 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
1729 > 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
1730 > 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
1731 > 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                        
1732                     getopt.o getopt1.o  
1733 > ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
1734 > rm -f bison.s1
1735 > sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1
1736
1737 Everything seems OK, so install the files:
1738
1739 > root@pumpy:/u/pkgsrc/lang/bison(1785)# make install
1740 > >> Checksum OK for bison-1.25.tar.gz.
1741 > ===>  Installing for bison-1.25
1742 > sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
1743 > rm -f /usr/pkg/bin/bison
1744 > cd /usr/pkg/share; rm -f bison.simple bison.hairy
1745 > rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
1746 > install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
1747 > /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
1748 > /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
1749 > cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
1750 > /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1751 > ===>  Registering installation for bison-1.25
1752
1753 You can now use bison, and also - if you decide so - remove it with
1754 "pkg_delete bison-1.25". Should you decide that you want a binary package,
1755 do this now:
1756
1757 > root@pumpy:/u/pkgsrc/lang/bison(1786)# make package
1758 > >> Checksum OK for bison-1.25.tar.gz.
1759 > ===>  Building package for bison-1.25
1760 > Creating package bison-1.25.tgz
1761 > Registering depends:.
1762 > Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'
1763
1764 Now that you don't need the source and object files any more, clean up:
1765
1766 > root@pumpy:/u/pkgsrc/lang/bison(1787)# make clean
1767 > ===>  Cleaning for bison-1.25
1768
1769
1770 ======================
1771 Appendix A: build logs
1772 ======================
1773
1774  A.1 Building top
1775  ================
1776
1777 > Script started on Fri Oct  3 13:22:31 1997
1778 > root@pumpy:/u/pkgsrc/sysutils/top(1342)# make
1779 > >> top-3.5beta5.tar.gz doesn't seem to exist on this system.
1780 > >> Attempting to fetch from ftp://ftp.groupsys.com/pub/top/.
1781 > Requesting ftp://ftp.groupsys.com/pub/top/top-3.5beta5.tar.gz (via ftp://orpheus.amdahl.com:80/)
1782 > Successfully retrieved file.
1783 > >> Checksum OK for top-3.5beta5.tar.gz.
1784 > ===>  Extracting for top-3.5beta5
1785 > ===>  Patching for top-3.5beta5
1786 > ===>  Applying NetBSD patches for top-3.5beta5
1787 > ===>  Configuring for top-3.5beta5
1788 > /bin/cp /u/pkgsrc/sysutils/top/files/defaults /u/pkgsrc/sysutils/top/work/top-3.5beta5/.defaults
1789 > chmod a-x /u/pkgsrc/sysutils/top/work/top-3.5beta5/install
1790
1791 > Reading configuration from last time...
1792
1793 > Using these settings:
1794 >         Bourne Shell   /bin/sh
1795 >           C compiler   cc
1796 >     Compiler options   -DHAVE_GETOPT -O
1797 >          Awk command   awk
1798 >      Install command   /usr/bin/install
1799
1800 >               Module   netbsd13
1801 >              LoadMax   5.0
1802 >         Default TOPN   -1
1803 >         Nominal TOPN   18
1804 >        Default Delay   2
1805 > Random passwd access   yes
1806 >           Table Size   47
1807 >                Owner   root
1808 >          Group Owner   kmem
1809 >                 Mode   2755
1810 >        bin directory   $(PREFIX)/bin
1811 >        man directory   $(PREFIX)/man/man1
1812 >        man extension   1
1813 >        man style       man
1814
1815 > Building Makefile...
1816 > Building top.local.h...
1817 > Building top.1...
1818 > Doing a "make clean".
1819 > rm -f *.o top core core.* sigdesc.h
1820 > To create the executable, type "make".
1821 > To install the executable, type "make install".
1822 > ===>  Building for top-3.5beta5
1823 > cc -DHAVE_GETOPT -DORDER -DHAVE_GETOPT -O  -c top.c
1824 > awk -f sigconv.awk /usr/include/sys/signal.h >sigdesc.h
1825 > cc -DHAVE_GETOPT -DORDER -DHAVE_GETOPT -O  -c commands.c
1826 > cc -DHAVE_GETOPT -DORDER -DHAVE_GETOPT -O  -c display.c
1827 > cc -DHAVE_GETOPT -DORDER -DHAVE_GETOPT -O  -c screen.c
1828 > cc -DHAVE_GETOPT -DORDER -DHAVE_GETOPT -O  -c username.c
1829 > cc -DHAVE_GETOPT -DORDER -DHAVE_GETOPT -O  -c utils.c
1830 > utils.c: In function `errmsg':
1831 > utils.c:348: warning: return discards `const' from pointer target type
1832 > cc -DHAVE_GETOPT -DORDER -DHAVE_GETOPT -O  -c version.c
1833 > cc -DHAVE_GETOPT -DORDER -DHAVE_GETOPT -O  -c getopt.c
1834 > cc "-DOSREV=12G" -DHAVE_GETOPT -DORDER -DHAVE_GETOPT -O -c machine.c
1835 > rm -f top
1836 > cc -o top top.o commands.o display.o screen.o username.o  utils.o version.o getopt.o machine.o -ltermcap -lm -lkvm
1837 > root@pumpy:/u/pkgsrc/sysutils/top(1343)# make install
1838 > >> Checksum OK for top-3.5beta5.tar.gz.
1839 > ===>  Installing for top-3.5beta5
1840 > /usr/bin/install -o root -m 2755 -g kmem top /usr/pkg/bin
1841 > /usr/bin/install top.1 /usr/pkg/man/man1/top.1
1842 > strip /usr/pkg/bin/top
1843 > ===>  Registering installation for top-3.5beta5
1844 > root@pumpy:/u/pkgsrc/sysutils/top(1344)# 
1845
1846
1847  A.2 Packaging top
1848  =================
1849
1850 > root@pumpy:/u/pkgsrc/sysutils/top(1344)# make package
1851  > >> Checksum OK for top-3.5beta5.tar.gz.
1852 > ===>  Building package for top-3.5beta5
1853 > Creating package top-3.5beta5.tgz
1854 > Registering depends:.
1855 > Creating gzip'd tar ball in '/u/pkgsrc/sysutils/top/top-3.5beta5.tgz'
1856 > root@pumpy:/u/pkgsrc/sysutils/top(1345)#
1857
1858
1859 ======================================================
1860 Appendix B: Layout of the FTP server's package archive
1861 ======================================================
1862
1863 Layout for precompiled binary packages on ftp.netbsd.org:
1864
1865 /pub/NetBSD/packages/
1866                 README
1867                 distfiles/
1868                 pkgsrc -> /pub/NetBSD/NetBSD-current/pkgsrc
1869                 1.3/
1870                         i386/
1871                                 All/
1872                                 archivers/
1873                                         foo -> ../All/foo
1874                                 ...
1875                         m68k/
1876                                 All/
1877                                 archivers/
1878                                         foo -> ../All/foo
1879                                 ...
1880                         amiga -> m68k
1881                         atari -> m68k
1882                         ...
1883
1884
1885 To create:
1886  - cd /usr/pkgsrc ; make install ; make package
1887  - upload /usr/pkgsrc/packages to
1888    ftp://ftp.netbsd.org/pub/NetBSD/packages/`uname -r`/`sysctl -n hw.machine_arch`
1889  - if necessary ln -s `sysctl -n hw.machine` `sysctl -n hw.machine_arch`
1890
1891 Disk space needed: unknown.
1892
1893
1894 ###########################################################################
1895 # Local Variables:
1896 # mode:                         Text
1897 # fill-column:                  75
1898 # sentence-end-double-space:    nil
1899 # End: