Annotation of htdocs/docs/pkgsrc/pkgsrc.txt, revision 1.2

1.1       dsieger     1: The pkgsrc guide
                      2: 
                      3: Documentation on the NetBSD packages system
                      4: 
                      5: Alistair Crooks
                      6: 
                      7: <agc@NetBSD.org>
                      8: 
                      9: Hubert Feyrer
                     10: 
                     11: <hubertf@NetBSD.org>
                     12: 
                     13: The pkgsrc Developers
                     14: 
                     15: Copyright   1994-2006 The NetBSD Foundation, Inc
                     16: 
1.2     ! rillig     17: $NetBSD: pkgsrc.xml,v 1.24 2006/11/11 05:39:09 rillig Exp $
1.1       dsieger    18: 
                     19: Abstract
                     20: 
                     21: pkgsrc is a centralized package management system for Unix-like operating
                     22: systems. This guide provides information for users and developers of pkgsrc. It
                     23: covers installation of binary and source packages, creation of binary and
                     24: source packages and a high-level overview about the infrastructure.
                     25: 
                     26: -------------------------------------------------------------------------------
                     27: 
                     28: Table of Contents
                     29: 
                     30: 1. What is pkgsrc?
                     31: 
                     32:     1.1. Introduction
                     33: 
                     34:         1.1.1. Why pkgsrc?
                     35:         1.1.2. Supported platforms
                     36: 
                     37:     1.2. Overview
                     38:     1.3. Terminology
                     39: 
                     40:         1.3.1. Roles involved in pkgsrc
                     41: 
                     42:     1.4. Typography
                     43: 
                     44: I. The pkgsrc user's guide
                     45: 
                     46:     2. Where to get pkgsrc and how to keep it up-to-date
                     47: 
                     48:         2.1. Getting pkgsrc for the first time
                     49: 
                     50:             2.1.1. As tar file
                     51:             2.1.2. Via SUP
                     52:             2.1.3. Via anonymous CVS
                     53: 
                     54:         2.2. Keeping pkgsrc up-to-date
                     55: 
                     56:             2.2.1. Via tar files
                     57:             2.2.2. Via CVS
                     58: 
                     59:     3. Using pkgsrc on systems other than NetBSD
                     60: 
                     61:         3.1. Binary distribution
                     62:         3.2. Bootstrapping pkgsrc
                     63:         3.3. Platform-specific notes
                     64: 
                     65:             3.3.1. Darwin (Mac OS X)
                     66:             3.3.2. FreeBSD
                     67:             3.3.3. Interix
                     68:             3.3.4. IRIX
                     69:             3.3.5. Linux
                     70:             3.3.6. OpenBSD
                     71:             3.3.7. Solaris
                     72: 
                     73:     4. Using pkgsrc
                     74: 
                     75:         4.1. Using binary packages
                     76: 
                     77:             4.1.1. Finding binary packages
                     78:             4.1.2. Installing binary packages
                     79:             4.1.3. Deinstalling packages
                     80:             4.1.4. Getting information about installed packages
                     81:             4.1.5. Checking for security vulnerabilities in installed packages
                     82:             4.1.6. Finding if newer versions of your installed packages are in
                     83:                 pkgsrc
                     84:             4.1.7. Other administrative functions
                     85:             4.1.8. A word of warning
                     86: 
                     87:         4.2. Building packages from source
                     88: 
                     89:             4.2.1. Requirements
                     90:             4.2.2. Fetching distfiles
                     91:             4.2.3. How to build and install
                     92: 
                     93:     5. Configuring pkgsrc
                     94: 
                     95:         5.1. General configuration
                     96:         5.2. Variables affecting the build process
                     97:         5.3. Selecting and configuring the compiler
                     98: 
                     99:             5.3.1. Selecting the compiler
                    100:             5.3.2. Additional flags to the compiler (CFLAGS)
                    101:             5.3.3. Additional flags to the linker (LDFLAGS)
                    102: 
                    103:         5.4. Developer/advanced settings
                    104:         5.5. Selecting Build Options
                    105: 
                    106:     6. Creating binary packages
                    107: 
                    108:         6.1. Building a single binary package
                    109:         6.2. Settings for creation of binary packages
                    110:         6.3. Doing a bulk build of all packages
                    111: 
                    112:             6.3.1. Configuration
                    113:             6.3.2. Other environmental considerations
                    114:             6.3.3. Operation
                    115:             6.3.4. What it does
                    116:             6.3.5. Disk space requirements
                    117:             6.3.6. Setting up a sandbox for chrooted builds
                    118:             6.3.7. Building a partial set of packages
                    119:             6.3.8. Uploading results of a bulk build
                    120: 
                    121:         6.4. Creating a multiple CD-ROM packages collection
                    122: 
                    123:             6.4.1. Example of cdpack
                    124: 
                    125:     7. Directory layout of the installed files
                    126: 
                    127:         7.1. File system layout in ${LOCALBASE}
                    128:         7.2. File system layout in ${VARBASE}
                    129: 
                    130:     8. Frequently Asked Questions
                    131: 
                    132:         8.1. Are there any mailing lists for pkg-related discussion?
                    133:         8.2. Where's the pkgviews documentation?
                    134:         8.3. Utilities for package management (pkgtools)
                    135:         8.4. How to use pkgsrc as non-root
                    136:         8.5. How to resume transfers when fetching distfiles?
                    137:         8.6. How can I install/use XFree86 from pkgsrc?
                    138:         8.7. How can I install/use X.org from pkgsrc?
                    139:         8.8. How to fetch files from behind a firewall
                    140:         8.9. How do I tell make fetch to do passive FTP?
                    141:         8.10. How to fetch all distfiles at once
                    142:         8.11. What does "Don't know how to make /usr/share/tmac/tmac.andoc"
                    143:             mean?
                    144:         8.12. What does "Could not find bsd.own.mk" mean?
                    145:         8.13. Using 'sudo' with pkgsrc
                    146:         8.14. How do I change the location of configuration files?
                    147:         8.15. Automated security checks
                    148:         8.16. Why do some packages ignore my CFLAGS?
                    149:         8.17. A package does not build. What shall I do?
                    150:         8.18. What does "Makefile appears to contain unresolved cvs/rcs/???
                    151:             merge conflicts" mean?
                    152: 
                    153: II. The pkgsrc developer's guide
                    154: 
                    155:     9. Creating a new pkgsrc package from scratch
                    156: 
                    157:         9.1. Common types of packages
                    158: 
                    159:             9.1.1. Perl modules
                    160:             9.1.2. KDE applications
                    161: 
                    162:         9.2. Examples
                    163: 
                    164:             9.2.1. How the www/nvu package came into pkgsrc
                    165: 
                    166:     10. Package components - files, directories and contents
                    167: 
                    168:         10.1. Makefile
                    169:         10.2. distinfo
                    170:         10.3. patches/*
                    171: 
                    172:             10.3.1. Structure of a single patch file
                    173:             10.3.2. Creating patch files
                    174:             10.3.3. Sources where the patch files come from
                    175:             10.3.4. Patching guidelines
                    176:             10.3.5. Feedback to the author
                    177: 
                    178:         10.4. Other mandatory files
                    179:         10.5. Optional files
                    180: 
                    181:             10.5.1. Files affecting the binary package
                    182:             10.5.2. Files affecting the build process
                    183:             10.5.3. Files affecting nothing at all
                    184: 
                    185:         10.6. work*
                    186:         10.7. files/*
                    187: 
                    188:     11. Programming in Makefiles
                    189: 
                    190:         11.1. Caveats
                    191:         11.2. Makefile variables
                    192: 
                    193:             11.2.1. Naming conventions
                    194: 
                    195:         11.3. Code snippets
                    196: 
                    197:             11.3.1. Adding things to a list
                    198:             11.3.2. Converting an internal list into an external list
                    199:             11.3.3. Passing variables to a shell command
                    200:             11.3.4. Quoting guideline
                    201:             11.3.5. Workaround for a bug in BSD Make
                    202: 
                    203:     12. PLIST issues
                    204: 
                    205:         12.1. RCS ID
                    206:         12.2. Semi-automatic PLIST generation
                    207:         12.3. Tweaking output of make print-PLIST
                    208:         12.4. Variable substitution in PLIST
                    209:         12.5. Man page compression
                    210:         12.6. Changing PLIST source with PLIST_SRC
                    211:         12.7. Platform-specific and differing PLISTs
                    212:         12.8. Sharing directories between packages
                    213: 
                    214:     13. Buildlink methodology
                    215: 
                    216:         13.1. Converting packages to use buildlink3
                    217:         13.2. Writing buildlink3.mk files
                    218: 
                    219:             13.2.1. Anatomy of a buildlink3.mk file
                    220:             13.2.2. Updating BUILDLINK_API_DEPENDS.pkg in buildlink3.mk files
                    221: 
                    222:         13.3. Writing builtin.mk files
                    223: 
                    224:             13.3.1. Anatomy of a builtin.mk file
                    225:             13.3.2. Global preferences for native or pkgsrc software
                    226: 
                    227:     14. The pkginstall framework
                    228: 
                    229:         14.1. Files and directories outside the installation prefix
                    230: 
                    231:             14.1.1. Directory manipulation
                    232:             14.1.2. File manipulation
                    233: 
                    234:         14.2. Configuration files
                    235: 
                    236:             14.2.1. How PKG_SYSCONFDIR is set
                    237:             14.2.2. Telling the software where configuration files are
                    238:             14.2.3. Patching installations
                    239:             14.2.4. Disabling handling of configuration files
                    240: 
                    241:         14.3. System startup scripts
                    242: 
                    243:             14.3.1. Disabling handling of system startup scripts
                    244: 
                    245:         14.4. System users and groups
                    246:         14.5. System shells
                    247: 
                    248:             14.5.1. Disabling shell registration
                    249: 
                    250:         14.6. Fonts
                    251: 
                    252:             14.6.1. Disabling automatic update of the fonts databases
                    253: 
                    254:     15. Options handling
                    255: 
                    256:         15.1. Global default options
                    257:         15.2. Converting packages to use bsd.options.mk
                    258:         15.3. Option Names
                    259: 
                    260:     16. The build process
                    261: 
                    262:         16.1. Introduction
                    263:         16.2. Program location
                    264:         16.3. Directories used during the build process
                    265:         16.4. Running a phase
                    266:         16.5. The fetch phase
                    267: 
                    268:             16.5.1. What to fetch and where to get it from
                    269:             16.5.2. How are the files fetched?
                    270: 
                    271:         16.6. The checksum phase
                    272:         16.7. The extract phase
                    273:         16.8. The patch phase
                    274:         16.9. The tools phase
                    275:         16.10. The wrapper phase
                    276:         16.11. The configure phase
                    277:         16.12. The build phase
                    278:         16.13. The test phase
                    279:         16.14. The install phase
                    280:         16.15. The package phase
                    281:         16.16. Cleaning up
                    282:         16.17. Other helpful targets
                    283: 
                    284:     17. Tools needed for building or running
                    285: 
                    286:         17.1. Tools for pkgsrc builds
                    287:         17.2. Tools needed by packages
                    288:         17.3. Tools provided by platforms
                    289:         17.4. Questions regarding the tools
                    290: 
                    291:     18. Making your package work
                    292: 
                    293:         18.1. General operation
                    294: 
                    295:             18.1.1. Portability of packages
                    296:             18.1.2. How to pull in user-settable variables from mk.conf
                    297:             18.1.3. User interaction
                    298:             18.1.4. Handling licenses
                    299:             18.1.5. Restricted packages
                    300:             18.1.6. Handling dependencies
                    301:             18.1.7. Handling conflicts with other packages
                    302:             18.1.8. Packages that cannot or should not be built
                    303:             18.1.9. Packages which should not be deleted, once installed
                    304:             18.1.10. Handling packages with security problems
                    305:             18.1.11. How to handle incrementing versions when fixing an
                    306:                 existing package
                    307:             18.1.12. Substituting variable text in the package files (the SUBST
                    308:                 framework)
                    309: 
                    310:         18.2. Fixing problems in the fetch phase
                    311: 
                    312:             18.2.1. Packages whose distfiles aren't available for plain
                    313:                 downloading
                    314:             18.2.2. How to handle modified distfiles with the 'old' name
                    315: 
                    316:         18.3. Fixing problems in the configure phase
                    317: 
                    318:             18.3.1. Shared libraries - libtool
                    319:             18.3.2. Using libtool on GNU packages that already support libtool
                    320:             18.3.3. GNU Autoconf/Automake
                    321: 
                    322:         18.4. Programming languages
                    323: 
                    324:             18.4.1. C, C++, and Fortran
                    325:             18.4.2. Java
                    326:             18.4.3. Packages containing perl scripts
                    327:             18.4.4. Other programming languages
                    328: 
                    329:         18.5. Fixing problems in the build phase
                    330: 
                    331:             18.5.1. Compiling C and C++ code conditionally
                    332:             18.5.2. How to handle compiler bugs
                    333:             18.5.3. Undefined reference to "..."
                    334:             18.5.4. Running out of memory
                    335: 
                    336:         18.6. Fixing problems in the install phase
                    337: 
                    338:             18.6.1. Creating needed directories
                    339:             18.6.2. Where to install documentation
                    340:             18.6.3. Installing highscore files
                    341:             18.6.4. Packages with hardcoded paths to other interpreters
                    342:             18.6.5. Packages installing perl modules
                    343:             18.6.6. Packages installing info files
                    344:             18.6.7. Packages installing man pages
                    345:             18.6.8. Packages installing GConf2 data files
                    346:             18.6.9. Packages installing scrollkeeper data files
                    347:             18.6.10. Packages installing X11 fonts
                    348:             18.6.11. Packages installing GTK2 modules
                    349:             18.6.12. Packages installing SGML or XML data
                    350:             18.6.13. Packages installing extensions to the MIME database
                    351:             18.6.14. Packages using intltool
                    352:             18.6.15. Packages installing startup scripts
                    353:             18.6.16. Packages installing TeX modules
                    354:             18.6.17. Packages supporting running binaries in emulation
                    355:             18.6.18. Packages installing hicolor theme icons
                    356:             18.6.19. Packages installing desktop files
                    357: 
                    358:         18.7. Marking packages as having problems
                    359: 
                    360:     19. Debugging
                    361:     20. Submitting and Committing
                    362: 
                    363:         20.1. Submitting binary packages
                    364:         20.2. Submitting source packages (for non-NetBSD-developers)
                    365:         20.3. General notes when adding, updating, or removing packages
                    366:         20.4. Committing: Importing a package into CVS
                    367:         20.5. Updating a package to a newer version
                    368:         20.6. Moving a package in pkgsrc
                    369: 
                    370:     21. Frequently Asked Questions
                    371:     22. GNOME packaging and porting
                    372: 
                    373:         22.1. Meta packages
                    374:         22.2. Packaging a GNOME application
                    375:         22.3. Updating GNOME to a newer version
                    376:         22.4. Patching guidelines
                    377: 
                    378: III. The pkgsrc infrastructure internals
                    379: 
                    380:     23. Design of the pkgsrc infrastructure
                    381: 
                    382:         23.1. The meaning of variable definitions
                    383:         23.2. Avoiding problems before they arise
                    384:         23.3. Variable evaluation
                    385: 
                    386:             23.3.1. At load time
                    387:             23.3.2. At runtime
                    388: 
                    389:         23.4. How can variables be specified?
                    390:         23.5. Designing interfaces for Makefile fragments
                    391: 
                    392:             23.5.1. Procedures with parameters
                    393:             23.5.2. Actions taken on behalf of parameters
                    394: 
                    395:         23.6. The order in which files are loaded
                    396: 
                    397:             23.6.1. The order in bsd.prefs.mk
                    398:             23.6.2. The order in bsd.pkg.mk
                    399: 
                    400:     24. Regression tests
                    401: 
                    402:         24.1. The regression tests framework
                    403:         24.2. Running the regression tests
                    404:         24.3. Adding a new regression test
                    405: 
                    406:             24.3.1. Overridable functions
                    407:             24.3.2. Helper functions
                    408: 
                    409:     25. Porting pkgsrc
                    410: 
                    411:         25.1. Porting pkgsrc to a new operating system
                    412:         25.2. Adding support for a new compiler
                    413: 
                    414: A. A simple example package: bison
                    415: 
                    416:     A.1. files
                    417: 
                    418:         A.1.1. Makefile
                    419:         A.1.2. DESCR
                    420:         A.1.3. PLIST
                    421:         A.1.4. Checking a package with pkglint
                    422: 
                    423:     A.2. Steps for building, installing, packaging
                    424: 
                    425: B. Build logs
                    426: 
                    427:     B.1. Building figlet
                    428:     B.2. Packaging figlet
                    429: 
                    430: C. Directory layout of the pkgsrc FTP server
                    431: 
                    432:     C.1. bootstrap-pkgsrc: Bootstrap kits
                    433:     C.2. distfiles: The distributed source files
                    434:     C.3. iso: Currently empty
                    435:     C.4. misc: Miscellaneous things
                    436:     C.5. packages*: Binary packages
                    437:     C.6. current, pkgsrc-200xQy: source packages
                    438: 
                    439: D. Editing guidelines for the pkgsrc guide
                    440: 
                    441:     D.1. Make targets
                    442:     D.2. Procedure
                    443: 
                    444: List of Tables
                    445: 
                    446: 1.1. Platforms supported by pkgsrc
                    447: 3.1. Binary kits and available packages
                    448: 10.1. Patching examples
                    449: 22.1. PLIST handling for GNOME packages
                    450: 
                    451: Chapter 1. What is pkgsrc?
                    452: 
                    453: Table of Contents
                    454: 
                    455: 1.1. Introduction
                    456: 
                    457:     1.1.1. Why pkgsrc?
                    458:     1.1.2. Supported platforms
                    459: 
                    460: 1.2. Overview
                    461: 1.3. Terminology
                    462: 
                    463:     1.3.1. Roles involved in pkgsrc
                    464: 
                    465: 1.4. Typography
                    466: 
                    467: 1.1. Introduction
                    468: 
                    469: There is a lot of software freely available for Unix-based systems, which is
                    470: usually available in form of the source code. Before such software can be used,
                    471: it needs to be configured to the local system, compiled and installed, and this
                    472: is exactly what The NetBSD Packages Collection (pkgsrc) does. pkgsrc also has
                    473: some basic commands to handle binary packages, so that not every user has to
                    474: build the packages for himself, which is a time-costly task.
                    475: 
                    476: pkgsrc currently contains several thousand packages, including:
                    477: 
                    478:   * www/apache - The Apache web server
                    479: 
                    480:   * www/firefox - The Firefox web browser
                    481: 
                    482:   * meta-pkgs/gnome - The GNOME Desktop Environment
                    483: 
                    484:   * meta-pkgs/kde3 - The K Desktop Environment
                    485: 
                    486: ...just to name a few.
                    487: 
                    488: pkgsrc has built-in support for handling varying dependencies, such as pthreads
                    489: and X11, and extended features such as IPv6 support on a range of platforms.
                    490: 
                    491: 1.1.1. Why pkgsrc?
                    492: 
                    493: pkgsrc provides the following key features:
                    494: 
                    495:   * Easy building of software from source as well as the creation and
                    496:     installation of binary packages. The source and latest patches are
                    497:     retrieved from a master or mirror download site, checksum verified, then
                    498:     built on your system. Support for binary-only distributions is available
                    499:     for both native platforms and NetBSD emulated platforms.
                    500: 
                    501:   * All packages are installed in a consistent directory tree, including
                    502:     binaries, libraries, man pages and other documentation.
                    503: 
                    504:   * Package dependencies, including when performing package updates, are
                    505:     handled automatically. The configuration files of various packages are
                    506:     handled automatically during updates, so local changes are preserved.
                    507: 
                    508:   * Like NetBSD, pkgsrc is designed with portability in mind and consists of
                    509:     highly portable code. This allows the greatest speed of development when
                    510:     porting to new a platform. This portability also ensures that pkgsrc is
                    511:     consistent across all platforms.
                    512: 
                    513:   * The installation prefix, acceptable software licenses, international
                    514:     encryption requirements and build-time options for a large number of
                    515:     packages are all set in a simple, central configuration file.
                    516: 
                    517:   * The entire source (not including the distribution files) is freely
                    518:     available under a BSD license, so you may extend and adapt pkgsrc to your
                    519:     needs. Support for local packages and patches is available right out of the
                    520:     box, so you can configure it specifically for your environment.
                    521: 
                    522: The following principles are basic to pkgsrc:
                    523: 
                    524:   * "It should only work if it's right." ? That means, if a package contains
                    525:     bugs, it's better to find them and to complain about them rather than to
                    526:     just install the package and hope that it works. There are numerous checks
                    527:     in pkgsrc that try to find such bugs: Static analysis tools (pkgtools/
                    528:     pkglint), build-time checks (portability of shell scripts), and
                    529:     post-installation checks (installed files, references to shared libraries,
                    530:     script interpreters).
                    531: 
                    532:   * "If it works, it should work everywhere" ? Like NetBSD has been ported to
                    533:     many hardware architectures, pkgsrc has been ported to many operating
                    534:     systems. Care is taken that packages behave the same on all platforms.
                    535: 
                    536: 1.1.2. Supported platforms
                    537: 
                    538: pkgsrc consists of both a source distribution and a binary distribution for
                    539: these operating systems. After retrieving the required source or binaries, you
                    540: can be up and running with pkgsrc in just minutes!
                    541: 
                    542: pkgsrc was derived from FreeBSD's ports system, and initially developed for
                    543: NetBSD only. Since then, pkgsrc has grown a lot, and now supports the following
                    544: platforms:
                    545: 
                    546: Table 1.1. Platforms supported by pkgsrc
                    547: 
                    548: +----------------------------------------------------------------+
                    549: |                  Platform                   |Date Support Added|
                    550: |---------------------------------------------+------------------|
                    551: |NetBSD                                       |     Aug 1997     |
                    552: |---------------------------------------------+------------------|
                    553: |Solaris                                      |     Mar 1999     |
                    554: |---------------------------------------------+------------------|
                    555: |Linux                                        |     Jun 1999     |
                    556: |---------------------------------------------+------------------|
                    557: |Darwin (Mac OS X)                            |     Oct 2001     |
                    558: |---------------------------------------------+------------------|
                    559: |FreeBSD                                      |     Nov 2002     |
                    560: |---------------------------------------------+------------------|
                    561: |OpenBSD                                      |     Nov 2002     |
                    562: |---------------------------------------------+------------------|
                    563: |IRIX                                         |     Dec 2002     |
                    564: |---------------------------------------------+------------------|
                    565: |BSD/OS                                       |     Dec 2003     |
                    566: |---------------------------------------------+------------------|
                    567: |AIX                                          |     Dec 2003     |
                    568: |---------------------------------------------+------------------|
                    569: |Interix (Microsoft Windows Services for Unix)|     Mar 2004     |
                    570: |---------------------------------------------+------------------|
                    571: |DragonFlyBSD                                 |     Oct 2004     |
                    572: |---------------------------------------------+------------------|
                    573: |OSF/1                                        |     Nov 2004     |
                    574: |---------------------------------------------+------------------|
                    575: |HP-UX                                        |     Apr 2007     |
                    576: +----------------------------------------------------------------+
                    577: 
                    578: 
                    579: 1.2. Overview
                    580: 
                    581: This document is divided into three parts. The first, The pkgsrc user's guide,
                    582: describes how one can use one of the packages in the Package Collection, either
                    583: by installing a precompiled binary package, or by building one's own copy using
                    584: the NetBSD package system. The second part, The pkgsrc developer's guide,
                    585: explains how to prepare a package so it can be easily built by other NetBSD
                    586: users without knowing about the package's building details. The third part, The
                    587: pkgsrc infrastructure internals is intended for those who want to understand
                    588: how pkgsrc is implemented.
                    589: 
                    590: This document is available in various formats: HTML, PDF, PS, TXT.
                    591: 
                    592: 1.3. Terminology
                    593: 
                    594: There has been a lot of talk about "ports", "packages", etc. so far. Here is a
                    595: description of all the terminology used within this document.
                    596: 
                    597: Package
                    598: 
                    599:     A set of files and building instructions that describe what's necessary to
                    600:     build a certain piece of software using pkgsrc. Packages are traditionally
                    601:     stored under /usr/pkgsrc.
                    602: 
                    603: The NetBSD package system
                    604: 
                    605:     This is the former name of "pkgsrc". It is part of the NetBSD operating
                    606:     system and can be bootstrapped to run on non-NetBSD operating systems as
                    607:     well. It handles building (compiling), installing, and removing of
                    608:     packages.
                    609: 
                    610: Distfile
                    611: 
                    612:     This term describes the file or files that are provided by the author of
                    613:     the piece of software to distribute his work. All the changes necessary to
                    614:     build on NetBSD are reflected in the corresponding package. Usually the
                    615:     distfile is in the form of a compressed tar-archive, but other types are
                    616:     possible, too. Distfiles are usually stored below /usr/pkgsrc/distfiles.
                    617: 
                    618: Port
                    619: 
                    620:     This is the term used by FreeBSD and OpenBSD people for what we call a
                    621:     package. In NetBSD terminology, "port" refers to a different architecture.
                    622: 
                    623: Precompiled/binary package
                    624: 
                    625:     A set of binaries built with pkgsrc from a distfile and stuffed together in
                    626:     a single .tgz file so it can be installed on machines of the same machine
                    627:     architecture without the need to recompile. Packages are usually generated
                    628:     in /usr/pkgsrc/packages; there is also an archive on ftp.NetBSD.org.
                    629: 
                    630:     Sometimes, this is referred to by the term "package" too, especially in the
                    631:     context of precompiled packages.
                    632: 
                    633: Program
                    634: 
                    635:     The piece of software to be installed which will be constructed from all
                    636:     the files in the distfile by the actions defined in the corresponding
                    637:     package.
                    638: 
                    639: 1.3.1. Roles involved in pkgsrc
                    640: 
                    641: pkgsrc users
                    642: 
                    643:     The pkgsrc users are people who use the packages provided by pkgsrc.
                    644:     Typically they are system administrators. The people using the software
                    645:     that is inside the packages (maybe called "end users") are not covered by
                    646:     the pkgsrc guide.
                    647: 
                    648:     There are two kinds of pkgsrc users: Some only want to install pre-built
                    649:     binary packages. Others build the pkgsrc packages from source, either for
                    650:     installing them directly or for building binary packages themselves. For
                    651:     pkgsrc users Part I, "The pkgsrc user's guide" should provide all necessary
                    652:     documentation.
                    653: 
                    654: package maintainers
                    655: 
                    656:     A package maintainer creates packages as described in Part II, "The pkgsrc
                    657:     developer's guide".
                    658: 
                    659: infrastructure developers
                    660: 
                    661:     These people are involved in all those files that live in the mk/ directory
                    662:     and below. Only these people should need to read through Part III, "The
                    663:     pkgsrc infrastructure internals", though others might be curious, too.
                    664: 
                    665: 1.4. Typography
                    666: 
                    667: When giving examples for commands, shell prompts are used to show if the
                    668: command should/can be issued as root, or if "normal" user privileges are
                    669: sufficient. We use a # for root's shell prompt, and a % for users' shell
                    670: prompt, assuming they use the C-shell or tcsh.
                    671: 
                    672: Part I. The pkgsrc user's guide
                    673: 
                    674: Table of Contents
                    675: 
                    676: 2. Where to get pkgsrc and how to keep it up-to-date
                    677: 
                    678:     2.1. Getting pkgsrc for the first time
                    679: 
                    680:         2.1.1. As tar file
                    681:         2.1.2. Via SUP
                    682:         2.1.3. Via anonymous CVS
                    683: 
                    684:     2.2. Keeping pkgsrc up-to-date
                    685: 
                    686:         2.2.1. Via tar files
                    687:         2.2.2. Via CVS
                    688: 
                    689: 3. Using pkgsrc on systems other than NetBSD
                    690: 
                    691:     3.1. Binary distribution
                    692:     3.2. Bootstrapping pkgsrc
                    693:     3.3. Platform-specific notes
                    694: 
                    695:         3.3.1. Darwin (Mac OS X)
                    696:         3.3.2. FreeBSD
                    697:         3.3.3. Interix
                    698:         3.3.4. IRIX
                    699:         3.3.5. Linux
                    700:         3.3.6. OpenBSD
                    701:         3.3.7. Solaris
                    702: 
                    703: 4. Using pkgsrc
                    704: 
                    705:     4.1. Using binary packages
                    706: 
                    707:         4.1.1. Finding binary packages
                    708:         4.1.2. Installing binary packages
                    709:         4.1.3. Deinstalling packages
                    710:         4.1.4. Getting information about installed packages
                    711:         4.1.5. Checking for security vulnerabilities in installed packages
                    712:         4.1.6. Finding if newer versions of your installed packages are in
                    713:             pkgsrc
                    714:         4.1.7. Other administrative functions
                    715:         4.1.8. A word of warning
                    716: 
                    717:     4.2. Building packages from source
                    718: 
                    719:         4.2.1. Requirements
                    720:         4.2.2. Fetching distfiles
                    721:         4.2.3. How to build and install
                    722: 
                    723: 5. Configuring pkgsrc
                    724: 
                    725:     5.1. General configuration
                    726:     5.2. Variables affecting the build process
                    727:     5.3. Selecting and configuring the compiler
                    728: 
                    729:         5.3.1. Selecting the compiler
                    730:         5.3.2. Additional flags to the compiler (CFLAGS)
                    731:         5.3.3. Additional flags to the linker (LDFLAGS)
                    732: 
                    733:     5.4. Developer/advanced settings
                    734:     5.5. Selecting Build Options
                    735: 
                    736: 6. Creating binary packages
                    737: 
                    738:     6.1. Building a single binary package
                    739:     6.2. Settings for creation of binary packages
                    740:     6.3. Doing a bulk build of all packages
                    741: 
                    742:         6.3.1. Configuration
                    743:         6.3.2. Other environmental considerations
                    744:         6.3.3. Operation
                    745:         6.3.4. What it does
                    746:         6.3.5. Disk space requirements
                    747:         6.3.6. Setting up a sandbox for chrooted builds
                    748:         6.3.7. Building a partial set of packages
                    749:         6.3.8. Uploading results of a bulk build
                    750: 
                    751:     6.4. Creating a multiple CD-ROM packages collection
                    752: 
                    753:         6.4.1. Example of cdpack
                    754: 
                    755: 7. Directory layout of the installed files
                    756: 
                    757:     7.1. File system layout in ${LOCALBASE}
                    758:     7.2. File system layout in ${VARBASE}
                    759: 
                    760: 8. Frequently Asked Questions
                    761: 
                    762:     8.1. Are there any mailing lists for pkg-related discussion?
                    763:     8.2. Where's the pkgviews documentation?
                    764:     8.3. Utilities for package management (pkgtools)
                    765:     8.4. How to use pkgsrc as non-root
                    766:     8.5. How to resume transfers when fetching distfiles?
                    767:     8.6. How can I install/use XFree86 from pkgsrc?
                    768:     8.7. How can I install/use X.org from pkgsrc?
                    769:     8.8. How to fetch files from behind a firewall
                    770:     8.9. How do I tell make fetch to do passive FTP?
                    771:     8.10. How to fetch all distfiles at once
                    772:     8.11. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean?
                    773:     8.12. What does "Could not find bsd.own.mk" mean?
                    774:     8.13. Using 'sudo' with pkgsrc
                    775:     8.14. How do I change the location of configuration files?
                    776:     8.15. Automated security checks
                    777:     8.16. Why do some packages ignore my CFLAGS?
                    778:     8.17. A package does not build. What shall I do?
                    779:     8.18. What does "Makefile appears to contain unresolved cvs/rcs/??? merge
                    780:         conflicts" mean?
                    781: 
                    782: Chapter 2. Where to get pkgsrc and how to keep it up-to-date
                    783: 
                    784: Table of Contents
                    785: 
                    786: 2.1. Getting pkgsrc for the first time
                    787: 
                    788:     2.1.1. As tar file
                    789:     2.1.2. Via SUP
                    790:     2.1.3. Via anonymous CVS
                    791: 
                    792: 2.2. Keeping pkgsrc up-to-date
                    793: 
                    794:     2.2.1. Via tar files
                    795:     2.2.2. Via CVS
                    796: 
                    797: Before you download and extract the files, you need to decide where you want to
                    798: extract them. When using pkgsrc as root user, pkgsrc is usually installed in /
                    799: usr/pkgsrc. You are though free to install the sources and binary packages
                    800: wherever you want in your filesystem, provided that the pathname does not
                    801: contain white-space or other characters that are interpreted specially by the
                    802: shell and some other programs. A safe bet is to use only letters, digits,
                    803: underscores and dashes.
                    804: 
                    805: 2.1. Getting pkgsrc for the first time
                    806: 
                    807: Before you download any pkgsrc files, you should decide whether you want the
                    808: current branch or the stable branch. The latter is forked on a quarterly basis
                    809: from the current branch and only gets modified for security updates. The names
                    810: of the stable branches are built from the year and the quarter, for example
                    811: 2007Q1.
                    812: 
                    813: The second step is to decide how you want to download pkgsrc. You can get it as
                    814: a tar file, via SUP, or via CVS. All three ways are described here.
                    815: 
                    816: 2.1.1. As tar file
                    817: 
                    818: The primary download location for all pkgsrc files is ftp://ftp.NetBSD.org/pub/
                    819: pkgsrc/. There are a number of subdirectories for different purposes, which are
                    820: described in detail in Appendix C, Directory layout of the pkgsrc FTP server.
                    821: 
                    822: The tar file for the current branch is in the directory current and is called
                    823: pkgsrc.tar.gz. It is autogenerated daily.
                    824: 
                    825: The tar file for the stable branch 2007Q1 is in the directory pkgsrc-2007Q1 and
                    826: is also called pkgsrc-2007Q1.tar.gz.
                    827: 
                    828: After downloading the tar file, change to the directory where you want to have
                    829: pkgsrc. This is usually /usr. Then, run gzcat pkgsrc.tar.gz | tar xf - to
                    830: extract the files.
                    831: 
                    832: 2.1.2. Via SUP
                    833: 
                    834: As an alternative to the tar file, you can get pkgsrc via the Software Update
                    835: Protocol, SUP. To do so, make sure your supfile has a line
                    836: 
                    837: release=pkgsrc
                    838: 
                    839: in it, see the examples in /usr/share/examples/supfiles, and that the /usr/
                    840: pkgsrc directory exists. Then, simply run sup -v /path/to/your/supfile.
                    841: 
                    842: 2.1.3. Via anonymous CVS
                    843: 
                    844: To get pkgsrc via CVS, make sure you have cvs(1) installed. To do an initial
                    845: (full) checkout of pkgsrc, you first have to set some environment variables.
                    846: For the C-Shell, type:
                    847: 
                    848:     % setenv CVSROOT anoncvs@anoncvs.NetBSD.org:/cvsroot
                    849:     % setenv CVS_RSH ssh
                    850: 
                    851: Or, the same for the bourne shell:
                    852: 
                    853:     $ CVSROOT="anoncvs@anoncvs.NetBSD.org:/cvsroot"
                    854:     $ CVS_RSH="ssh"
                    855:     $ export CVSROOT CVS_RSH
                    856: 
1.2     ! rillig    857: By default, cvs doesn't do things like most people would expect it to do, and
        !           858: this is unlikely to change. But there is a way to convince cvs, by creating a
        !           859: file called .cvsrc in your home directory and saving the following lines to it.
        !           860: This file will save you lots of headache and some bug reports, so we strongly
        !           861: recommend it. You can find an explanation of this file in the CVS
        !           862: documentation.
        !           863: 
        !           864: # recommended CVS configuration file from the pkgsrc guide
        !           865: checkout -P
        !           866: update -d
        !           867: release -d
        !           868: diff -up
        !           869: cvs -q -z3
        !           870: rdiff -u
        !           871: 
1.1       dsieger   872: Then, you change to the directory where you want to have your copy of pkgsrc.
                    873: In most cases this is /usr. In that directory you run the checkout command,
                    874: which is cvs -q checkout -P pkgsrc for the current branch and cvs -q checkout
                    875: -rpkgsrc-2007Q1 -P pkgsrc for the stable branch. This command will create a
                    876: directory called pkgsrc with all the pkgsrc files in it.
                    877: 
                    878: 2.2. Keeping pkgsrc up-to-date
                    879: 
                    880: The preferred way to keep pkgsrc up-to-date is via CVS (which also works if you
                    881: have first installed it via a tar file). It saves bandwidth and hard disk
                    882: activity, compared to downloading the tar file again.
                    883: 
                    884: 2.2.1. Via tar files
                    885: 
                    886: Warning
                    887: 
                    888: When updating from a tar file, you first need to completely remove the old
                    889: pkgsrc directory. Otherwise those files that have been removed from pkgsrc in
                    890: the mean time will not be removed on your local disk, resulting in
                    891: inconsistencies. When removing the old files, any changes that you have done to
                    892: the pkgsrc files will be lost after updating. Therefore updating via CVS is
                    893: strongly recommended.
                    894: 
                    895: Note that by default the distfiles and the binary packages are saved in the
                    896: pkgsrc tree, so don't forget to rescue them before updating. You can also
                    897: configure pkgsrc to use other than the default directories by setting the
                    898: DISTDIR and PACKAGES variables. See Chapter 5, Configuring pkgsrc for the
                    899: details.
                    900: 
                    901: To update pkgsrc from a tar file, download the tar file as explained above.
                    902: Then, make sure that you have not made any changes to the files in the pkgsrc
                    903: directory. Remove the pkgsrc directory and extract the new tar file. Done.
                    904: 
                    905: 2.2.2. Via CVS
                    906: 
                    907: To update pkgsrc via CVS, make sure the environment variable CVS_RSH is set as
                    908: above. Then, change to the pkgsrc directory and run cvs -q update -dP.
                    909: 
                    910: 2.2.2.1. Switching between different pkgsrc branches
                    911: 
                    912: When updating pkgsrc, the CVS program keeps track of the branch you selected.
                    913: But if you, for whatever reason, want to switch from the stable branch to the
                    914: current one, you can do it by adding the option "-A" after the "update"
                    915: keyword. To switch from the current branch back to the stable branch, add the
                    916: "-rpkgsrc-2007Q1" option.
                    917: 
                    918: 2.2.2.2. What happens to my changes when updating?
                    919: 
                    920: When you update pkgsrc, the CVS program will only touch those files that are
                    921: registered in the CVS repository. That means that any packages that you created
                    922: on your own will stay unmodified. If you change files that are managed by CVS,
                    923: later updates will try to merge your changes with those that have been done by
                    924: others. See the CVS manual, chapter "update" for details.
                    925: 
                    926: Chapter 3. Using pkgsrc on systems other than NetBSD
                    927: 
                    928: Table of Contents
                    929: 
                    930: 3.1. Binary distribution
                    931: 3.2. Bootstrapping pkgsrc
                    932: 3.3. Platform-specific notes
                    933: 
                    934:     3.3.1. Darwin (Mac OS X)
                    935:     3.3.2. FreeBSD
                    936:     3.3.3. Interix
                    937:     3.3.4. IRIX
                    938:     3.3.5. Linux
                    939:     3.3.6. OpenBSD
                    940:     3.3.7. Solaris
                    941: 
                    942: 3.1. Binary distribution
                    943: 
                    944: We provide a bootstrap kit in both source and binary form for other platforms
                    945: than NetBSD, consisting of the pkg administration tools and other tools
                    946: required to use pkgsrc and build packages.
                    947: 
                    948: Note
                    949: 
                    950: Older binary snapshots are available in the bootstrap-pkgsrc/archive directory
                    951: on ftp.NetBSD.org.
                    952: 
                    953: Table 3.1. Binary kits and available packages
                    954: 
                    955: +------------------------------------------------------------------------------+
                    956: |             Platform              |Latest snapshot|Binary kit|Binary packages|
                    957: |-----------------------------------+---------------+----------+---------------|
                    958: |Darwin 5.5/powerpc (Mac OS X       |20021209       |binary kit|               |
                    959: |10.1.5)                            |               |          |               |
                    960: |-----------------------------------+---------------+----------+---------------|
                    961: |Darwin 6.6/powerpc (Mac OS X       |20030623       |binary kit|               |
                    962: |10.2.6)                            |               |          |               |
                    963: |-----------------------------------+---------------+----------+---------------|
                    964: |Darwin 7.6/powerpc (Mac OS X       |20041219       |binary kit|binary packages|
                    965: |10.3.6)                            |               |          |               |
                    966: |-----------------------------------+---------------+----------+---------------|
                    967: |Darwin 7.8/powerpc (Mac OS X       |20050320       |binary kit|               |
                    968: |10.3.8)                            |               |          |               |
                    969: |-----------------------------------+---------------+----------+---------------|
                    970: |Darwin 8.1/powerpc (Mac OS X       |20050625       |binary kit|binary packages|
                    971: |10.4.1)                            |               |          |               |
                    972: |-----------------------------------+---------------+----------+---------------|
                    973: |Debian GNU Linux/i386              |20031023       |binary kit|               |
                    974: |-----------------------------------+---------------+----------+---------------|
                    975: |Fedora Core 2 Linux/i386           |20050618       |binary kit|               |
                    976: |-----------------------------------+---------------+----------+---------------|
                    977: |Fedora Core 4 Linux/i386           |20060105       |binary kit|               |
                    978: |-----------------------------------+---------------+----------+---------------|
                    979: |FreeBSD 3.5/i386                   |20030411       |binary kit|               |
                    980: |-----------------------------------+---------------+----------+---------------|
                    981: |FreeBSD 4.7/i386                   |20021211       |binary kit|               |
                    982: |-----------------------------------+---------------+----------+---------------|
                    983: |FreeBSD 5.0/i386                   |20030411       |binary kit|               |
                    984: |-----------------------------------+---------------+----------+---------------|
                    985: |FreeBSD 5.1/i386                   |20030630       |binary kit|               |
                    986: |-----------------------------------+---------------+----------+---------------|
                    987: |FreeBSD 5.2.1/i386                 |20040227       |binary kit|               |
                    988: |-----------------------------------+---------------+----------+---------------|
                    989: |FreeBSD 5.3/i386                   |20050119       |binary kit|               |
                    990: |-----------------------------------+---------------+----------+---------------|
                    991: |HP-UX 11.11/hppa                   |20070421       |binary kit|               |
                    992: |-----------------------------------+---------------+----------+---------------|
                    993: |Interix 3.5                        |20061106       |binary kit|               |
                    994: |-----------------------------------+---------------+----------+---------------|
                    995: |IRIX 6.5 n32-bit ABI               |20040911       |binary kit|binary packages|
                    996: |-----------------------------------+---------------+----------+---------------|
                    997: |IRIX 6.5 64-bit ABI                |20040912       |binary kit|binary packages|
                    998: |-----------------------------------+---------------+----------+---------------|
                    999: |OpenBSD 3.2/i386                   |20030420       |binary kit|               |
                   1000: |-----------------------------------+---------------+----------+---------------|
                   1001: |OpenBSD 3.3/i386                   |20030503       |binary kit|               |
                   1002: |-----------------------------------+---------------+----------+---------------|
                   1003: |OpenBSD 3.5/i386                   |20040703       |binary kit|               |
                   1004: |-----------------------------------+---------------+----------+---------------|
                   1005: |OSF1 5.1/alpha                     |20070420       |binary kit|               |
                   1006: |-----------------------------------+---------------+----------+---------------|
                   1007: |Slackware Linux 8.1/i386           |20030417       |binary kit|               |
                   1008: |-----------------------------------+---------------+----------+---------------|
                   1009: |Slackware Linux 9/i386             |20040703       |binary kit|               |
                   1010: |-----------------------------------+---------------+----------+---------------|
                   1011: |Solaris 8/sparc                    |20050220       |binary kit|               |
                   1012: |-----------------------------------+---------------+----------+---------------|
                   1013: |Solaris 8/i386                     |20050220       |binary kit|               |
                   1014: |-----------------------------------+---------------+----------+---------------|
                   1015: |Solaris 9/sparc                    |20060713       |binary kit|               |
                   1016: |-----------------------------------+---------------+----------+---------------|
                   1017: |Solaris 9/i386                     |20030411       |binary kit|               |
                   1018: +------------------------------------------------------------------------------+
                   1019: 
                   1020: 
                   1021: Simply download the binary kit for your platform, and extract it into / e.g.
                   1022: 
                   1023: # cd /
                   1024: # gzip -c -d /tmp/bootstrap-pkgsrc-SunOS-5.9-sparc-20031023.tar.gz \
                   1025:   | tar -xpf -
                   1026: 
                   1027: Of course, as with any binary distributions, you should verify the checksum
                   1028: against the SUM or CKSUM file and inspect the contents before extracting it.
                   1029: 
                   1030: 3.2. Bootstrapping pkgsrc
                   1031: 
                   1032: Installing the bootstrap kit from source should be as simple as:
                   1033: 
                   1034: # env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc
                   1035: # cd pkgsrc/bootstrap
                   1036: # ./bootstrap
                   1037: 
                   1038: 
                   1039: See Chapter 2, Where to get pkgsrc and how to keep it up-to-date for other ways
                   1040: to get pkgsrc before bootstrapping. The given bootstrap command will use the
                   1041: defaults of /usr/pkg for the prefix where programs will be installed in, and /
                   1042: var/db/pkg for the package database directory where pkgsrc will do its internal
                   1043: bookkeeping. However, these can also be set using command-line arguments.
                   1044: 
                   1045: Binary packages for the pkgsrc tools and an initial set of packages is
                   1046: available for supported platforms. An up-to-date list of these can be found on
                   1047: www.pkgsrc.org. Note that this only works for privileged builds that install
                   1048: into /usr/pkg.
                   1049: 
                   1050: Note
                   1051: 
                   1052: The bootstrap installs a bmake tool. Use this bmake when building via pkgsrc.
                   1053: For examples in this guide, use bmake instead of "make".
                   1054: 
                   1055: 3.3. Platform-specific notes
                   1056: 
                   1057: Here are some platform-specific notes you should be aware of.
                   1058: 
                   1059: 3.3.1. Darwin (Mac OS X)
                   1060: 
                   1061: Darwin 5.x and up are supported. There are two methods of using pkgsrc on Mac
                   1062: OS X, by using a disk image, or a UFS or HFSX partition.
                   1063: 
                   1064: Before you start, you will need to download and install the Mac OS X Developer
                   1065: Tools from Apple's Developer Connection. See http://developer.apple.com/macosx/
                   1066: for details. Also, make sure you install X11 for Mac OS X and the X11 SDK from
                   1067: http://www.apple.com/macosx/x11/download/ if you intend to build packages that
                   1068: use the X11 Window System.
                   1069: 
                   1070: If you already have a UFS or HFSX partition, or have a spare partition that you
                   1071: can format as UFS or HFSX, it is recommended to use that instead of the disk
                   1072: image. It'll be somewhat faster and will mount automatically at boot time,
                   1073: where you must manually mount a disk image.
                   1074: 
                   1075: Note
                   1076: 
                   1077: You cannot use an ordinary HFS+ file system for pkgsrc, because pkgsrc
                   1078: currently requires the file system to be case-sensitive. You can, however, use
                   1079: a case-sensitive HFS+ (aka HFSX) file system as found in Darwin 7.0 and newer.
                   1080: 
                   1081: 3.3.1.1. Using a disk image
                   1082: 
                   1083: Create the disk image:
                   1084: 
                   1085: # cd pkgsrc/bootstrap
                   1086: # ./darwindiskimage create ~/Documents/NetBSD 1024 # megabytes - season to taste
                   1087: # ./darwindiskimage mount ~/Documents/NetBSD
                   1088: # sudo chown `id -u`:`id -g` /Volumes/NetBSD
                   1089: 
                   1090: Note
                   1091: 
                   1092: darwindiskimage will mount the filesystem nosuid, which will cause problems for
                   1093: packages that depend on setgid. In the case of UFS, it will also mount the
                   1094: filesystem asynchronous, which is somewhat dangerous according to the mount(8)
                   1095: man page. In the case of HFSX, it will disable journalling.
                   1096: 
                   1097: Allow suid:
                   1098: 
                   1099: # sudo mount -u -o suid /Volumes/NetBSD
                   1100: 
                   1101: 3.3.1.2. Using a UFS or HFSX partition
                   1102: 
                   1103: By default, /usr will be on your root file system, normally HFS+. It is
                   1104: possible to use the default prefix of /usr/pkg by symlinking /usr/pkg to a
                   1105: directory on a UFS or HFSX file system. Obviously, another symlink is required
                   1106: if you want to place the package database directory outside the prefix. e.g.
                   1107: 
                   1108: # ./bootstrap --pkgdbdir /usr/pkg/pkgdb
                   1109: 
                   1110: If you created your partitions at the time of installing Mac OS X and formatted
                   1111: the target partition as UFS or HFSX, it should automatically mount on /Volumes/
                   1112: <volume name> when the machine boots. If you are (re)formatting a partition as
                   1113: UFS or HFSX, you need to ensure that the partition map correctly reflects
                   1114: "Apple_UFS" or "Apple_HFSX" and not "Apple_HFS".
                   1115: 
                   1116: The problem is that none of the disk tools will let you touch a disk that is
                   1117: booted from. You can unmount the partition, but even if you newfs it, the
                   1118: partition type will be incorrect and the automounter won't mount it. It can be
                   1119: mounted manually, but it won't appear in Finder.
                   1120: 
                   1121: You'll need to boot off of the OS X Installation (User) CD. When the
                   1122: Installation program starts, go up to the menu and select Disk Utility. Now,
                   1123: you will be able to select the partition you want to be UFS or HFSX, and Format
                   1124: it Apple UFS or HFSX. Quit the Disk Utility, quit the installer which will
                   1125: reboot your machine. The new UFS or HFSX file system will appear in Finder.
                   1126: 
                   1127: Be aware that the permissions on the new file system will be writable by root
                   1128: only.
                   1129: 
                   1130: This note is as of 10.2 (Jaguar) and applies to earlier versions. Hopefully
                   1131: Apple will fix Disk Utility in 10.3 (Panther).
                   1132: 
                   1133: 3.3.2. FreeBSD
                   1134: 
                   1135: FreeBSD 4.7 and 5.0 have been tested and are supported, other versions may
                   1136: work.
                   1137: 
                   1138: Care should be taken so that the tools that this kit installs do not conflict
                   1139: with the FreeBSD userland tools. There are several steps:
                   1140: 
                   1141:  1. FreeBSD stores its ports pkg database in /var/db/pkg. It is therefore
                   1142:     recommended that you choose a different location (e.g. /usr/pkgdb) by using
                   1143:     the --pkgdbdir option to the bootstrap script.
                   1144: 
                   1145:  2. If you do not intend to use the FreeBSD ports tools, it's probably a good
                   1146:     idea to move them out of the way to avoid confusion, e.g.
                   1147: 
                   1148:     # cd /usr/sbin
                   1149:     # mv pkg_add pkg_add.orig
                   1150:     # mv pkg_create pkg_create.orig
                   1151:     # mv pkg_delete pkg_delete.orig
                   1152:     # mv pkg_info pkg_info.orig
                   1153: 
                   1154: 
                   1155:  3. An example /etc/mk.conf file will be placed in /etc/mk.conf.example file
                   1156:     when you use the bootstrap script.
                   1157: 
                   1158: 3.3.3. Interix
                   1159: 
                   1160: Interix is a POSIX-compatible subsystem for the Windows NT kernel, providing a
                   1161: Unix-like environment with a tighter kernel integration than available with
                   1162: Cygwin. It is part of the Windows Services for Unix package, available for free
                   1163: for any licensed copy of Windows 2000, XP (not including XP Home), or 2003. SFU
                   1164: can be downloaded from http://www.microsoft.com/windows/sfu/.
                   1165: 
                   1166: Services for Unix 3.5 has been tested. 3.0 or 3.1 may work, but are not
                   1167: officially supported. (The main difference in 3.0/3.1 is lack of pthreads, but
                   1168: other parts of libc may also be lacking.)
                   1169: 
                   1170: Services for Unix Applications (aka SUA) is an integrated component of Windows
                   1171: Server 2003 R2 and Windows Vista. As of this writing, SUA's Interix 5.x
                   1172: subsystem has not yet been tested with pkgsrc.
                   1173: 
                   1174: 3.3.3.1. When installing Interix/SFU
                   1175: 
                   1176: At an absolute minimum, the following packages must be installed from the
                   1177: Windows Services for Unix 3.5 distribution in order to use pkgsrc:
                   1178: 
                   1179:   * Utilities -> Base Utilities
                   1180: 
                   1181:   * Interix GNU Components -> (all)
                   1182: 
                   1183:   * Remote Connectivity
                   1184: 
                   1185:   * Interix SDK
                   1186: 
                   1187: When using pkgsrc on Interix, DO NOT install the Utilities subcomponent "UNIX
                   1188: Perl". That is Perl 5.6 without shared module support, installed to /usr/local,
                   1189: and will only cause confusion. Instead, install Perl 5.8 from pkgsrc (or from a
                   1190: binary package).
                   1191: 
                   1192: The Remote Connectivity subcomponent "Windows Remote Shell Service" does not
                   1193: need to be installed, but Remote Connectivity itself should be installed in
                   1194: order to have a working inetd.
                   1195: 
                   1196: During installation you may be asked whether to enable setuid behavior for
                   1197: Interix programs, and whether to make pathnames default to case-sensitive.
                   1198: Setuid should be enabled, and case-sensitivity MUST be enabled. (Without
                   1199: case-sensitivity, a large number of packages including perl will not build.)
                   1200: 
                   1201: NOTE: Newer Windows service packs change the way binary execution works (via
                   1202: the Data Execution Prevention feature). In order to use pkgsrc and other
                   1203: gcc-compiled binaries reliably, a hotfix containing POSIX.EXE, PSXDLL.DLL,
                   1204: PSXRUN.EXE, and PSXSS.EXE (899522 or newer) must be installed. Hotfixes are
                   1205: available from Microsoft through a support contract; however, a NetBSD
                   1206: developer has made most Interix hotfixes available for personal use from http:/
                   1207: /www.duh.org/interix/hotfixes.php.
                   1208: 
                   1209: In addition to the hotfix noted above, it may be necessary to disable Data
                   1210: Execution Prevention entirely to make Interix functional. This may happen only
                   1211: with certain types of CPUs; the cause is not fully understood at this time. If
                   1212: gcc or other applications still segfault repeatedly after installing one of the
                   1213: hotfixes note above, the following option can be added to the appropriate
                   1214: "boot.ini" line on the Windows boot drive: /NoExecute=AlwaysOff (WARNING, this
                   1215: will disable DEP completely, which may be a security risk if applications are
                   1216: often run as a user in the Administrators group!)
                   1217: 
                   1218: 3.3.3.2. What to do if Interix/SFU is already installed
                   1219: 
                   1220: If SFU is already installed and you wish to alter these settings to work with
                   1221: pkgsrc, note the following things.
                   1222: 
                   1223:   * To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft Windows
                   1224:     Services for UNIX, then click Change. In the installer, choose Add or
                   1225:     Remove, then uncheck Utilities->UNIX Perl.
                   1226: 
                   1227:   * To enable case-sensitivity for the file system, run REGEDIT.EXE, and change
                   1228:     the following registry key:
                   1229: 
                   1230:     HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel
                   1231: 
                   1232:     Set the DWORD value "obcaseinsensitive" to 0; then reboot.
                   1233: 
                   1234:   * To enable setuid binaries (optional), run REGEDIT.EXE, and change the
                   1235:     following registry key:
                   1236: 
                   1237:     HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX
                   1238: 
                   1239:     Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.
                   1240: 
                   1241: 3.3.3.3. Important notes for using pkgsrc
                   1242: 
                   1243: The package manager (either the pkgsrc "su" user, or the user running
                   1244: "pkg_add") must be a member of the local Administrators group. Such a user must
                   1245: also be used to run the bootstrap. This is slightly relaxed from the normal
                   1246: pkgsrc requirement of "root".
                   1247: 
                   1248: The package manager should use a umask of 002. "make install" will
                   1249: automatically complain if this is not the case. This ensures that directories
                   1250: written in /var/db/pkg are Administrators-group writeable.
                   1251: 
                   1252: The popular Interix binary packages from http://www.interopsystems.com/ use an
                   1253: older version of pkgsrc's pkg_* tools. Ideally, these should NOT be used in
                   1254: conjunction with pkgsrc. If you choose to use them at the same time as the
                   1255: pkgsrc packages, ensure that you use the proper pkg_* tools for each type of
                   1256: binary package.
                   1257: 
                   1258: The TERM setting used for DOS-type console windows (including those invoked by
                   1259: the csh and ksh startup shortcuts) is "interix". Most systems don't have a
                   1260: termcap/terminfo entry for it, but the following .termcap entry provides
                   1261: adequate emulation in most cases:
                   1262: 
                   1263: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
                   1264: 
                   1265: 
                   1266: 3.3.3.4. Limitations of the Interix platform
                   1267: 
                   1268: Though Interix suffices as a familiar and flexible substitute for a full
                   1269: Unix-like platform, it has some drawbacks that should be noted for those
                   1270: desiring to make the most of Interix.
                   1271: 
                   1272:   * X11:
                   1273: 
                   1274:     Interix comes with the standard set of X11R6 client libraries, and can run
                   1275:     X11 based applications, but it does not come with an X server. Some options
                   1276:     are StarNet X-Win32, Hummingbird Exceed (available in a trimmed version for
                   1277:     Interix from Interop Systems as the Interop X Server), and the free X11
                   1278:     server included with Cygwin.
                   1279: 
                   1280:   * X11 acceleration:
                   1281: 
                   1282:     Because Interix runs in a completely different NT subsystem from Win32
                   1283:     applications, it does not currently support various X11 protocol extensions
                   1284:     for acceleration (such as MIT-SHM or DGA). Most interactive applications to
                   1285:     a local X server will run reasonably fast, but full motion video and other
                   1286:     graphics intensive applications may require a faster-than-expected CPU.
                   1287: 
                   1288:   * Audio:
                   1289: 
                   1290:     Interix has no native support for audio output. For audio support, pkgsrc
                   1291:     uses the esound client/server audio system on Interix. Unlike on most
                   1292:     platforms, the audio/esound package does not contain the esd server
                   1293:     component. To output audio via an Interix host, the emulators/cygwin_esound
                   1294:     package must also be installed.
                   1295: 
                   1296:   * CD/DVDs, USB, and SCSI:
                   1297: 
                   1298:     Direct device access is not currently supported in Interix, so it is not
                   1299:     currently possible to access CD/DVD drives, USB devices, or SCSI devices
                   1300:     through non-filesystem means. Among other things, this makes it impossible
                   1301:     to use Interix directly for CD/DVD burning.
                   1302: 
                   1303:   * Tape drives:
                   1304: 
                   1305:     Due to the same limitations as for CD-ROMs and SCSI devices, tape drives
                   1306:     are also not directly accessible in Interix. However, support is in work to
                   1307:     make tape drive access possible by using Cygwin as a bridge (similarly to
                   1308:     audio bridged via Cygwin's esound server).
                   1309: 
                   1310: 3.3.3.5. Known issues for pkgsrc on Interix
                   1311: 
                   1312: It is not necessary, in general, to have a "root" user on the Windows system;
                   1313: any member of the local Administrators group will suffice. However, some
                   1314: packages currently assume that the user named "root" is the privileged user. To
                   1315: accommodate these, you may create such a user; make sure it is in the local
                   1316: group Administrators (or your language equivalent).
                   1317: 
                   1318: pkg_add creates directories of mode 0755, not 0775, in $PKG_DBDIR. For the time
                   1319: being, install packages as the local Administrator (or your language
                   1320: equivalent), or run the following command after installing a package to work
                   1321: around the issue:
                   1322: 
                   1323: # chmod -R g+w $PKG_DBDIR
                   1324: 
                   1325: 
                   1326: 3.3.4. IRIX
                   1327: 
                   1328: You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
                   1329: compiler (cc/c89). Please set the CC environment variable according to your
                   1330: preference. If you do not have a license for the MIPSpro compiler suite, you
                   1331: can download a gcc tardist file from http://freeware.sgi.com/.
                   1332: 
                   1333: Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
                   1334: version of IRIX providing support for if_indextoname(3), if_nametoindex(3),
                   1335: etc.
                   1336: 
                   1337: At this point in time, pkgsrc only supports one ABI at a time. That is, you
                   1338: cannot switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit
                   1339: ABI. If you start out using "abi=n32", that's what all your packages will be
                   1340: built with.
                   1341: 
                   1342: Therefore, please make sure that you have no conflicting CFLAGS in your
                   1343: environment or the /etc/mk.conf. Particularly, make sure that you do not try to
                   1344: link n32 object files with lib64 or vice versa. Check your /etc/
                   1345: compiler.defaults!
                   1346: 
                   1347: If you have the actual pkgsrc tree mounted via NFS from a different host,
                   1348: please make sure to set WRKOBJDIR to a local directory, as it appears that IRIX
                   1349: linker occasionally runs into issues when trying to link over a network-mounted
                   1350: file system.
                   1351: 
                   1352: The bootstrapping process should set all the right options for programs such as
                   1353: imake(1), but you may want to set some options depending on your local setup.
                   1354: Please see pkgsrc/mk/defaults/mk.conf and, of course, your compiler's man pages
                   1355: for details.
                   1356: 
                   1357: If you are using SGI's MIPSPro compiler, please set
                   1358: 
                   1359: PKGSRC_COMPILER=        mipspro
                   1360: 
                   1361: 
                   1362: in /etc/mk.conf. Otherwise, pkgsrc will assume you are using gcc and may end up
                   1363: passing invalid flags to the compiler. Note that bootstrap should create an
                   1364: appropriate mk.conf.example by default.
                   1365: 
                   1366: If you have both the MIPSPro compiler chain installed as well as gcc, but want
                   1367: to make sure that MIPSPro is used, please set your PATH to not include the
                   1368: location of gcc (often /usr/freeware/bin), and (important) pass the
                   1369: '--preserve-path' flag.
                   1370: 
                   1371: 3.3.5. Linux
                   1372: 
                   1373: Some versions of Linux (for example Debian GNU/Linux) need either libtermcap or
                   1374: libcurses (libncurses). Installing the distributions libncurses-dev package (or
                   1375: equivalent) should fix the problem.
                   1376: 
                   1377: pkgsrc supports both gcc (GNU Compiler Collection) and icc (Intel C++
                   1378: Compiler). gcc is the default. icc 8.0 and 8.1 on i386 have been tested.
                   1379: 
                   1380: To bootstrap using icc, assuming the default icc installation directory:
                   1381: 
                   1382: env CC=/opt/intel_cc_80/bin/icc LDFLAGS=-static-libcxa \
                   1383: ac_cv___attribute__=yes ./bootstrap
                   1384: 
                   1385: 
                   1386: Note
                   1387: 
                   1388: icc 8.1 needs the `-i-static' argument instead of -static-libcxa.
                   1389: 
                   1390: icc supports __attribute__, but the GNU configure test uses a nested function,
                   1391: which icc does not support. #undef'ing __attribute__ has the unfortunate
                   1392: side-effect of breaking many of the Linux header files, which cannot be
                   1393: compiled properly without __attribute__. The test must be overridden so that
                   1394: __attribute__ is assumed supported by the compiler.
                   1395: 
                   1396: After bootstrapping, you should set PKGSRC_COMPILER in /etc/mk.conf:
                   1397: 
                   1398: PKGSRC_COMPILER=        icc
                   1399: 
                   1400: 
                   1401: The default installation directory for icc is /opt/intel_cc_80, which is also
                   1402: the pkgsrc default. If you have installed it into a different directory, set
                   1403: ICCBASE in /etc/mk.conf:
                   1404: 
                   1405: ICCBASE=                /opt/icc
                   1406: 
                   1407: 
                   1408: pkgsrc uses the static linking method of the runtime libraries provided by icc,
                   1409: so binaries can be run on other systems which do not have the shared libraries
                   1410: installed.
                   1411: 
                   1412: Libtool, however, extracts a list of libraries from the ld(1) command run when
                   1413: linking a C++ shared library and records it, throwing away the -Bstatic and
                   1414: -Bdynamic options interspersed between the libraries. This means that
                   1415: libtool-linked C++ shared libraries will have a runtime dependency on the icc
                   1416: libraries until this is fixed in libtool.
                   1417: 
                   1418: 3.3.6. OpenBSD
                   1419: 
                   1420: OpenBSD 3.0 and 3.2 are tested and supported.
                   1421: 
                   1422: Care should be taken so that the tools that this kit installs do not conflict
                   1423: with the OpenBSD userland tools. There are several steps:
                   1424: 
                   1425:  1. OpenBSD stores its ports pkg database in /var/db/pkg. It is therefore
                   1426:     recommended that you choose a different location (e.g. /usr/pkgdb) by using
                   1427:     the --pkgdbdir option to the bootstrap script.
                   1428: 
                   1429:  2. If you do not intend to use the OpenBSD ports tools, it's probably a good
                   1430:     idea to move them out of the way to avoid confusion, e.g.
                   1431: 
                   1432:     # cd /usr/sbin
                   1433:     # mv pkg_add pkg_add.orig
                   1434:     # mv pkg_create pkg_create.orig
                   1435:     # mv pkg_delete pkg_delete.orig
                   1436:     # mv pkg_info pkg_info.orig
                   1437: 
                   1438: 
                   1439:  3. An example /etc/mk.conf file will be placed in /etc/mk.conf.example file
                   1440:     when you use the bootstrap script. OpenBSD's make program uses /etc/mk.conf
                   1441:     as well. You can work around this by enclosing all the pkgsrc-specific
                   1442:     parts of the file with:
                   1443: 
                   1444:     .ifdef BSD_PKG_MK
                   1445:     # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
                   1446:     .else
                   1447:     # OpenBSD stuff
                   1448:     .endif
                   1449: 
                   1450: 
                   1451: 3.3.7. Solaris
                   1452: 
                   1453: Solaris 2.6 through 9 are supported on both x86 and sparc. You will need a
                   1454: working C compiler. Both gcc 2.95.3 and Sun WorkShop 5 have been tested.
                   1455: 
                   1456: The following packages are required on Solaris 8 for the bootstrap process and
                   1457: to build packages.
                   1458: 
                   1459:   * SUNWsprot
                   1460: 
                   1461:   * SUNWarc
                   1462: 
                   1463:   * SUNWbtool
                   1464: 
                   1465:   * SUNWtoo
                   1466: 
                   1467:   * SUNWlibm
                   1468: 
                   1469: Please note that the use of GNU binutils on Solaris is not supported, as of
                   1470: June 2006.
                   1471: 
                   1472: Whichever compiler you use, please ensure the compiler tools and your $prefix
                   1473: are in your PATH. This includes /usr/ccs/{bin,lib} and e.g. /usr/pkg/
                   1474: {bin,sbin}.
                   1475: 
                   1476: 3.3.7.1. If you are using gcc
                   1477: 
                   1478: It makes life much simpler if you only use the same gcc consistently for
                   1479: building all packages.
                   1480: 
                   1481: It is recommended that an external gcc be used only for bootstrapping, then
                   1482: either build gcc from lang/gcc or install a binary gcc package, then remove gcc
                   1483: used during bootstrapping.
                   1484: 
                   1485: Binary packages of gcc can be found through http://www.sunfreeware.com/.
                   1486: 
                   1487: 3.3.7.2. If you are using Sun WorkShop
                   1488: 
                   1489: You will need at least the following packages installed (from WorkShop 5.0)
                   1490: 
                   1491:   * SPROcc - Sun WorkShop Compiler C 5.0
                   1492: 
                   1493:   * SPROcpl - Sun WorkShop Compiler C++ 5.0
                   1494: 
                   1495:   * SPROild - Sun WorkShop Incremental Linker
                   1496: 
                   1497:   * SPROlang - Sun WorkShop Compilers common components
                   1498: 
                   1499: You should set the following variables in your mk.conf file:
                   1500: 
                   1501: CC=     cc
                   1502: CXX=    CC
                   1503: CPP=    cc -E
                   1504: CXXCPP= CC -E
                   1505: 
                   1506: Note
                   1507: 
                   1508: The CPP setting might break some packages that use the C preprocessor for
                   1509: processing things other than C source code.
                   1510: 
                   1511: 3.3.7.3. Building 64-bit binaries with SunPro
                   1512: 
                   1513: To build 64-bit packages, you just need to have the following lines in your
                   1514: mk.conf file:
                   1515: 
                   1516: PKGSRC_COMPILER=        sunpro
                   1517: ABI=                    64
                   1518: 
                   1519: Note
                   1520: 
                   1521: This setting has been tested for the SPARC architecture. Intel and AMD machines
                   1522: need some more work.
                   1523: 
                   1524: 3.3.7.4. Common problems
                   1525: 
                   1526: Sometimes, when using libtool, /bin/ksh crashes with a segmentation fault. The
                   1527: workaround is to use another shell for the configure scripts, for example by
                   1528: installing shells/bash and adding the following lines to your mk.conf:
                   1529: 
                   1530: CONFIG_SHELL=   ${LOCALBASE}/bin/bash
                   1531: WRAPPER_SHELL=  ${LOCALBASE}/bin/bash
                   1532: 
                   1533: 
                   1534: Then, rebuild the devel/libtool-base package.
                   1535: 
                   1536: Chapter 4. Using pkgsrc
                   1537: 
                   1538: Table of Contents
                   1539: 
                   1540: 4.1. Using binary packages
                   1541: 
                   1542:     4.1.1. Finding binary packages
                   1543:     4.1.2. Installing binary packages
                   1544:     4.1.3. Deinstalling packages
                   1545:     4.1.4. Getting information about installed packages
                   1546:     4.1.5. Checking for security vulnerabilities in installed packages
                   1547:     4.1.6. Finding if newer versions of your installed packages are in pkgsrc
                   1548:     4.1.7. Other administrative functions
                   1549:     4.1.8. A word of warning
                   1550: 
                   1551: 4.2. Building packages from source
                   1552: 
                   1553:     4.2.1. Requirements
                   1554:     4.2.2. Fetching distfiles
                   1555:     4.2.3. How to build and install
                   1556: 
                   1557: Basically, there are two ways of using pkgsrc. The first is to only install the
                   1558: package tools and to use binary packages that someone else has prepared. This
                   1559: is the "pkg" in pkgsrc. The second way is to install the "src" of pkgsrc, too.
                   1560: Then you are able to build your own packages, and you can still use binary
                   1561: packages from someone else.
                   1562: 
                   1563: 4.1. Using binary packages
                   1564: 
                   1565: To use binary packages, you need some tools to manage them. On NetBSD, these
                   1566: tools are already installed. On all other operating systems, you need to
                   1567: install them first. For the following platforms, prebuilt versions of the
                   1568: package tools are available and can simply be downloaded and unpacked in the /
                   1569: directory:
                   1570: 
                   1571: +------------------------------------------------------------------------+
                   1572: | Platform |                             URL                             |
                   1573: |----------+-------------------------------------------------------------|
                   1574: |Solaris 9 |ftp://ftp0.mh.bbc.co.uk/pub/pkgsrc/packages/bootstrap-pkgsrc/|
                   1575: |----------+-------------------------------------------------------------|
                   1576: |Solaris 10|http://public.enst.fr/pkgsrc/packages/bootstrap-pkgsrc/      |
                   1577: +------------------------------------------------------------------------+
                   1578: 
                   1579: These pre-built package tools use /usr/pkg for the base directory, and /var/db/
                   1580: pkg for the database of installed packages. If you cannot use these directories
                   1581: for whatever reasons (maybe because you're not root), you have to build the
                   1582: package tools yourself, which is explained in Section 3.2, "Bootstrapping
                   1583: pkgsrc".
                   1584: 
                   1585: 4.1.1. Finding binary packages
                   1586: 
                   1587: To install binary packages, you first need to know from where to get them. You
                   1588: can get them on CD-ROMs, DVDs, or via FTP or HTTP.
                   1589: 
                   1590: The binary packages can be found at the following locations.
                   1591: 
                   1592: +-------------------------------------------------------+
                   1593: | Platform |                    URL                     |
                   1594: |----------+--------------------------------------------|
                   1595: |NetBSD    |ftp://ftp.NetBSD.org/pub/NetBSD/packages/   |
                   1596: |----------+--------------------------------------------|
                   1597: |Solaris 9 |ftp://ftp0.mh.bbc.co.uk/pub/pkgsrc/packages/|
                   1598: |----------+--------------------------------------------|
                   1599: |Solaris 10|http://public.enst.fr/pkgsrc/packages/      |
                   1600: +-------------------------------------------------------+
                   1601: 
                   1602: Most of these directories contain binary packages for multiple platforms.
                   1603: Select the appropriate subdirectories, according to your machine architecture
                   1604: and operating system, until you find a directory called All. This directory
                   1605: contains all the binary packages. Further, there are subdirectories for
                   1606: categories that contain symbolic links that point to the actual binary package
                   1607: in ../All. This directory layout is used for all package repositories, no
                   1608: matter if they are accessed via HTTP, FTP, NFS, CD-ROM, or the local
                   1609: filesystem.
                   1610: 
                   1611: 4.1.2. Installing binary packages
                   1612: 
                   1613: If you have the files on a CD-ROM or downloaded them to your hard disk, you can
                   1614: install them with the following command (be sure to su to root first):
                   1615: 
                   1616: # pkg_add /path/to/package.tgz
                   1617: 
                   1618: If you have FTP access and you don't want to download the packages via FTP
                   1619: prior to installation, you can do this automatically by giving pkg_add an FTP
                   1620: URL:
                   1621: 
                   1622: # pkg_add ftp://ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/All/package
                   1623: 
                   1624: Note that any prerequisite packages needed to run the package in question will
                   1625: be installed, too, assuming they are present where you install from.
                   1626: 
                   1627: To save some typing, you can set the PKG_PATH environment variable to a
                   1628: semicolon-separated list of paths (including remote URLs); trailing slashes are
                   1629: not allowed.
                   1630: 
                   1631: Additionally to the All directory there exists a vulnerable directory to which
                   1632: binary packages with known vulnerabilities are moved, since removing them could
                   1633: cause missing dependencies. To use these packages, add the vulnerable directory
                   1634: to your PKG_PATH. However, you should run security/audit-packages regularly,
                   1635: especially after installing new packages, and verify that the vulnerabilities
                   1636: are acceptable for your configuration. An example PKG_PATH would be: ftp://
                   1637: ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/All;ftp://ftp.NetBSD.org/
                   1638: pub/NetBSD/packages/<OSVERSION>/<ARCH>/vulnerable Please note that semicolon
                   1639: (';') is a shell meta-character, so you'll probably have to quote it.
                   1640: 
                   1641: After you've installed packages, be sure to have /usr/pkg/bin and /usr/pkg/sbin
                   1642: in your PATH so you can actually start the just installed program.
                   1643: 
                   1644: 4.1.3. Deinstalling packages
                   1645: 
                   1646: To deinstall a package, it does not matter whether it was installed from source
                   1647: code or from a binary package. The pkg_delete command does not know it anyway.
                   1648: To delete a package, you can just run pkg_delete package-name. The package name
                   1649: can be given with or without version number. Wildcards can also be used to
                   1650: deinstall a set of packages, for example *emacs*. Be sure to include them in
                   1651: quotes, so that the shell does not expand them before pkg_delete sees them.
                   1652: 
                   1653: The -r option is very powerful: it removes all the packages that require the
                   1654: package in question and then removes the package itself. For example:
                   1655: 
                   1656: # pkg_delete -r jpeg
                   1657: 
                   1658: 
                   1659: will remove jpeg and all the packages that used it; this allows upgrading the
                   1660: jpeg package.
                   1661: 
                   1662: 4.1.4. Getting information about installed packages
                   1663: 
                   1664: The pkg_info shows information about installed packages or binary package
                   1665: files.
                   1666: 
                   1667: 4.1.5. Checking for security vulnerabilities in installed packages
                   1668: 
                   1669: The NetBSD Security-Officer and Packages Groups maintain a list of known
                   1670: security vulnerabilities to packages which are (or have been) included in
                   1671: pkgsrc. The list is available from the NetBSD FTP site at ftp://ftp.NetBSD.org/
                   1672: pub/pkgsrc/distfiles/vulnerabilities.
                   1673: 
                   1674: Through security/audit-packages, this list can be downloaded automatically, and
                   1675: a security audit of all packages installed on a system can take place.
                   1676: 
                   1677: There are two components to security/audit-packages. The first component,
                   1678: "download-vulnerability-list", is for downloading the list of vulnerabilities
                   1679: from the NetBSD FTP site. The second component, "audit-packages", checks to see
                   1680: if any of your installed packages are vulnerable. If a package is vulnerable,
                   1681: you will see output similar to the following:
                   1682: 
                   1683: Package samba-2.0.9 has a local-root-shell vulnerability, see
                   1684:     http://www.samba.org/samba/whatsnew/macroexploit.html
                   1685: 
                   1686: One can set up security/audit-packages to download the vulnerabilities file
                   1687: daily, and include a package audit in the daily security script. Details on
                   1688: this are located in the MESSAGE file for security/audit-packages.
                   1689: 
                   1690: 4.1.6. Finding if newer versions of your installed packages are in pkgsrc
                   1691: 
                   1692: Install pkgtools/pkglint and run lintpkgsrc with the "-i" argument to check if
                   1693: your packages are up-to-date, e.g.
                   1694: 
                   1695: % lintpkgsrc -i
                   1696: ...
                   1697: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   1698: 
                   1699: 
                   1700: You can then use make update to update the package on your system and rebuild
                   1701: any dependencies.
                   1702: 
                   1703: 4.1.7. Other administrative functions
                   1704: 
                   1705: The pkg_admin executes various administrative functions on the package system.
                   1706: 
                   1707: 4.1.8. A word of warning
                   1708: 
                   1709: Please pay very careful attention to the warnings expressed in the pkg_add(1)
                   1710: manual page about the inherent dangers of installing binary packages which you
                   1711: did not create yourself, and the security holes that can be introduced onto
                   1712: your system by indiscriminate adding of such files.
                   1713: 
                   1714: The same warning of course applies to every package you install from source
                   1715: when you haven't completely read and understood the source code of the package,
                   1716: the compiler that is used to build the package and all the other tools that are
                   1717: involved.
                   1718: 
                   1719: 4.2. Building packages from source
                   1720: 
                   1721: After obtaining pkgsrc, the pkgsrc directory now contains a set of packages,
                   1722: organized into categories. You can browse the online index of packages, or run
                   1723: make readme from the pkgsrc directory to build local README.html files for all
                   1724: packages, viewable with any web browser such as www/lynx or www/firefox.
                   1725: 
                   1726: The default prefix for installed packages is /usr/pkg. If you wish to change
                   1727: this, you should do so by setting LOCALBASE in mk.conf. You should not try to
                   1728: use multiple different LOCALBASE definitions on the same system (inside a
                   1729: chroot is an exception).
                   1730: 
                   1731: The rest of this chapter assumes that the package is already in pkgsrc. If it
                   1732: is not, see Part II, "The pkgsrc developer's guide" for instructions how to
                   1733: create your own packages.
                   1734: 
                   1735: 4.2.1. Requirements
                   1736: 
                   1737: To build packages from source, you need a working C compiler. On NetBSD, you
                   1738: need to install the "comp" and the "text" distribution sets. If you want to
                   1739: build X11-related packages, the "xbase" and "xcomp" distribution sets are
                   1740: required, too.
                   1741: 
                   1742: 4.2.2. Fetching distfiles
                   1743: 
                   1744: The first step for building a package is downloading the distfiles (i.e. the
                   1745: unmodified source). If they have not yet been downloaded, pkgsrc will fetch
                   1746: them automatically.
                   1747: 
                   1748: If you have all files that you need in the distfiles directory, you don't need
                   1749: to connect. If the distfiles are on CD-ROM, you can mount the CD-ROM on /cdrom
                   1750: and add:
                   1751: 
                   1752: DISTDIR=/cdrom/pkgsrc/distfiles
                   1753: 
                   1754: to your mk.conf.
                   1755: 
                   1756: By default a list of distribution sites will be randomly intermixed to prevent
                   1757: huge load on servers which holding popular packages (for example,
                   1758: SourceForge.net mirrors). Thus, every time when you need to fetch yet another
                   1759: distfile all the mirrors will be tried in new (random) order. You can turn this
                   1760: feature off by setting MASTER_SORT_RANDOM=NO (for PKG_DEVELOPERs it's already
                   1761: disabled).
                   1762: 
                   1763: You can overwrite some of the major distribution sites to fit to sites that are
                   1764: close to your own. By setting one or two variables you can modify the order in
                   1765: which the master sites are accessed. MASTER_SORT contains a whitespace
                   1766: delimited list of domain suffixes. MASTER_SORT_REGEX is even more flexible, it
                   1767: contains a whitespace delimited list of regular expressions. It has higher
                   1768: priority than MASTER_SORT. Have a look at pkgsrc/mk/defaults/mk.conf to find
                   1769: some examples. This may save some of your bandwidth and time.
                   1770: 
                   1771: You can change these settings either in your shell's environment, or, if you
                   1772: want to keep the settings, by editing the /etc/mk.conf file, and adding the
                   1773: definitions there.
                   1774: 
                   1775: If a package depends on many other packages (such as meta-pkgs/kde3), the build
                   1776: process may alternate between periods of downloading source, and compiling. To
                   1777: ensure you have all the source downloaded initially you can run the command:
                   1778: 
                   1779: % make fetch-list | sh
                   1780: 
                   1781: which will output and run a set of shell commands to fetch the necessary files
                   1782: into the distfiles directory. You can also choose to download the files
                   1783: manually.
                   1784: 
                   1785: 4.2.3. How to build and install
                   1786: 
                   1787: Once the software has downloaded, any patches will be applied, then it will be
                   1788: compiled for you. This may take some time depending on your computer, and how
                   1789: many other packages the software depends on and their compile time.
                   1790: 
                   1791: Note
                   1792: 
                   1793: If using bootstrap or pkgsrc on a non-NetBSD system, use the pkgsrc bmake
                   1794: command instead of "make" in the examples in this guide.
                   1795: 
                   1796: For example, type
                   1797: 
                   1798: % cd misc/figlet
                   1799: % make
                   1800: 
                   1801: 
                   1802: at the shell prompt to build the various components of the package.
                   1803: 
                   1804: The next stage is to actually install the newly compiled program onto your
                   1805: system. Do this by entering:
                   1806: 
                   1807: % make install
                   1808: 
                   1809: 
                   1810: while you are still in the directory for whatever package you are installing.
                   1811: 
                   1812: Installing the package on your system may require you to be root. However,
                   1813: pkgsrc has a just-in-time-su feature, which allows you to only become root for
                   1814: the actual installation step.
                   1815: 
                   1816: That's it, the software should now be installed and setup for use. You can now
                   1817: enter:
                   1818: 
                   1819: % make clean
                   1820: 
                   1821: 
                   1822: to remove the compiled files in the work directory, as you shouldn't need them
                   1823: any more. If other packages were also added to your system (dependencies) to
                   1824: allow your program to compile, you can tidy these up also with the command:
                   1825: 
                   1826: % make clean-depends
                   1827: 
                   1828: 
                   1829: Taking the figlet utility as an example, we can install it on our system by
                   1830: building as shown in Appendix B, Build logs.
                   1831: 
                   1832: The program is installed under the default root of the packages tree - /usr/
                   1833: pkg. Should this not conform to your tastes, set the LOCALBASE variable in your
                   1834: environment, and it will use that value as the root of your packages tree. So,
                   1835: to use /usr/local, set LOCALBASE=/usr/local in your environment. Please note
                   1836: that you should use a directory which is dedicated to packages and not shared
                   1837: with other programs (i.e., do not try and use LOCALBASE=/usr). Also, you should
                   1838: not try to add any of your own files or directories (such as src/, obj/, or
                   1839: pkgsrc/) below the LOCALBASE tree. This is to prevent possible conflicts
                   1840: between programs and other files installed by the package system and whatever
                   1841: else may have been installed there.
                   1842: 
                   1843: Some packages look in /etc/mk.conf to alter some configuration options at build
                   1844: time. Have a look at pkgsrc/mk/defaults/mk.conf to get an overview of what will
                   1845: be set there by default. Environment variables such as LOCALBASE can be set in
                   1846: /etc/mk.conf to save having to remember to set them each time you want to use
                   1847: pkgsrc.
                   1848: 
                   1849: Occasionally, people want to "look under the covers" to see what is going on
                   1850: when a package is building or being installed. This may be for debugging
                   1851: purposes, or out of simple curiosity. A number of utility values have been
                   1852: added to help with this.
                   1853: 
                   1854:  1. If you invoke the make(1) command with PKG_DEBUG_LEVEL=2, then a huge
                   1855:     amount of information will be displayed. For example,
                   1856: 
                   1857:     make patch PKG_DEBUG_LEVEL=2
                   1858: 
                   1859:     will show all the commands that are invoked, up to and including the
                   1860:     "patch" stage.
                   1861: 
                   1862:  2. If you want to know the value of a certain make(1) definition, then the
                   1863:     VARNAME definition should be used, in conjunction with the show-var target.
                   1864:     e.g. to show the expansion of the make(1) variable LOCALBASE:
                   1865: 
                   1866:     % make show-var VARNAME=LOCALBASE
                   1867:     /usr/pkg
                   1868:     %
                   1869: 
                   1870: 
                   1871: If you want to install a binary package that you've either created yourself
                   1872: (see next section), that you put into pkgsrc/packages manually or that is
                   1873: located on a remote FTP server, you can use the "bin-install" target. This
                   1874: target will install a binary package - if available - via pkg_add(1), else do a
                   1875: make package. The list of remote FTP sites searched is kept in the variable
                   1876: BINPKG_SITES, which defaults to ftp.NetBSD.org. Any flags that should be added
                   1877: to pkg_add(1) can be put into BIN_INSTALL_FLAGS. See pkgsrc/mk/defaults/mk.conf
                   1878: for more details.
                   1879: 
                   1880: A final word of warning: If you set up a system that has a non-standard setting
                   1881: for LOCALBASE, be sure to set that before any packages are installed, as you
                   1882: cannot use several directories for the same purpose. Doing so will result in
                   1883: pkgsrc not being able to properly detect your installed packages, and fail
                   1884: miserably. Note also that precompiled binary packages are usually built with
                   1885: the default LOCALBASE of /usr/pkg, and that you should not install any if you
                   1886: use a non-standard LOCALBASE.
                   1887: 
                   1888: Chapter 5. Configuring pkgsrc
                   1889: 
                   1890: Table of Contents
                   1891: 
                   1892: 5.1. General configuration
                   1893: 5.2. Variables affecting the build process
                   1894: 5.3. Selecting and configuring the compiler
                   1895: 
                   1896:     5.3.1. Selecting the compiler
                   1897:     5.3.2. Additional flags to the compiler (CFLAGS)
                   1898:     5.3.3. Additional flags to the linker (LDFLAGS)
                   1899: 
                   1900: 5.4. Developer/advanced settings
                   1901: 5.5. Selecting Build Options
                   1902: 
                   1903: The whole pkgsrc system is configured in a single file, usually called mk.conf.
                   1904: In which directory pkgsrc looks for that file depends on the installation. On
                   1905: NetBSD, when you use make(1) from the base system, it is in the directory /etc
                   1906: /. In all other cases the default location is ${PREFIX}/etc/, depending on
                   1907: where you told the bootstrap program to install the binary packages.
                   1908: 
                   1909: During the bootstrap, an example configuration file is created. To use that,
                   1910: you have to create the directory ${PREFIX}/etc and copy the example file there.
                   1911: 
                   1912: The format of the configuration file is that of the usual BSD-style Makefiles.
                   1913: The whole pkgsrc configuration is done by setting variables in this file. Note
                   1914: that you can define all kinds of variables, and no special error checking (for
                   1915: example for spelling mistakes) takes place, so you have to try it out to see if
                   1916: it works.
                   1917: 
                   1918: 5.1. General configuration
                   1919: 
                   1920: In this section, you can find some variables that apply to all pkgsrc packages.
                   1921: A complete list of the variables that can be configured by the user is
                   1922: available in mk/defaults/mk.conf, together with some comments that describe
                   1923: each variable's intent.
                   1924: 
                   1925:   * LOCALBASE: Where packages will be installed. The default is /usr/pkg. Do
                   1926:     not mix binary packages with different LOCALBASEs!
                   1927: 
                   1928:   * CROSSBASE: Where "cross" category packages will be installed. The default
                   1929:     is ${LOCALBASE}/cross.
                   1930: 
                   1931:   * X11BASE: Where X11 is installed on the system. The default is /usr/X11R6.
                   1932: 
                   1933:   * DISTDIR: Where to store the downloaded copies of the original source
                   1934:     distributions used for building pkgsrc packages. The default is $
                   1935:     {PKGSRCDIR}/distfiles.
                   1936: 
                   1937:   * PKG_DBDIR: Where the database about installed packages is stored. The
                   1938:     default is /var/db/pkg.
                   1939: 
                   1940:   * MASTER_SITE_OVERRIDE: If set, override the packages' MASTER_SITES with this
                   1941:     value.
                   1942: 
                   1943:   * MASTER_SITE_BACKUP: Backup location(s) for distribution files and patch
                   1944:     files if not found locally or in ${MASTER_SITES} or ${PATCH_SITES}
                   1945:     respectively. The defaults are ftp://ftp.NetBSD.org/pub/NetBSD/packages/
                   1946:     distfiles/${DIST_SUBDIR}/ and ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/$
                   1947:     {DIST_SUBDIR}/.
                   1948: 
                   1949:   * BINPKG_SITES: List of sites carrying binary pkgs. rel and arch are replaced
                   1950:     with OS release ("2.0", etc.) and architecture ("mipsel", etc.).
                   1951: 
                   1952:   * ACCEPTABLE_LICENSES: List of acceptable licenses. Whenever you try to build
                   1953:     a package whose license is not in this list, you will get an error message
                   1954:     that includes instructions on how to change this variable.
                   1955: 
                   1956: 5.2. Variables affecting the build process
                   1957: 
                   1958: XXX
                   1959: 
                   1960:   * PACKAGES: The top level directory for the binary packages. The default is $
                   1961:     {PKGSRCDIR}/packages.
                   1962: 
                   1963:   * WRKOBJDIR: The top level directory where, if defined, the separate working
                   1964:     directories will get created, and symbolically linked to from ${WRKDIR}
                   1965:     (see below). This is useful for building packages on several architectures,
                   1966:     then ${PKGSRCDIR} can be NFS-mounted while ${WRKOBJDIR} is local to every
                   1967:     architecture. (It should be noted that PKGSRCDIR should not be set by the
                   1968:     user ? it is an internal definition which refers to the root of the pkgsrc
                   1969:     tree. It is possible to have many pkgsrc tree instances.)
                   1970: 
                   1971:   * LOCALPATCHES: Directory for local patches that aren't part of pkgsrc. See
                   1972:     Section 10.3, "patches/*" for more information.
                   1973: 
                   1974:   * PKGMAKECONF: Location of the mk.conf file used by a package's BSD-style
                   1975:     Makefile. If this is not set, MAKECONF is set to /dev/null to avoid picking
                   1976:     up settings used by builds in /usr/src.
                   1977: 
                   1978:   * DEPENDS_TARGET: By default, dependencies are only installed, and no binary
                   1979:     package is created for them. You can set this variable to package to
                   1980:     automatically create binary packages after installing dependencies.
                   1981: 
                   1982: 5.3. Selecting and configuring the compiler
                   1983: 
                   1984: 5.3.1. Selecting the compiler
                   1985: 
                   1986: By default, pkgsrc will use GCC to build packages. This may be overridden by
                   1987: setting the following variables in /etc/mk.conf:
                   1988: 
                   1989: PKGSRC_COMPILER:
                   1990: 
                   1991:     This is a list of values specifying the chain of compilers to invoke when
                   1992:     building packages. Valid values are:
                   1993: 
                   1994:       * distcc: distributed C/C++ (chainable)
                   1995: 
                   1996:       * ccache: compiler cache (chainable)
                   1997: 
                   1998:       * gcc: GNU C/C++ Compiler
                   1999: 
                   2000:       * mipspro: Silicon Graphics, Inc. MIPSpro (n32/n64)
                   2001: 
                   2002:       * mipspro: Silicon Graphics, Inc. MIPSpro (o32)
                   2003: 
                   2004:       * sunpro: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio
                   2005: 
                   2006:     The default is "gcc". You can use ccache and/or distcc with an appropriate
                   2007:     PKGSRC_COMPILER setting, e.g. "ccache gcc". This variable should always be
                   2008:     terminated with a value for a real compiler. Note that only one real
                   2009:     compiler should be listed (e.g. "sunpro gcc" is not allowed).
                   2010: 
                   2011: GCC_REQD:
                   2012: 
                   2013:     This specifies the minimum version of GCC to use when building packages. If
                   2014:     the system GCC doesn't satisfy this requirement, then pkgsrc will build and
                   2015:     install one of the GCC packages to use instead.
                   2016: 
                   2017: 5.3.2. Additional flags to the compiler (CFLAGS)
                   2018: 
                   2019: If you wish to set the CFLAGS variable, please make sure to use the += operator
                   2020: instead of the = operator:
                   2021: 
                   2022: CFLAGS+=        -your -flags
                   2023: 
                   2024: Using CFLAGS= (i.e. without the "+") may lead to problems with packages that
                   2025: need to add their own flags. Also, you may want to take a look at the devel/
                   2026: cpuflags package if you're interested in optimization for the current CPU.
                   2027: 
                   2028: 5.3.3. Additional flags to the linker (LDFLAGS)
                   2029: 
                   2030: If you want to pass flags to the linker, both in the configure step and the
                   2031: build step, you can do this in two ways. Either set LDFLAGS or LIBS. The
                   2032: difference between the two is that LIBS will be appended to the command line,
                   2033: while LDFLAGS come earlier. LDFLAGS is pre-loaded with rpath settings for ELF
                   2034: machines depending on the setting of USE_IMAKE or the inclusion of mk/
                   2035: x11.buildlink3.mk. As with CFLAGS, if you do not wish to override these
                   2036: settings, use the += operator:
                   2037: 
                   2038: LDFLAGS+=        -your -linkerflags
                   2039: 
                   2040: 5.4. Developer/advanced settings
                   2041: 
                   2042: XXX
                   2043: 
                   2044:   * PKG_DEVELOPER: Run some sanity checks that package developers want:
                   2045: 
                   2046:       o make sure patches apply with zero fuzz
                   2047: 
                   2048:       o run check-shlibs to see that all binaries will find their shared libs.
                   2049: 
                   2050:   * PKG_DEBUG_LEVEL: The level of debugging output which is displayed whilst
                   2051:     making and installing the package. The default value for this is 0, which
                   2052:     will not display the commands as they are executed (normal, default, quiet
                   2053:     operation); the value 1 will display all shell commands before their
                   2054:     invocation, and the value 2 will display both the shell commands before
                   2055:     their invocation, and their actual execution progress with set -x will be
                   2056:     displayed.
                   2057: 
                   2058: 5.5. Selecting Build Options
                   2059: 
                   2060: Some packages have build time options, usually to select between different
                   2061: dependencies, enable optional support for big dependencies or enable
                   2062: experimental features.
                   2063: 
                   2064: To see which options, if any, a package supports, and which options are
                   2065: mutually exclusive, run make show-options, for example:
                   2066: 
                   2067:     The following options are supported by this package:
                   2068:         ssl      Enable SSL support.
                   2069:     Exactly one of the following gecko options is required:
                   2070:         firefox  Use firefox as gecko rendering engine.
                   2071:         mozilla  Use mozilla as gecko rendering engine.
                   2072:     At most one of the following database options may be selected:
                   2073:         mysql    Enable support for MySQL database.
                   2074:         pgsql    Enable support for PostgreSQL database.
                   2075: 
                   2076:     These options are enabled by default: firefox
                   2077:     These options are currently enabled: mozilla ssl
                   2078: 
                   2079: The following variables can be defined in /etc/mk.conf to select which options
                   2080: to enable for a package: PKG_DEFAULT_OPTIONS, which can be used to select or
                   2081: disable options for all packages that support them, and PKG_OPTIONS.pkgbase,
                   2082: which can be used to select or disable options specifically for package pkgbase
                   2083: . Options listed in these variables are selected, options preceded by "-" are
                   2084: disabled. A few examples:
                   2085: 
                   2086: $ grep "PKG.*OPTION" /etc/mk.conf
                   2087: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   2088: PKG_OPTIONS.kdebase=    debug -sasl
                   2089: PKG_OPTIONS.apache=     suexec
                   2090: 
                   2091: The following settings are consulted in the order given, and the last setting
                   2092: that selects or disables an option is used:
                   2093: 
                   2094:  1. the default options as suggested by the package maintainer
                   2095: 
                   2096:  2. the options implied by the settings of legacy variables (see below)
                   2097: 
                   2098:  3. PKG_DEFAULT_OPTIONS
                   2099: 
                   2100:  4. PKG_OPTIONS.pkgbase
                   2101: 
                   2102: For groups of mutually exclusive options, the last option selected is used, all
                   2103: others are automatically disabled. If an option of the group is explicitly
                   2104: disabled, the previously selected option, if any, is used. It is an error if no
                   2105: option from a required group of options is selected, and building the package
                   2106: will fail.
                   2107: 
                   2108: Before the options framework was introduced, build options were selected by
                   2109: setting a variable (often named USE_FOO) in /etc/mk.conf for each option. To
                   2110: ease transition to the options framework for the user, these legacy variables
                   2111: are converted to the appropriate options setting (PKG_OPTIONS.pkgbase)
                   2112: automatically. A warning is issued to prompt the user to update /etc/mk.conf to
                   2113: use the options framework directly. Support for the legacy variables will be
                   2114: removed eventually.
                   2115: 
                   2116: Chapter 6. Creating binary packages
                   2117: 
                   2118: Table of Contents
                   2119: 
                   2120: 6.1. Building a single binary package
                   2121: 6.2. Settings for creation of binary packages
                   2122: 6.3. Doing a bulk build of all packages
                   2123: 
                   2124:     6.3.1. Configuration
                   2125:     6.3.2. Other environmental considerations
                   2126:     6.3.3. Operation
                   2127:     6.3.4. What it does
                   2128:     6.3.5. Disk space requirements
                   2129:     6.3.6. Setting up a sandbox for chrooted builds
                   2130:     6.3.7. Building a partial set of packages
                   2131:     6.3.8. Uploading results of a bulk build
                   2132: 
                   2133: 6.4. Creating a multiple CD-ROM packages collection
                   2134: 
                   2135:     6.4.1. Example of cdpack
                   2136: 
                   2137: 6.1. Building a single binary package
                   2138: 
                   2139: Once you have built and installed a package, you can create a binary package
                   2140: which can be installed on another system with pkg_add(1). This saves having to
                   2141: build the same package on a group of hosts and wasting CPU time. It also
                   2142: provides a simple means for others to install your package, should you
                   2143: distribute it.
                   2144: 
                   2145: To create a binary package, change into the appropriate directory in pkgsrc,
                   2146: and run make package:
                   2147: 
                   2148: # cd misc/figlet
                   2149: # make package
                   2150: 
                   2151: 
                   2152: This will build and install your package (if not already done), and then build
                   2153: a binary package from what was installed. You can then use the pkg_* tools to
                   2154: manipulate it. Binary packages are created by default in /usr/pkgsrc/packages,
                   2155: in the form of a gzipped tar file. See Section B.2, "Packaging figlet" for a
                   2156: continuation of the above misc/figlet example.
                   2157: 
                   2158: See Chapter 20, Submitting and Committing for information on how to submit such
                   2159: a binary package.
                   2160: 
                   2161: 6.2. Settings for creation of binary packages
                   2162: 
                   2163: See Section 16.17, "Other helpful targets".
                   2164: 
                   2165: 6.3. Doing a bulk build of all packages
                   2166: 
                   2167: If you want to get a full set of precompiled binary packages, this section
                   2168: describes how to get them. Beware that the bulk build will remove all currently
                   2169: installed packages from your system!
                   2170: 
                   2171: Having an FTP server configured either on the machine doing the bulk builds or
                   2172: on a nearby NFS server can help to make the packages available to other
                   2173: machines that can then save time by installing only the binary packages. See
                   2174: ftpd(8) for more information. If you use a remote NFS server's storage, be sure
                   2175: to not actually compile on NFS storage, as this slows things down a lot.
                   2176: 
                   2177: 6.3.1. Configuration
                   2178: 
                   2179: 6.3.1.1. build.conf
                   2180: 
                   2181: The build.conf file is the main configuration file for bulk builds. You can
                   2182: configure how your copy of pkgsrc is kept up to date, how the distfiles are
                   2183: downloaded, how the packages are built and how the report is generated. You can
                   2184: find an annotated example file in pkgsrc/mk/bulk/build.conf-example. To use it,
                   2185: copy build.conf-example to build.conf and edit it, following the comments in
                   2186: that file.
                   2187: 
                   2188: 6.3.1.2. /etc/mk.conf
                   2189: 
                   2190: You may want to set variables in /etc/mk.conf. Look at pkgsrc/mk/defaults/
                   2191: mk.conf for details of the default settings. You will want to ensure that
                   2192: ACCEPTABLE_LICENSES meet your local policy. As used in this example,
                   2193: _ACCEPTABLE=yes accepts all licenses.
                   2194: 
                   2195: PACKAGES?=      ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
                   2196: WRKOBJDIR?=     /usr/tmp/pkgsrc   # build here instead of in pkgsrc
                   2197: BSDSRCDIR=      /usr/src
                   2198: BSDXSRCDIR=     /usr/xsrc         # for x11/xservers
                   2199: OBJHOSTNAME?=   yes               # use work.`hostname`
                   2200: FAILOVER_FETCH= yes               # insist on the correct checksum
                   2201: PKG_DEVELOPER?= yes
                   2202: _ACCEPTABLE=    yes
                   2203: 
                   2204: Some options that are especially useful for bulk builds can be found at the top
                   2205: lines of the file mk/bulk/bsd.bulk-pkg.mk. The most useful options of these are
                   2206: briefly described here.
                   2207: 
                   2208:   * If you are on a slow machine, you may want to set USE_BULK_BROKEN_CHECK to
                   2209:     "no".
                   2210: 
                   2211:   * If you are doing bulk builds from a read-only copy of pkgsrc, you have to
                   2212:     set BULKFILESDIR to the directory where all log files are created.
                   2213:     Otherwise the log files are created in the pkgsrc directory.
                   2214: 
                   2215:   * Another important variable is BULK_PREREQ, which is a list of packages that
                   2216:     should be always available while building other packages.
                   2217: 
                   2218: Some other options are scattered in the pkgsrc infrastructure:
                   2219: 
                   2220:   * ALLOW_VULNERABLE_PACKAGES should be set to yes. The purpose of the bulk
                   2221:     builds is creating binary packages, no matter if they are vulnerable or
                   2222:     not. When uploading the packages to a public server, the vulnerable
                   2223:     packages will be put into a directory of their own. Leaving this variable
                   2224:     unset would prevent the bulk build system from even trying to build them,
                   2225:     so possible building errors would not show up.
                   2226: 
                   2227:   * CHECK_FILES (pkgsrc/mk/check/check-files.mk) can be set to "yes" to check
                   2228:     that the installed set of files matches the PLIST.
                   2229: 
                   2230:   * CHECK_INTERPRETER (pkgsrc/mk/check/check-interpreter.mk) can be set to
                   2231:     "yes" to check that the installed "#!"-scripts will find their interpreter.
                   2232: 
                   2233:   * PKGSRC_RUN_TEST can be set to "yes" to run each package's self-test before
                   2234:     installing it. Note that some packages make heavy use of "good" random
                   2235:     numbers, so you need to assure that the machine on which you are doing the
                   2236:     bulk builds is not completely idle. Otherwise some test programs will seem
                   2237:     to hang, while they are just waiting for new random data to be available.
                   2238: 
                   2239: 6.3.1.3. pre-build.local
                   2240: 
                   2241: It is possible to configure the bulk build to perform certain site-specific
                   2242: tasks at the end of the pre-build stage. If the file pre-build.local exists in
                   2243: /usr/pkgsrc/mk/bulk, it will be executed (as a sh(1) script) at the end of the
                   2244: usual pre-build stage. An example use of pre-build.local is to have the line:
                   2245: 
                   2246: echo "I do not have enough disk space to build this pig." \
                   2247:         > misc/openoffice/$BROKENF
                   2248: 
                   2249: to prevent the system from trying to build a particular package which requires
                   2250: nearly 3 GB of disk space.
                   2251: 
                   2252: 6.3.2. Other environmental considerations
                   2253: 
                   2254: As /usr/pkg will be completely deleted at the start of bulk builds, make sure
                   2255: your login shell is placed somewhere else. Either drop it into /usr/local/bin
                   2256: (and adjust your login shell in the passwd file), or (re-)install it via
                   2257: pkg_add(1) from /etc/rc.local, so you can login after a reboot (remember that
                   2258: your current process won't die if the package is removed, you just can't start
                   2259: any new instances of the shell any more). Also, if you use NetBSD earlier than
                   2260: 1.5, or you still want to use the pkgsrc version of ssh for some reason, be
                   2261: sure to install ssh before starting it from rc.local:
                   2262: 
                   2263: (cd /usr/pkgsrc/security/ssh && make bulk-install)
                   2264: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
                   2265:   /usr/pkg/etc/rc.d/sshd
                   2266: fi
                   2267: 
                   2268: Not doing so will result in you being not able to log in via ssh after the bulk
                   2269: build is finished or if the machine gets rebooted or crashes. You have been
                   2270: warned! :)
                   2271: 
                   2272: 6.3.3. Operation
                   2273: 
                   2274: Make sure you don't need any of the packages still installed.
                   2275: 
                   2276: Warning
                   2277: 
                   2278: During the bulk build, all packages, their configuration files and some more
                   2279: files from /var, /home and possibly other locations will be removed! So don't
                   2280: run a bulk build with privileges that might harm your system.
                   2281: 
                   2282: Be sure to remove all other things that might interfere with builds, like some
                   2283: libs installed in /usr/local, etc. then become root and type:
                   2284: 
                   2285: # cd /usr/pkgsrc
                   2286: # sh mk/bulk/build
                   2287: 
                   2288: 
                   2289: If for some reason your last build didn't complete (power failure, system
                   2290: panic, ...), you can continue it by running:
                   2291: 
                   2292: # sh mk/bulk/build restart
                   2293: 
                   2294: At the end of the bulk build, you will get a summary via mail, and find build
                   2295: logs in the directory specified by FTP in the build.conf file.
                   2296: 
                   2297: 6.3.4. What it does
                   2298: 
                   2299: The bulk builds consist of three steps:
                   2300: 
                   2301: 1. pre-build
                   2302: 
                   2303:     The script updates your pkgsrc tree via (anon)cvs, then cleans out any
                   2304:     broken distfiles, and removes all packages installed.
                   2305: 
                   2306: 2. the bulk build
                   2307: 
                   2308:     This is basically "make bulk-package" with an optimised order in which
                   2309:     packages will be built. Packages that don't require other packages will be
                   2310:     built first, and packages with many dependencies will be built later.
                   2311: 
                   2312: 3. post-build
                   2313: 
                   2314:     Generates a report that's placed in the directory specified in the
                   2315:     build.conf file named broken.html, a short version of that report will also
                   2316:     be mailed to the build's admin.
                   2317: 
                   2318: During the build, a list of broken packages will be compiled in /usr/pkgsrc
                   2319: /.broken (or .../.broken.${MACHINE} if OBJMACHINE is set), individual build
                   2320: logs of broken builds can be found in the package's directory. These files are
                   2321: used by the bulk-targets to mark broken builds to not waste time trying to
                   2322: rebuild them, and they can be used to debug these broken package builds later.
                   2323: 
                   2324: 6.3.5. Disk space requirements
                   2325: 
                   2326: Currently, roughly the following requirements are valid for NetBSD 2.0/i386:
                   2327: 
                   2328:   * 10 GB - distfiles (NFS ok)
                   2329: 
                   2330:   * 8 GB - full set of all binaries (NFS ok)
                   2331: 
                   2332:   * 5 GB - temp space for compiling (local disk recommended)
                   2333: 
                   2334: Note that all pkgs will be de-installed as soon as they are turned into a
                   2335: binary package, and that sources are removed, so there is no excessively huge
                   2336: demand to disk space. Afterwards, if the package is needed again, it will be
                   2337: installed via pkg_add(1) instead of building again, so there are no cycles
                   2338: wasted by recompiling.
                   2339: 
                   2340: 6.3.6. Setting up a sandbox for chrooted builds
                   2341: 
                   2342: If you don't want all the packages nuked from a machine (rendering it useless
                   2343: for anything but pkg compiling), there is the possibility of doing the package
                   2344: bulk build inside a chroot environment.
                   2345: 
                   2346: The first step is to set up a chroot sandbox, e.g. /usr/sandbox. This can be
                   2347: done by using null mounts, or manually.
                   2348: 
                   2349: There is a shell script called pkgsrc/mk/bulk/mksandbox which will set up the
                   2350: sandbox environment using null mounts. It will also create a script called
                   2351: sandbox in the root of the sandbox environment, which will allow the null
                   2352: mounts to be activated using the sandbox mount command and deactivated using
                   2353: the sandbox umount command.
                   2354: 
                   2355: To set up a sandbox environment by hand, after extracting all the sets from a
                   2356: NetBSD installation or doing a make distribution DESTDIR=/usr/sandbox in /usr/
                   2357: src/etc, be sure the following items are present and properly configured:
                   2358: 
                   2359:  1. Kernel
                   2360: 
                   2361:     # cp /netbsd /usr/sandbox
                   2362: 
                   2363:  2. /dev/*
                   2364: 
                   2365:     # cd /usr/sandbox/dev ; sh MAKEDEV all
                   2366: 
                   2367:  3. /etc/resolv.conf (for security/smtpd and mail):
                   2368: 
                   2369:     # cp /etc/resolv.conf /usr/sandbox/etc
                   2370: 
                   2371:  4. Working(!) mail config (hostname, sendmail.cf):
                   2372: 
                   2373:     # cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail
                   2374: 
                   2375:  5. /etc/localtime (for security/smtpd):
                   2376: 
                   2377:     # ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime
                   2378: 
                   2379:  6. /usr/src (system sources, e. g. for sysutils/aperture):
                   2380: 
                   2381:     # ln -s ../disk1/cvs .
                   2382:               # ln -s cvs/src-2.0 src
                   2383: 
                   2384:  7. Create /var/db/pkg (not part of default install):
                   2385: 
                   2386:     # mkdir /usr/sandbox/var/db/pkg
                   2387: 
                   2388:  8. Create /usr/pkg (not part of default install):
                   2389: 
                   2390:     # mkdir /usr/sandbox/usr/pkg
                   2391: 
                   2392:  9. Checkout pkgsrc via cvs into /usr/sandbox/usr/pkgsrc:
                   2393: 
                   2394:     # cd /usr/sandbox/usr
                   2395:     # cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc
                   2396: 
                   2397: 
                   2398:     Do not mount/link this to the copy of your pkgsrc tree you do development
                   2399:     in, as this will likely cause problems!
                   2400: 
                   2401: 10. Make /usr/sandbox/usr/pkgsrc/packages and .../distfiles point somewhere
                   2402:     appropriate. NFS- and/or nullfs-mounts may come in handy!
                   2403: 
                   2404: 11. Edit /etc/mk.conf, see Section 6.3.1.2, "/etc/mk.conf".
                   2405: 
                   2406: 12. Adjust mk/bulk/build.conf to suit your needs.
                   2407: 
                   2408: When the chroot sandbox is set up, you can start the build with the following
                   2409: steps:
                   2410: 
                   2411: # cd /usr/sandbox/usr/pkgsrc
                   2412: # sh mk/bulk/do-sandbox-build
                   2413: 
                   2414: 
                   2415: This will just jump inside the sandbox and start building. At the end of the
                   2416: build, mail will be sent with the results of the build. Created binary pkgs
                   2417: will be in /usr/sandbox/usr/pkgsrc/packages (wherever that points/mounts to/
                   2418: from).
                   2419: 
                   2420: 6.3.7. Building a partial set of packages
                   2421: 
                   2422: In addition to building a complete set of all packages in pkgsrc, the pkgsrc/mk
                   2423: /bulk/build script may be used to build a subset of the packages contained in
                   2424: pkgsrc. By setting SPECIFIC_PKGS in /etc/mk.conf, the variables
                   2425: 
                   2426:   * SITE_SPECIFIC_PKGS
                   2427: 
                   2428:   * HOST_SPECIFIC_PKGS
                   2429: 
                   2430:   * GROUP_SPECIFIC_PKGS
                   2431: 
                   2432:   * USER_SPECIFIC_PKGS
                   2433: 
                   2434: will define the set of packages which should be built. The bulk build code will
                   2435: also include any packages which are needed as dependencies for the explicitly
                   2436: listed packages.
                   2437: 
                   2438: One use of this is to do a bulk build with SPECIFIC_PKGS in a chroot sandbox
                   2439: periodically to have a complete set of the binary packages needed for your site
                   2440: available without the overhead of building extra packages that are not needed.
                   2441: 
                   2442: 6.3.8. Uploading results of a bulk build
                   2443: 
                   2444: This section describes how pkgsrc developers can upload binary pkgs built by
                   2445: bulk builds to ftp.NetBSD.org.
                   2446: 
                   2447: If you would like to automatically create checksum files for the binary
                   2448: packages you intend to upload, remember to set MKSUMS=yes in your mk/bulk/
                   2449: build.conf.
                   2450: 
                   2451: If you would like to PGP sign the checksum files (highly recommended!),
                   2452: remember to set SIGN_AS=username@NetBSD.org in your mk/bulk/build.conf. This
                   2453: will prompt you for your GPG password to sign the files before uploading
                   2454: everything.
                   2455: 
                   2456: Then, make sure that you have RSYNC_DST set properly in your mk/bulk/build.conf
                   2457: file, i.e. adjust it to something like one of the following:
                   2458: 
                   2459: RSYNC_DST=ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload
                   2460: 
                   2461: Please use appropriate values for "packages-200xQy", "NetBSD-a.b.c" and "arch"
                   2462: here. If your login on ftp.NetBSD.org is different from your local login, write
                   2463: your login directly into the variable, e.g. my local account is "feyrer", but
                   2464: for my login "hubertf", I use:
                   2465: 
                   2466: RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload
                   2467: 
                   2468: A separate upload directory is used here to allow "closing" the directory
                   2469: during upload. To do so, run the following command on ftp.NetBSD.org next:
                   2470: 
                   2471: nbftp% mkdir -p -m 750 /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload
                   2472: 
                   2473: Please note that /pub/NetBSD/packages is only appropriate for packages for the
                   2474: NetBSD operating system. Binary packages for other operating systems should go
                   2475: into /pub/pkgsrc.
                   2476: 
                   2477: Before uploading the binary pkgs, ssh authentication needs to be set up. This
                   2478: example shows how to set up temporary keys for the root account inside the
                   2479: sandbox (assuming that no keys should be present there usually):
                   2480: 
                   2481: # chroot /usr/sandbox
                   2482: chroot-# rm $HOME/.ssh/id-dsa*
                   2483: chroot-# ssh-keygen -t dsa
                   2484: chroot-# cat $HOME/.ssh/id-dsa.pub
                   2485: 
                   2486: 
                   2487: Now take the output of id-dsa.pub and append it to your ~/.ssh/authorized_keys
                   2488: file on ftp.NetBSD.org. You can remove the key after the upload is done!
                   2489: 
                   2490: Next, test if your ssh connection really works:
                   2491: 
                   2492: chroot-# ssh ftp.NetBSD.org date
                   2493: 
                   2494: Use "-l yourNetBSDlogin" here as appropriate!
                   2495: 
                   2496: Now after all this works, you can exit the sandbox and start the upload:
                   2497: 
                   2498: chroot-# exit
                   2499: # cd /usr/sandbox/usr/pkgsrc
                   2500: # sh mk/bulk/do-sandbox-upload
                   2501: 
                   2502: 
                   2503: The upload process may take quite some time. Use ls(1) or du(1) on the FTP
                   2504: server to monitor progress of the upload. The upload script will take care of
                   2505: not uploading restricted packages and putting vulnerable packages into the
                   2506: vulnerable subdirectory.
                   2507: 
                   2508: After the upload has ended, first thing is to revoke ssh access:
                   2509: 
                   2510: nbftp% vi ~/.ssh/authorized_keys
                   2511:       Gdd:x!
                   2512: 
                   2513: Use whatever is needed to remove the key you've entered before! Last, move the
                   2514: uploaded packages out of the upload directory to have them accessible to
                   2515: everyone:
                   2516: 
                   2517: nbftp% cd /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch
                   2518: nbftp% mv upload/* .
                   2519: nbftp% rmdir upload
                   2520: nbftp% chmod 755 .
                   2521: 
                   2522: 
                   2523: 6.4. Creating a multiple CD-ROM packages collection
                   2524: 
                   2525: After your pkgsrc bulk-build has completed, you may wish to create a CD-ROM set
                   2526: of the resulting binary packages to assist in installing packages on other
                   2527: machines. The pkgtools/cdpack package provides a simple tool for creating the
                   2528: ISO 9660 images. cdpack arranges the packages on the CD-ROMs in a way that
                   2529: keeps all the dependencies for a given package on the same CD as that package.
                   2530: 
                   2531: 6.4.1. Example of cdpack
                   2532: 
                   2533: Complete documentation for cdpack is found in the cdpack(1) man page. The
                   2534: following short example assumes that the binary packages are left in /usr/
                   2535: pkgsrc/packages/All and that sufficient disk space exists in /u2 to hold the
                   2536: ISO 9660 images.
                   2537: 
                   2538: # mkdir /u2/images
                   2539: # pkg_add /usr/pkgsrc/packages/All/cdpack
                   2540: # cdpack /usr/pkgsrc/packages/All /u2/images
                   2541: 
                   2542: 
                   2543: If you wish to include a common set of files (COPYRIGHT, README, etc.) on each
                   2544: CD in the collection, then you need to create a directory which contains these
                   2545: files. e.g.
                   2546: 
                   2547: # mkdir /tmp/common
                   2548: # echo "This is a README" > /tmp/common/README
                   2549: # echo "Another file" > /tmp/common/COPYING
                   2550: # mkdir /tmp/common/bin
                   2551: # echo "#!/bin/sh" > /tmp/common/bin/myscript
                   2552: # echo "echo Hello world" >> /tmp/common/bin/myscript
                   2553: # chmod 755 /tmp/common/bin/myscript
                   2554: 
                   2555: 
                   2556: Now create the images:
                   2557: 
                   2558: # cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images
                   2559: 
                   2560: Each image will contain README, COPYING, and bin/myscript in their root
                   2561: directories.
                   2562: 
                   2563: Chapter 7. Directory layout of the installed files
                   2564: 
                   2565: Table of Contents
                   2566: 
                   2567: 7.1. File system layout in ${LOCALBASE}
                   2568: 7.2. File system layout in ${VARBASE}
                   2569: 
                   2570: The files that are installed by pkgsrc are organized in a way that is similar
                   2571: to what you find in the /usr directory of the base system. But some details are
                   2572: different. This is because pkgsrc initially came from FreeBSD and had adopted
                   2573: its file system hierarchy. Later it was largely influenced by NetBSD. But no
                   2574: matter which operating system you are using pkgsrc with, you can expect the
                   2575: same layout for pkgsrc.
                   2576: 
                   2577: There are mainly four root directories for pkgsrc, which are all configurable
                   2578: in the bootstrap/bootstrap script. When pkgsrc has been installed as root, the
                   2579: default locations are:
                   2580: 
                   2581: LOCALBASE=              /usr/pkg
                   2582: PKG_SYSCONFBASE=        /usr/pkg/etc
                   2583: VARBASE=                /var
                   2584: PKG_DBDIR=              /var/db/pkg
                   2585: 
                   2586: In unprivileged mode (when pkgsrc has been installed as any other user), the
                   2587: default locations are:
                   2588: 
                   2589: LOCALBASE=              ${HOME}/pkg
                   2590: PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   2591: VARBASE=                ${HOME}/pkg/var
                   2592: PKG_DBDIR=              ${HOME}/pkg/var/db/pkg
                   2593: 
                   2594: What these four directories are for, and what they look like is explained
                   2595: below.
                   2596: 
                   2597:   * LOCALBASE corresponds to the /usr directory in the base system. It is the
                   2598:     "main" directory where the files are installed and contains the well-known
                   2599:     subdirectories like bin, include, lib, share and sbin.
                   2600: 
                   2601:   * VARBASE corresponds to /var in the base system. Some programs (especially
                   2602:     games, network daemons) need write access to it during normal operation.
                   2603: 
                   2604:   * PKG_SYSCONFDIR corresponds to /etc in the base system. It contains
                   2605:     configuration files of the packages, as well as pkgsrc's mk.conf itself.
                   2606: 
                   2607: 7.1. File system layout in ${LOCALBASE}
                   2608: 
                   2609: The following directories exist in a typical pkgsrc installation in $
                   2610: {LOCALBASE}.
                   2611: 
                   2612: bin
                   2613: 
                   2614:     Contains executable programs that are intended to be directly used by the
                   2615:     end user.
                   2616: 
                   2617: emul
                   2618: 
                   2619:     Contains files for the emulation layers of various other operating systems,
                   2620:     especially for NetBSD.
                   2621: 
                   2622: etc (the usual location of ${PKG_SYSCONFDIR})
                   2623: 
                   2624:     Contains the configuration files.
                   2625: 
                   2626: include
                   2627: 
                   2628:     Contains headers for the C and C++ programming languages.
                   2629: 
                   2630: info
                   2631: 
                   2632:     Contains GNU info files of various packages.
                   2633: 
                   2634: lib
                   2635: 
                   2636:     Contains shared and static libraries.
                   2637: 
                   2638: libdata
                   2639: 
                   2640:     Contains data files that don't change after installation. Other data files
                   2641:     belong into ${VARBASE}.
                   2642: 
                   2643: libexec
                   2644: 
                   2645:     Contains programs that are not intended to be used by end users, such as
                   2646:     helper programs or network daemons.
                   2647: 
                   2648: libexec/cgi-bin
                   2649: 
                   2650:     Contains programs that are intended to be executed as CGI scripts by a web
                   2651:     server.
                   2652: 
                   2653: man (the usual value of ${PKGMANDIR})
                   2654: 
                   2655:     Contains brief documentation in form of manual pages.
                   2656: 
                   2657: sbin
                   2658: 
                   2659:     Contains programs that are intended to be used only by the super-user.
                   2660: 
                   2661: share
                   2662: 
                   2663:     Contains platform-independent data files that don't change after
                   2664:     installation.
                   2665: 
                   2666: share/doc
                   2667: 
                   2668:     Contains documentation files provided by the packages.
                   2669: 
                   2670: share/examples
                   2671: 
                   2672:     Contains example files provided by the packages. Among others, the original
                   2673:     configuration files are saved here and copied to ${PKG_SYSCONFDIR} during
                   2674:     installation.
                   2675: 
                   2676: share/examples/rc.d
                   2677: 
                   2678:     Contains the original files for rc.d scripts.
                   2679: 
                   2680: var (the usual location of ${VARBASE})
                   2681: 
                   2682:     Contains files that may be modified after installation.
                   2683: 
                   2684: 7.2. File system layout in ${VARBASE}
                   2685: 
                   2686: db/pkg (the usual location of ${PKG_DBDIR})
                   2687: 
                   2688:     Contains information about the currently installed packages.
                   2689: 
                   2690: games
                   2691: 
                   2692:     Contains highscore files.
                   2693: 
                   2694: log
                   2695: 
                   2696:     Contains log files.
                   2697: 
                   2698: run
                   2699: 
                   2700:     Contains informational files about daemons that are currently running.
                   2701: 
                   2702: Chapter 8. Frequently Asked Questions
                   2703: 
                   2704: Table of Contents
                   2705: 
                   2706: 8.1. Are there any mailing lists for pkg-related discussion?
                   2707: 8.2. Where's the pkgviews documentation?
                   2708: 8.3. Utilities for package management (pkgtools)
                   2709: 8.4. How to use pkgsrc as non-root
                   2710: 8.5. How to resume transfers when fetching distfiles?
                   2711: 8.6. How can I install/use XFree86 from pkgsrc?
                   2712: 8.7. How can I install/use X.org from pkgsrc?
                   2713: 8.8. How to fetch files from behind a firewall
                   2714: 8.9. How do I tell make fetch to do passive FTP?
                   2715: 8.10. How to fetch all distfiles at once
                   2716: 8.11. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean?
                   2717: 8.12. What does "Could not find bsd.own.mk" mean?
                   2718: 8.13. Using 'sudo' with pkgsrc
                   2719: 8.14. How do I change the location of configuration files?
                   2720: 8.15. Automated security checks
                   2721: 8.16. Why do some packages ignore my CFLAGS?
                   2722: 8.17. A package does not build. What shall I do?
                   2723: 8.18. What does "Makefile appears to contain unresolved cvs/rcs/??? merge
                   2724:     conflicts" mean?
                   2725: 
                   2726: This section contains hints, tips & tricks on special things in pkgsrc that we
                   2727: didn't find a better place for in the previous chapters, and it contains items
                   2728: for both pkgsrc users and developers.
                   2729: 
                   2730: 8.1. Are there any mailing lists for pkg-related discussion?
                   2731: 
                   2732: The following mailing lists may be of interest to pkgsrc users:
                   2733: 
                   2734:   * pkgsrc-users: This is a general purpose list for most issues regarding
                   2735:     pkgsrc, regardless of platform, e.g. soliciting user help for pkgsrc
                   2736:     configuration, unexpected build failures, using particular packages,
                   2737:     upgrading pkgsrc installations, questions regarding the pkgsrc release
                   2738:     branches, etc. General announcements or proposals for changes that impact
                   2739:     the pkgsrc user community, e.g. major infrastructure changes, new features,
                   2740:     package removals, etc., may also be posted.
                   2741: 
                   2742:   * pkgsrc-bulk: A list where the results of pkgsrc bulk builds are sent and
                   2743:     discussed.
                   2744: 
                   2745:   * pkgsrc-changes: This list is for those who are interested in getting a
                   2746:     commit message for every change committed to pkgsrc. It is also available
                   2747:     in digest form, meaning one daily message containing all commit messages
                   2748:     for changes to the package source tree in that 24 hour period.
                   2749: 
                   2750: To subscribe, do:
                   2751: 
                   2752: % echo subscribe listname | mail majordomo@NetBSD.org
                   2753: 
                   2754: Archives for all these mailing lists are available from http://
                   2755: mail-index.NetBSD.org/.
                   2756: 
                   2757: 8.2. Where's the pkgviews documentation?
                   2758: 
                   2759: Pkgviews is tightly integrated with buildlink. You can find a pkgviews User's
                   2760: guide in pkgsrc/mk/buildlink3/PKGVIEWS_UG.
                   2761: 
                   2762: 8.3. Utilities for package management (pkgtools)
                   2763: 
                   2764: The directory pkgsrc/pkgtools contains a number of useful utilities for both
                   2765: users and developers of pkgsrc. This section attempts only to make the reader
                   2766: aware of the utilities and when they might be useful, and not to duplicate the
                   2767: documentation that comes with each package.
                   2768: 
                   2769: Utilities used by pkgsrc (automatically installed when needed):
                   2770: 
                   2771:   * pkgtools/x11-links: Symlinks for use by buildlink.
                   2772: 
                   2773: OS tool augmentation (automatically installed when needed):
                   2774: 
                   2775:   * pkgtools/digest: Calculates various kinds of checksums (including SHA1).
                   2776: 
                   2777:   * pkgtools/libnbcompat: Compatibility library for pkgsrc tools.
                   2778: 
                   2779:   * pkgtools/mtree: Installed on non-BSD systems due to lack of native mtree.
                   2780: 
                   2781:   * pkgtools/pkg_install: Up-to-date replacement for /usr/sbin/pkg_install, or
                   2782:     for use on operating systems where pkg_install is not present.
                   2783: 
                   2784: Utilities used by pkgsrc (not automatically installed):
                   2785: 
                   2786:   * pkgtools/pkg_tarup: Create a binary package from an already-installed
                   2787:     package. Used by make replace to save the old package.
                   2788: 
                   2789:   * pkgtools/dfdisk: Adds extra functionality to pkgsrc, allowing it to fetch
                   2790:     distfiles from multiple locations. It currently supports the following
                   2791:     methods: multiple CD-ROMs and network FTP/HTTP connections.
                   2792: 
                   2793:   * pkgtools/xpkgwedge: Put X11 packages someplace else (enabled by default).
                   2794: 
                   2795:   * devel/cpuflags: Determine the best compiler flags to optimise code for your
                   2796:     current CPU and compiler.
                   2797: 
                   2798: Utilities for keeping track of installed packages, being up to date, etc:
                   2799: 
                   2800:   * pkgtools/pkg_chk: Reports on packages whose installed versions do not match
                   2801:     the latest pkgsrc entries.
                   2802: 
                   2803:   * pkgtools/pkgdep: Makes dependency graphs of packages, to aid in choosing a
                   2804:     strategy for updating.
                   2805: 
                   2806:   * pkgtools/pkgdepgraph: Makes graphs from the output of pkgtools/pkgdep (uses
                   2807:     graphviz).
                   2808: 
                   2809:   * pkgtools/pkglint: The pkglint(1) program checks a pkgsrc entry for errors,
                   2810:     lintpkgsrc(1) does various checks on the complete pkgsrc system.
                   2811: 
                   2812:   * pkgtools/pkgsurvey: Report what packages you have installed.
                   2813: 
                   2814: Utilities for people maintaining or creating individual packages:
                   2815: 
                   2816:   * pkgtools/pkgdiff: Automate making and maintaining patches for a package
                   2817:     (includes pkgdiff, pkgvi, mkpatches, etc.).
                   2818: 
                   2819:   * pkgtools/rpm2pkg, pkgtools/url2pkg: Aids in converting to pkgsrc.
                   2820: 
                   2821:   * pkgtools/gensolpkg: Convert pkgsrc to a Solaris package.
                   2822: 
                   2823: Utilities for people maintaining pkgsrc (or: more obscure pkg utilities)
                   2824: 
                   2825:   * pkgtools/pkg_comp: Build packages in a chrooted area.
                   2826: 
                   2827:   * pkgtools/libkver: Spoof kernel version for chrooted cross builds.
                   2828: 
                   2829: 8.4. How to use pkgsrc as non-root
                   2830: 
                   2831: If you want to use pkgsrc as non-root user, you can set some variables to make
                   2832: pkgsrc work under these conditions. At the very least, you need to set
                   2833: UNPRIVILEGED to "yes"; this will turn on unprivileged mode and set multiple
                   2834: related variables to allow installation of packages as non-root.
                   2835: 
                   2836: In case the defaults are not enough, you may want to tune some other variables
                   2837: used. For example, if the automatic user/group detection leads to incorrect
                   2838: values (or not the ones you would like to use), you can change them by setting
                   2839: UNPRIVILEGED_USER and UNPRIVILEGED_GROUP respectively.
                   2840: 
                   2841: As regards bootstrapping, please note that the bootstrap script will ease
                   2842: non-root configuration when given the "--ignore-user-check" flag, as it will
                   2843: choose and use multiple default directories under ~/pkg as the installation
                   2844: targets. These directories can be overridden by the "--prefix" flag provided by
                   2845: the script, as well as some others that allow finer tuning of the tree layout.
                   2846: 
                   2847: 8.5. How to resume transfers when fetching distfiles?
                   2848: 
                   2849: By default, resuming transfers in pkgsrc is disabled, but you can enable this
                   2850: feature by adding the option PKG_RESUME_TRANSFERS=YES into /etc/mk.conf. If,
                   2851: during a fetch step, an incomplete distfile is found, pkgsrc will try to resume
                   2852: it.
                   2853: 
                   2854: You can also use a different program than the default ftp(1) by changing the
                   2855: FETCH_CMD variable. Don't forget to set FETCH_RESUME_ARGS and FETCH_OUTPUT_ARGS
                   2856: if you are not using default values.
                   2857: 
                   2858: For example, if you want to use wget to resume downloads, you'll have to use
                   2859: something like:
                   2860: 
                   2861: FETCH_CMD=             wget
                   2862: FETCH_BEFORE_ARGS=     --passive-ftp
                   2863: FETCH_RESUME_ARGS=     -c
                   2864: FETCH_OUTPUT_ARGS=     -O
                   2865: 
                   2866: 8.6. How can I install/use XFree86 from pkgsrc?
                   2867: 
                   2868: If you want to use XFree86 from pkgsrc instead of your system's own X11 (/usr/
                   2869: X11R6, /usr/openwin, ...), you will have to add the following line into /etc/
                   2870: mk.conf:
                   2871: 
                   2872: X11_TYPE=XFree86
                   2873: 
                   2874: 8.7. How can I install/use X.org from pkgsrc?
                   2875: 
                   2876: If you want to use X.org from pkgsrc instead of your system's own X11 (/usr/
                   2877: X11R6, /usr/openwin, ...) you will have to add the following line into /etc/
                   2878: mk.conf:
                   2879: 
                   2880: X11_TYPE=xorg
                   2881: 
                   2882: Note
                   2883: 
                   2884: The DragonFly operating system defaults to using this X.org X11 implementation
                   2885: from pkgsrc.
                   2886: 
                   2887: 8.8. How to fetch files from behind a firewall
                   2888: 
                   2889: If you are sitting behind a firewall which does not allow direct connections to
                   2890: Internet hosts (i.e. non-NAT), you may specify the relevant proxy hosts. This
                   2891: is done using an environment variable in the form of a URL, e.g. in Amdahl, the
                   2892: machine "orpheus.amdahl.com" is one of the firewalls, and it uses port 80 as
                   2893: the proxy port number. So the proxy environment variables are:
                   2894: 
                   2895: ftp_proxy=ftp://orpheus.amdahl.com:80/
                   2896: http_proxy=http://orpheus.amdahl.com:80/
                   2897: 
                   2898: 8.9. How do I tell make fetch to do passive FTP?
                   2899: 
                   2900: This depends on which utility is used to retrieve distfiles. From bsd.pkg.mk,
                   2901: FETCH_CMD is assigned the first available command from the following list:
                   2902: 
                   2903:   * ${LOCALBASE}/bin/ftp
                   2904: 
                   2905:   * /usr/bin/ftp
                   2906: 
                   2907: On a default NetBSD installation, this will be /usr/bin/ftp, which
                   2908: automatically tries passive connections first, and falls back to active
                   2909: connections if the server refuses to do passive. For the other tools, add the
                   2910: following to your /etc/mk.conf file: PASSIVE_FETCH=1.
                   2911: 
                   2912: Having that option present will prevent /usr/bin/ftp from falling back to
                   2913: active transfers.
                   2914: 
                   2915: 8.10. How to fetch all distfiles at once
                   2916: 
                   2917: You would like to download all the distfiles in a single batch from work or
                   2918: university, where you can't run a make fetch. There is an archive of distfiles
                   2919: on ftp.NetBSD.org, but downloading the entire directory may not be appropriate.
                   2920: 
                   2921: The answer here is to do a make fetch-list in /usr/pkgsrc or one of its
                   2922: subdirectories, carry the resulting list to your machine at work/school and use
                   2923: it there. If you don't have a NetBSD-compatible ftp(1) (like tnftp) at work,
                   2924: don't forget to set FETCH_CMD to something that fetches a URL:
                   2925: 
                   2926: At home:
                   2927: 
                   2928: % cd /usr/pkgsrc
                   2929: % make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh
                   2930: % scp /tmp/fetch.sh work:/tmp
                   2931: 
                   2932: At work:
                   2933: 
                   2934: % sh /tmp/fetch.sh
                   2935: 
                   2936: then tar up /tmp/distfiles and take it home.
                   2937: 
                   2938: If you have a machine running NetBSD, and you want to get all distfiles (even
                   2939: ones that aren't for your machine architecture), you can do so by using the
                   2940: above-mentioned make fetch-list approach, or fetch the distfiles directly by
                   2941: running:
                   2942: 
                   2943: % make mirror-distfiles
                   2944: 
                   2945: If you even decide to ignore NO_{SRC,BIN}_ON_{FTP,CDROM}, then you can get
                   2946: everything by running:
                   2947: 
                   2948: % make fetch NO_SKIP=yes
                   2949: 
                   2950: 8.11. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean?
                   2951: 
                   2952: When compiling the pkgtools/pkg_install package, you get the error from make
                   2953: that it doesn't know how to make /usr/share/tmac/tmac.andoc? This indicates
                   2954: that you don't have installed the "text" set (nroff, ...) from the NetBSD base
                   2955: distribution on your machine. It is recommended to do that to format man pages.
                   2956: 
                   2957: In the case of the pkgtools/pkg_install package, you can get away with setting
                   2958: NOMAN=YES either in the environment or in /etc/mk.conf.
                   2959: 
                   2960: 8.12. What does "Could not find bsd.own.mk" mean?
                   2961: 
                   2962: You didn't install the compiler set, comp.tgz, when you installed your NetBSD
                   2963: machine. Please get and install it, by extracting it in /:
                   2964: 
                   2965: # cd /
                   2966: # tar --unlink -zxvpf .../comp.tgz
                   2967: 
                   2968: comp.tgz is part of every NetBSD release. Get the one that corresponds to your
                   2969: release (determine via uname -r).
                   2970: 
                   2971: 8.13. Using 'sudo' with pkgsrc
                   2972: 
                   2973: When installing packages as non-root user and using the just-in-time su(1)
                   2974: feature of pkgsrc, it can become annoying to type in the root password for each
                   2975: required package installed. To avoid this, the sudo package can be used, which
                   2976: does password caching over a limited time. To use it, install sudo (either as
                   2977: binary package or from security/sudo) and then put the following into your /etc
                   2978: /mk.conf, somewhere after the definition of the LOCALBASE variable:
                   2979: 
                   2980: .if exists(${LOCALBASE}/bin/sudo)
                   2981: SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
                   2982: .endif
                   2983: 
                   2984: 8.14. How do I change the location of configuration files?
                   2985: 
                   2986: As the system administrator, you can choose where configuration files are
                   2987: installed. The default settings make all these files go into ${PREFIX}/etc or
                   2988: some of its subdirectories; this may be suboptimal depending on your
                   2989: expectations (e.g., a read-only, NFS-exported PREFIX with a need of per-machine
                   2990: configuration of the provided packages).
                   2991: 
                   2992: In order to change the defaults, you can modify the PKG_SYSCONFBASE variable
                   2993: (in /etc/mk.conf) to point to your preferred configuration directory; some
                   2994: common examples include /etc or /etc/pkg.
                   2995: 
                   2996: Furthermore, you can change this value on a per-package basis by setting the
                   2997: PKG_SYSCONFDIR.${PKG_SYSCONFVAR} variable. PKG_SYSCONFVAR's value usually
                   2998: matches the name of the package you would like to modify, that is, the contents
                   2999: of PKGBASE.
                   3000: 
                   3001: Note that after changing these settings, you must rebuild and reinstall any
                   3002: affected packages.
                   3003: 
                   3004: 8.15. Automated security checks
                   3005: 
                   3006: Please be aware that there can often be bugs in third-party software, and some
                   3007: of these bugs can leave a machine vulnerable to exploitation by attackers. In
                   3008: an effort to lessen the exposure, the NetBSD packages team maintains a database
                   3009: of known-exploits to packages which have at one time been included in pkgsrc.
                   3010: The database can be downloaded automatically, and a security audit of all
                   3011: packages installed on a system can take place. To do this, install the security
                   3012: /audit-packages package. It has two components:
                   3013: 
                   3014:  1. download-vulnerability-list, an easy way to download a list of the security
                   3015:     vulnerabilities information. This list is kept up to date by the NetBSD
                   3016:     security officer and the NetBSD packages team, and is distributed from the
                   3017:     NetBSD ftp server:
                   3018: 
                   3019:     ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/pkg-vulnerabilities
                   3020: 
                   3021:  2. audit-packages, an easy way to audit the current machine, checking each
                   3022:     vulnerability which is known. If a vulnerable package is installed, it will
                   3023:     be shown by output to stdout, including a description of the type of
                   3024:     vulnerability, and a URL containing more information.
                   3025: 
                   3026: Use of the security/audit-packages package is strongly recommended! After
                   3027: "audit-packages" is installed, please read the package's message, which you can
                   3028: get by running pkg_info -D audit-packages.
                   3029: 
                   3030: If this package is installed, pkgsrc builds will use it to perform a security
                   3031: check before building any package. See Section 5.2, "Variables affecting the
                   3032: build process" for ways to control this check.
                   3033: 
                   3034: 8.16. Why do some packages ignore my CFLAGS?
                   3035: 
                   3036: When you add your own preferences to the CFLAGS variable in your mk.conf, these
                   3037: flags are passed in environment variables to the ./configure scripts and to
                   3038: make(1). Some package authors ignore the CFLAGS from the environment variable
                   3039: by overriding them in the Makefiles of their package.
                   3040: 
                   3041: Currently there is no solution to this problem. If you really need the package
                   3042: to use your CFLAGS you should run make patch in the package directory and then
                   3043: inspect any Makefile and Makefile.in for whether they define CFLAGS explicitly.
                   3044: Usually you can remove these lines. But be aware that some "smart" programmers
                   3045: write so bad code that it only works for the specific combination of CFLAGS
                   3046: they have chosen.
                   3047: 
                   3048: 8.17. A package does not build. What shall I do?
                   3049: 
                   3050:  1. Make sure that your copy of pkgsrc is consistent. A case that occurs often
                   3051:     is that people only update pkgsrc in parts, because of performance reasons.
                   3052:     Since pkgsrc is one large system, not a collection of many small systems,
                   3053:     there are sometimes changes that only work when the whole pkgsrc tree is
                   3054:     updated.
                   3055: 
                   3056:  2. Make sure that you don't have any CVS conflicts. Search for "<<<<<<" or
                   3057:     ">>>>>>" in all your pkgsrc files.
                   3058: 
                   3059:  3. Make sure that you don't have old copies of the packages extracted. Run
                   3060:     make clean clean-depends to verify this.
                   3061: 
                   3062:  4. If the problem still exists, write a mail to the pkgsrc-users mailing list.
                   3063: 
                   3064: 8.18. What does "Makefile appears to contain unresolved cvs/rcs/??? merge
                   3065: conflicts" mean?
                   3066: 
                   3067: You have modified a file from pkgsrc, and someone else has modified that same
                   3068: file afterwards in the CVS repository. Both changes are in the same region of
                   3069: the file, so when you updated pkgsrc, the cvs command marked the conflicting
                   3070: changes in the file. Because of these markers, the file is no longer a valid
                   3071: Makefile.
                   3072: 
                   3073: Have a look at that file, and if you don't need your local changes anymore, you
                   3074: can remove that file and run cvs -q update -dP in that directory to download
                   3075: the current version.
                   3076: 
                   3077: Part II. The pkgsrc developer's guide
                   3078: 
                   3079: This part of the book deals with creating and modifying packages. It starts
                   3080: with a "HOWTO"-like guide on creating a new package. The remaining chapters are
                   3081: more like a reference manual for pkgsrc.
                   3082: 
                   3083: Table of Contents
                   3084: 
                   3085: 9. Creating a new pkgsrc package from scratch
                   3086: 
                   3087:     9.1. Common types of packages
                   3088: 
                   3089:         9.1.1. Perl modules
                   3090:         9.1.2. KDE applications
                   3091: 
                   3092:     9.2. Examples
                   3093: 
                   3094:         9.2.1. How the www/nvu package came into pkgsrc
                   3095: 
                   3096: 10. Package components - files, directories and contents
                   3097: 
                   3098:     10.1. Makefile
                   3099:     10.2. distinfo
                   3100:     10.3. patches/*
                   3101: 
                   3102:         10.3.1. Structure of a single patch file
                   3103:         10.3.2. Creating patch files
                   3104:         10.3.3. Sources where the patch files come from
                   3105:         10.3.4. Patching guidelines
                   3106:         10.3.5. Feedback to the author
                   3107: 
                   3108:     10.4. Other mandatory files
                   3109:     10.5. Optional files
                   3110: 
                   3111:         10.5.1. Files affecting the binary package
                   3112:         10.5.2. Files affecting the build process
                   3113:         10.5.3. Files affecting nothing at all
                   3114: 
                   3115:     10.6. work*
                   3116:     10.7. files/*
                   3117: 
                   3118: 11. Programming in Makefiles
                   3119: 
                   3120:     11.1. Caveats
                   3121:     11.2. Makefile variables
                   3122: 
                   3123:         11.2.1. Naming conventions
                   3124: 
                   3125:     11.3. Code snippets
                   3126: 
                   3127:         11.3.1. Adding things to a list
                   3128:         11.3.2. Converting an internal list into an external list
                   3129:         11.3.3. Passing variables to a shell command
                   3130:         11.3.4. Quoting guideline
                   3131:         11.3.5. Workaround for a bug in BSD Make
                   3132: 
                   3133: 12. PLIST issues
                   3134: 
                   3135:     12.1. RCS ID
                   3136:     12.2. Semi-automatic PLIST generation
                   3137:     12.3. Tweaking output of make print-PLIST
                   3138:     12.4. Variable substitution in PLIST
                   3139:     12.5. Man page compression
                   3140:     12.6. Changing PLIST source with PLIST_SRC
                   3141:     12.7. Platform-specific and differing PLISTs
                   3142:     12.8. Sharing directories between packages
                   3143: 
                   3144: 13. Buildlink methodology
                   3145: 
                   3146:     13.1. Converting packages to use buildlink3
                   3147:     13.2. Writing buildlink3.mk files
                   3148: 
                   3149:         13.2.1. Anatomy of a buildlink3.mk file
                   3150:         13.2.2. Updating BUILDLINK_API_DEPENDS.pkg in buildlink3.mk files
                   3151: 
                   3152:     13.3. Writing builtin.mk files
                   3153: 
                   3154:         13.3.1. Anatomy of a builtin.mk file
                   3155:         13.3.2. Global preferences for native or pkgsrc software
                   3156: 
                   3157: 14. The pkginstall framework
                   3158: 
                   3159:     14.1. Files and directories outside the installation prefix
                   3160: 
                   3161:         14.1.1. Directory manipulation
                   3162:         14.1.2. File manipulation
                   3163: 
                   3164:     14.2. Configuration files
                   3165: 
                   3166:         14.2.1. How PKG_SYSCONFDIR is set
                   3167:         14.2.2. Telling the software where configuration files are
                   3168:         14.2.3. Patching installations
                   3169:         14.2.4. Disabling handling of configuration files
                   3170: 
                   3171:     14.3. System startup scripts
                   3172: 
                   3173:         14.3.1. Disabling handling of system startup scripts
                   3174: 
                   3175:     14.4. System users and groups
                   3176:     14.5. System shells
                   3177: 
                   3178:         14.5.1. Disabling shell registration
                   3179: 
                   3180:     14.6. Fonts
                   3181: 
                   3182:         14.6.1. Disabling automatic update of the fonts databases
                   3183: 
                   3184: 15. Options handling
                   3185: 
                   3186:     15.1. Global default options
                   3187:     15.2. Converting packages to use bsd.options.mk
                   3188:     15.3. Option Names
                   3189: 
                   3190: 16. The build process
                   3191: 
                   3192:     16.1. Introduction
                   3193:     16.2. Program location
                   3194:     16.3. Directories used during the build process
                   3195:     16.4. Running a phase
                   3196:     16.5. The fetch phase
                   3197: 
                   3198:         16.5.1. What to fetch and where to get it from
                   3199:         16.5.2. How are the files fetched?
                   3200: 
                   3201:     16.6. The checksum phase
                   3202:     16.7. The extract phase
                   3203:     16.8. The patch phase
                   3204:     16.9. The tools phase
                   3205:     16.10. The wrapper phase
                   3206:     16.11. The configure phase
                   3207:     16.12. The build phase
                   3208:     16.13. The test phase
                   3209:     16.14. The install phase
                   3210:     16.15. The package phase
                   3211:     16.16. Cleaning up
                   3212:     16.17. Other helpful targets
                   3213: 
                   3214: 17. Tools needed for building or running
                   3215: 
                   3216:     17.1. Tools for pkgsrc builds
                   3217:     17.2. Tools needed by packages
                   3218:     17.3. Tools provided by platforms
                   3219:     17.4. Questions regarding the tools
                   3220: 
                   3221: 18. Making your package work
                   3222: 
                   3223:     18.1. General operation
                   3224: 
                   3225:         18.1.1. Portability of packages
                   3226:         18.1.2. How to pull in user-settable variables from mk.conf
                   3227:         18.1.3. User interaction
                   3228:         18.1.4. Handling licenses
                   3229:         18.1.5. Restricted packages
                   3230:         18.1.6. Handling dependencies
                   3231:         18.1.7. Handling conflicts with other packages
                   3232:         18.1.8. Packages that cannot or should not be built
                   3233:         18.1.9. Packages which should not be deleted, once installed
                   3234:         18.1.10. Handling packages with security problems
                   3235:         18.1.11. How to handle incrementing versions when fixing an existing
                   3236:             package
                   3237:         18.1.12. Substituting variable text in the package files (the SUBST
                   3238:             framework)
                   3239: 
                   3240:     18.2. Fixing problems in the fetch phase
                   3241: 
                   3242:         18.2.1. Packages whose distfiles aren't available for plain downloading
                   3243:         18.2.2. How to handle modified distfiles with the 'old' name
                   3244: 
                   3245:     18.3. Fixing problems in the configure phase
                   3246: 
                   3247:         18.3.1. Shared libraries - libtool
                   3248:         18.3.2. Using libtool on GNU packages that already support libtool
                   3249:         18.3.3. GNU Autoconf/Automake
                   3250: 
                   3251:     18.4. Programming languages
                   3252: 
                   3253:         18.4.1. C, C++, and Fortran
                   3254:         18.4.2. Java
                   3255:         18.4.3. Packages containing perl scripts
                   3256:         18.4.4. Other programming languages
                   3257: 
                   3258:     18.5. Fixing problems in the build phase
                   3259: 
                   3260:         18.5.1. Compiling C and C++ code conditionally
                   3261:         18.5.2. How to handle compiler bugs
                   3262:         18.5.3. Undefined reference to "..."
                   3263:         18.5.4. Running out of memory
                   3264: 
                   3265:     18.6. Fixing problems in the install phase
                   3266: 
                   3267:         18.6.1. Creating needed directories
                   3268:         18.6.2. Where to install documentation
                   3269:         18.6.3. Installing highscore files
                   3270:         18.6.4. Packages with hardcoded paths to other interpreters
                   3271:         18.6.5. Packages installing perl modules
                   3272:         18.6.6. Packages installing info files
                   3273:         18.6.7. Packages installing man pages
                   3274:         18.6.8. Packages installing GConf2 data files
                   3275:         18.6.9. Packages installing scrollkeeper data files
                   3276:         18.6.10. Packages installing X11 fonts
                   3277:         18.6.11. Packages installing GTK2 modules
                   3278:         18.6.12. Packages installing SGML or XML data
                   3279:         18.6.13. Packages installing extensions to the MIME database
                   3280:         18.6.14. Packages using intltool
                   3281:         18.6.15. Packages installing startup scripts
                   3282:         18.6.16. Packages installing TeX modules
                   3283:         18.6.17. Packages supporting running binaries in emulation
                   3284:         18.6.18. Packages installing hicolor theme icons
                   3285:         18.6.19. Packages installing desktop files
                   3286: 
                   3287:     18.7. Marking packages as having problems
                   3288: 
                   3289: 19. Debugging
                   3290: 20. Submitting and Committing
                   3291: 
                   3292:     20.1. Submitting binary packages
                   3293:     20.2. Submitting source packages (for non-NetBSD-developers)
                   3294:     20.3. General notes when adding, updating, or removing packages
                   3295:     20.4. Committing: Importing a package into CVS
                   3296:     20.5. Updating a package to a newer version
                   3297:     20.6. Moving a package in pkgsrc
                   3298: 
                   3299: 21. Frequently Asked Questions
                   3300: 22. GNOME packaging and porting
                   3301: 
                   3302:     22.1. Meta packages
                   3303:     22.2. Packaging a GNOME application
                   3304:     22.3. Updating GNOME to a newer version
                   3305:     22.4. Patching guidelines
                   3306: 
                   3307: Chapter 9. Creating a new pkgsrc package from scratch
                   3308: 
                   3309: Table of Contents
                   3310: 
                   3311: 9.1. Common types of packages
                   3312: 
                   3313:     9.1.1. Perl modules
                   3314:     9.1.2. KDE applications
                   3315: 
                   3316: 9.2. Examples
                   3317: 
                   3318:     9.2.1. How the www/nvu package came into pkgsrc
                   3319: 
                   3320: When you find a package that is not yet in pkgsrc, you most likely have a URL
                   3321: from where you can download the source code. Starting with this URL, creating a
                   3322: package involves only a few steps.
                   3323: 
                   3324:  1. First, install the packages pkgtools/url2pkg and pkgtools/pkglint.
                   3325: 
                   3326:  2. Then, choose one of the top-level directories as the category in which you
                   3327:     want to place your package. You can also create a directory of your own
                   3328:     (maybe called local). In that category directory, create another directory
                   3329:     for your package and change into it.
                   3330: 
                   3331:  3. Run the program url2pkg, which will ask you for a URL. Enter the URL of the
                   3332:     distribution file (in most cases a .tar.gz file) and watch how the basic
                   3333:     ingredients of your package are created automatically. The distribution
                   3334:     file is extracted automatically to fill in some details in the Makefile
                   3335:     that would otherwise have to be done manually.
                   3336: 
                   3337:  4. Examine the extracted files to determine the dependencies of your package.
                   3338:     Ideally, this is mentioned in some README file, but things may differ. For
                   3339:     each of these dependencies, look where it exists in pkgsrc, and if there is
                   3340:     a file called buildlink3.mk in that directory, add a line to your package
                   3341:     Makefile which includes that file just before the last line. If the
                   3342:     buildlink3.mk file does not exist, add a DEPENDS line to the Makefile,
                   3343:     which specifies the version of the dependency and where it can be found in
                   3344:     pkgsrc. This line should be placed in the third paragraph. If the
                   3345:     dependency is only needed for building the package, but not when using it,
                   3346:     use BUILD_DEPENDS instead of DEPENDS. Your package may then look like this:
                   3347: 
                   3348:     [...]
                   3349: 
                   3350:     BUILD_DEPENDS+= lua>=5.0:../../lang/lua
                   3351:     DEPENDS+=       screen-[0-9]*:../../misc/screen
                   3352:     DEPENDS+=       screen>=4.0:../../misc/screen
                   3353: 
                   3354:     [...]
                   3355: 
                   3356:     .include "../../category/package/buildlink3.mk"
                   3357:     .include "../../devel/glib2/buildlink3.mk"
                   3358:     .include "../../mk/bsd.pkg.mk"
                   3359: 
                   3360:  5. Run pkglint to see what things still need to be done to make your package a
                   3361:     "good" one. If you don't know what pkglint's warnings want to tell you, try
                   3362:     pkglint --explain or pkglint -e, which outputs additional explanations.
                   3363: 
                   3364:  6. In many cases the package is not yet ready to build. You can find
                   3365:     instructions for the most common cases in the next section, Section 9.1,
                   3366:     "Common types of packages". After you have followed the instructions over
                   3367:     there, you can hopefully continue here.
                   3368: 
                   3369:  7. Run bmake clean to clean the working directory from the extracted files.
                   3370:     Besides these files, a lot of cache files and other system information has
                   3371:     been saved in the working directory, which may become wrong after you
                   3372:     edited the Makefile.
                   3373: 
                   3374:  8. Now, run bmake to build the package. For the various things that can go
                   3375:     wrong in this phase, consult Chapter 18, Making your package work.
                   3376: 
                   3377:  9. When the package builds fine, the next step is to install the package. Run
                   3378:     bmake install and hope that everything works.
                   3379: 
                   3380: 10. Up to now, the file PLIST, which contains a list of the files that are
                   3381:     installed by the package, is nearly empty. Run bmake print-PLIST >PLIST to
                   3382:     generate a probably correct list. Check the file using your preferred text
                   3383:     editor to see if the list of files looks plausible.
                   3384: 
                   3385: 11. Run pkglint again to see if the generated PLIST contains garbage or not.
                   3386: 
                   3387: 12. When you ran bmake install, the package has been registered in the database
                   3388:     of installed files, but with an empty list of files. To fix this, run bmake
                   3389:     deinstall and bmake install again. Now the package is registered with the
                   3390:     list of files from PLIST.
                   3391: 
                   3392: 13. Run bmake package to create a binary package from the set of installed
                   3393:     files.
                   3394: 
                   3395: 9.1. Common types of packages
                   3396: 
                   3397: 9.1.1. Perl modules
                   3398: 
                   3399: Simple Perl modules are handled automatically by url2pkg, including
                   3400: dependencies.
                   3401: 
                   3402: 9.1.2. KDE applications
                   3403: 
                   3404: KDE applications should always include meta-pkgs/kde3/kde3.mk, which contains
                   3405: numerous settings that are typical of KDE packages.
                   3406: 
                   3407: 9.2. Examples
                   3408: 
                   3409: 9.2.1. How the www/nvu package came into pkgsrc
                   3410: 
                   3411: 9.2.1.1. The initial package
                   3412: 
                   3413: Looking at the file pkgsrc/doc/TODO, I saw that the "nvu" package has not yet
                   3414: been imported into pkgsrc. As the description says it has to do with the web,
                   3415: the obvious choice for the category is "www".
                   3416: 
                   3417: $ mkdir www/nvu
                   3418: $ cd www/nvu
                   3419: 
                   3420: The web site says that the sources are available as a tar file, so I fed that
                   3421: URL to the url2pkg program:
                   3422: 
                   3423: $ url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   3424: 
                   3425: My editor popped up, and I added a PKGNAME line below the DISTNAME line, as the
                   3426: package name should not have the word "sources" in it. I also filled in the
                   3427: MAINTAINER, HOMEPAGE and COMMENT fields. Then the package Makefile looked like
                   3428: that:
                   3429: 
1.2     ! rillig   3430: # $NetBSD$
1.1       dsieger  3431: #
                   3432: 
                   3433: DISTNAME=       nvu-1.0-sources
                   3434: PKGNAME=        nvu-1.0
                   3435: CATEGORIES=     www
                   3436: MASTER_SITES=   http://cvs.nvu.com/download/
                   3437: EXTRACT_SUFX=   .tar.bz2
                   3438: 
                   3439: MAINTAINER=     rillig@NetBSD.org
                   3440: HOMEPAGE=       http://cvs.nvu.com/
                   3441: COMMENT=        Web Authoring System
                   3442: 
                   3443: # url2pkg-marker (please do not remove this line.)
                   3444: .include "../../mk/bsd.pkg.mk"
                   3445: 
                   3446: Then, I quit the editor and watched pkgsrc downloading a large source archive:
                   3447: 
                   3448: url2pkg> Running "make makesum" ...
                   3449: => Required installed package digest>=20010302: digest-20060826 found
                   3450: => Fetching nvu-1.0-sources.tar.bz2
                   3451: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   3452: 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
                   3453: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   3454: url2pkg> Running "make extract" ...
                   3455: => Required installed package digest>=20010302: digest-20060826 found
                   3456: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   3457: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   3458: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
                   3459: ===> Installing dependencies for nvu-1.0
                   3460: ===> Overriding tools for nvu-1.0
                   3461: ===> Extracting for nvu-1.0
                   3462: url2pkg> Adjusting the Makefile.
                   3463: 
                   3464: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
                   3465: 
                   3466: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
                   3467: 
                   3468: 9.2.1.2. Fixing all kinds of problems to make the package work
                   3469: 
                   3470: Now that the package has been extracted, let's see what's inside it. The
                   3471: package has a README.txt, but that only says something about mozilla, so it's
                   3472: probably useless for seeing what dependencies this package has. But since there
                   3473: is a GNU configure script in the package, let's hope that it will complain
                   3474: about everything it needs.
                   3475: 
                   3476: $ bmake
                   3477: => Required installed package digest>=20010302: digest-20060826 found
                   3478: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   3479: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   3480: ===> Patching for nvu-1.0
                   3481: ===> Creating toolchain wrappers for nvu-1.0
                   3482: ===> Configuring for nvu-1.0
                   3483: [...]
                   3484: configure: error: Perl 5.004 or higher is required.
                   3485: [...]
                   3486: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   3487: [...]
                   3488: 
                   3489: That worked quite well. So I opened the package Makefile in my editor, and
                   3490: since it already has a USE_TOOLS line, I just appended "perl" to it. Since the
                   3491: dependencies of the package have changed now, and since a perl wrapper is
                   3492: automatically installed in the "tools" phase, I need to build the package from
                   3493: scratch.
                   3494: 
                   3495: $ bmake clean
                   3496: ===> Cleaning for nvu-1.0
                   3497: $ bmake
                   3498: [...]
                   3499: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   3500: GNU Make.  You will not be able to build Mozilla without GNU Make.
                   3501: [...]
                   3502: 
                   3503: So I added "gmake" to the USE_TOOLS line and tried again (from scratch).
                   3504: 
                   3505: [...]
                   3506: checking for GTK - version >= 1.2.0... no
                   3507: *** Could not run GTK test program, checking why...
                   3508: [...]
                   3509: 
                   3510: Now to the other dependencies. The first question is: Where is the GTK package
                   3511: hidden in pkgsrc?
                   3512: 
                   3513: $ echo ../../*/gtk*
                   3514: [many packages ...]
                   3515: $ echo ../../*/gtk
                   3516: ../../x11/gtk
                   3517: $ echo ../../*/gtk2
                   3518: ../../x11/gtk2
                   3519: $ echo ../../*/gtk2/bui*
                   3520: ../../x11/gtk2/buildlink3.mk
                   3521: 
                   3522: The first try was definitely too broad. The second one had exactly one result,
                   3523: which is very good. But there is one pitfall with GNOME packages. Before GNOME
                   3524: 2 had been released, there were already many GNOME 1 packages in pkgsrc. To be
                   3525: able to continue to use these packages, the GNOME 2 packages were imported as
                   3526: separate packages, and their names usually have a "2" appended. So I checked
                   3527: whether this was the case here, and indeed it was.
                   3528: 
                   3529: Since the GTK2 package has a buildlink3.mk file, adding the dependency is very
                   3530: easy. I just inserted an .include line before the last line of the package
                   3531: Makefile, so that it now looks like this:
                   3532: 
                   3533: [...]
                   3534: .include "../../x11/gtk2/buildlink3.mk"
                   3535: .include "../../mk/bsd.pkg.mk
                   3536: 
                   3537: After another bmake clean && bmake, the answer was:
                   3538: 
                   3539: [...]
                   3540: checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   3541: checking for GTK - version >= 1.2.0... no
                   3542: *** Could not run GTK test program, checking why...
                   3543: *** The test program failed to compile or link. See the file config.log for the
                   3544: *** exact error that occured. This usually means GTK was incorrectly installed
                   3545: *** or that you have moved GTK since it was installed. In the latter case, you
                   3546: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   3547: configure: error: Test for GTK failed.
                   3548: [...]
                   3549: 
                   3550: In this particular case, the assumption that "every package prefers GNOME 2"
                   3551: had been wrong. The first of the lines above told me that this package really
                   3552: wanted to have the GNOME 1 version of GTK. If the package had looked for GTK2,
                   3553: it would have looked for pkg-config instead of gtk-config. So I changed the x11
                   3554: /gtk2 to x11/gtk in the package Makefile, and tried again.
                   3555: 
                   3556: [...]
                   3557: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\"   -I../../../dist/include/xpcom -I../../../dist/include -I/tmp/roland/pkgsrc/www/nvu/work.bacc/mozilla/dist/include/nspr -I/usr/X11R6/include   -fPIC -DPIC -I/home/roland/pkg/include -I/usr/include  -I/usr/X11R6/include -Wall -W -Wno-unused -Wpointer-arith -Wcast-align -Wno-long-long -pedantic -O2 -I/home/roland/pkg/include -I/usr/include -Dunix -pthread -pipe  -DDEBUG -D_DEBUG -DDEBUG_roland -DTRACING -g -I/home/roland/pkg/include/glib/glib-1.2 -I/home/roland/pkg/lib/glib/include -I/usr/pkg/include/orbit-1.0   -I/home/roland/pkg/include -I/usr/include  -I/usr/X11R6/include -include ../../../mozilla-config.h -DMOZILLA_CLIENT -Wp,-MD,.deps/xpidl.pp xpidl.c
                   3558: In file included from xpidl.c:42:
                   3559: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   3560: In file included from xpidl.c:42:
                   3561: xpidl.h:132: error: parse error before "IDL_ns"
                   3562: [...]
                   3563: 
                   3564: The package still does not find all of its dependencies. Now the question is:
                   3565: Which package provides the libIDL/IDL.h header file?
                   3566: 
                   3567: $ echo ../../*/*idl*
                   3568: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   3569: $ echo ../../*/*IDL*
                   3570: ../../net/libIDL
                   3571: 
                   3572: Let's take the one from the second try. So I included the ../../net/libIDL/
                   3573: buildlink3.mk file and tried again. But the error didn't change. After digging
                   3574: through some of the code, I concluded that the build process of the package was
                   3575: broken and couldn't have ever worked, but since the Mozilla source tree is
                   3576: quite large, I didn't want to fix it. So I added the following to the package
                   3577: Makefile and tried again:
                   3578: 
                   3579: CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
                   3580: BUILDLINK_TRANSFORM+=   -l:IDL:IDL-2
                   3581: 
                   3582: The latter line is needed because the package expects the library libIDL.so,
                   3583: but only libIDL-2.so is available. So I told the compiler wrapper to rewrite
                   3584: that on the fly.
                   3585: 
                   3586: The next problem was related to a recent change of the FreeType interface. I
                   3587: looked up in www/seamonkey which patch files were relevant for this issue and
                   3588: copied them to the patches directory. Then I retried, fixed the patches so that
                   3589: they applied cleanly and retried again. This time, everything worked.
                   3590: 
                   3591: 9.2.1.3. Installing the package
                   3592: 
                   3593: $ bmake CHECK_FILES=no install
                   3594: [...]
                   3595: $ bmake print-PLIST >PLIST
                   3596: $ bmake deinstall
                   3597: $ bmake install
                   3598: 
                   3599: Chapter 10. Package components - files, directories and contents
                   3600: 
                   3601: Table of Contents
                   3602: 
                   3603: 10.1. Makefile
                   3604: 10.2. distinfo
                   3605: 10.3. patches/*
                   3606: 
                   3607:     10.3.1. Structure of a single patch file
                   3608:     10.3.2. Creating patch files
                   3609:     10.3.3. Sources where the patch files come from
                   3610:     10.3.4. Patching guidelines
                   3611:     10.3.5. Feedback to the author
                   3612: 
                   3613: 10.4. Other mandatory files
                   3614: 10.5. Optional files
                   3615: 
                   3616:     10.5.1. Files affecting the binary package
                   3617:     10.5.2. Files affecting the build process
                   3618:     10.5.3. Files affecting nothing at all
                   3619: 
                   3620: 10.6. work*
                   3621: 10.7. files/*
                   3622: 
                   3623: Whenever you're preparing a package, there are a number of files involved which
                   3624: are described in the following sections.
                   3625: 
                   3626: 10.1. Makefile
                   3627: 
                   3628: Building, installation and creation of a binary package are all controlled by
                   3629: the package's Makefile. The Makefile describes various things about a package,
                   3630: for example from where to get it, how to configure, build, and install it.
                   3631: 
                   3632: A package Makefile contains several sections that describe the package.
                   3633: 
                   3634: In the first section there are the following variables, which should appear
                   3635: exactly in the order given here. The order and grouping of the variables is
                   3636: mostly historical and has no further meaning.
                   3637: 
                   3638:   * DISTNAME is the basename of the distribution file to be downloaded from the
                   3639:     package's website.
                   3640: 
                   3641:   * PKGNAME is the name of the package, as used by pkgsrc. You only need to
                   3642:     provide it if DISTNAME (which is the default) is not a good name for the
                   3643:     package in pkgsrc. Usually it is the pkgsrc directory name together with
                   3644:     the version number. It must match the regular expression ^[A-Za-z0-9]
                   3645:     [A-Za-z0-9-_.+]*$, that is, it starts with a letter or digit, and contains
                   3646:     only letters, digits, dashes, underscores, dots and plus signs.
                   3647: 
                   3648:   * SVR4_PKGNAME is the name of the package file to create if the PKGNAME isn't
                   3649:     unique on a SVR4 system. The default is PKGNAME, which may be shortened
                   3650:     when you use pkgtools/gensolpkg. Only add SVR4_PKGNAME if PKGNAME does not
                   3651:     produce an unique package name on a SVR4 system. The length of SVR4_PKGNAME
                   3652:     is limited to 5 characters.
                   3653: 
                   3654:   * CATEGORIES is a list of categories which the package fits in. You can
                   3655:     choose any of the top-level directories of pkgsrc for it.
                   3656: 
                   3657:     Currently the following values are available for CATEGORIES. If more than
                   3658:     one is used, they need to be separated by spaces:
                   3659: 
                   3660:     archivers     cross         geography     meta-pkgs     security
                   3661:     audio         databases     graphics      misc          shells
                   3662:     benchmarks    devel         ham           multimedia    sysutils
                   3663:     biology       editors       inputmethod   net           textproc
                   3664:     cad           emulators     lang          news          time
                   3665:     chat          finance       mail          parallel      wm
                   3666:     comms         fonts         math          pkgtools      www
                   3667:     converters    games         mbone         print         x11
                   3668: 
                   3669:   * MASTER_SITES, DYNAMIC_MASTER_SITES, DIST_SUBDIR, EXTRACT_SUFX and DISTFILES
                   3670:     are discussed in detail in Section 16.5, "The fetch phase".
                   3671: 
                   3672: The second section contains information about separately downloaded patches, if
                   3673: any.
                   3674: 
                   3675:   * PATCHFILES: Name(s) of additional files that contain distribution patches.
                   3676:     There is no default. pkgsrc will look for them at PATCH_SITES. They will
                   3677:     automatically be uncompressed before patching if the names end with .gz or
                   3678:     .Z.
                   3679: 
                   3680:   * PATCH_SITES: Primary location(s) for distribution patch files (see
                   3681:     PATCHFILES below) if not found locally.
                   3682: 
                   3683: The third section contains the following variables.
                   3684: 
                   3685:   * MAINTAINER is the email address of the person who feels responsible for
                   3686:     this package, and who is most likely to look at problems or questions
                   3687:     regarding this package which have been reported with send-pr(1). Other
                   3688:     developers should contact the MAINTAINER before making major changes to the
                   3689:     package. When packaging a new program, set MAINTAINER to yourself. If you
                   3690:     really can't maintain the package for future updates, set it to <
                   3691:     pkgsrc-users@NetBSD.org>.
                   3692: 
                   3693:   * HOMEPAGE is a URL where users can find more information about the package.
                   3694: 
                   3695:   * COMMENT is a one-line description of the package (should not include the
                   3696:     package name).
                   3697: 
                   3698: Other variables that affect the build:
                   3699: 
                   3700:   * WRKSRC: The directory where the interesting distribution files of the
                   3701:     package are found. The default is ${WRKDIR}/${DISTNAME}, which works for
                   3702:     most packages.
                   3703: 
                   3704:     If a package doesn't create a subdirectory for itself (most GNU software
                   3705:     does, for instance), but extracts itself in the current directory, you
                   3706:     should set WRKSRC=${WRKDIR}.
                   3707: 
                   3708:     If a package doesn't create a subdirectory with the name of DISTNAME but
                   3709:     some different name, set WRKSRC to point to the proper name in ${WRKDIR},
                   3710:     for example WRKSRC=${WRKDIR}/${DISTNAME}/unix. See lang/tcl and x11/tk for
                   3711:     other examples.
                   3712: 
                   3713:     The name of the working directory created by pkgsrc is taken from the
                   3714:     WRKDIR_BASENAME variable. By default, its value is work. If you want to use
                   3715:     the same pkgsrc tree for building different kinds of binary packages, you
                   3716:     can change the variable according to your needs. Two other variables handle
                   3717:     common cases of setting WRKDIR_BASENAME individually. If OBJHOSTNAME is
                   3718:     defined in /etc/mk.conf, the first component of the host's name is attached
                   3719:     to the directory name. If OBJMACHINE is defined, the platform name is
                   3720:     attached, which might look like work.i386 or work.sparc.
                   3721: 
                   3722: Please pay attention to the following gotchas:
                   3723: 
                   3724:   * Add MANCOMPRESSED if man pages are installed in compressed form by the
                   3725:     package. For packages using BSD-style makefiles which honor MANZ, there is
                   3726:     MANCOMPRESSED_IF_MANZ.
                   3727: 
                   3728:   * Replace /usr/local with "${PREFIX}" in all files (see patches, below).
                   3729: 
                   3730:   * If the package installs any info files, see Section 18.6.6, "Packages
                   3731:     installing info files".
                   3732: 
                   3733: 10.2. distinfo
                   3734: 
                   3735: The distinfo file contains the message digest, or checksum, of each distfile
                   3736: needed for the package. This ensures that the distfiles retrieved from the
                   3737: Internet have not been corrupted during transfer or altered by a malign force
                   3738: to introduce a security hole. Due to recent rumor about weaknesses of digest
                   3739: algorithms, all distfiles are protected using both SHA1 and RMD160 message
                   3740: digests, as well as the file size.
                   3741: 
                   3742: The distinfo file also contains the checksums for all the patches found in the
                   3743: patches directory (see Section 10.3, "patches/*").
                   3744: 
                   3745: To regenerate the distinfo file, use the make makedistinfo or make mdi command.
                   3746: 
                   3747: Some packages have different sets of distfiles depending on the platform, for
                   3748: example www/navigator). These are kept in the same distinfo file and care
                   3749: should be taken when upgrading such a package to ensure distfile information is
                   3750: not lost.
                   3751: 
                   3752: 10.3. patches/*
                   3753: 
                   3754: Many packages still don't work out-of-the box on the various platforms that are
                   3755: supported by pkgsrc. Therefore, a number of custom patch files are needed to
                   3756: make the package work. These patch files are found in the patches/ directory.
                   3757: 
                   3758: In the patch phase, these patches are applied to the files in WRKSRC directory
                   3759: after extracting them, in alphabetic order, so patch-aa is applied before
                   3760: patch-ab, etc.
                   3761: 
                   3762: 10.3.1. Structure of a single patch file
                   3763: 
                   3764: The patch-* files should be in diff -bu format, and apply without a fuzz to
                   3765: avoid problems. (To force patches to apply with fuzz you can set
                   3766: PATCH_FUZZ_FACTOR=-F2). Furthermore, each patch should contain only changes for
                   3767: a single file, and no file should be patched by more than one patch file. This
                   3768: helps to keep future modifications simple.
                   3769: 
                   3770: Each patch file is structured as follows: In the first line, there is the RCS
                   3771: Id of the patch itself. The second line should be empty for aesthetic reasons.
                   3772: After that, there should be a comment for each change that the patch does.
                   3773: There are a number of standard cases:
                   3774: 
                   3775:   * Patches that replace the == operator for test(1) with = in shell scripts
                   3776:     should contain a reference to , to avoid redundant explanations.
                   3777: 
                   3778:   * Patches for commonly known vulnerabilities should mention the vulnerability
                   3779:     ID (CAN, CVE).
                   3780: 
                   3781:   * Patches that change source code should mention the platform and other
                   3782:     environment (for example, the compiler) that the patch is needed for.
                   3783: 
                   3784: In all other cases, the patch should be commented so that any developer who
                   3785: knows the code of the application can make some use of the patch. Special care
                   3786: should be taken for the upstream developers, since we generally want that they
                   3787: accept our patches, so we have less work in the future.
                   3788: 
                   3789: 10.3.2. Creating patch files
                   3790: 
                   3791: One important thing to mention is to pay attention that no RCS IDs get stored
                   3792: in the patch files, as these will cause problems when later checked into the
                   3793: NetBSD CVS tree. Use the pkgdiff command from the pkgtools/pkgdiff package to
                   3794: avoid these problems.
                   3795: 
                   3796: For even more automation, we recommend using mkpatches from the same package to
                   3797: make a whole set of patches. You just have to backup files before you edit them
                   3798: to filename.orig, e.g. with cp -p filename filename.orig or, easier, by using
                   3799: pkgvi again from the same package. If you upgrade a package this way, you can
                   3800: easily compare the new set of patches with the previously existing one with
                   3801: patchdiff. Copy the patches you want to use or update from the work/.newpatches
                   3802: directory to patches/.
                   3803: 
                   3804: When you have finished a package, remember to generate the checksums for the
                   3805: patch files by using the make makepatchsum command, see Section 10.2,
                   3806: "distinfo".
                   3807: 
                   3808: When adding a patch that corrects a problem in the distfile (rather than e.g.
                   3809: enforcing pkgsrc's view of where man pages should go), send the patch as a bug
                   3810: report to the maintainer. This benefits non-pkgsrc users of the package, and
                   3811: usually makes it possible to remove the patch in future version.
                   3812: 
1.2     ! rillig   3813: The file names of the patch files are usually of the form patch-[a-z][a-z].
        !          3814: 
1.1       dsieger  3815: 10.3.3. Sources where the patch files come from
                   3816: 
                   3817: If you want to share patches between multiple packages in pkgsrc, e.g. because
                   3818: they use the same distfiles, set PATCHDIR to the path where the patch files can
                   3819: be found, e.g.:
                   3820: 
                   3821: PATCHDIR= ${.CURDIR}/../xemacs/patches
                   3822: 
                   3823: Patch files that are distributed by the author or other maintainers can be
                   3824: listed in PATCHFILES.
                   3825: 
                   3826: If it is desired to store any patches that should not be committed into pkgsrc,
                   3827: they can be kept outside the pkgsrc tree in the $LOCALPATCHES directory. The
                   3828: directory tree there is expected to have the same "category/package" structure
                   3829: as pkgsrc, and patches are expected to be stored inside these dirs (also known
                   3830: as $LOCALPATCHES/$PKGPATH). For example, if you want to keep a private patch
                   3831: for pkgsrc/graphics/png, keep it in $LOCALPATCHES/graphics/png/mypatch. All
                   3832: files in the named directory are expected to be patch files, and they are
                   3833: applied after pkgsrc patches are applied.
                   3834: 
                   3835: 10.3.4. Patching guidelines
                   3836: 
                   3837: When fixing a portability issue in the code do not use preprocessor magic to
                   3838: check for the current operating system nor platform. Doing so hurts portability
                   3839: to other platforms because the OS-specific details are not abstracted
                   3840: appropriately.
                   3841: 
                   3842: The general rule to follow is: instead of checking for the operating system the
                   3843: application is being built on, check for the specific features you need. For
                   3844: example, instead of assuming that kqueue is available under NetBSD and using
                   3845: the __NetBSD__ macro to conditionalize kqueue support, add a check that detects
                   3846: kqueue itself ? yes, this generally involves patching the configure script.
                   3847: There is absolutely nothing that prevents some OSes from adopting interfaces
                   3848: from other OSes (e.g. Linux implementing kqueue), something that the above
                   3849: checks cannot take into account.
                   3850: 
                   3851: Of course, checking for features generally involves more work on the
                   3852: developer's side, but the resulting changes are cleaner and there are chances
                   3853: they will work on many other platforms. Not to mention that there are higher
                   3854: chances of being later integrated into the mainstream sources. Remember: It
                   3855: doesn't work unless it is right!
                   3856: 
                   3857: Some typical examples:
                   3858: 
                   3859: Table 10.1. Patching examples
                   3860: 
                   3861: +-------------------------------------------------------------------------------------------+
                   3862: |  Where  |        Incorrect         |                       Correct                        |
                   3863: |---------+--------------------------+------------------------------------------------------|
                   3864: |         |case ${target_os} in      |                                                      |
                   3865: |configure|netbsd*) have_kvm=yes ;;  |AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)|
                   3866: |script   |*)       have_kvm=no  ;;  |                                                      |
                   3867: |         |esac                      |                                                      |
                   3868: |---------+--------------------------+------------------------------------------------------|
1.2     ! rillig   3869: |C source |#if defined(__NetBSD__)   |#if defined(HAVE_SYS_EVENT_H)                         |
        !          3870: |file     |#  include <sys/event.h>  |#  include <sys/event.h>                              |
        !          3871: |         |#endif                    |#endif                                                |
1.1       dsieger  3872: |---------+--------------------------+------------------------------------------------------|
                   3873: |         |int                       |int                                                   |
                   3874: |         |monitor_file(...)         |monitor_file(...)                                     |
                   3875: |         |{                         |{                                                     |
                   3876: |         |#if defined(__NetBSD__)   |#if defined(HAVE_KQUEUE)                              |
                   3877: |C source |        int fd = kqueue();|        int fd = kqueue();                            |
                   3878: |file     |        ...               |        ...                                           |
                   3879: |         |#else                     |#else                                                 |
                   3880: |         |        ...               |        ...                                           |
                   3881: |         |#endif                    |#endif                                                |
                   3882: |         |}                         |}                                                     |
                   3883: +-------------------------------------------------------------------------------------------+
                   3884: 
                   3885: 
                   3886: For more information, please read the Making packager-friendly software article
                   3887: (part 1, part 2). It summarizes multiple details on how to make software easier
                   3888: to package; all the suggestions in it were collected from our experience in
                   3889: pkgsrc work, so they are possibly helpful when creating patches too.
                   3890: 
                   3891: 10.3.5. Feedback to the author
                   3892: 
                   3893: Always, always, always feed back any portability fixes or improvements you do
                   3894: to a package to the mainstream developers. This is the only way to get their
                   3895: attention on portability issues and to ensure that future versions can be built
                   3896: out-of-the box on NetBSD. Furthermore, any user that gets newer distfiles will
                   3897: get the fixes straight from the packaged code.
                   3898: 
                   3899: This generally involves cleaning up the patches (because sometimes the patches
                   3900: that are added to pkgsrc are quick hacks), filling bug reports in the
                   3901: appropriate trackers for the projects and working with the mainstream authors
                   3902: to accept your changes. It is extremely important that you do it so that the
                   3903: packages in pkgsrc are kept simple and thus further changes can be done without
                   3904: much hassle.
                   3905: 
                   3906: Support the idea of free software!
                   3907: 
                   3908: 10.4. Other mandatory files
                   3909: 
                   3910: DESCR
                   3911: 
                   3912:     A multi-line description of the piece of software. This should include any
                   3913:     credits where they are due. Please bear in mind that others do not share
                   3914:     your sense of humour (or spelling idiosyncrasies), and that others will
                   3915:     read everything that you write here.
                   3916: 
                   3917: PLIST
                   3918: 
                   3919:     This file governs the files that are installed on your system: all the
                   3920:     binaries, manual pages, etc. There are other directives which may be
                   3921:     entered in this file, to control the creation and deletion of directories,
                   3922:     and the location of inserted files. See Chapter 12, PLIST issues for more
                   3923:     information.
                   3924: 
                   3925: 10.5. Optional files
                   3926: 
                   3927: 10.5.1. Files affecting the binary package
                   3928: 
                   3929: INSTALL
                   3930: 
                   3931:     This shell script is invoked twice by pkg_add(1). First time after package
                   3932:     extraction and before files are moved in place, the second time after the
                   3933:     files to install are moved in place. This can be used to do any custom
                   3934:     procedures not possible with @exec commands in PLIST. See pkg_add(1) and
                   3935:     pkg_create(1) for more information. See also Section 14.1, "Files and
                   3936:     directories outside the installation prefix".
                   3937: 
                   3938: DEINSTALL
                   3939: 
                   3940:     This script is executed before and after any files are removed. It is this
                   3941:     script's responsibility to clean up any additional messy details around the
                   3942:     package's installation, since all pkg_delete knows is how to delete the
                   3943:     files created in the original distribution. See pkg_delete(1) and
                   3944:     pkg_create(1) for more information.
                   3945: 
                   3946: MESSAGE
                   3947: 
                   3948:     This file is displayed after installation of the package. Useful for things
                   3949:     like legal notices on almost-free software and hints for updating config
                   3950:     files after installing modules for apache, PHP etc. Please note that you
                   3951:     can modify variables in it easily by using MESSAGE_SUBST in the package's
                   3952:     Makefile:
                   3953: 
                   3954:     MESSAGE_SUBST+=  SOMEVAR="somevalue"
                   3955: 
                   3956:     replaces "${SOMEVAR}" with "somevalue" in MESSAGE. By default, substitution
                   3957:     is performed for PKGNAME, PKGBASE, PREFIX, LOCALBASE, X11PREFIX, X11BASE,
                   3958:     PKG_SYSCONFDIR, ROOT_GROUP, and ROOT_GROUP.
                   3959: 
                   3960:     You can display a different or additional files by setting the MESSAGE_SRC
                   3961:     variable. Its default is MESSAGE, if the file exists.
                   3962: 
                   3963: ALTERNATIVES
                   3964: 
                   3965:     FIXME: There is no documentation on the alternatives framework.
                   3966: 
                   3967: 10.5.2. Files affecting the build process
                   3968: 
                   3969: Makefile.common
                   3970: 
                   3971:     This file contains arbitrary things that could also go into a Makefile, but
                   3972:     its purpose is to be used by more than one package. This file should only
                   3973:     be used when the packages that will use the file are known in advance. For
                   3974:     other purposes it is often better to write a *.mk file and give it a good
                   3975:     name that describes what it does.
                   3976: 
                   3977: buildlink3.mk
                   3978: 
                   3979:     This file contains the dependency information for the buildlink3 framework
                   3980:     (see Chapter 13, Buildlink methodology).
                   3981: 
                   3982: hacks.mk
                   3983: 
                   3984:     This file contains workarounds for compiler bugs and similar things. It is
                   3985:     included automatically by the pkgsrc infrastructure, so you don't need an
                   3986:     extra .include line for it.
                   3987: 
                   3988: options.mk
                   3989: 
                   3990:     This file contains the code for the package-specific options (see
                   3991:     Chapter 15, Options handling) that can be selected by the user. If a
                   3992:     package has only one or two options, it is equally acceptable to put the
                   3993:     code directly into the Makefile.
                   3994: 
                   3995: 10.5.3. Files affecting nothing at all
                   3996: 
                   3997: README*
                   3998: 
                   3999:     These files do not take place in the creation of a package and thus are
                   4000:     purely informative to the package developer.
                   4001: 
                   4002: TODO
                   4003: 
                   4004:     This file contains things that need to be done to make the package even
                   4005:     better.
                   4006: 
                   4007: 10.6. work*
                   4008: 
                   4009: When you type make, the distribution files are unpacked into the directory
                   4010: denoted by WRKDIR. It can be removed by running make clean. Besides the
                   4011: sources, this directory is also used to keep various timestamp files. The
                   4012: directory gets removed completely on clean. The default is ${.CURDIR}/work or $
                   4013: {.CURDIR}/work.${MACHINE_ARCH} if OBJMACHINE is set.
                   4014: 
                   4015: 10.7. files/*
                   4016: 
                   4017: If you have any files that you wish to be placed in the package prior to
                   4018: configuration or building, you could place these files here and use a ${CP}
                   4019: command in the "pre-configure" target to achieve this. Alternatively, you could
                   4020: simply diff the file against /dev/null and use the patch mechanism to manage
                   4021: the creation of this file.
                   4022: 
                   4023: If you want to share files in this way with other packages, set the FILESDIR
                   4024: variable to point to the other package's files directory, e.g.:
                   4025: 
                   4026: FILESDIR=${.CURDIR}/../xemacs/files
                   4027: 
                   4028: Chapter 11. Programming in Makefiles
                   4029: 
                   4030: Table of Contents
                   4031: 
                   4032: 11.1. Caveats
                   4033: 11.2. Makefile variables
                   4034: 
                   4035:     11.2.1. Naming conventions
                   4036: 
                   4037: 11.3. Code snippets
                   4038: 
                   4039:     11.3.1. Adding things to a list
                   4040:     11.3.2. Converting an internal list into an external list
                   4041:     11.3.3. Passing variables to a shell command
                   4042:     11.3.4. Quoting guideline
                   4043:     11.3.5. Workaround for a bug in BSD Make
                   4044: 
                   4045: Pkgsrc consists of many Makefile fragments, each of which forms a well-defined
                   4046: part of the pkgsrc system. Using the make(1) system as a programming language
                   4047: for a big system like pkgsrc requires some discipline to keep the code correct
                   4048: and understandable.
                   4049: 
                   4050: The basic ingredients for Makefile programming are variables (which are
                   4051: actually macros) and shell commands. Among these shell commands may even be
                   4052: more complex ones like awk(1) programs. To make sure that every shell command
                   4053: runs as intended it is necessary to quote all variables correctly when they are
                   4054: used.
                   4055: 
                   4056: This chapter describes some patterns, that appear quite often in Makefiles,
                   4057: including the pitfalls that come along with them.
                   4058: 
                   4059: 11.1. Caveats
                   4060: 
                   4061:   * When you are creating a file as a target of a rule, always write the data
                   4062:     to a temporary file first and finally rename that file. Otherwise there
                   4063:     might occur an error in the middle of generating the file, and when the
                   4064:     user runs make(1) for the second time, the file exists and will not be
                   4065:     regenerated properly. Example:
                   4066: 
                   4067:     wrong:
                   4068:             @echo "line 1" > ${.TARGET}
                   4069:             @echo "line 2" >> ${.TARGET}
                   4070:             @false
                   4071: 
                   4072:     correct:
                   4073:             @echo "line 1" > ${.TARGET}.tmp
                   4074:             @echo "line 2" >> ${.TARGET}.tmp
                   4075:             @false
                   4076:             @mv ${.TARGET}.tmp ${.TARGET}
                   4077: 
                   4078:     When you run make wrong twice, the file wrong will exist, although there
                   4079:     was an error message in the first run. On the other hand, running make
                   4080:     correct gives an error message twice, as expected.
                   4081: 
                   4082:     You might remember that make(1) sometimes removes ${.TARGET} in case of
                   4083:     error, but this only happens when it is interrupted, for example by
                   4084:     pressing ^C. This does not happen when one of the commands fails (like
                   4085:     false(1) above).
                   4086: 
                   4087: 11.2. Makefile variables
                   4088: 
                   4089: Makefile variables contain strings that can be processed using the five
                   4090: operators ``='', ``+='', ``?='', ``:='', and ``!='', which are described in the
                   4091: make(1) man page.
                   4092: 
                   4093: When a variable's value is parsed from a Makefile, the hash character ``#'' and
                   4094: the backslash character ``\'' are handled specially. If a backslash is followed
                   4095: by a newline, any whitespace immediately in front of the backslash, the
                   4096: backslash, the newline, and any whitespace immediately behind the newline are
                   4097: replaced with a single space. A backslash character and an immediately
                   4098: following hash character are replaced with a single hash character. Otherwise,
                   4099: the backslash is passed as is. In a variable assignment, any hash character
                   4100: that is not preceded by a backslash starts a comment that continues upto the
                   4101: end of the logical line.
                   4102: 
                   4103: Note: Because of this parsing algorithm the only way to create a variable
                   4104: consisting of a single backslash is using the ``!='' operator, for example:
                   4105: BACKSLASH!=echo "\\".
                   4106: 
                   4107: So far for defining variables. The other thing you can do with variables is
                   4108: evaluating them. A variable is evaluated when it is part of the right side of
                   4109: the ``:='' or the ``!='' operator, or directly before executing a shell command
                   4110: which the variable is part of. In all other cases, make(1) performs lazy
                   4111: evaluation, that is, variables are not evaluated until there's no other way.
                   4112: The ``modifiers'' mentioned in the man page also evaluate the variable.
                   4113: 
                   4114: Some of the modifiers split the string into words and then operate on the
                   4115: words, others operate on the string as a whole. When a string is split into
                   4116: words, it is split as you would expect it from sh(1).
                   4117: 
                   4118: No rule without exception?the .for loop does not follow the shell quoting rules
                   4119: but splits at sequences of whitespace.
                   4120: 
                   4121: There are several types of variables that should be handled differently.
                   4122: Strings and two types of lists.
                   4123: 
                   4124:   * Strings can contain arbitrary characters. Nevertheless, you should restrict
                   4125:     yourself to only using printable characters. Examples are PREFIX and
                   4126:     COMMENT.
                   4127: 
                   4128:   * Internal lists are lists that are never exported to any shell command.
                   4129:     Their elements are separated by whitespace. Therefore, the elements
                   4130:     themselves cannot have embedded whitespace. Any other characters are
                   4131:     allowed. Internal lists can be used in .for loops. Examples are DEPENDS and
                   4132:     BUILD_DEPENDS.
                   4133: 
                   4134:   * External lists are lists that may be exported to a shell command. Their
                   4135:     elements can contain any characters, including whitespace. That's why they
                   4136:     cannot be used in .for loops. Examples are DISTFILES and MASTER_SITES.
                   4137: 
                   4138: 11.2.1. Naming conventions
                   4139: 
                   4140:   * All variable names starting with an underscore are reserved for use by the
                   4141:     pkgsrc infrastructure. They shall not be used by package Makefiles.
                   4142: 
                   4143:   * In .for loops you should use lowercase variable names for the iteration
                   4144:     variables.
                   4145: 
                   4146:   * All list variables should have a ``plural'' name, e.g. PKG_OPTIONS or
                   4147:     DISTFILES.
                   4148: 
                   4149: 11.3. Code snippets
                   4150: 
                   4151: This section presents you with some code snippets you should use in your own
                   4152: code. If you don't find anything appropriate here, you should test your code
                   4153: and add it here.
                   4154: 
                   4155: 11.3.1. Adding things to a list
                   4156: 
                   4157: STRING=                 foo * bar `date`
                   4158: INT_LIST=               # empty
                   4159: ANOTHER_INT_LIST=       apache-[0-9]*:../../www/apache
                   4160: EXT_LIST=               # empty
                   4161: ANOTHER_EXT_LIST=       a=b c=d
                   4162: 
                   4163: INT_LIST+=              ${STRING}               # 1
                   4164: INT_LIST+=              ${ANOTHER_INT_LIST}     # 2
                   4165: EXT_LIST+=              ${STRING:Q}             # 3
                   4166: EXT_LIST+=              ${ANOTHER_EXT_LIST}     # 4
                   4167: 
                   4168: When you add a string to an external list (example 3), it must be quoted. In
                   4169: all other cases, you must not add a quoting level. You must not merge internal
                   4170: and external lists, unless you are sure that all entries are correctly
                   4171: interpreted in both lists.
                   4172: 
                   4173: 11.3.2. Converting an internal list into an external list
                   4174: 
                   4175: EXT_LIST=       # empty
                   4176: .for i in ${INT_LIST}
                   4177: EXT_LIST+=      ${i:Q}""
                   4178: .endfor
                   4179: 
                   4180: This code converts the internal list INT_LIST into the external list EXT_LIST.
                   4181: As the elements of an internal list are unquoted they must be quoted here. The
                   4182: reason for appending "" is explained below.
                   4183: 
                   4184: 11.3.3. Passing variables to a shell command
                   4185: 
                   4186: Sometimes you may want to print an arbitrary string. There are many ways to get
                   4187: it wrong and only few that can handle every nastiness.
                   4188: 
                   4189: STRING=         foo bar <    > * `date` $$HOME ' "
                   4190: EXT_LIST=       string=${STRING:Q} x=second\ item
                   4191: 
                   4192: all:
                   4193:         echo ${STRING}                  # 1
                   4194:         echo "${STRING}"                # 2
                   4195:         echo "${STRING:Q}"              # 3
                   4196:         echo ${STRING:Q}                # 4
                   4197:         echo x${STRING:Q} | sed 1s,.,,  # 5
                   4198:         printf "%s\\n" ${STRING:Q}""    # 6
                   4199:         env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
                   4200: 
                   4201: Example 1 leads to a syntax error in the shell, as the characters are just
                   4202: copied.
                   4203: 
                   4204: Example 2 leads to a syntax error too, and if you leave out the last "
                   4205: character from ${STRING}, date(1) will be executed. The $HOME shell variable
                   4206: would be evaluated, too.
                   4207: 
                   4208: Example 3 outputs each space character preceded by a backslash (or not),
                   4209: depending on the implementation of the echo(1) command.
                   4210: 
                   4211: Example 4 handles correctly every string that does not start with a dash. In
                   4212: that case, the result depends on the implementation of the echo(1) command. As
                   4213: long as you can guarantee that your input does not start with a dash, this form
                   4214: is appropriate.
                   4215: 
                   4216: Example 5 handles even the case of a leading dash correctly.
                   4217: 
                   4218: Example 6 also works with every string and is the light-weight solution, since
                   4219: it does not involve a pipe, which has its own problems.
                   4220: 
                   4221: The EXT_LIST does not need to be quoted because the quoting has already been
                   4222: done when adding elements to the list.
                   4223: 
                   4224: As internal lists shall not be passed to the shell, there is no example for it.
                   4225: 
                   4226: 11.3.4. Quoting guideline
                   4227: 
                   4228: There are many possible sources of wrongly quoted variables. This section lists
                   4229: some of the commonly known ones.
                   4230: 
                   4231:   * Whenever you use the value of a list, think about what happens to leading
                   4232:     or trailing whitespace. If the list is a well-formed shell expression, you
                   4233:     can apply the :M* modifier to strip leading and trailing whitespace from
                   4234:     each word. The :M operator first splits its argument according to the rules
                   4235:     of the shell, and then creates a new list consisting of all words that
                   4236:     match the shell glob expression *, that is: all. One class of situations
                   4237:     where this is needed is when adding a variable like CPPFLAGS to
                   4238:     CONFIGURE_ARGS. If the configure script invokes other configure scripts, it
                   4239:     strips the leading and trailing whitespace from the variable and then
                   4240:     passes it to the other configure scripts. But these configure scripts
                   4241:     expect the (child) CPPFLAGS variable to be the same as the parent CPPFLAGS.
                   4242:     That's why we better pass the CPPFLAGS value properly trimmed. And here is
                   4243:     how we do it:
                   4244: 
                   4245:     CPPFLAGS=               # empty
                   4246:     CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX:Q}\"
                   4247:     CPPFLAGS+=              ${MY_CPPFLAGS}
                   4248: 
                   4249:     CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
                   4250: 
                   4251:     all:
                   4252:             echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
                   4253:             echo x${CONFIGURE_ARGS}x        # properly trimmed
                   4254: 
                   4255:   * The example above contains one bug: The ${PREFIX} is a properly quoted
                   4256:     shell expression, but there is the C compiler after it, which also expects
                   4257:     a properly quoted string (this time in C syntax). The version above is
                   4258:     therefore only correct if ${PREFIX} does not have embedded backslashes or
                   4259:     double quotes. If you want to allow these, you have to add another layer of
                   4260:     quoting to each variable that is used as a C string literal. You cannot use
                   4261:     the :Q operator for it, as this operator only works for the shell.
                   4262: 
                   4263:   * Whenever a variable can be empty, the :Q operator can have surprising
                   4264:     results. Here are two completely different cases which can be solved with
                   4265:     the same trick.
                   4266: 
                   4267:     EMPTY=                  # empty
                   4268:     empty_test:
                   4269:             for i in a ${EMPTY:Q} c; do \
                   4270:                 echo "$$i"; \
                   4271:             done
                   4272: 
                   4273:     for_test:
                   4274:     .for i in a:\ a:\test.txt
                   4275:             echo ${i:Q}
                   4276:             echo "foo"
                   4277:     .endfor
                   4278: 
                   4279:     The first example will only print two of the three lines we might have
                   4280:     expected. This is because ${EMPTY:Q} expands to the empty string, which the
                   4281:     shell cannot see. The workaround is to write ${EMPTY:Q}"". This pattern can
                   4282:     be often found as ${TEST} -z ${VAR:Q} or as ${TEST} -f ${FNAME:Q} (both of
                   4283:     these are wrong).
                   4284: 
                   4285:     The second example will only print three lines instead of four. The first
                   4286:     line looks like a:\ echo foo. This is because the backslash of the value a:
                   4287:     \ is interpreted as a line-continuation by make(1), which makes the second
                   4288:     line the arguments of the echo(1) command from the first line. To avoid
                   4289:     this, write ${i:Q}"".
                   4290: 
                   4291: 11.3.5. Workaround for a bug in BSD Make
                   4292: 
                   4293: The pkgsrc bmake program does not handle the following assignment correctly. In
                   4294: case _othervar_ contains a ``-'' character, one of the closing braces is
                   4295: included in ${VAR} after this code executes.
                   4296: 
                   4297: VAR:=   ${VAR:N${_othervar_:C/-//}}
                   4298: 
                   4299: For a more complex code snippet and a workaround, see the package regress/
                   4300: make-quoting, testcase bug1.
                   4301: 
                   4302: Chapter 12. PLIST issues
                   4303: 
                   4304: Table of Contents
                   4305: 
                   4306: 12.1. RCS ID
                   4307: 12.2. Semi-automatic PLIST generation
                   4308: 12.3. Tweaking output of make print-PLIST
                   4309: 12.4. Variable substitution in PLIST
                   4310: 12.5. Man page compression
                   4311: 12.6. Changing PLIST source with PLIST_SRC
                   4312: 12.7. Platform-specific and differing PLISTs
                   4313: 12.8. Sharing directories between packages
                   4314: 
                   4315: The PLIST file contains a package's "packing list", i.e. a list of files that
                   4316: belong to the package (relative to the ${PREFIX} directory it's been installed
                   4317: in) plus some additional statements - see the pkg_create(1) man page for a full
                   4318: list. This chapter addresses some issues that need attention when dealing with
                   4319: the PLIST file (or files, see below!).
                   4320: 
                   4321: 12.1. RCS ID
                   4322: 
                   4323: Be sure to add a RCS ID line as the first thing in any PLIST file you write:
                   4324: 
1.2     ! rillig   4325: @comment $NetBSD$
1.1       dsieger  4326: 
                   4327: 
                   4328: 12.2. Semi-automatic PLIST generation
                   4329: 
                   4330: You can use the make print-PLIST command to output a PLIST that matches any new
                   4331: files since the package was extracted. See Section 16.17, "Other helpful
                   4332: targets" for more information on this target.
                   4333: 
                   4334: 12.3. Tweaking output of make print-PLIST
                   4335: 
                   4336: If you have used any of the *-dirs packages, as explained in Section 12.8,
                   4337: "Sharing directories between packages", you may have noticed that make
                   4338: print-PLIST outputs a set of @comments instead of real @dirrm lines. You can
                   4339: also do this for specific directories and files, so that the results of that
                   4340: command are very close to reality. This helps a lot during the update of
                   4341: packages.
                   4342: 
                   4343: The PRINT_PLIST_AWK variable takes a set of AWK patterns and actions that are
                   4344: used to filter the output of print-PLIST. You can append any chunk of AWK
                   4345: scripting you like to it, but be careful with quoting.
                   4346: 
                   4347: For example, to get all files inside the libdata/foo directory removed from the
                   4348: resulting PLIST:
                   4349: 
                   4350: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
                   4351: 
                   4352: 
                   4353: And to get all the @dirrm lines referring to a specific (shared) directory
                   4354: converted to @comments:
                   4355: 
                   4356: PRINT_PLIST_AWK+=       /^@dirrm share\/specific/ { print "@comment " $$0; next; }
                   4357: 
                   4358: 
                   4359: 12.4. Variable substitution in PLIST
                   4360: 
                   4361: A number of variables are substituted automatically in PLISTs when a package is
                   4362: installed on a system. This includes the following variables:
                   4363: 
                   4364: ${MACHINE_ARCH}, ${MACHINE_GNU_ARCH}
                   4365: 
                   4366:     Some packages like emacs and perl embed information about which
                   4367:     architecture they were built on into the pathnames where they install their
                   4368:     files. To handle this case, PLIST will be preprocessed before actually
                   4369:     used, and the symbol "${MACHINE_ARCH}" will be replaced by what uname -p
                   4370:     gives. The same is done if the string ${MACHINE_GNU_ARCH} is embedded in
                   4371:     PLIST somewhere - use this on packages that have GNU autoconf-created
                   4372:     configure scripts.
                   4373: 
                   4374:     Legacy note
                   4375: 
                   4376:     There used to be a symbol "$ARCH" that was replaced by the output of uname
                   4377:     -m, but that's no longer supported and has been removed.
                   4378: 
                   4379: ${OPSYS}, ${LOWER_OPSYS}, ${OS_VERSION}
                   4380: 
                   4381:     Some packages want to embed the OS name and version into some paths. To do
                   4382:     this, use these variables in the PLIST:
                   4383: 
                   4384:       * ${OPSYS} - output of "uname -s"
                   4385: 
                   4386:       * ${LOWER_OPSYS} - lowercase common name (eg. "solaris")
                   4387: 
                   4388:       * ${OS_VERSION} - "uname -r"
                   4389: 
                   4390: For a complete list of values which are replaced by default, please look in
                   4391: bsd.pkg.mk (and search for PLIST_SUBST).
                   4392: 
                   4393: If you want to change other variables not listed above, you can add variables
                   4394: and their expansions to this variable in the following way, similar to
                   4395: MESSAGE_SUBST (see Section 10.5, "Optional files"):
                   4396: 
                   4397: PLIST_SUBST+=   SOMEVAR="somevalue"
                   4398: 
                   4399: 
                   4400: This replaces all occurrences of "${SOMEVAR}" in the PLIST with "somevalue".
                   4401: 
                   4402: 12.5. Man page compression
                   4403: 
                   4404: Man pages should be installed in compressed form if MANZ is set (in
                   4405: bsd.own.mk), and uncompressed otherwise. To handle this in the PLIST file, the
                   4406: suffix ".gz" is appended/removed automatically for man pages according to MANZ
                   4407: and MANCOMPRESSED being set or not, see above for details. This modification of
                   4408: the PLIST file is done on a copy of it, not PLIST itself.
                   4409: 
                   4410: 12.6. Changing PLIST source with PLIST_SRC
                   4411: 
                   4412: To use one or more files as source for the PLIST used in generating the binary
                   4413: package, set the variable PLIST_SRC to the names of that file(s). The files are
                   4414: later concatenated using cat(1), and the order of things is important. The
                   4415: default for PLIST_SRC is ${PKGDIR}/PLIST.
                   4416: 
                   4417: 12.7. Platform-specific and differing PLISTs
                   4418: 
                   4419: Some packages decide to install a different set of files based on the operating
                   4420: system being used. These differences can be automatically handled by using the
                   4421: following files:
                   4422: 
                   4423:   * PLIST.common
                   4424: 
                   4425:   * PLIST.${OPSYS}
                   4426: 
                   4427:   * PLIST.${MACHINE_ARCH}
                   4428: 
                   4429:   * PLIST.${OPSYS}-${MACHINE_ARCH}
                   4430: 
                   4431:   * PLIST.common_end
                   4432: 
                   4433: 12.8. Sharing directories between packages
                   4434: 
                   4435: A "shared directory" is a directory where multiple (and unrelated) packages
                   4436: install files. These directories are problematic because you have to add
                   4437: special tricks in the PLIST to conditionally remove them, or have some
                   4438: centralized package handle them.
                   4439: 
                   4440: Within pkgsrc, you'll find both approaches. If a directory is shared by a few
                   4441: unrelated packages, it's often not worth to add an extra package to remove it.
                   4442: Therefore, one simply does:
                   4443: 
                   4444: @unexec ${RMDIR} %D/path/to/shared/directory 2>/dev/null || ${TRUE}
                   4445: 
                   4446: 
                   4447: in the PLISTs of all affected packages, instead of the regular "@dirrm" line.
                   4448: 
                   4449: However, if the directory is shared across many packages, two different
                   4450: solutions are available:
                   4451: 
                   4452:  1. If the packages have a common dependency, the directory can be removed in
                   4453:     that. For example, see textproc/scrollkeeper, which removes the shared
                   4454:     directory share/omf.
                   4455: 
                   4456:  2. If the packages using the directory are not related at all (they have no
                   4457:     common dependencies), a *-dirs package is used.
                   4458: 
                   4459: From now on, we'll discuss the second solution. To get an idea of the *-dirs
                   4460: packages available, issue:
                   4461: 
                   4462: % cd .../pkgsrc
                   4463: % ls -d */*-dirs
                   4464: 
                   4465: 
                   4466: Their use from other packages is very simple. The USE_DIRS variable takes a
                   4467: list of package names (without the "-dirs" part) together with the required
                   4468: version number (always pick the latest one when writing new packages).
                   4469: 
                   4470: For example, if a package installs files under share/applications, it should
                   4471: have the following line in it:
                   4472: 
                   4473: USE_DIRS+=      xdg-1.1
                   4474: 
                   4475: 
                   4476: After regenerating the PLIST using make print-PLIST, you should get the right
                   4477: (commented out) lines.
                   4478: 
                   4479: Note that even if your package is using $X11BASE, it must not depend on the
                   4480: *-x11-dirs packages. Just specify the name without that part and pkgsrc (in
                   4481: particular, mk/dirs.mk) will take care of it.
                   4482: 
                   4483: Chapter 13. Buildlink methodology
                   4484: 
                   4485: Table of Contents
                   4486: 
                   4487: 13.1. Converting packages to use buildlink3
                   4488: 13.2. Writing buildlink3.mk files
                   4489: 
                   4490:     13.2.1. Anatomy of a buildlink3.mk file
                   4491:     13.2.2. Updating BUILDLINK_API_DEPENDS.pkg in buildlink3.mk files
                   4492: 
                   4493: 13.3. Writing builtin.mk files
                   4494: 
                   4495:     13.3.1. Anatomy of a builtin.mk file
                   4496:     13.3.2. Global preferences for native or pkgsrc software
                   4497: 
                   4498: Buildlink is a framework in pkgsrc that controls what headers and libraries are
                   4499: seen by a package's configure and build processes. This is implemented in a two
                   4500: step process:
                   4501: 
                   4502:  1. Symlink headers and libraries for dependencies into BUILDLINK_DIR, which by
                   4503:     default is a subdirectory of WRKDIR.
                   4504: 
                   4505:  2. Create wrapper scripts that are used in place of the normal compiler tools
                   4506:     that translate -I${LOCALBASE}/include and -L${LOCALBASE}/lib into
                   4507:     references to BUILDLINK_DIR. The wrapper scripts also make native compiler
                   4508:     on some operating systems look like GCC, so that packages that expect GCC
                   4509:     won't require modifications to build with those native compilers.
                   4510: 
                   4511: This normalizes the environment in which a package is built so that the package
                   4512: may be built consistently despite what other software may be installed. Please
                   4513: note that the normal system header and library paths, e.g. /usr/include, /usr/
                   4514: lib, etc., are always searched -- buildlink3 is designed to insulate the
                   4515: package build from non-system-supplied software.
                   4516: 
                   4517: 13.1. Converting packages to use buildlink3
                   4518: 
                   4519: The process of converting packages to use the buildlink3 framework
                   4520: ("bl3ifying") is fairly straightforward. The things to keep in mind are:
                   4521: 
                   4522:  1. Ensure that the build always calls the wrapper scripts instead of the
                   4523:     actual toolchain. Some packages are tricky, and the only way to know for
                   4524:     sure is the check ${WRKDIR}/.work.log to see if the wrappers are being
                   4525:     invoked.
                   4526: 
                   4527:  2. Don't override PREFIX from within the package Makefile, e.g. Java VMs,
                   4528:     standalone shells, etc., because the code to symlink files into $
                   4529:     {BUILDLINK_DIR} looks for files relative to "pkg_info -qp pkgname".
                   4530: 
                   4531:  3. Remember that only the buildlink3.mk files that you list in a package's
                   4532:     Makefile are added as dependencies for that package.
                   4533: 
                   4534: If a dependency on a particular package is required for its libraries and
                   4535: headers, then we replace:
                   4536: 
                   4537: DEPENDS+=       foo>=1.1.0:../../category/foo
                   4538: 
                   4539: with
                   4540: 
                   4541: .include "../../category/foo/buildlink3.mk"
                   4542: 
                   4543: The buildlink3.mk files usually define the required dependencies. If you need a
                   4544: newer version of the dependency when using buildlink3.mk files, then you can
                   4545: define it in your Makefile; for example:
                   4546: 
                   4547: BUILDLINK_API_DEPENDS.foo+=   foo>=1.1.0
                   4548: .include "../../category/foo/buildlink3.mk"
                   4549: 
                   4550: There are several buildlink3.mk files in pkgsrc/mk that handle special package
                   4551: issues:
                   4552: 
                   4553:   * bdb.buildlink3.mk chooses either the native or a pkgsrc Berkeley DB
                   4554:     implementation based on the values of BDB_ACCEPTED and BDB_DEFAULT.
                   4555: 
                   4556:   * curses.buildlink3.mk: If the system comes with neither Curses nor NCurses,
                   4557:     this will take care to install the devel/ncurses package.
                   4558: 
                   4559:   * krb5.buildlink3.mk uses the value of KRB5_ACCEPTED to choose between adding
                   4560:     a dependency on Heimdal or MIT-krb5 for packages that require a Kerberos 5
                   4561:     implementation.
                   4562: 
                   4563:   * motif.buildlink3.mk checks for a system-provided Motif installation or adds
                   4564:     a dependency on x11/lesstif or x11/openmotif. The user can set MOTIF_TYPE
                   4565:     to "dt", "lesstif", or "openmotif" to choose which Motif version will be
                   4566:     used.
                   4567: 
                   4568:   * oss.buildlink3.mk defines several variables that may be used by packages
                   4569:     that use the Open Sound System (OSS) API.
                   4570: 
                   4571:   * pgsql.buildlink3.mk will accept either Postgres 8.0, 8.1, or 8.2, whichever
                   4572:     is found installed. See the file for more information.
                   4573: 
                   4574:   * pthread.buildlink3.mk uses the value of PTHREAD_OPTS and checks for native
                   4575:     pthreads or adds a dependency on devel/pth as needed.
                   4576: 
                   4577:   * xaw.buildlink3.mk uses the value of XAW_TYPE to choose a particular Athena
                   4578:     widgets library.
                   4579: 
                   4580: The comments in those buildlink3.mk files provide a more complete description
                   4581: of how to use them properly.
                   4582: 
                   4583: 13.2. Writing buildlink3.mk files
                   4584: 
                   4585: A package's buildlink3.mk file is included by Makefiles to indicate the need to
                   4586: compile and link against header files and libraries provided by the package. A
                   4587: buildlink3.mk file should always provide enough information to add the correct
                   4588: type of dependency relationship and include any other buildlink3.mk files that
                   4589: it needs to find headers and libraries that it needs in turn.
                   4590: 
                   4591: To generate an initial buildlink3.mk file for further editing, Rene Hexel's
                   4592: pkgtools/createbuildlink package is highly recommended. For most packages, the
                   4593: following command will generate a good starting point for buildlink3.mk files:
                   4594: 
                   4595: % cd pkgsrc/category/pkgdir
                   4596: % createbuildlink >buildlink3.mk
                   4597: 
                   4598: 
                   4599: 13.2.1. Anatomy of a buildlink3.mk file
                   4600: 
                   4601: The following real-life example buildlink3.mk is taken from pkgsrc/graphics/
                   4602: tiff:
                   4603: 
1.2     ! rillig   4604: # $NetBSD: buildlink3.mk,v 1.7 2004/03/18 09:12:12 jlam Exp $
1.1       dsieger  4605: 
                   4606: BUILDLINK_DEPTH:=       ${BUILDLINK_DEPTH}+
                   4607: TIFF_BUILDLINK3_MK:=    ${TIFF_BUILDLINK3_MK}+
                   4608: 
                   4609: .if ${BUILDLINK_DEPTH} == "+"
                   4610: BUILDLINK_DEPENDS+=     tiff
                   4611: .endif
                   4612: 
                   4613: BUILDLINK_PACKAGES:=    ${BUILDLINK_PACKAGES:Ntiff}
                   4614: BUILDLINK_PACKAGES+=    tiff
                   4615: 
                   4616: .if ${TIFF_BUILDLINK3_MK} == "+"
                   4617: BUILDLINK_API_DEPENDS.tiff+=        tiff>=3.6.1
                   4618: BUILDLINK_PKGSRCDIR.tiff?=      ../../graphics/tiff
                   4619: .endif  # TIFF_BUILDLINK3_MK
                   4620: 
                   4621: .include "../../devel/zlib/buildlink3.mk"
                   4622: .include "../../graphics/jpeg/buildlink3.mk"
                   4623: 
                   4624: BUILDLINK_DEPTH:=       ${BUILDLINK_DEPTH:S/+$//}
                   4625: 
                   4626: The header and footer manipulate BUILDLINK_DEPTH, which is common across all
                   4627: buildlink3.mk files and is used to track at what depth we are including
                   4628: buildlink3.mk files.
                   4629: 
                   4630: The first section controls if the dependency on pkg is added. BUILDLINK_DEPENDS
                   4631: is the global list of packages for which dependencies are added by buildlink3.
                   4632: 
                   4633: The second section advises pkgsrc that the buildlink3.mk file for pkg has been
                   4634: included at some point. BUILDLINK_PACKAGES is the global list of packages for
                   4635: which buildlink3.mk files have been included. It must always be appended to
                   4636: within a buildlink3.mk file.
                   4637: 
                   4638: The third section is protected from multiple inclusion and controls how the
                   4639: dependency on pkg is added. Several important variables are set in the section:
                   4640: 
                   4641:   * BUILDLINK_API_DEPENDS.pkg is the actual dependency recorded in the
                   4642:     installed package; this should always be set using += to ensure that we're
                   4643:     appending to any pre-existing list of values. This variable should be set
                   4644:     to the first version of the package that had an API change.
                   4645: 
                   4646:   * BUILDLINK_PKGSRCDIR.pkg is the location of the pkg pkgsrc directory.
                   4647: 
                   4648:   * BUILDLINK_DEPMETHOD.pkg (not shown above) controls whether we use
                   4649:     BUILD_DEPENDS or DEPENDS to add the dependency on pkg. The build dependency
                   4650:     is selected by setting BUILDLINK_DEPMETHOD.pkg to "build". By default, the
                   4651:     full dependency is used.
                   4652: 
                   4653:   * BUILDLINK_INCDIRS.pkg and BUILDLINK_LIBDIRS.pkg (not shown above) are lists
                   4654:     of subdirectories of ${BUILDLINK_PREFIX.pkg} to add to the header and
                   4655:     library search paths. These default to "include" and "lib" respectively.
                   4656: 
                   4657:   * BUILDLINK_CPPFLAGS.pkg (not shown above) is the list of preprocessor flags
                   4658:     to add to CPPFLAGS, which are passed on to the configure and build phases.
                   4659:     The "-I" option should be avoided and instead be handled using
                   4660:     BUILDLINK_INCDIRS.pkg as above.
                   4661: 
                   4662: The following variables are all optionally defined within this second section
                   4663: (protected against multiple inclusion) and control which package files are
                   4664: symlinked into ${BUILDLINK_DIR} and how their names are transformed during the
                   4665: symlinking:
                   4666: 
                   4667:   * BUILDLINK_FILES.pkg (not shown above) is a shell glob pattern relative to $
                   4668:     {BUILDLINK_PREFIX.pkg} to be symlinked into ${BUILDLINK_DIR}, e.g. include/
                   4669:     *.h.
                   4670: 
                   4671:   * BUILDLINK_FILES_CMD.pkg (not shown above) is a shell pipeline that outputs
                   4672:     to stdout a list of files relative to ${BUILDLINK_PREFIX.pkg}. The
                   4673:     resulting files are to be symlinked into ${BUILDLINK_DIR}. By default, this
                   4674:     takes the +CONTENTS of a pkg and filters it through $
                   4675:     {BUILDLINK_CONTENTS_FILTER.pkg}.
                   4676: 
                   4677:   * BUILDLINK_CONTENTS_FILTER.pkg (not shown above) is a filter command that
                   4678:     filters +CONTENTS input into a list of files relative to $
                   4679:     {BUILDLINK_PREFIX.pkg} on stdout. By default for overwrite packages,
                   4680:     BUILDLINK_CONTENTS_FILTER.pkg outputs the contents of the include and lib
                   4681:     directories in the package +CONTENTS, and for pkgviews packages, it outputs
                   4682:     any libtool archives in lib directories.
                   4683: 
                   4684:   * BUILDLINK_FNAME_TRANSFORM.pkg (not shown above) is a list of sed arguments
                   4685:     used to transform the name of the source filename into a destination
                   4686:     filename, e.g. -e "s|/curses.h|/ncurses.h|g".
                   4687: 
                   4688: The last section includes any buildlink3.mk needed for pkg's library
                   4689: dependencies. Including these buildlink3.mk files means that the headers and
                   4690: libraries for these dependencies are also symlinked into ${BUILDLINK_DIR}
                   4691: whenever the pkg buildlink3.mk file is included.
                   4692: 
                   4693: 13.2.2. Updating BUILDLINK_API_DEPENDS.pkg in buildlink3.mk files
                   4694: 
                   4695: The situation that requires increasing the dependency listed in
                   4696: BUILDLINK_API_DEPENDS.pkg after a package update is when the API or interface
                   4697: to the header files change.
                   4698: 
                   4699: In this case, BUILDLINK_API_DEPENDS.pkg should be adjusted to require at least
                   4700: the new package version. In some cases, the packages that depend on this new
                   4701: version may need their PKGREVISIONs increased and, if they have buildlink3.mk
                   4702: files, their BUILDLINK_API_DEPENDS.pkg adjusted, too. This is needed so pkgsrc
                   4703: will require the correct package dependency and not settle for an older one
                   4704: when building the source.
                   4705: 
                   4706: BUILDLINK_ABI_DEPENDS.pkg should be increased when the binary interface or
                   4707: sonames (major number of the library version) of any installed shared libraries
                   4708: change. This is needed so that binary packages made using it will require the
                   4709: correct package dependency and not settle for an older one which will not
                   4710: contain the necessary shared libraries.
                   4711: 
                   4712: See Section 18.1.6, "Handling dependencies" for more information about
                   4713: dependencies on other packages, including the BUILDLINK_ABI_DEPENDS and
                   4714: ABI_DEPENDS definitions.
                   4715: 
                   4716: Please take careful consideration before adjusting BUILDLINK_API_DEPENDS.pkg or
                   4717: BUILDLINK_ABI_DEPENDS.pkg as we don't want to cause unneeded package deletions
                   4718: and rebuilds. In many cases, new versions of packages work just fine with older
                   4719: dependencies.
                   4720: 
                   4721: Also it is not needed to set BUILDLINK_ABI_DEPENDS.pkg when it is identical to
                   4722: BUILDLINK_API_DEPENDS.pkg.
                   4723: 
                   4724: 13.3. Writing builtin.mk files
                   4725: 
                   4726: Some packages in pkgsrc install headers and libraries that coincide with
                   4727: headers and libraries present in the base system. Aside from a buildlink3.mk
                   4728: file, these packages should also include a builtin.mk file that includes the
                   4729: necessary checks to decide whether using the built-in software or the pkgsrc
                   4730: software is appropriate.
                   4731: 
                   4732: The only requirements of a builtin.mk file for pkg are:
                   4733: 
                   4734:  1. It should set USE_BUILTIN.pkg to either "yes" or "no" after it is included.
                   4735: 
                   4736:  2. It should not override any USE_BUILTIN.pkg which is already set before the
                   4737:     builtin.mk file is included.
                   4738: 
                   4739:  3. It should be written to allow multiple inclusion. This is very important
                   4740:     and takes careful attention to Makefile coding.
                   4741: 
                   4742: 13.3.1. Anatomy of a builtin.mk file
                   4743: 
                   4744: The following is the recommended template for builtin.mk files:
                   4745: 
                   4746: .if !defined(IS_BUILTIN.foo)
                   4747: #
                   4748: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   4749: # genuinely exists in the system or not.
                   4750: #
                   4751: IS_BUILTIN.foo?=        no
                   4752: 
                   4753: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   4754: # version can be determined.
                   4755: #
                   4756: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   4757: BUILTIN_PKG.foo?=       foo-1.0
                   4758: .  endif
                   4759: .endif  # IS_BUILTIN.foo
                   4760: 
                   4761: .if !defined(USE_BUILTIN.foo)
                   4762: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   4763: .  if defined(BUILTIN_PKG.foo)
                   4764: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   4765: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   4766: USE_BUILTIN.foo!=                                                       \
                   4767:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
                   4768:         && ${ECHO} "yes" || ${ECHO} "no"
                   4769: .      endif
                   4770: .    endfor
                   4771: .  endif
                   4772: .endif  # USE_BUILTIN.foo
                   4773: 
                   4774: CHECK_BUILTIN.foo?=     no
                   4775: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   4776: #
                   4777: # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   4778: # "yes" or "no".
                   4779: #
                   4780: .endif  # CHECK_BUILTIN.foo
                   4781: 
                   4782: The first section sets IS_BUILTIN.pkg depending on if pkg really exists in the
                   4783: base system. This should not be a base system software with similar
                   4784: functionality to pkg; it should only be "yes" if the actual package is included
                   4785: as part of the base system. This variable is only used internally within the
                   4786: builtin.mk file.
                   4787: 
                   4788: The second section sets BUILTIN_PKG.pkg to the version of pkg in the base
                   4789: system if it exists (if IS_BUILTIN.pkg is "yes"). This variable is only used
                   4790: internally within the builtin.mk file.
                   4791: 
                   4792: The third section sets USE_BUILTIN.pkg and is required in all builtin.mk files.
                   4793: The code in this section must make the determination whether the built-in
                   4794: software is adequate to satisfy the dependencies listed in
                   4795: BUILDLINK_API_DEPENDS.pkg. This is typically done by comparing BUILTIN_PKG.pkg
                   4796: against each of the dependencies in BUILDLINK_API_DEPENDS.pkg. USE_BUILTIN.pkg
                   4797: must be set to the correct value by the end of the builtin.mk file. Note that
                   4798: USE_BUILTIN.pkg may be "yes" even if IS_BUILTIN.pkg is "no" because we may make
                   4799: the determination that the built-in version of the software is similar enough
                   4800: to be used as a replacement.
                   4801: 
                   4802: The last section is guarded by CHECK_BUILTIN.pkg, and includes code that uses
                   4803: the value of USE_BUILTIN.pkg set in the previous section. This typically
                   4804: includes, e.g., adding additional dependency restrictions and listing
                   4805: additional files to symlink into ${BUILDLINK_DIR} (via BUILDLINK_FILES.pkg).
                   4806: 
                   4807: 13.3.2. Global preferences for native or pkgsrc software
                   4808: 
                   4809: When building packages, it's possible to choose whether to set a global
                   4810: preference for using either the built-in (native) version or the pkgsrc version
                   4811: of software to satisfy a dependency. This is controlled by setting
                   4812: PREFER_PKGSRC and PREFER_NATIVE. These variables take values of either "yes",
                   4813: "no", or a list of packages. PREFER_PKGSRC tells pkgsrc to use the pkgsrc
                   4814: versions of software, while PREFER_NATIVE tells pkgsrc to use the built-in
                   4815: versions. Preferences are determined by the most specific instance of the
                   4816: package in either PREFER_PKGSRC or PREFER_NATIVE. If a package is specified in
                   4817: neither or in both variables, then PREFER_PKGSRC has precedence over
                   4818: PREFER_NATIVE. For example, to require using pkgsrc versions of software for
                   4819: all but the most basic bits on a NetBSD system, you can set:
                   4820: 
                   4821: PREFER_PKGSRC=  yes
                   4822: PREFER_NATIVE=  getopt skey tcp_wrappers
                   4823: 
                   4824: A package must have a builtin.mk file to be listed in PREFER_NATIVE, otherwise
                   4825: it is simply ignored in that list.
                   4826: 
                   4827: Chapter 14. The pkginstall framework
                   4828: 
                   4829: Table of Contents
                   4830: 
                   4831: 14.1. Files and directories outside the installation prefix
                   4832: 
                   4833:     14.1.1. Directory manipulation
                   4834:     14.1.2. File manipulation
                   4835: 
                   4836: 14.2. Configuration files
                   4837: 
                   4838:     14.2.1. How PKG_SYSCONFDIR is set
                   4839:     14.2.2. Telling the software where configuration files are
                   4840:     14.2.3. Patching installations
                   4841:     14.2.4. Disabling handling of configuration files
                   4842: 
                   4843: 14.3. System startup scripts
                   4844: 
                   4845:     14.3.1. Disabling handling of system startup scripts
                   4846: 
                   4847: 14.4. System users and groups
                   4848: 14.5. System shells
                   4849: 
                   4850:     14.5.1. Disabling shell registration
                   4851: 
                   4852: 14.6. Fonts
                   4853: 
                   4854:     14.6.1. Disabling automatic update of the fonts databases
                   4855: 
                   4856: This chapter describes the framework known as pkginstall, whose key features
                   4857: are:
                   4858: 
                   4859:   * Generic installation and manipulation of directories and files outside the
                   4860:     pkgsrc-handled tree, LOCALBASE.
                   4861: 
                   4862:   * Automatic handling of configuration files during installation, provided
                   4863:     that packages are correctly designed.
                   4864: 
                   4865:   * Generation and installation of system startup scripts.
                   4866: 
                   4867:   * Registration of system users and groups.
                   4868: 
                   4869:   * Registration of system shells.
                   4870: 
                   4871:   * Automatic updating of fonts databases.
                   4872: 
                   4873: The following sections inspect each of the above points in detail.
                   4874: 
                   4875: You may be thinking that many of the things described here could be easily done
                   4876: with simple code in the package's post-installation target (post-install). This
                   4877: is incorrect, as the code in them is only executed when building from source.
                   4878: Machines using binary packages could not benefit from it at all (as the code
                   4879: itself could be unavailable). Therefore, the only way to achieve any of the
                   4880: items described above is by means of the installation scripts, which are
                   4881: automatically generated by pkginstall.
                   4882: 
                   4883: 14.1. Files and directories outside the installation prefix
                   4884: 
                   4885: As you already know, the PLIST file holds a list of files and directories that
                   4886: belong to a package. The names used in it are relative to the installation
                   4887: prefix (${PREFIX}), which means that it cannot register files outside this
                   4888: directory (absolute path names are not allowed). Despite this restriction, some
                   4889: packages need to install files outside this location; e.g., under ${VARBASE} or
                   4890: ${PKG_SYSCONFDIR}. The only way to achieve this is to create such files during
                   4891: installation time by using installation scripts.
                   4892: 
                   4893: The generic installation scripts are shell scripts that can contain arbitrary
                   4894: code. The list of scripts to execute is taken from the INSTALL_FILE variable,
                   4895: which defaults to INSTALL. A similar variable exists for package removal
                   4896: (DEINSTALL_FILE, whose default is DEINSTALL). These scripts can run arbitrary
                   4897: commands, so they have the potential to create and manage files anywhere in the
                   4898: file system.
                   4899: 
                   4900: Using these general installation files is not recommended, but may be needed in
                   4901: some special cases. One reason for avoiding them is that the user has to trust
                   4902: the packager that there is no unwanted or simply erroneous code included in the
                   4903: installation script. Also, previously there were many similar scripts for the
                   4904: same functionality, and fixing a common error involved finding and changing all
                   4905: of them.
                   4906: 
                   4907: The pkginstall framework offers another, standardized way. It provides generic
                   4908: scripts to abstract the manipulation of such files and directories based on
                   4909: variables set in the package's Makefile. The rest of this section describes
                   4910: these variables.
                   4911: 
                   4912: 14.1.1. Directory manipulation
                   4913: 
                   4914: The following variables can be set to request the creation of directories
                   4915: anywhere in the file system:
                   4916: 
                   4917:   * MAKE_DIRS and OWN_DIRS contain a list of directories that should be created
                   4918:     and should attempt to be destroyed by the installation scripts. The
                   4919:     difference between the two is that the latter prompts the administrator to
                   4920:     remove any directories that may be left after deinstallation (because they
                   4921:     were not empty), while the former does not.
                   4922: 
                   4923:   * MAKE_DIRS_PERMS and OWN_DIRS_PERMS contain a list of tuples describing
                   4924:     which directories should be created and should attempt to be destroyed by
                   4925:     the installation scripts. Each tuple holds the following values, separated
                   4926:     by spaces: the directory name, its owner, its group and its numerical mode.
                   4927:     For example:
                   4928: 
                   4929:     MAKE_DIRS_PERMS+=         ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
                   4930: 
                   4931:     The difference between the two is exactly the same as their non-PERMS
                   4932:     counterparts.
                   4933: 
                   4934: 14.1.2. File manipulation
                   4935: 
                   4936: Creating non-empty files outside the installation prefix is tricky because the
                   4937: PLIST forces all files to be inside it. To overcome this problem, the only
                   4938: solution is to extract the file in the known place (i.e., inside the
                   4939: installation prefix) and copy it to the appropriate location during
                   4940: installation (done by the installation scripts generated by pkginstall). We
                   4941: will call the former the master file in the following paragraphs, which
                   4942: describe the variables that can be used to automatically and consistently
                   4943: handle files outside the installation prefix:
                   4944: 
                   4945:   * CONF_FILES and SUPPORT_FILES are pairs of master and target files. During
                   4946:     installation time, the master file is copied to the target one if and only
                   4947:     if the latter does not exist. Upon deinstallation, the target file is
                   4948:     removed provided that it was not modified by the installation.
                   4949: 
                   4950:     The difference between the two is that the latter prompts the administrator
                   4951:     to remove any files that may be left after deinstallation (because they
                   4952:     were not empty), while the former does not.
                   4953: 
                   4954:   * CONF_FILES_PERMS and SUPPORT_FILES_PERMS contain tuples describing master
                   4955:     files as well as their target locations. For each of them, it also
                   4956:     specifies their owner, their group and their numeric permissions, in this
                   4957:     order. For example:
                   4958: 
                   4959:     SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
                   4960: 
                   4961:     The difference between the two is exactly the same as their non-PERMS
                   4962:     counterparts.
                   4963: 
                   4964: 14.2. Configuration files
                   4965: 
                   4966: Configuration files are special in the sense that they are installed in their
                   4967: own specific directory, PKG_SYSCONFDIR, and need special treatment during
                   4968: installation (most of which is automated by pkginstall). The main concept you
                   4969: must bear in mind is that files marked as configuration files are automatically
                   4970: copied to the right place (somewhere inside PKG_SYSCONFDIR) during installation
                   4971: if and only if they didn't exist before. Similarly, they will not be removed if
                   4972: they have local modifications. This ensures that administrators never lose any
                   4973: custom changes they may have made.
                   4974: 
                   4975: 14.2.1. How PKG_SYSCONFDIR is set
                   4976: 
                   4977: As said before, the PKG_SYSCONFDIR variable specifies where configuration files
                   4978: shall be installed. Its contents are set based upon the following variables:
                   4979: 
                   4980:   * PKG_SYSCONFBASE: The configuration's root directory. Defaults to ${PREFIX}/
                   4981:     etc although it may be overridden by the user to point to his preferred
                   4982:     location (e.g., /etc, /etc/pkg, etc.). Packages must not use it directly.
                   4983: 
                   4984:   * PKG_SYSCONFSUBDIR: A subdirectory of PKG_SYSCONFBASE under which the
                   4985:     configuration files for the package being built shall be installed. The
                   4986:     definition of this variable only makes sense in the package's Makefile
                   4987:     (i.e., it is not user-customizable).
                   4988: 
                   4989:     As an example, consider the Apache package, www/apache2, which places its
                   4990:     configuration files under the httpd/ subdirectory of PKG_SYSCONFBASE. This
                   4991:     should be set in the package Makefile.
                   4992: 
                   4993:   * PKG_SYSCONFVAR: Specifies the name of the variable that holds this
                   4994:     package's configuration directory (if different from PKG_SYSCONFBASE). It
                   4995:     defaults to PKGBASE's value, and is always prefixed with PKG_SYSCONFDIR.
                   4996: 
                   4997:   * PKG_SYSCONFDIR.${PKG_SYSCONFVAR}: Holds the directory where the
                   4998:     configuration files for the package identified by PKG_SYSCONFVAR's shall be
                   4999:     placed.
                   5000: 
                   5001: Based on the above variables, pkginstall determines the value of
                   5002: PKG_SYSCONFDIR, which is the only variable that can be used within a package to
                   5003: refer to its configuration directory. The algorithm used to set its value is
                   5004: basically the following:
                   5005: 
                   5006:  1. If PKG_SYSCONFDIR.${PKG_SYSCONFVAR} is set, its value is used.
                   5007: 
                   5008:  2. If the previous variable is not defined but PKG_SYSCONFSUBDIR is set in the
                   5009:     package's Makefile, the resulting value is ${PKG_SYSCONFBASE}/$
                   5010:     {PKG_SYSCONFSUBDIR}.
                   5011: 
                   5012:  3. Otherwise, it is set to ${PKG_SYSCONFBASE}.
                   5013: 
                   5014: It is worth mentioning that ${PKG_SYSCONFDIR} is automatically added to
                   5015: OWN_DIRS. See Section 14.1.1, "Directory manipulation" what this means.
                   5016: 
                   5017: 14.2.2. Telling the software where configuration files are
                   5018: 
                   5019: Given that pkgsrc (and users!) expect configuration files to be in a known
                   5020: place, you need to teach each package where it shall install its files. In some
                   5021: cases you will have to patch the package Makefiles to achieve it. If you are
                   5022: lucky, though, it may be as easy as passing an extra flag to the configuration
                   5023: script; this is the case of GNU Autoconf- generated files:
                   5024: 
                   5025: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
                   5026: 
                   5027: Note that this specifies where the package has to look for its configuration
                   5028: files, not where they will be originally installed (although the difference is
                   5029: never explicit, unfortunately).
                   5030: 
                   5031: 14.2.3. Patching installations
                   5032: 
                   5033: As said before, pkginstall automatically handles configuration files. This
                   5034: means that the packages themselves must not touch the contents of $
                   5035: {PKG_SYSCONFDIR} directly. Bad news is that many software installation scripts
                   5036: will, out of the box, mess with the contents of that directory. So what is the
                   5037: correct procedure to fix this issue?
                   5038: 
                   5039: You must teach the package (usually by manually patching it) to install any
                   5040: configuration files under the examples hierarchy, share/examples/${PKGBASE}/.
                   5041: This way, the PLIST registers them and the administrator always has the
                   5042: original copies available.
                   5043: 
                   5044: Once the required configuration files are in place (i.e., under the examples
                   5045: hierarchy), the pkginstall framework can use them as master copies during the
                   5046: package installation to update what is in ${PKG_SYSCONFDIR}. To achieve this,
                   5047: the variables CONF_FILES and CONF_FILES_PERMS are used. Check out
                   5048: Section 14.1.2, "File manipulation" for information about their syntax and
                   5049: their purpose. Here is an example, taken from the mail/mutt package:
                   5050: 
                   5051: EGDIR=        ${PREFIX}/share/doc/mutt/samples
                   5052: CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
                   5053: 
                   5054: Note that the EGDIR variable is specific to that package and has no meaning
                   5055: outside it.
                   5056: 
                   5057: 14.2.4. Disabling handling of configuration files
                   5058: 
                   5059: The automatic copying of config files can be toggled by setting the environment
                   5060: variable PKG_CONFIG prior to package installation.
                   5061: 
                   5062: 14.3. System startup scripts
                   5063: 
                   5064: System startup scripts are special files because they must be installed in a
                   5065: place known by the underlying OS, usually outside the installation prefix.
                   5066: Therefore, the same rules described in Section 14.1, "Files and directories
                   5067: outside the installation prefix" apply, and the same solutions can be used.
                   5068: However, pkginstall provides a special mechanism to handle these files.
                   5069: 
                   5070: In order to provide system startup scripts, the package has to:
                   5071: 
                   5072:  1. Store the script inside ${FILESDIR}, with the .sh suffix appended.
                   5073:     Considering the print/cups package as an example, it has a cupsd.sh in its
                   5074:     files directory.
                   5075: 
                   5076:  2. Tell pkginstall to handle it, appending the name of the script, without its
                   5077:     extension, to the RCD_SCRIPTS variable. Continuing the previous example:
                   5078: 
                   5079:     RCD_SCRIPTS+=   cupsd
                   5080: 
                   5081: Once this is done, pkginstall will do the following steps for each script in an
                   5082: automated fashion:
                   5083: 
                   5084:  1. Process the file found in the files directory applying all the
                   5085:     substitutions described in the FILES_SUBST variable.
                   5086: 
                   5087:  2. Copy the script from the files directory to the examples hierarchy, $
                   5088:     {PREFIX}/share/examples/rc.d/. Note that this master file must be
                   5089:     explicitly registered in the PLIST.
                   5090: 
                   5091:  3. Add code to the installation scripts to copy the startup script from the
                   5092:     examples hierarchy into the system-wide startup scripts directory.
                   5093: 
                   5094: 14.3.1. Disabling handling of system startup scripts
                   5095: 
                   5096: The automatic copying of config files can be toggled by setting the environment
                   5097: variable PKG_RCD_SCRIPTS prior to package installation. Note that the scripts
                   5098: will be always copied inside the examples hierarchy, ${PREFIX}/share/examples/
                   5099: rc.d/, no matter what the value of this variable is.
                   5100: 
                   5101: 14.4. System users and groups
                   5102: 
                   5103: If a package needs to create special users and/or groups during installation,
                   5104: it can do so by using the pkginstall framework.
                   5105: 
                   5106: Users can be created by adding entries to the PKG_USERS variable. Each entry
                   5107: has the following syntax:
                   5108: 
                   5109: user:group
                   5110: 
                   5111: Further specification of user details may be done by setting per-user
                   5112: variables. PKG_UID.user is the numeric UID for the user. PKG_GECOS.user is the
                   5113: user's description or comment. PKG_HOME.user is the user's home directory, and
                   5114: defaults to /nonexistent if not specified. PKG_SHELL.user is the user's shell,
                   5115: and defaults to /sbin/nologin if not specified.
                   5116: 
                   5117: Similarly, groups can be created by adding entries to the PKG_GROUPS variable,
                   5118: whose syntax is:
                   5119: 
                   5120: group
                   5121: 
                   5122: The numeric GID of the group may be set by defining PKG_GID.group.
                   5123: 
                   5124: If a package needs to create the users and groups at an earlier stage, then it
                   5125: can set USERGROUP_PHASE to either configure or build to indicate the phase
                   5126: before which the users and groups are created. In this case, the numeric UIDs
                   5127: and GIDs of the created users and groups are automatically hardcoded into the
                   5128: final installation scripts.
                   5129: 
                   5130: 14.5. System shells
                   5131: 
                   5132: Packages that install system shells should register them in the shell database,
                   5133: /etc/shells, to make things easier to the administrator. This must be done from
                   5134: the installation scripts to keep binary packages working on any system.
                   5135: pkginstall provides an easy way to accomplish this task.
                   5136: 
                   5137: When a package provides a shell interpreter, it has to set the PKG_SHELL
                   5138: variable to its absolute file name. This will add some hooks to the
                   5139: installation scripts to handle it. Consider the following example, taken from
                   5140: shells/zsh:
                   5141: 
                   5142: PKG_SHELL=      ${PREFIX}/bin/zsh
                   5143: 
                   5144: 14.5.1. Disabling shell registration
                   5145: 
                   5146: The automatic registration of shell interpreters can be disabled by the
                   5147: administrator by setting the PKG_REGISTER_SHELLS environment variable to NO.
                   5148: 
                   5149: 14.6. Fonts
                   5150: 
                   5151: Packages that install X11 fonts should update the database files that index the
                   5152: fonts within each fonts directory. This can easily be accomplished within the
                   5153: pkginstall framework.
                   5154: 
                   5155: When a package installs X11 fonts, it must list the directories in which fonts
                   5156: are installed in the FONTS_DIRS.type variables, where type can be one of "ttf",
                   5157: "type1" or "x11". This will add hooks to the installation scripts to run the
                   5158: appropriate commands to update the fonts database files within each of those
                   5159: directories. For convenience, if the directory path is relative, it is taken to
                   5160: be relative to the package's installation prefix. Consider the following
                   5161: example, taken from fonts/dbz-ttf:
                   5162: 
                   5163: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
                   5164: 
                   5165: 14.6.1. Disabling automatic update of the fonts databases
                   5166: 
                   5167: The automatic update of fonts databases can be disabled by the administrator by
                   5168: setting the PKG_UPDATE_FONTS_DB environment variable to NO.
                   5169: 
                   5170: Chapter 15. Options handling
                   5171: 
                   5172: Table of Contents
                   5173: 
                   5174: 15.1. Global default options
                   5175: 15.2. Converting packages to use bsd.options.mk
                   5176: 15.3. Option Names
                   5177: 
                   5178: Many packages have the ability to be built to support different sets of
                   5179: features. bsd.options.mk is a framework in pkgsrc that provides generic
                   5180: handling of those options that determine different ways in which the packages
                   5181: can be built. It's possible for the user to specify exactly which sets of
                   5182: options will be built into a package or to allow a set of global default
                   5183: options apply.
                   5184: 
                   5185: 15.1. Global default options
                   5186: 
                   5187: Global default options are listed in PKG_DEFAULT_OPTIONS, which is a list of
                   5188: the options that should be built into every package if that option is
                   5189: supported. This variable should be set in /etc/mk.conf.
                   5190: 
                   5191: 15.2. Converting packages to use bsd.options.mk
                   5192: 
                   5193: The following example shows how bsd.options.mk should be used by the
                   5194: hypothetical ``wibble'' package, either in the package Makefile, or in a file,
                   5195: e.g. options.mk, that is included by the main package Makefile.
                   5196: 
                   5197: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   5198: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   5199: PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   5200: PKG_OPTIONS_GROUP.database=     mysql pgsql
                   5201: PKG_SUGGESTED_OPTIONS=          wibble-foo
                   5202: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   5203: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
                   5204: 
                   5205: .include "../../mk/bsd.prefs.mk"
                   5206: 
                   5207: # this package was previously named wibble2
                   5208: .if defined(PKG_OPTIONS.wibble2)
                   5209: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   5210: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
                   5211:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
                   5212: .endif
                   5213: 
                   5214: .include "../../mk/bsd.options.mk"
                   5215: 
                   5216: # Package-specific option-handling
                   5217: 
                   5218: ###
                   5219: ### FOO support
                   5220: ###
                   5221: .if !empty(PKG_OPTIONS:Mwibble-foo)
                   5222: CONFIGURE_ARGS+=    --enable-foo
                   5223: .endif
                   5224: 
                   5225: ###
                   5226: ### LDAP support
                   5227: ###
                   5228: .if !empty(PKG_OPTIONS:Mldap)
                   5229: .  include "../../databases/openldap-client/buildlink3.mk"
                   5230: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
                   5231: .endif
                   5232: 
                   5233: ###
                   5234: ### database support
                   5235: ###
                   5236: .if !empty(PKG_OPTIONS:Mmysql)
                   5237: .  include "../../mk/mysql.buildlink3.mk"
                   5238: .endif
                   5239: .if !empty(PKG_OPTIONS:Mpgsql)
                   5240: .  include "../../mk/pgsql.buildlink3.mk"
                   5241: .endif
                   5242: 
                   5243: The first section contains the information about which build options are
                   5244: supported by the package, and any default options settings if needed.
                   5245: 
                   5246:  1. PKG_OPTIONS_VAR is the name of the make(1) variable that the user can set
                   5247:     to override the default options. It should be set to PKG_OPTIONS.pkgbase.
                   5248:     Do not set it to PKG_OPTIONS.${PKGBASE}, since PKGBASE is not defined at
                   5249:     the point where the options are processed.
                   5250: 
                   5251:  2. PKG_SUPPORTED_OPTIONS is a list of build options supported by the package.
                   5252: 
                   5253:  3. PKG_OPTIONS_OPTIONAL_GROUPS is a list of names of groups of mutually
                   5254:     exclusive options. The options in each group are listed in
                   5255:     PKG_OPTIONS_GROUP.groupname. The most specific setting of any option from
                   5256:     the group takes precedence over all other options in the group. Options
                   5257:     from the groups will be automatically added to PKG_SUPPORTED_OPTIONS.
                   5258: 
                   5259:  4. PKG_OPTIONS_REQUIRED_GROUPS is like PKG_OPTIONS_OPTIONAL_GROUPS, but
                   5260:     building the packages will fail if no option from the group is selected.
                   5261: 
                   5262:  5. PKG_OPTIONS_NONEMPTY_SETS is a list of names of sets of options. At least
                   5263:     one option from each set must be selected. The options in each set are
                   5264:     listed in PKG_OPTIONS_SET.setname. Options from the sets will be
                   5265:     automatically added to PKG_SUPPORTED_OPTIONS. Building the package will
                   5266:     fail if no option from the set is selected.
                   5267: 
                   5268:  6. PKG_SUGGESTED_OPTIONS is a list of build options which are enabled by
                   5269:     default.
                   5270: 
                   5271:  7. PKG_OPTIONS_LEGACY_VARS is a list of "USE_VARIABLE:option" pairs that map
                   5272:     legacy /etc/mk.conf variables to their option counterparts. Pairs should be
                   5273:     added with "+=" to keep the listing of global legacy variables. A warning
                   5274:     will be issued if the user uses a legacy variable.
                   5275: 
                   5276:  8. PKG_OPTIONS_LEGACY_OPTS is a list of "old-option:new-option" pairs that map
                   5277:     options that have been renamed to their new counterparts. Pairs should be
                   5278:     added with "+=" to keep the listing of global legacy options. A warning
                   5279:     will be issued if the user uses a legacy option.
                   5280: 
                   5281:  9. PKG_LEGACY_OPTIONS is a list of options implied by deprecated variables
                   5282:     used. This can be used for cases that neither PKG_OPTIONS_LEGACY_VARS nor
                   5283:     PKG_OPTIONS_LEGACY_OPTS can handle, e. g. when PKG_OPTIONS_VAR is renamed.
                   5284: 
                   5285: 10. PKG_OPTIONS_DEPRECATED_WARNINGS is a list of warnings about deprecated
                   5286:     variables or options used, and what to use instead.
                   5287: 
                   5288: A package should never modify PKG_DEFAULT_OPTIONS or the variable named in
                   5289: PKG_OPTIONS_VAR. These are strictly user-settable. To suggest a default set of
                   5290: options, use PKG_SUGGESTED_OPTIONS.
                   5291: 
                   5292: PKG_OPTIONS_VAR must be defined before including bsd.options.mk. If none of
                   5293: PKG_SUPPORTED_OPTIONS, PKG_OPTIONS_OPTIONAL_GROUPS, and
                   5294: PKG_OPTIONS_REQUIRED_GROUPS are defined (as can happen with platform-specific
                   5295: options if none of them is supported on the current platform), PKG_OPTIONS is
                   5296: set to the empty list and the package is otherwise treated as not using the
                   5297: options framework.
                   5298: 
                   5299: After the inclusion of bsd.options.mk, the variable PKG_OPTIONS contains the
                   5300: list of selected build options, properly filtered to remove unsupported and
                   5301: duplicate options.
                   5302: 
                   5303: The remaining sections contain the logic that is specific to each option. The
                   5304: correct way to check for an option is to check whether it is listed in
                   5305: PKG_OPTIONS:
                   5306: 
                   5307: .if !empty(PKG_OPTIONS:Moption)
                   5308: 
                   5309: 15.3. Option Names
                   5310: 
                   5311: Options that enable similar features in different packages (like optional
                   5312: support for a library) should use a common name in all packages that support it
                   5313: (like the name of the library). If another package already has an option with
                   5314: the same meaning, use the same name.
                   5315: 
                   5316: Options that enable features specific to one package, where it's unlikely that
                   5317: another (unrelated) package has the same (or a similar) optional feature,
                   5318: should use a name prefixed with pkgname-.
                   5319: 
                   5320: If a group of related packages share an optional feature specific to that
                   5321: group, prefix it with the name of the "main" package (e. g.
                   5322: djbware-errno-hack).
                   5323: 
                   5324: For new options, add a line to mk/defaults/options.description. Lines have two
                   5325: fields, separated by tab. The first field is the option name, the second its
                   5326: description. The description should be a whole sentence (starting with an
                   5327: uppercase letter and ending with a period) that describes what enabling the
                   5328: option does. E. g. "Enable ispell support." The file is sorted by option names.
                   5329: 
                   5330: Chapter 16. The build process
                   5331: 
                   5332: Table of Contents
                   5333: 
                   5334: 16.1. Introduction
                   5335: 16.2. Program location
                   5336: 16.3. Directories used during the build process
                   5337: 16.4. Running a phase
                   5338: 16.5. The fetch phase
                   5339: 
                   5340:     16.5.1. What to fetch and where to get it from
                   5341:     16.5.2. How are the files fetched?
                   5342: 
                   5343: 16.6. The checksum phase
                   5344: 16.7. The extract phase
                   5345: 16.8. The patch phase
                   5346: 16.9. The tools phase
                   5347: 16.10. The wrapper phase
                   5348: 16.11. The configure phase
                   5349: 16.12. The build phase
                   5350: 16.13. The test phase
                   5351: 16.14. The install phase
                   5352: 16.15. The package phase
                   5353: 16.16. Cleaning up
                   5354: 16.17. Other helpful targets
                   5355: 
                   5356: 16.1. Introduction
                   5357: 
                   5358: This chapter gives a detailed description on how a package is built. Building a
                   5359: package is separated into different phases (for example fetch, build, install),
                   5360: all of which are described in the following sections. Each phase is splitted
                   5361: into so-called stages, which take the name of the containing phase, prefixed by
                   5362: one of pre-, do- or post-. (Examples are pre-configure, post-build.) Most of
                   5363: the actual work is done in the do-* stages.
                   5364: 
                   5365: Never override the regular targets (like fetch), if you have to, override the
                   5366: do-* ones instead.
                   5367: 
                   5368: The basic steps for building a program are always the same. First the program's
                   5369: source (distfile) must be brought to the local system and then extracted. After
                   5370: any pkgsrc-specific patches to compile properly are applied, the software can
                   5371: be configured, then built (usually by compiling), and finally the generated
                   5372: binaries, etc. can be put into place on the system.
                   5373: 
                   5374: To get more details about what is happening at each step, you can set the
                   5375: PKG_VERBOSE variable, or the PATCH_DEBUG variable if you are just interested in
                   5376: more details about the patch step.
                   5377: 
                   5378: 16.2. Program location
                   5379: 
                   5380: Before outlining the process performed by the NetBSD package system in the next
                   5381: section, here's a brief discussion on where programs are installed, and which
                   5382: variables influence this.
                   5383: 
                   5384: The automatic variable PREFIX indicates where all files of the final program
                   5385: shall be installed. It is usually set to LOCALBASE (/usr/pkg), or CROSSBASE for
                   5386: pkgs in the cross category. The value of PREFIX needs to be put into the
                   5387: various places in the program's source where paths to these files are encoded.
                   5388: See Section 10.3, "patches/*" and Section 18.3.1, "Shared libraries - libtool"
                   5389: for more details.
                   5390: 
                   5391: When choosing which of these variables to use, follow the following rules:
                   5392: 
                   5393:   * PREFIX always points to the location where the current pkg will be
                   5394:     installed. When referring to a pkg's own installation path, use "${PREFIX}
                   5395:     ".
                   5396: 
                   5397:   * LOCALBASE is where all non-X11 pkgs are installed. If you need to construct
                   5398:     a -I or -L argument to the compiler to find includes and libraries
                   5399:     installed by another non-X11 pkg, use "${LOCALBASE}". The name LOCALBASE
                   5400:     stems from FreeBSD, which installed all packages in /usr/local. As pkgsrc
                   5401:     leaves /usr/local for the system administrator, this variable is a
                   5402:     misnomer.
                   5403: 
                   5404:   * X11BASE is where the actual X11 distribution (from xsrc, etc.) is
                   5405:     installed. When looking for standard X11 includes (not those installed by a
                   5406:     package), use "${X11BASE}".
                   5407: 
                   5408:   * X11-based packages are special in that they may be installed in either
                   5409:     X11BASE or LOCALBASE.
                   5410: 
                   5411:     Usually, X11 packages should be installed under LOCALBASE whenever
                   5412:     possible. Note that you will need to include ../../mk/x11.buildlink3.mk in
                   5413:     them to request the presence of X11 and to get the right compilation flags.
                   5414: 
                   5415:     Even though, there are some packages that cannot be installed under
                   5416:     LOCALBASE: those that come with app-defaults files. These packages are
                   5417:     special and they must be placed under X11BASE. To accomplish this, set
                   5418:     either USE_X11BASE or USE_IMAKE in your package.
                   5419: 
                   5420:     Some notes: If you need to find includes or libraries installed by a pkg
                   5421:     that has USE_IMAKE or USE_X11BASE in its pkg Makefile, you need to look in
                   5422:     both ${X11BASE} and ${LOCALBASE}. To force installation of all X11 packages
                   5423:     in LOCALBASE, the pkgtools/xpkgwedge package is enabled by default.
                   5424: 
                   5425:   * X11PREFIX should be used to refer to the installed location of an X11
                   5426:     package. X11PREFIX will be set to X11BASE if xpkgwedge is not installed,
                   5427:     and to LOCALBASE if xpkgwedge is installed.
                   5428: 
                   5429:   * If xpkgwedge is installed, it is possible to have some packages installed
                   5430:     in X11BASE and some in LOCALBASE. To determine the prefix of an installed
                   5431:     package, the EVAL_PREFIX definition can be used. It takes pairs in the
                   5432:     format "DIRNAME=<package>", and the make(1) variable DIRNAME will be set to
                   5433:     the prefix of the installed package <package>, or "${X11PREFIX}" if the
                   5434:     package is not installed.
                   5435: 
                   5436:     This is best illustrated by example.
                   5437: 
                   5438:     The following lines are taken from pkgsrc/wm/scwm/Makefile:
                   5439: 
                   5440:     EVAL_PREFIX+=           GTKDIR=gtk+
                   5441:     CONFIGURE_ARGS+=        --with-guile-prefix=${LOCALBASE:Q}
                   5442:     CONFIGURE_ARGS+=        --with-gtk-prefix=${GTKDIR:Q}
                   5443:     CONFIGURE_ARGS+=        --enable-multibyte
                   5444: 
                   5445:     Specific defaults can be defined for the packages evaluated using
                   5446:     EVAL_PREFIX, by using a definition of the form:
                   5447: 
                   5448:     GTKDIR_DEFAULT= ${LOCALBASE}
                   5449: 
                   5450:     where GTKDIR corresponds to the first definition in the EVAL_PREFIX pair.
                   5451: 
                   5452:   * Within ${PREFIX}, packages should install files according to hier(7), with
                   5453:     the exception that manual pages go into ${PREFIX}/man, not ${PREFIX}/share/
                   5454:     man.
                   5455: 
                   5456: 16.3. Directories used during the build process
                   5457: 
                   5458: When building a package, a number of directories is used to store source files,
                   5459: temporary files, pkgsrc-internal files, and so on. These directories are
                   5460: explained here.
                   5461: 
                   5462: Some of the directory variables contain relative pathnames. There are two
                   5463: common base directories for these relative directories: PKGSRCDIR/PKGPATH is
                   5464: used for directories that are pkgsrc-specific. WRKSRC is used for directories
                   5465: inside the package itself.
                   5466: 
                   5467: PKGSRCDIR
                   5468: 
                   5469:     This is an absolute pathname that points to the pkgsrc root directory.
                   5470:     Generally, you don't need it.
                   5471: 
                   5472: PKGDIR
                   5473: 
                   5474:     This is an absolute pathname that points to the current package.
                   5475: 
                   5476: PKGPATH
                   5477: 
                   5478:     This is a pathname relative to PKGSRCDIR that points to the current
                   5479:     package.
                   5480: 
                   5481: WRKDIR
                   5482: 
                   5483:     This is an absolute pathname pointing to the directory where all work takes
                   5484:     place. The distfiles are extracted to this directory. It also contains
                   5485:     temporary directories and log files used by the various pkgsrc frameworks,
                   5486:     like buildlink or the wrappers.
                   5487: 
                   5488: WRKSRC
                   5489: 
                   5490:     This is an absolute pathname pointing to the directory where the distfiles
                   5491:     are extracted. It is usually a direct subdirectory of WRKDIR, and often
                   5492:     it's the only directory entry that isn't hidden. This variable may be
                   5493:     changed by a package Makefile.
                   5494: 
                   5495: 16.4. Running a phase
                   5496: 
                   5497: You can run a particular phase by typing make phase, where phase is the name of
                   5498: the phase. This will automatically run all phases that are required for this
                   5499: phase. The default phase is build, that is, when you run make without
                   5500: parameters in a package directory, the package will be built, but not
                   5501: installed.
                   5502: 
                   5503: 16.5. The fetch phase
                   5504: 
                   5505: The first step in building a package is to fetch the distribution files
                   5506: (distfiles) from the sites that are providing them. This is the task of the
                   5507: fetch phase.
                   5508: 
                   5509: 16.5.1. What to fetch and where to get it from
                   5510: 
                   5511: In simple cases, MASTER_SITES defines all URLs from where the distfile, whose
                   5512: name is derived from the DISTNAME variable, is fetched. The more complicated
                   5513: cases are described below.
                   5514: 
                   5515: The variable DISTFILES specifies the list of distfiles that have to be fetched.
                   5516: Its value defaults to ${DISTNAME}${EXTRACT_SUFX}, so that most packages don't
                   5517: need to define it at all. EXTRACT_SUFX is .tar.gz by default, but can be
                   5518: changed freely. Note that if your package requires additional distfiles to the
                   5519: default one, you cannot just append the additional filenames using the +=
                   5520: operator, but you have write for example:
                   5521: 
                   5522: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
                   5523: 
                   5524: Each distfile is fetched from a list of sites, usually MASTER_SITES. If the
                   5525: package has multiple DISTFILES or multiple PATCHFILES from different sites, you
                   5526: can set SITES.distfile to the list of URLs where the file distfile (including
                   5527: the suffix) can be found.
                   5528: 
                   5529: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   5530: DISTFILES+=     foo-file.tar.gz
                   5531: SITES.foo-file.tar.gz= \
                   5532: http://www.somewhere.com/somehow/ \
                   5533: http://www.somewhereelse.com/mirror/somehow/
                   5534: 
                   5535: When actually fetching the distfiles, each item from MASTER_SITES or SITES.*
                   5536: gets the name of each distfile appended to it, without an intermediate slash.
                   5537: Therefore, all site values have to end with a slash or other separator
                   5538: character. This allows for example to set MASTER_SITES to a URL of a CGI script
                   5539: that gets the name of the distfile as a parameter. In this case, the definition
                   5540: would look like:
                   5541: 
                   5542: MASTER_SITES=   http://www.example.com/download.cgi?file=
                   5543: 
                   5544: There are some predefined values for MASTER_SITES, which can be used in
                   5545: packages. The names of the variables should speak for themselves.
                   5546: 
                   5547: ${MASTER_SITE_APACHE}
                   5548: ${MASTER_SITE_BACKUP}
                   5549: ${MASTER_SITE_CYGWIN}
                   5550: ${MASTER_SITE_DEBIAN}
                   5551: ${MASTER_SITE_FREEBSD}
                   5552: ${MASTER_SITE_FREEBSD_LOCAL}
                   5553: ${MASTER_SITE_GENTOO}
                   5554: ${MASTER_SITE_GNOME}
                   5555: ${MASTER_SITE_GNU}
                   5556: ${MASTER_SITE_GNUSTEP}
                   5557: ${MASTER_SITE_IFARCHIVE}
                   5558: ${MASTER_SITE_KDE}
                   5559: ${MASTER_SITE_MOZILLA}
                   5560: ${MASTER_SITE_MYSQL}
                   5561: ${MASTER_SITE_OPENOFFICE}
                   5562: ${MASTER_SITE_PERL_CPAN}
                   5563: ${MASTER_SITE_PGSQL}
                   5564: ${MASTER_SITE_R_CRAN}
                   5565: ${MASTER_SITE_SOURCEFORGE}
                   5566: ${MASTER_SITE_SOURCEFORGE_JP}
                   5567: ${MASTER_SITE_SUNSITE}
                   5568: ${MASTER_SITE_SUSE}
                   5569: ${MASTER_SITE_TEX_CTAN}
                   5570: ${MASTER_SITE_XCONTRIB}
                   5571: ${MASTER_SITE_XEMACS}
                   5572: 
                   5573: Some explanations for the less self-explaining ones: MASTER_SITE_BACKUP
                   5574: contains backup sites for packages that are maintained in ftp://ftp.NetBSD.org/
                   5575: pub/NetBSD/packages/distfiles/${DIST_SUBDIR}. MASTER_SITE_LOCAL contains local
                   5576: package source distributions that are maintained in ftp://ftp.NetBSD.org/pub/
                   5577: NetBSD/packages/distfiles/LOCAL_PORTS/.
                   5578: 
                   5579: If you choose one of these predefined sites, you may want to specify a
                   5580: subdirectory of that site. Since these macros may expand to more than one
                   5581: actual site, you must use the following construct to specify a subdirectory:
                   5582: 
                   5583: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   5584: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
                   5585: 
                   5586: Note the trailing slash after the subdirectory name.
                   5587: 
                   5588: 16.5.2. How are the files fetched?
                   5589: 
                   5590: The fetch phase makes sure that all the distfiles exist in a local directory
                   5591: (DISTDIR, which can be set by the pkgsrc user). If the files do not exist, they
                   5592: are fetched using commands of the form
                   5593: 
                   5594: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   5595: 
                   5596: where ${site} varies through several possibilities in turn: first,
                   5597: MASTER_SITE_OVERRIDE is tried, then the sites specified in either SITES.file if
                   5598: defined, else MASTER_SITES or PATCH_SITES, as applies, then finally the value
                   5599: of MASTER_SITE_BACKUP. The order of all except the first and the last can be
                   5600: optionally sorted by the user, via setting either MASTER_SORT_RANDOM, and
                   5601: MASTER_SORT_AWK or MASTER_SORT_REGEX.
                   5602: 
                   5603: The distfiles mirror run by the NetBSD Foundation uses the mirror-distfiles
                   5604: target to mirror the distfiles, if they are freely distributable. Packages
                   5605: setting NO_SRC_ON_FTP (usually to "${RESTRICTED}") will not have their
                   5606: distfiles mirrored.
                   5607: 
                   5608: 16.6. The checksum phase
                   5609: 
                   5610: After the distfile(s) are fetched, their checksum is generated and compared
                   5611: with the checksums stored in the distinfo file. If the checksums don't match,
                   5612: the build is aborted. This is to ensure the same distfile is used for building,
                   5613: and that the distfile wasn't changed, e.g. by some malign force, deliberately
                   5614: changed distfiles on the master distribution site or network lossage.
                   5615: 
                   5616: 16.7. The extract phase
                   5617: 
                   5618: When the distfiles are present on the local system, they need to be extracted,
                   5619: as they usually come in the form of some compressed archive format.
                   5620: 
                   5621: By default, all DISTFILES are extracted. If you only need some of them, you can
                   5622: set the EXTRACT_ONLY variable to the list of those files.
                   5623: 
                   5624: Extracting the files is usually done by a little program, mk/extract/extract,
                   5625: which already knows how to extract various archive formats, so most likely you
                   5626: will not need to change anything here. But if you need, the following variables
                   5627: may help you:
                   5628: 
                   5629: EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}
                   5630: 
                   5631:     Use these variables to override the default options for an extract command,
                   5632:     which are defined in mk/extract/extract.
                   5633: 
                   5634: EXTRACT_USING
                   5635: 
                   5636:     This variable can be set to gtar, nbtar (which is the default value), pax,
                   5637:     or an absolute pathname pointing to the command with which tar archives
                   5638:     should be extracted.
                   5639: 
                   5640: If the extract program doesn't serve your needs, you can also override the
                   5641: EXTRACT_CMD variable, which holds the command used for extracting the files.
                   5642: This command is executed in the ${WRKSRC} directory. During execution of this
                   5643: command, the shell variable extract_file holds the absolute pathname of the
                   5644: file that is going to be extracted.
                   5645: 
                   5646: And if that still does not suffice, you can override the do-extract target in
                   5647: the package Makefile.
                   5648: 
                   5649: 16.8. The patch phase
                   5650: 
                   5651: After extraction, all the patches named by the PATCHFILES, those present in the
                   5652: patches subdirectory of the package as well as in $LOCALPATCHES/$PKGPATH (e.g.
                   5653: /usr/local/patches/graphics/png) are applied. Patchfiles ending in .Z or .gz
                   5654: are uncompressed before they are applied, files ending in .orig or .rej are
                   5655: ignored. Any special options to patch(1) can be handed in PATCH_DIST_ARGS. See
                   5656: Section 10.3, "patches/*" for more details.
                   5657: 
                   5658: By default patch(1) is given special args to make it fail if the patches apply
                   5659: with some lines of fuzz. Please fix (regen) the patches so that they apply
                   5660: cleanly. The rationale behind this is that patches that don't apply cleanly may
                   5661: end up being applied in the wrong place, and cause severe harm there.
                   5662: 
                   5663: 16.9. The tools phase
                   5664: 
                   5665: This is covered in Chapter 17, Tools needed for building or running.
                   5666: 
                   5667: 16.10. The wrapper phase
                   5668: 
                   5669: This phase creates wrapper programs for the compilers and linkers. The
                   5670: following variables can be used to tweak the wrappers.
                   5671: 
                   5672: ECHO_WRAPPER_MSG
                   5673: 
                   5674:     The command used to print progress messages. Does nothing by default. Set
                   5675:     to ${ECHO} to see the progress messages.
                   5676: 
                   5677: WRAPPER_DEBUG
                   5678: 
                   5679:     This variable can be set to yes (default) or no, depending on whether you
                   5680:     want additional information in the wrapper log file.
                   5681: 
                   5682: WRAPPER_UPDATE_CACHE
                   5683: 
                   5684:     This variable can be set to yes or no, depending on whether the wrapper
                   5685:     should use its cache, which will improve the speed. The default value is
                   5686:     yes, but is forced to no if the platform does not support it.
                   5687: 
                   5688: WRAPPER_REORDER_CMDS
                   5689: 
                   5690:     A list of reordering commands. A reordering command has the form reorder:l:
                   5691:     lib1:lib2. It ensures that that -llib1 occurs before -llib2.
                   5692: 
                   5693: WRAPPER_TRANSFORM_CMDS
                   5694: 
                   5695:     A list of transformation commands. [TODO: investigate further]
                   5696: 
                   5697: 16.11. The configure phase
                   5698: 
                   5699: Most pieces of software need information on the header files, system calls, and
                   5700: library routines which are available on the platform they run on. The process
                   5701: of determining this information is known as configuration, and is usually
                   5702: automated. In most cases, a script is supplied with the distfiles, and its
                   5703: invocation results in generation of header files, Makefiles, etc.
                   5704: 
                   5705: If the package contains a configure script, this can be invoked by setting
                   5706: HAS_CONFIGURE to "yes". If the configure script is a GNU autoconf script, you
                   5707: should set GNU_CONFIGURE to "yes" instead. What happens in the configure phase
                   5708: is roughly:
                   5709: 
                   5710: .for d in ${CONFIGURE_DIRS}
                   5711:         cd ${WRKSRC} \
                   5712:         && cd ${d} \
                   5713:         && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
                   5714: .endfor
                   5715: 
                   5716: CONFIGURE_DIRS (default: ".") is a list of pathnames relative to WRKSRC. In
                   5717: each of these directories, the configure script is run with the environment
                   5718: CONFIGURE_ENV and arguments CONFIGURE_ARGS. The variables CONFIGURE_ENV,
                   5719: CONFIGURE_SCRIPT (default: "./configure") and CONFIGURE_ARGS may all be changed
                   5720: by the package.
                   5721: 
                   5722: If the program uses an Imakefile for configuration, the appropriate steps can
                   5723: be invoked by setting USE_IMAKE to "yes". (If you only want the package
                   5724: installed in ${X11PREFIX} but xmkmf not being run, set USE_X11BASE instead.)
                   5725: You can add variables to xmkmf's environment by adding them to the SCRIPTS_ENV
                   5726: variable.
                   5727: 
                   5728: If there is no configure step at all, set NO_CONFIGURE to "yes".
                   5729: 
                   5730: 16.12. The build phase
                   5731: 
                   5732: For building a package, a rough equivalent of the following code is executed.
                   5733: 
                   5734: .for d in ${BUILD_DIRS}
                   5735:         cd ${WRKSRC} \
                   5736:         && cd ${d} \
                   5737:         && env ${MAKE_ENV} \
                   5738:             ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
                   5739:                 -f ${MAKE_FILE} \
                   5740:                 ${BUILD_TARGET}
                   5741: .endfor
                   5742: 
                   5743: BUILD_DIRS (default: ".") is a list of pathnames relative to WRKSRC. In each of
                   5744: these directories, MAKE_PROGRAM is run with the environment MAKE_ENV and
                   5745: arguments BUILD_MAKE_FLAGS. The variables MAKE_ENV, BUILD_MAKE_FLAGS, MAKE_FILE
                   5746: and BUILD_TARGET may all be changed by the package.
                   5747: 
                   5748: The default value of MAKE_PROGRAM is "gmake" if USE_TOOLS contains "gmake",
                   5749: "make" otherwise. The default value of MAKE_FILE is "Makefile", and
                   5750: BUILD_TARGET defaults to "all".
                   5751: 
                   5752: If there is no build step at all, set NO_BUILD to "yes".
                   5753: 
                   5754: 16.13. The test phase
                   5755: 
                   5756: [TODO]
                   5757: 
                   5758: 16.14. The install phase
                   5759: 
                   5760: Once the build stage has completed, the final step is to install the software
                   5761: in public directories, so users can access the programs and files.
                   5762: 
                   5763: In the install phase, a rough equivalent of the following code is executed.
                   5764: Additionally, before and after this code, much magic is performed to do
                   5765: consistency checks, registering the package, and so on.
                   5766: 
                   5767: .for d in ${INSTALL_DIRS}
                   5768:         cd ${WRKSRC} \
                   5769:         && cd ${d} \
                   5770:         && env ${MAKE_ENV} \
                   5771:             ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
                   5772:                 -f ${MAKE_FILE} \
                   5773:                 ${INSTALL_TARGET}
                   5774: .endfor
                   5775: 
                   5776: The variable's meanings are analogous to the ones in the build phase.
                   5777: INSTALL_DIRS defaults to BUILD_DIRS. INSTALL_TARGET is "install" by default,
                   5778: plus "install.man" if USE_IMAKE is defined and NO_INSTALL_MANPAGES is not
                   5779: defined.
                   5780: 
                   5781: In the install phase, the following variables are useful. They are all
                   5782: variations of the install(1) command that have the owner, group and permissions
                   5783: preset. INSTALL is the plain install command. The specialized variants,
                   5784: together with their intended use, are:
                   5785: 
                   5786: INSTALL_PROGRAM_DIR
                   5787: 
                   5788:     directories that contain binaries
                   5789: 
                   5790: INSTALL_SCRIPT_DIR
                   5791: 
                   5792:     directories that contain scripts
                   5793: 
                   5794: INSTALL_LIB_DIR
                   5795: 
                   5796:     directories that contain shared and static libraries
                   5797: 
                   5798: INSTALL_DATA_DIR
                   5799: 
                   5800:     directories that contain data files
                   5801: 
                   5802: INSTALL_MAN_DIR
                   5803: 
                   5804:     directories that contain man pages
                   5805: 
                   5806: INSTALL_PROGRAM
                   5807: 
                   5808:     binaries that can be stripped from debugging symbols
                   5809: 
                   5810: INSTALL_SCRIPT
                   5811: 
                   5812:     binaries that cannot be stripped
                   5813: 
                   5814: INSTALL_GAME
                   5815: 
                   5816:     game binaries
                   5817: 
                   5818: INSTALL_LIB
                   5819: 
                   5820:     shared and static libraries
                   5821: 
                   5822: INSTALL_DATA
                   5823: 
                   5824:     data files
                   5825: 
                   5826: INSTALL_GAME_DATA
                   5827: 
                   5828:     data files for games
                   5829: 
                   5830: INSTALL_MAN
                   5831: 
                   5832:     man pages
                   5833: 
                   5834: Some other variables are:
                   5835: 
                   5836: INSTALLATION_DIRS
                   5837: 
                   5838:     A list of directories relative to PREFIX that are created by pkgsrc at the
                   5839:     beginning of the install phase. The package is supposed to create all
                   5840:     needed directories itself before installing files to it and list all other
                   5841:     directories here.
                   5842: 
                   5843: In the rare cases that a package shouldn't install anything, set NO_INSTALL to
                   5844: "yes". This is mostly relevant for packages in the regress category.
                   5845: 
                   5846: 16.15. The package phase
                   5847: 
                   5848: Once the install stage has completed, a binary package of the installed files
                   5849: can be built. These binary packages can be used for quick installation without
                   5850: previous compilation, e.g. by the make bin-install or by using pkg_add.
                   5851: 
                   5852: By default, the binary packages are created in ${PACKAGES}/All and symlinks are
                   5853: created in ${PACKAGES}/category, one for each category in the CATEGORIES
                   5854: variable. PACKAGES defaults to pkgsrc/packages.
                   5855: 
                   5856: If there should be no binary package, set NO_PACKAGE to "yes". This should only
                   5857: be used in rare cases, like when a package definitely is only usable on the
                   5858: machine where it is built and even then, a binary package can be useful.
                   5859: 
                   5860: 16.16. Cleaning up
                   5861: 
                   5862: Once you're finished with a package, you can clean the work directory by
                   5863: running make clean. If you want to clean the work directories of all
                   5864: dependencies too, use make clean-depends.
                   5865: 
                   5866: 16.17. Other helpful targets
                   5867: 
                   5868: pre/post-*
                   5869: 
                   5870:     For any of the main targets described in the previous section, two
                   5871:     auxiliary targets exist with "pre-" and "post-" used as a prefix for the
                   5872:     main target's name. These targets are invoked before and after the main
                   5873:     target is called, allowing extra configuration or installation steps be
                   5874:     performed from a package's Makefile, for example, which a program's
                   5875:     configure script or install target omitted.
                   5876: 
                   5877: do-*
                   5878: 
                   5879:     Should one of the main targets do the wrong thing, and should there be no
                   5880:     variable to fix this, you can redefine it with the do-* target. (Note that
                   5881:     redefining the target itself instead of the do-* target is a bad idea, as
                   5882:     the pre-* and post-* targets won't be called anymore, etc.) You will not
                   5883:     usually need to do this.
                   5884: 
                   5885: reinstall
                   5886: 
                   5887:     If you did a make install and you noticed some file was not installed
                   5888:     properly, you can repeat the installation with this target, which will
                   5889:     ignore the "already installed" flag.
                   5890: 
                   5891:     This is the default value of DEPENDS_TARGET except in the case of make
                   5892:     update and make package, where the defaults are "package" and "update",
                   5893:     respectively.
                   5894: 
                   5895: deinstall
                   5896: 
                   5897:     This target does a pkg_delete(1) in the current directory, effectively
                   5898:     de-installing the package. The following variables can be used to tune the
                   5899:     behaviour:
                   5900: 
                   5901:     PKG_VERBOSE
                   5902: 
                   5903:         Add a "-v" to the pkg_delete(1) command.
                   5904: 
                   5905:     DEINSTALLDEPENDS
                   5906: 
                   5907:         Remove all packages that require (depend on) the given package. This
                   5908:         can be used to remove any packages that may have been pulled in by a
                   5909:         given package, e.g. if make deinstall DEINSTALLDEPENDS=1 is done in
                   5910:         pkgsrc/x11/kde, this is likely to remove whole KDE. Works by adding
                   5911:         "-R" to the pkg_delete(1) command line.
                   5912: 
                   5913: bin-install
                   5914: 
                   5915:     Install a binary package from local disk and via FTP from a list of sites
                   5916:     (see the BINPKG_SITES variable), and do a make package if no binary package
                   5917:     is available anywhere. The arguments given to pkg_add can be set via
                   5918:     BIN_INSTALL_FLAGS e.g., to do verbose operation, etc.
                   5919: 
                   5920: update
                   5921: 
                   5922:     This target causes the current package to be updated to the latest version.
                   5923:     The package and all depending packages first get de-installed, then current
                   5924:     versions of the corresponding packages get compiled and installed. This is
                   5925:     similar to manually noting which packages are currently installed, then
                   5926:     performing a series of make deinstall and make install (or whatever
                   5927:     UPDATE_TARGET is set to) for these packages.
                   5928: 
                   5929:     You can use the "update" target to resume package updating in case a
                   5930:     previous make update was interrupted for some reason. However, in this
                   5931:     case, make sure you don't call make clean or otherwise remove the list of
                   5932:     dependent packages in WRKDIR. Otherwise, you lose the ability to
                   5933:     automatically update the current package along with the dependent packages
                   5934:     you have installed.
                   5935: 
                   5936:     Resuming an interrupted make update will only work as long as the package
                   5937:     tree remains unchanged. If the source code for one of the packages to be
                   5938:     updated has been changed, resuming make update will most certainly fail!
                   5939: 
                   5940:     The following variables can be used either on the command line or in /etc/
                   5941:     mk.conf to alter the behaviour of make update:
                   5942: 
                   5943:     UPDATE_TARGET
                   5944: 
                   5945:         Install target to recursively use for the updated package and the
                   5946:         dependent packages. Defaults to DEPENDS_TARGET if set, "install"
                   5947:         otherwise for make update. Other good targets are "package" or
                   5948:         "bin-install". Do not set this to "update" or you will get stuck in an
                   5949:         endless loop!
                   5950: 
                   5951:     NOCLEAN
                   5952: 
                   5953:         Don't clean up after updating. Useful if you want to leave the work
                   5954:         sources of the updated packages around for inspection or other
                   5955:         purposes. Be sure you eventually clean up the source tree (see the
                   5956:         "clean-update" target below) or you may run into troubles with old
                   5957:         source code still lying around on your next make or make update.
                   5958: 
                   5959:     REINSTALL
                   5960: 
                   5961:         Deinstall each package before installing (making DEPENDS_TARGET). This
                   5962:         may be necessary if the "clean-update" target (see below) was called
                   5963:         after interrupting a running make update.
                   5964: 
                   5965:     DEPENDS_TARGET
                   5966: 
                   5967:         Allows you to disable recursion and hardcode the target for packages.
                   5968:         The default is "update" for the update target, facilitating a recursive
                   5969:         update of prerequisite packages. Only set DEPENDS_TARGET if you want to
                   5970:         disable recursive updates. Use UPDATE_TARGET instead to just set a
                   5971:         specific target for each package to be installed during make update
                   5972:         (see above).
                   5973: 
                   5974: clean-update
                   5975: 
                   5976:     Clean the source tree for all packages that would get updated if make
                   5977:     update was called from the current directory. This target should not be
                   5978:     used if the current package (or any of its depending packages) have already
                   5979:     been de-installed (e.g., after calling make update) or you may lose some
                   5980:     packages you intended to update. As a rule of thumb: only use this target
                   5981:     before the first time you run make update and only if you have a dirty
                   5982:     package tree (e.g., if you used NOCLEAN).
                   5983: 
                   5984:     If you are unsure about whether your tree is clean, you can either perform
                   5985:     a make clean at the top of the tree, or use the following sequence of
                   5986:     commands from the directory of the package you want to update (before
                   5987:     running make update for the first time, otherwise you lose all the packages
                   5988:     you wanted to update!):
                   5989: 
                   5990:     # make clean-update
                   5991:     # make clean CLEANDEPENDS=YES
                   5992:     # make update
                   5993: 
                   5994: 
                   5995:     The following variables can be used either on the command line or in /etc/
                   5996:     mk.conf to alter the behaviour of make clean-update:
                   5997: 
                   5998:     CLEAR_DIRLIST
                   5999: 
                   6000:         After make clean, do not reconstruct the list of directories to update
                   6001:         for this package. Only use this if make update successfully installed
                   6002:         all packages you wanted to update. Normally, this is done automatically
                   6003:         on make update, but may have been suppressed by the NOCLEAN variable
                   6004:         (see above).
                   6005: 
                   6006: replace
                   6007: 
                   6008:     Update the installation of the current package. This differs from update in
                   6009:     that it does not replace dependent packages. You will need to install
                   6010:     pkgtools/pkg_tarup for this target to work.
                   6011: 
                   6012:     Be careful when using this target! There are no guarantees that dependent
                   6013:     packages will still work, in particular they will most certainly break if
                   6014:     you make replace a library package whose shared library major version
                   6015:     changed between your installed version and the new one. For this reason,
                   6016:     this target is not officially supported and only recommended for advanced
                   6017:     users.
                   6018: 
                   6019: info
                   6020: 
                   6021:     This target invokes pkg_info(1) for the current package. You can use this
                   6022:     to check which version of a package is installed.
                   6023: 
                   6024: index
                   6025: 
                   6026:     This is a top-level command, i.e. it should be used in the pkgsrc
                   6027:     directory. It creates a database of all packages in the local pkgsrc tree,
                   6028:     including dependencies, comment, maintainer, and some other useful
                   6029:     information. Individual entries are created by running make describe in the
                   6030:     packages' directories. This index file is saved as pkgsrc/INDEX. It can be
                   6031:     displayed in verbose format by running make print-index. You can search in
                   6032:     it with make search key=something. You can extract a list of all packages
                   6033:     that depend on a particular one by running make show-deps PKG=somepackage.
                   6034: 
                   6035:     Running this command takes a very long time, some hours even on fast
                   6036:     machines!
                   6037: 
                   6038: readme
                   6039: 
                   6040:     This target generates a README.html file, which can be viewed using a
                   6041:     browser such as www/firefox or www/links. The generated files contain
                   6042:     references to any packages which are in the PACKAGES directory on the local
                   6043:     host. The generated files can be made to refer to URLs based on
                   6044:     FTP_PKG_URL_HOST and FTP_PKG_URL_DIR. For example, if I wanted to generate
                   6045:     README.html files which pointed to binary packages on the local machine, in
                   6046:     the directory /usr/packages, set FTP_PKG_URL_HOST=file://localhost and
                   6047:     FTP_PKG_URL_DIR=/usr/packages. The ${PACKAGES} directory and its
                   6048:     subdirectories will be searched for all the binary packages.
                   6049: 
                   6050:     The target can be run at the toplevel or in category directories, in which
                   6051:     case it descends recursively.
                   6052: 
                   6053: readme-all
                   6054: 
                   6055:     This is a top-level command, run it in pkgsrc. Use this target to create a
                   6056:     file README-all.html which contains a list of all packages currently
                   6057:     available in the NetBSD Packages Collection, together with the category
                   6058:     they belong to and a short description. This file is compiled from the
                   6059:     pkgsrc/*/README.html files, so be sure to run this after a make readme.
                   6060: 
                   6061: cdrom-readme
                   6062: 
                   6063:     This is very much the same as the "readme" target (see above), but is to be
                   6064:     used when generating a pkgsrc tree to be written to a CD-ROM. This target
                   6065:     also produces README.html files, and can be made to refer to URLs based on
                   6066:     CDROM_PKG_URL_HOST and CDROM_PKG_URL_DIR.
                   6067: 
                   6068: show-distfiles
                   6069: 
                   6070:     This target shows which distfiles and patchfiles are needed to build the
                   6071:     package (ALLFILES, which contains all DISTFILES and PATCHFILES, but not
                   6072:     patches/*).
                   6073: 
                   6074: show-downlevel
                   6075: 
                   6076:     This target shows nothing if the package is not installed. If a version of
                   6077:     this package is installed, but is not the version provided in this version
                   6078:     of pkgsrc, then a warning message is displayed. This target can be used to
                   6079:     show which of your installed packages are downlevel, and so the old
                   6080:     versions can be deleted, and the current ones added.
                   6081: 
                   6082: show-pkgsrc-dir
                   6083: 
                   6084:     This target shows the directory in the pkgsrc hierarchy from which the
                   6085:     package can be built and installed. This may not be the same directory as
                   6086:     the one from which the package was installed. This target is intended to be
                   6087:     used by people who may wish to upgrade many packages on a single host, and
                   6088:     can be invoked from the top-level pkgsrc Makefile by using the
                   6089:     "show-host-specific-pkgs" target.
                   6090: 
                   6091: show-installed-depends
                   6092: 
                   6093:     This target shows which installed packages match the current package's
                   6094:     DEPENDS. Useful if out of date dependencies are causing build problems.
                   6095: 
                   6096: check-shlibs
                   6097: 
                   6098:     After a package is installed, check all its binaries and (on ELF platforms)
                   6099:     shared libraries to see if they find the shared libs they need. Run by
                   6100:     default if PKG_DEVELOPER is set in /etc/mk.conf.
                   6101: 
                   6102: print-PLIST
                   6103: 
                   6104:     After a "make install" from a new or upgraded pkg, this prints out an
                   6105:     attempt to generate a new PLIST from a find -newer work/.extract_done. An
                   6106:     attempt is made to care for shared libs etc., but it is strongly
                   6107:     recommended to review the result before putting it into PLIST. On upgrades,
                   6108:     it's useful to diff the output of this command against an already existing
                   6109:     PLIST file.
                   6110: 
                   6111:     If the package installs files via tar(1) or other methods that don't update
                   6112:     file access times, be sure to add these files manually to your PLIST, as
                   6113:     the "find -newer" command used by this target won't catch them!
                   6114: 
                   6115:     See Section 12.3, "Tweaking output of make print-PLIST" for more
                   6116:     information on this target.
                   6117: 
                   6118: bulk-package
                   6119: 
                   6120:     Used to do bulk builds. If an appropriate binary package already exists, no
                   6121:     action is taken. If not, this target will compile, install and package it
                   6122:     (and its depends, if PKG_DEPENDS is set properly. See Section 6.3.1,
                   6123:     "Configuration"). After creating the binary package, the sources, the
                   6124:     just-installed package and its required packages are removed, preserving
                   6125:     free disk space.
                   6126: 
                   6127:     Beware that this target may deinstall all packages installed on a system!
                   6128: 
                   6129: bulk-install
                   6130: 
                   6131:     Used during bulk-installs to install required packages. If an up-to-date
                   6132:     binary package is available, it will be installed via pkg_add(1). If not,
                   6133:     make bulk-package will be executed, but the installed binary won't be
                   6134:     removed.
                   6135: 
                   6136:     A binary package is considered "up-to-date" to be installed via pkg_add(1)
                   6137:     if:
                   6138: 
                   6139:       * None of the package's files (Makefile, ...) were modified since it was
                   6140:         built.
                   6141: 
                   6142:       * None of the package's required (binary) packages were modified since it
                   6143:         was built.
                   6144: 
                   6145:     Beware that this target may deinstall all packages installed on a system!
                   6146: 
                   6147: Chapter 17. Tools needed for building or running
                   6148: 
                   6149: Table of Contents
                   6150: 
                   6151: 17.1. Tools for pkgsrc builds
                   6152: 17.2. Tools needed by packages
                   6153: 17.3. Tools provided by platforms
                   6154: 17.4. Questions regarding the tools
                   6155: 
                   6156: The USE_TOOLS definition is used both internally by pkgsrc and also for
                   6157: individual packages to define what commands are needed for building a package
                   6158: (like BUILD_DEPENDS) or for later run-time of an installed packaged (such as
                   6159: DEPENDS). If the native system provides an adequate tool, then in many cases, a
                   6160: pkgsrc package will not be used.
                   6161: 
                   6162: When building a package, the replacement tools are made available in a
                   6163: directory (as symlinks or wrapper scripts) that is early in the executable
                   6164: search path. Just like the buildlink system, this helps with consistent builds.
                   6165: 
                   6166: A tool may be needed to help build a specific package. For example, perl, GNU
                   6167: make (gmake) or yacc may be needed.
                   6168: 
                   6169: Also a tool may be needed, for example, because the native system's supplied
                   6170: tool may be inefficient for building a package with pkgsrc. For example, a
                   6171: package may need GNU awk, bison (instead of yacc) or a better sed.
                   6172: 
                   6173: The tools used by a package can be listed by running make show-tools.
                   6174: 
                   6175: 17.1. Tools for pkgsrc builds
                   6176: 
                   6177: The default set of tools used by pkgsrc is defined in bsd.pkg.mk. This includes
                   6178: standard Unix tools, such as: cat, awk, chmod, test, and so on. These can be
                   6179: seen by running: make show-var VARNAME=USE_TOOLS.
                   6180: 
                   6181: If a package needs a specific program to build then the USE_TOOLS variable can
                   6182: be used to define the tools needed.
                   6183: 
                   6184: 17.2. Tools needed by packages
                   6185: 
                   6186: In the following examples, the :pkgsrc means to use the pkgsrc version and not
                   6187: the native version for a build dependency. And the :run means that it is used
                   6188: for a run-time dependencies also (and becomes a DEPENDS). The default is a
                   6189: build dependency which can be set with :build. (So in this example, it is the
                   6190: same as gmake:build and pkg-config:build.)
                   6191: 
                   6192: USE_TOOLS+=     mktemp:pkgsrc
                   6193: USE_TOOLS+=     gmake perl:run pkg-config
                   6194: 
                   6195: When using the tools framework, a TOOLS_PATH.foo variable is defined which
                   6196: contains the full path to the appropriate tool. For example, TOOLS_PATH.bash
                   6197: could be "/bin/bash" on Linux systems.
                   6198: 
                   6199: If you always need a pkgsrc version of the tool at run-time, then just use
                   6200: DEPENDS instead.
                   6201: 
                   6202: 17.3. Tools provided by platforms
                   6203: 
                   6204: When improving or porting pkgsrc to a new platform, have a look at (or create)
                   6205: the corresponding platform specific make file fragment under pkgsrc/mk/tools/
                   6206: tools.${OPSYS}.mk which defines the name of the common tools. For example:
                   6207: 
                   6208: .if exists(/usr/bin/bzcat)
                   6209: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   6210: .elif exists(/usr/bin/bzip2)
                   6211: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   6212: .endif
                   6213: 
                   6214: TOOLS_PLATFORM.true?=           true                    # shell builtin
                   6215: 
                   6216: 17.4. Questions regarding the tools
                   6217: 
                   6218: 17.4.1. How do I add a new tool?
                   6219: 17.4.2. How do I get a list of all available tools?
                   6220: 17.4.3. How can I get a list of all the tools that a package is using while
                   6221:     being built? I want to know whether it uses sed or not.
                   6222: 
                   6223: 17.4.1. How do I add a new tool?
                   6224: 
                   6225:         TODO
                   6226: 
                   6227: 17.4.2. How do I get a list of all available tools?
                   6228: 
                   6229:         TODO
                   6230: 
                   6231: 17.4.3. How can I get a list of all the tools that a package is using while
                   6232:         being built? I want to know whether it uses sed or not.
                   6233: 
                   6234:         Currently, you can't. (TODO: But I want to be able to do it.)
                   6235: 
                   6236: Chapter 18. Making your package work
                   6237: 
                   6238: Table of Contents
                   6239: 
                   6240: 18.1. General operation
                   6241: 
                   6242:     18.1.1. Portability of packages
                   6243:     18.1.2. How to pull in user-settable variables from mk.conf
                   6244:     18.1.3. User interaction
                   6245:     18.1.4. Handling licenses
                   6246:     18.1.5. Restricted packages
                   6247:     18.1.6. Handling dependencies
                   6248:     18.1.7. Handling conflicts with other packages
                   6249:     18.1.8. Packages that cannot or should not be built
                   6250:     18.1.9. Packages which should not be deleted, once installed
                   6251:     18.1.10. Handling packages with security problems
                   6252:     18.1.11. How to handle incrementing versions when fixing an existing
                   6253:         package
                   6254:     18.1.12. Substituting variable text in the package files (the SUBST
                   6255:         framework)
                   6256: 
                   6257: 18.2. Fixing problems in the fetch phase
                   6258: 
                   6259:     18.2.1. Packages whose distfiles aren't available for plain downloading
                   6260:     18.2.2. How to handle modified distfiles with the 'old' name
                   6261: 
                   6262: 18.3. Fixing problems in the configure phase
                   6263: 
                   6264:     18.3.1. Shared libraries - libtool
                   6265:     18.3.2. Using libtool on GNU packages that already support libtool
                   6266:     18.3.3. GNU Autoconf/Automake
                   6267: 
                   6268: 18.4. Programming languages
                   6269: 
                   6270:     18.4.1. C, C++, and Fortran
                   6271:     18.4.2. Java
                   6272:     18.4.3. Packages containing perl scripts
                   6273:     18.4.4. Other programming languages
                   6274: 
                   6275: 18.5. Fixing problems in the build phase
                   6276: 
                   6277:     18.5.1. Compiling C and C++ code conditionally
                   6278:     18.5.2. How to handle compiler bugs
                   6279:     18.5.3. Undefined reference to "..."
                   6280:     18.5.4. Running out of memory
                   6281: 
                   6282: 18.6. Fixing problems in the install phase
                   6283: 
                   6284:     18.6.1. Creating needed directories
                   6285:     18.6.2. Where to install documentation
                   6286:     18.6.3. Installing highscore files
                   6287:     18.6.4. Packages with hardcoded paths to other interpreters
                   6288:     18.6.5. Packages installing perl modules
                   6289:     18.6.6. Packages installing info files
                   6290:     18.6.7. Packages installing man pages
                   6291:     18.6.8. Packages installing GConf2 data files
                   6292:     18.6.9. Packages installing scrollkeeper data files
                   6293:     18.6.10. Packages installing X11 fonts
                   6294:     18.6.11. Packages installing GTK2 modules
                   6295:     18.6.12. Packages installing SGML or XML data
                   6296:     18.6.13. Packages installing extensions to the MIME database
                   6297:     18.6.14. Packages using intltool
                   6298:     18.6.15. Packages installing startup scripts
                   6299:     18.6.16. Packages installing TeX modules
                   6300:     18.6.17. Packages supporting running binaries in emulation
                   6301:     18.6.18. Packages installing hicolor theme icons
                   6302:     18.6.19. Packages installing desktop files
                   6303: 
                   6304: 18.7. Marking packages as having problems
                   6305: 
                   6306: 18.1. General operation
                   6307: 
                   6308: 18.1.1. Portability of packages
                   6309: 
                   6310: One appealing feature of pkgsrc is that it runs on many different platforms. As
                   6311: a result, it is important to ensure, where possible, that packages in pkgsrc
                   6312: are portable. This chapter mentions some particular details you should pay
                   6313: attention to while working on pkgsrc.
                   6314: 
                   6315: 18.1.2. How to pull in user-settable variables from mk.conf
                   6316: 
                   6317: The pkgsrc user can configure pkgsrc by overriding several variables in the
                   6318: file pointed to by MAKECONF, which is /etc/mk.conf by default. When you want to
                   6319: use those variables in the preprocessor directives of make(1) (for example .if
                   6320: or .for), you need to include the file ../../mk/bsd.prefs.mk before, which in
                   6321: turn loads the user preferences.
                   6322: 
                   6323: But note that some variables may not be completely defined after ../../mk/
                   6324: bsd.prefs.mk has been included, as they may contain references to variables
                   6325: that are not yet defined. In shell commands this is no problem, since variables
                   6326: are actually macros, which are only expanded when they are used. But in the
                   6327: preprocessor directives mentioned above and in dependency lines (of the form
                   6328: target: dependencies) the variables are expanded at load time.
                   6329: 
                   6330: Note
                   6331: 
                   6332: Currently there is no exhaustive list of all variables that tells you whether
                   6333: they can be used at load time or only at run time, but it is in preparation.
                   6334: 
                   6335: 18.1.3. User interaction
                   6336: 
                   6337: Occasionally, packages require interaction from the user, and this can be in a
                   6338: number of ways:
                   6339: 
                   6340:   * When fetching the distfiles, some packages require user interaction such as
                   6341:     entering username/password or accepting a license on a web page.
                   6342: 
                   6343:   * When extracting the distfiles, some packages may ask for passwords.
                   6344: 
                   6345:   * help to configure the package before it is built
                   6346: 
                   6347:   * help during the build process
                   6348: 
                   6349:   * help during the installation of a package
                   6350: 
                   6351: The INTERACTIVE_STAGE definition is provided to notify the pkgsrc mechanism of
                   6352: an interactive stage which will be needed, and this should be set in the
                   6353: package's Makefile, e.g.:
                   6354: 
                   6355: INTERACTIVE_STAGE=      build
                   6356: 
                   6357: 
                   6358: Multiple interactive stages can be specified:
                   6359: 
                   6360: INTERACTIVE_STAGE=      configure install
                   6361: 
                   6362: 
                   6363: The user can then decide to skip this package by setting the BATCH variable.
                   6364: 
                   6365: 18.1.4. Handling licenses
                   6366: 
                   6367: Authors of software can choose the licence under which software can be copied.
                   6368: This is due to copyright law, and reasons for license choices are outside the
                   6369: scope of pkgsrc. The pkgsrc system recognizes that there are a number of
                   6370: licenses which some users may find objectionable or difficult or impossible to
                   6371: comply with. The Free Software Foundation has declared some licenses "Free",
                   6372: and the Open Source Initiative has a definition of "Open Source". The pkgsrc
                   6373: system, as a policy choice, does not label packages which have licenses that
                   6374: are Free or Open Source. However, packages without a license meeting either of
                   6375: those tests are labeled with a license tag denoting the license. Note that a
                   6376: package with no license to copy trivially does not meet either the Free or Open
                   6377: Source test.
                   6378: 
                   6379: For packages which are not Free or Open Source, pkgsrc will not build the
                   6380: package unless the user has indicated to pkgsrc that packages with that
                   6381: particular license may be built. Note that this documentation avoids the term
                   6382: "accepted the license". The pkgsrc system is merely providing a mechanism to
                   6383: avoid accidentally building a package with a non-free license; judgement and
                   6384: responsibility remain with the user. (Installation of binary packages are not
                   6385: currently subject to this mechanism; this is a bug.)
                   6386: 
                   6387: One might want to only install packages with a BSD license, or the GPL, and not
                   6388: the other. The pkgsrc license tag mechanism does not provide a way to do this.
                   6389: It might be possible to put in tags for free licenses, and have a default
                   6390: ACCEPTABLE_LICENSES variable value, but this is widely viewed as having a very
                   6391: poor ratio of benefit to work.
                   6392: 
                   6393: The license tag mechanism is intended to address copyright-related issues
                   6394: surrounding building, installing and using a package, and not to address
                   6395: redistribution issues (see RESTRICTED and NO_SRC_ON_FTP, etc.). However, the
                   6396: above definition of licenses for which tags are not needed implies that
                   6397: packages with redistribution restrictions should have tags, because Free or
                   6398: Open Source programs do not have redistribution restrictions.
                   6399: 
                   6400: Denoting that a package may be copied according to a particular license is done
                   6401: by placing the license in pkgsrc/licenses and setting the LICENSE variable to a
                   6402: string identifying the license, e.g. in graphics/xv:
                   6403: 
                   6404: LICENSE=        xv-license
                   6405: 
                   6406: 
                   6407: When trying to build, the user will get a notice that the package is covered by
                   6408: a license which has not been placed in the ACCEPTABLE_LICENSES variable:
                   6409: 
                   6410: % make
                   6411: ===> xv-3.10anb9 has an unacceptable license: xv-license.
                   6412: ===>     To view the license, enter "/usr/bin/make show-license".
                   6413: ===>     To indicate acceptance, add this line to your /etc/mk.conf:
                   6414: ===>     ACCEPTABLE_LICENSES+=xv-license
                   6415: *** Error code 1
                   6416: 
                   6417: 
                   6418: The license can be viewed with make show-license, and if the user so chooses,
                   6419: the line printed above can be added to /etc/mk.conf to convey to pkgsrc that it
                   6420: should not in the future fail because of that license:
                   6421: 
                   6422: ACCEPTABLE_LICENSES+=xv-license
                   6423: 
                   6424: 
                   6425: When adding a package with a new license, the license text should be added to
                   6426: pkgsrc/licenses for displaying. A list of known licenses can be seen in this
                   6427: directory.
                   6428: 
                   6429: When the license changes (in a way other than formatting), please make sure
                   6430: that the new license has a different name (e.g., append the version number if
                   6431: it exists, or the date). Just because a user told pkgsrc to build programs
                   6432: under a previous version of a license does not mean that pkgsrc should build
                   6433: programs under the new licenses. The higher-level point is that pkgsrc does not
                   6434: evaluate licenses for reasonableness; the only test is a mechanistic test of
                   6435: whether a particular text has been approved by either of two bodies.
                   6436: 
                   6437: The use of LICENSE=shareware, LICENSE=no-commercial-use, and similar language
                   6438: is deprecated because it does not crisply refer to a particular license text.
                   6439: Another problem with such usage is that it does not enable a user to tell
                   6440: pkgsrc to proceed for a single package without also telling pkgsrc to proceed
                   6441: for all packages with that tag.
                   6442: 
                   6443: 18.1.5. Restricted packages
                   6444: 
                   6445: Some licenses restrict how software may be re-distributed. Because a license
                   6446: tag is required unless the package is Free or Open Source, all packages with
                   6447: restrictions should have license tags. By declaring the restrictions, package
                   6448: tools can automatically refrain from e.g. placing binary packages on FTP sites.
                   6449: 
                   6450: There are four restrictions that may be encoded, which are the cross product of
                   6451: sources (distfiles) and binaries not being placed on FTP sites and CD-ROMs.
                   6452: Because this is rarely the exact language in any license, and because non-Free
                   6453: licenses tend to be different from each other, pkgsrc adopts a definition of
                   6454: FTP and CD-ROM. Pkgsrc uses "FTP" to mean that the source or binary file should
                   6455: not be made available over the Internet at no charge. Pkgsrc uses "CD-ROM" to
                   6456: mean that the source or binary may not be made available on some kind of media,
                   6457: together with other source and binary packages, and which is sold for a
                   6458: distribution charge.
                   6459: 
                   6460: In order to encode these restrictions, the package system defines five make
                   6461: variables that can be set to note these restrictions:
                   6462: 
                   6463:   * RESTRICTED
                   6464: 
                   6465:     This variable should be set whenever a restriction exists (regardless of
                   6466:     its kind). Set this variable to a string containing the reason for the
                   6467:     restriction. It should be understood that those wanting to understand the
                   6468:     restriction will have to read the license, and perhaps seek advice of
                   6469:     counsel.
                   6470: 
                   6471:   * NO_BIN_ON_CDROM
                   6472: 
                   6473:     Binaries may not be placed on CD-ROM containing other binary packages, for
                   6474:     which a distribution charge may be made. In this case, set this variable to
                   6475:     ${RESTRICTED}.
                   6476: 
                   6477:   * NO_BIN_ON_FTP
                   6478: 
                   6479:     Binaries may not made available on the Internet without charge. In this
                   6480:     case, set this variable to ${RESTRICTED}. If this variable is set, binary
                   6481:     packages will not be included on ftp.NetBSD.org.
                   6482: 
                   6483:   * NO_SRC_ON_CDROM
                   6484: 
                   6485:     Distfiles may not be placed on CD-ROM, together with other distfiles, for
                   6486:     which a fee may be charged. In this case, set this variable to $
                   6487:     {RESTRICTED}.
                   6488: 
                   6489:   * NO_SRC_ON_FTP
                   6490: 
                   6491:     Distfiles may not made available via FTP at no charge. In this case, set
                   6492:     this variable to ${RESTRICTED}. If this variable is set, the distfile(s)
                   6493:     will not be mirrored on ftp.NetBSD.org.
                   6494: 
                   6495: Please note that the use of NO_PACKAGE, IGNORE, NO_CDROM, or other generic make
                   6496: variables to denote restrictions is deprecated, because they unconditionally
                   6497: prevent users from generating binary packages!
                   6498: 
                   6499: 18.1.6. Handling dependencies
                   6500: 
                   6501: Your package may depend on some other package being present - and there are
                   6502: various ways of expressing this dependency. pkgsrc supports the BUILD_DEPENDS
                   6503: and DEPENDS definitions, the USE_TOOLS definition, as well as dependencies via
                   6504: buildlink3.mk, which is the preferred way to handle dependencies, and which
                   6505: uses the variables named above. See Chapter 13, Buildlink methodology for more
                   6506: information.
                   6507: 
                   6508: The basic difference between the two variables is as follows: The DEPENDS
                   6509: definition registers that pre-requisite in the binary package so it will be
                   6510: pulled in when the binary package is later installed, whilst the BUILD_DEPENDS
                   6511: definition does not, marking a dependency that is only needed for building the
                   6512: package.
                   6513: 
                   6514: This means that if you only need a package present whilst you are building, it
                   6515: should be noted as a BUILD_DEPENDS.
                   6516: 
                   6517: The format for a BUILD_DEPENDS and a DEPENDS definition is:
                   6518: 
                   6519: <pre-req-package-name>:../../<category>/<pre-req-package>
                   6520: 
                   6521: 
                   6522: Please note that the "pre-req-package-name" may include any of the wildcard
                   6523: version numbers recognized by pkg_info(1).
                   6524: 
                   6525:  1. If your package needs another package's binaries or libraries to build or
                   6526:     run, and if that package has a buildlink3.mk file available, use it:
                   6527: 
                   6528:     .include "../../graphics/jpeg/buildlink3.mk"
                   6529: 
                   6530: 
                   6531:  2. If your package needs to use another package to build itself and there is
                   6532:     no buildlink3.mk file available, use the BUILD_DEPENDS definition:
                   6533: 
                   6534:     BUILD_DEPENDS+= autoconf-2.13:../../devel/autoconf
                   6535: 
                   6536: 
                   6537:  3. If your package needs a library with which to link and again there is no
                   6538:     buildlink3.mk file available, this is specified using the DEPENDS
                   6539:     definition. For example:
                   6540: 
                   6541:     DEPENDS+=       xpm-3.4j:../../graphics/xpm
                   6542: 
                   6543: 
                   6544:     You can also use wildcards in package dependences:
                   6545: 
                   6546:     DEPENDS+=       xpm-[0-9]*:../../graphics/xpm
                   6547: 
                   6548: 
                   6549:     Note that such wildcard dependencies are retained when creating binary
                   6550:     packages. The dependency is checked when installing the binary package and
                   6551:     any package which matches the pattern will be used. Wildcard dependencies
                   6552:     should be used with care.
                   6553: 
                   6554:     The "-[0-9]*" should be used instead of "-*" to avoid potentially ambiguous
                   6555:     matches such as "tk-postgresql" matching a "tk-*" DEPENDS.
                   6556: 
                   6557:     Wildcards can also be used to specify that a package will only build
                   6558:     against a certain minimum version of a pre-requisite:
                   6559: 
                   6560:     DEPENDS+=       tiff>=3.5.4:../../graphics/tiff
                   6561: 
                   6562: 
                   6563:     This means that the package will build against version 3.5.4 of the tiff
                   6564:     library or newer. Such a dependency may be warranted if, for example, the
                   6565:     API of the library has changed with version 3.5.4 and a package would not
                   6566:     compile against an earlier version of tiff.
                   6567: 
                   6568:     Please note that such dependencies should only be updated if a package
                   6569:     requires a newer pre-requisite, but not to denote recommendations such as
                   6570:     ABI changes that do not prevent a package from building correctly. Such
                   6571:     recommendations can be expressed using ABI_DEPENDS:
                   6572: 
                   6573:     ABI_DEPENDS+=   tiff>=3.6.1:../../graphics/tiff
                   6574: 
                   6575: 
                   6576:     In addition to the above DEPENDS line, this denotes that while a package
                   6577:     will build against tiff>=3.5.4, at least version 3.6.1 is recommended.
                   6578:     ABI_DEPENDS entries will be turned into dependencies unless explicitly
                   6579:     ignored (in which case a warning will be printed).
                   6580: 
                   6581:     To ignore these ABI dependency recommendations and just use the required
                   6582:     DEPENDS, set USE_ABI_DEPENDS=NO. This may make it easier and faster to
                   6583:     update packages built using pkgsrc, since older compatible dependencies can
                   6584:     continue to be used. This is useful for people who watch their rebuilds
                   6585:     very carefully; it is not very good as a general-purpose hammer. If you use
                   6586:     it, you need to be mindful of possible ABI changes, including those from
                   6587:     the underlying OS.
                   6588: 
                   6589:     Packages that are built with recommendations ignored may not be uploaded to
                   6590:     ftp.NetBSD.org by developers and should not be used across different
                   6591:     systems that may have different versions of binary packages installed.
                   6592: 
                   6593:     For security fixes, please update the package vulnerabilities file. See
                   6594:     Section 18.1.10, "Handling packages with security problems" for more
                   6595:     information.
                   6596: 
                   6597:  4. If your package needs some executable to be able to run correctly and if
                   6598:     there's no buildlink3.mk file, this is specified using the DEPENDS
                   6599:     variable. The print/lyx package needs to be able to execute the latex
                   6600:     binary from the teTeX package when it runs, and that is specified:
                   6601: 
                   6602:     DEPENDS+=        teTeX-[0-9]*:../../print/teTeX
                   6603: 
                   6604: 
                   6605:     The comment about wildcard dependencies from previous paragraph applies
                   6606:     here, too.
                   6607: 
                   6608: If your package needs files from another package to build, add the relevant
                   6609: distribution files to DISTFILES, so they will be extracted automatically. See
                   6610: the print/ghostscript package for an example. (It relies on the jpeg sources
                   6611: being present in source form during the build.)
                   6612: 
                   6613: 18.1.7. Handling conflicts with other packages
                   6614: 
                   6615: Your package may conflict with other packages a user might already have
                   6616: installed on his system, e.g. if your package installs the same set of files as
                   6617: another package in the pkgsrc tree.
                   6618: 
                   6619: In this case you can set CONFLICTS to a space-separated list of packages
                   6620: (including version string) your package conflicts with.
                   6621: 
                   6622: For example, x11/Xaw3d and x11/Xaw-Xpm install the same shared library, thus
                   6623: you set in pkgsrc/x11/Xaw3d/Makefile:
                   6624: 
                   6625: CONFLICTS=      Xaw-Xpm-[0-9]*
                   6626: 
                   6627: 
                   6628: and in pkgsrc/x11/Xaw-Xpm/Makefile:
                   6629: 
                   6630: CONFLICTS=      Xaw3d-[0-9]*
                   6631: 
                   6632: 
                   6633: Packages will automatically conflict with other packages with the name prefix
                   6634: and a different version string. "Xaw3d-1.5" e.g. will automatically conflict
                   6635: with the older version "Xaw3d-1.3".
                   6636: 
                   6637: 18.1.8. Packages that cannot or should not be built
                   6638: 
                   6639: There are several reasons why a package might be instructed to not build under
                   6640: certain circumstances. If the package builds and runs on most platforms, the
                   6641: exceptions should be noted with NOT_FOR_PLATFORM. If the package builds and
                   6642: runs on a small handful of platforms, set ONLY_FOR_PLATFORM instead. Both
                   6643: ONLY_FOR_PLATFORM and NOT_FOR_PLATFORM are OS triples (OS-version-platform)
                   6644: that can use glob-style wildcards.
                   6645: 
                   6646: Some packages are tightly bound to a specific version of an operating system,
                   6647: e.g. LKMs or sysutils/lsof. Such binary packages are not backwards compatible
                   6648: with other versions of the OS, and should be uploaded to a version specific
                   6649: directory on the FTP server. Mark these packages by setting OSVERSION_SPECIFIC
                   6650: to "yes". This variable is not currently used by any of the package system
                   6651: internals, but may be used in the future.
                   6652: 
                   6653: If the package should be skipped (for example, because it provides
                   6654: functionality already provided by the system), set PKG_SKIP_REASON to a
                   6655: descriptive message. If the package should fail because some preconditions are
                   6656: not met, set PKG_FAIL_REASON to a descriptive message.
                   6657: 
                   6658: 18.1.9. Packages which should not be deleted, once installed
                   6659: 
                   6660: To ensure that a package may not be deleted, once it has been installed, the
                   6661: PKG_PRESERVE definition should be set in the package Makefile. This will be
                   6662: carried into any binary package that is made from this pkgsrc entry. A
                   6663: "preserved" package will not be deleted using pkg_delete(1) unless the "-f"
                   6664: option is used.
                   6665: 
                   6666: 18.1.10. Handling packages with security problems
                   6667: 
                   6668: When a vulnerability is found, this should be noted in localsrc/security/
                   6669: advisories/pkg-vulnerabilities, and after committing that file, use make upload
                   6670: in the same directory to update the file on ftp.NetBSD.org.
                   6671: 
                   6672: After fixing the vulnerability by a patch, its PKGREVISION should be increased
                   6673: (this is of course not necessary if the problem is fixed by using a newer
                   6674: release of the software).
                   6675: 
                   6676: Also, if the fix should be applied to the stable pkgsrc branch, be sure to
                   6677: submit a pullup request!
                   6678: 
                   6679: Binary packages already on ftp.NetBSD.org will be handled semi-automatically by
                   6680: a weekly cron job.
                   6681: 
                   6682: 18.1.11. How to handle incrementing versions when fixing an existing package
                   6683: 
                   6684: When making fixes to an existing package it can be useful to change the version
                   6685: number in PKGNAME. To avoid conflicting with future versions by the original
                   6686: author, a "nb1", "nb2", ... suffix can be used on package versions by setting
                   6687: PKGREVISION=1 (2, ...). The "nb" is treated like a "." by the package tools.
                   6688: e.g.
                   6689: 
                   6690: DISTNAME=       foo-17.42
                   6691: PKGREVISION=    9
                   6692: 
                   6693: 
                   6694: will result in a PKGNAME of "foo-17.42nb9". If you want to use the original
                   6695: value of PKGNAME without the "nbX" suffix, e.g. for setting DIST_SUBDIR, use
                   6696: PKGNAME_NOREV.
                   6697: 
                   6698: When a new release of the package is released, the PKGREVISION should be
                   6699: removed, e.g. on a new minor release of the above package, things should be
                   6700: like:
                   6701: 
                   6702: DISTNAME=       foo-17.43
                   6703: 
                   6704: 
                   6705: PKGREVISION should be incremented for any non-trivial change in the resulting
                   6706: binary package. Without a PKGREVISION bump, someone with the previous version
                   6707: installed has no way of knowing that their package is out of date. Thus,
                   6708: changes without increasing PKGREVISION are essentially labeled "this is so
                   6709: trivial that no reasonable person would want to upgrade", and this is the rough
                   6710: test for when increasing PKGREVISION is appropriate. Examples of changes that
                   6711: do not merit increasing PKGREVISION are:
                   6712: 
                   6713:   * Changing HOMEPAGE, MAINTAINER, or comments in Makefile.
                   6714: 
                   6715:   * Changing build variables if the resulting binary package is the same.
                   6716: 
                   6717:   * Changing DESCR.
                   6718: 
                   6719:   * Adding PKG_OPTIONS if the default options don't change.
                   6720: 
                   6721: Examples of changes that do merit an increase to PKGREVISION include:
                   6722: 
                   6723:   * Security fixes
                   6724: 
                   6725:   * Changes or additions to a patch file
                   6726: 
                   6727:   * Changes to the PLIST
                   6728: 
                   6729: PKGREVISION must also be incremented when dependencies have ABI changes.
                   6730: 
                   6731: 18.1.12. Substituting variable text in the package files (the SUBST framework)
                   6732: 
                   6733: When you want to replace the same text in multiple files or when the
                   6734: replacement text varies, patches alone cannot help. This is where the SUBST
                   6735: framework comes in. It provides an easy-to-use interface for replacing text in
                   6736: files. Example:
                   6737: 
                   6738: SUBST_CLASSES+=                 fix-paths
                   6739: SUBST_STAGE.fix-paths=          pre-configure
                   6740: SUBST_MESSAGE.fix-paths=        Fixing absolute paths.
                   6741: SUBST_FILES.fix-paths=          src/*.c
                   6742: SUBST_FILES.fix-paths+=         scripts/*.sh
                   6743: SUBST_SED.fix-paths=            -e 's,"/usr/local,"${PREFIX},g'
                   6744: SUBST_SED.fix-paths+=           -e 's,"/var/log,"${VARBASE}/log,g'
                   6745: 
                   6746: 
                   6747: SUBST_CLASSES is a list of identifiers that are used to identify the different
                   6748: SUBST blocks that are defined. The SUBST framework is heavily used by pkgsrc,
                   6749: so it is important to always use the += operator with this variable. Otherwise
                   6750: some substitutions may be skipped.
                   6751: 
                   6752: The remaining variables of each SUBST block are parameterized with the
                   6753: identifier from the first line (fix-paths in this case.) They can be seen as
                   6754: parameters to a function call.
                   6755: 
                   6756: SUBST_STAGE.* specifies the stage at which the replacement will take place. All
                   6757: combinations of pre-, do- and post- together with a phase name are possible,
                   6758: though only few are actually used. Most commonly used are post-patch and
                   6759: pre-configure. Of these two, pre-configure should be preferred because then it
                   6760: is possible to run bmake patch and have the state after applying the patches
                   6761: but before making any other changes. This is especially useful when you are
                   6762: debugging a package in order to create new patches for it. Similarly,
                   6763: post-build is preferred over pre-install, because the install phase should
                   6764: generally be kept as simple as possible. When you use post-build, you have the
                   6765: same files in the working directory that will be installed later, so you can
                   6766: check if the substitution has succeeded.
                   6767: 
                   6768: SUBST_MESSAGE.* is an optional text that is printed just before the
                   6769: substitution is done.
                   6770: 
                   6771: SUBST_FILES.* is the list of shell globbing patterns that specifies the files
                   6772: in which the substitution will take place. The patterns are interpreted
                   6773: relatively to the WRKSRC directory.
                   6774: 
                   6775: SUBST_SED.* is a list of arguments to sed(1) that specify the actual
                   6776: substitution. Every sed command should be prefixed with -e, so that all SUBST
                   6777: blocks look uniform.
                   6778: 
                   6779: There are some more variables, but they are so seldomly used that they are only
                   6780: documented in the mk/subst.mk file.
                   6781: 
                   6782: 18.2. Fixing problems in the fetch phase
                   6783: 
                   6784: 18.2.1. Packages whose distfiles aren't available for plain downloading
                   6785: 
                   6786: If you need to download from a dynamic URL you can set DYNAMIC_MASTER_SITES and
                   6787: a make fetch will call files/getsite.sh with the name of each file to download
                   6788: as an argument, expecting it to output the URL of the directory from which to
                   6789: download it. graphics/ns-cult3d is an example of this usage.
                   6790: 
                   6791: If the download can't be automated, because the user must submit personal
                   6792: information to apply for a password, or must pay for the source, or whatever,
                   6793: you can set FETCH_MESSAGE to a list of lines that are displayed to the user
                   6794: before aborting the build. Example:
                   6795: 
                   6796: FETCH_MESSAGE=  "Please download the files"
                   6797: FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   6798: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
                   6799: 
                   6800: 
                   6801: 18.2.2. How to handle modified distfiles with the 'old' name
                   6802: 
                   6803: Sometimes authors of a software package make some modifications after the
                   6804: software was released, and they put up a new distfile without changing the
                   6805: package's version number. If a package is already in pkgsrc at that time, the
                   6806: checksum will no longer match. The contents of the new distfile should be
                   6807: compared against the old one before changing anything, to make sure the
                   6808: distfile was really updated on purpose, and that no trojan horse or so crept
                   6809: in. Please mention that the distfiles were compared and what was found in your
                   6810: commit message. Then, the correct way to work around this is to set DIST_SUBDIR
                   6811: to a unique directory name, usually based on PKGNAME_NOREV. All DISTFILES and
                   6812: PATCHFILES for this package will be put in that subdirectory of the local
                   6813: distfiles directory. (See Section 18.1.11, "How to handle incrementing versions
                   6814: when fixing an existing package" for more details.) In case this happens more
                   6815: often, PKGNAME can be used (thus including the nbX suffix) or a date stamp can
                   6816: be appended, like ${PKGNAME_NOREV}-YYYYMMDD. Do not forget regenerating the
                   6817: distinfo file after that, since it contains the DIST_SUBDIR path in the
                   6818: filenames. Also increase the PKGREVISION if the installed package is different.
                   6819: Furthermore, a mail to the package's authors seems appropriate telling them
                   6820: that changing distfiles after releases without changing the file names is not
                   6821: good practice.
                   6822: 
                   6823: 18.3. Fixing problems in the configure phase
                   6824: 
                   6825: 18.3.1. Shared libraries - libtool
                   6826: 
                   6827: pkgsrc supports many different machines, with different object formats like
                   6828: a.out and ELF, and varying abilities to do shared library and dynamic loading
                   6829: at all. To accompany this, varying commands and options have to be passed to
                   6830: the compiler, linker, etc. to get the Right Thing, which can be pretty annoying
                   6831: especially if you don't have all the machines at your hand to test things. The
                   6832: devel/libtool pkg can help here, as it just "knows" how to build both static
                   6833: and dynamic libraries from a set of source files, thus being
                   6834: platform-independent.
                   6835: 
                   6836: Here's how to use libtool in a package in seven simple steps:
                   6837: 
                   6838:  1. Add USE_LIBTOOL=yes to the package Makefile.
                   6839: 
                   6840:  2. For library objects, use "${LIBTOOL} --mode=compile ${CC}" in place of "$
                   6841:     {CC}". You could even add it to the definition of CC, if only libraries are
                   6842:     being built in a given Makefile. This one command will build both PIC and
                   6843:     non-PIC library objects, so you need not have separate shared and
                   6844:     non-shared library rules.
                   6845: 
                   6846:  3. For the linking of the library, remove any "ar", "ranlib", and "ld
                   6847:     -Bshareable" commands, and instead use:
                   6848: 
                   6849:     ${LIBTOOL} --mode=link \
                   6850:         ${CC} -o ${.TARGET:.a=.la} \
                   6851:             ${OBJS:.o=.lo} \
                   6852:             -rpath ${PREFIX}/lib \
                   6853:             -version-info major:minor
                   6854: 
                   6855: 
                   6856:     Note that the library is changed to have a .la extension, and the objects
                   6857:     are changed to have a .lo extension. Change OBJS as necessary. This
                   6858:     automatically creates all of the .a, .so.major.minor, and ELF symlinks (if
                   6859:     necessary) in the build directory. Be sure to include "-version-info",
                   6860:     especially when major and minor are zero, as libtool will otherwise strip
                   6861:     off the shared library version.
                   6862: 
                   6863:     From the libtool manual:
                   6864: 
                   6865:     So, libtool library versions are described by three integers:
                   6866: 
                   6867:     CURRENT
                   6868:     The most recent interface number that this library implements.
                   6869: 
                   6870:     REVISION
                   6871:     The implementation number of the CURRENT interface.
                   6872: 
                   6873:     AGE
                   6874:     The difference between the newest and oldest interfaces that
                   6875:     this library implements.  In other words, the library implements
                   6876:     all the interface numbers in the range from number `CURRENT -
                   6877:     AGE' to `CURRENT'.
                   6878: 
                   6879:     If two libraries have identical CURRENT and AGE numbers, then the
                   6880:     dynamic linker chooses the library with the greater REVISION number.
                   6881: 
                   6882: 
                   6883:     The "-release" option will produce different results for a.out and ELF
                   6884:     (excluding symlinks) in only one case. An ELF library of the form
                   6885:     "libfoo-release.so.x.y" will have a symlink of "libfoo.so.x.y" on an a.out
                   6886:     platform. This is handled automatically.
                   6887: 
                   6888:     The "-rpath argument" is the install directory of the library being built.
                   6889: 
                   6890:     In the PLIST, include only the .la file, the other files will be added
                   6891:     automatically.
                   6892: 
                   6893:  4. When linking shared object (.so) files, i.e. files that are loaded via
                   6894:     dlopen(3), NOT shared libraries, use "-module -avoid-version" to prevent
                   6895:     them getting version tacked on.
                   6896: 
                   6897:     The PLIST file gets the foo.so entry.
                   6898: 
                   6899:  5. When linking programs that depend on these libraries before they are
                   6900:     installed, preface the cc(1) or ld(1) line with "${LIBTOOL} --mode=link",
                   6901:     and it will find the correct libraries (static or shared), but please be
                   6902:     aware that libtool will not allow you to specify a relative path in -L
                   6903:     (such as "-L../somelib"), because it expects you to change that argument to
                   6904:     be the .la file. e.g.
                   6905: 
                   6906:     ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
                   6907: 
                   6908: 
                   6909:     should be changed to:
                   6910: 
                   6911:     ${LIBTOOL} --mode=link ${CC} -o someprog ../somelib/somelib.la
                   6912: 
                   6913: 
                   6914:     and it will do the right thing with the libraries.
                   6915: 
                   6916:  6. When installing libraries, preface the install(1) or cp(1) command with "$
                   6917:     {LIBTOOL} --mode=install", and change the library name to .la. e.g.
                   6918: 
                   6919:     ${LIBTOOL} --mode=install ${BSD_INSTALL_DATA} ${SOMELIB:.a=.la} ${PREFIX}/lib
                   6920: 
                   6921: 
                   6922:     This will install the static .a, shared library, any needed symlinks, and
                   6923:     run ldconfig(8).
                   6924: 
                   6925:  7. In your PLIST, include only the .la file (this is a change from previous
                   6926:     behaviour).
                   6927: 
                   6928: 18.3.2. Using libtool on GNU packages that already support libtool
                   6929: 
                   6930: Add USE_LIBTOOL=yes to the package Makefile. This will override the package's
                   6931: own libtool in most cases. For older libtool using packages, libtool is made by
                   6932: ltconfig script during the do-configure step; you can check the libtool script
                   6933: location by doing make configure; find work*/ -name libtool.
                   6934: 
                   6935: LIBTOOL_OVERRIDE specifies which libtool scripts, relative to WRKSRC, to
                   6936: override. By default, it is set to "libtool */libtool */*/libtool". If this
                   6937: does not match the location of the package's libtool script(s), set it as
                   6938: appropriate.
                   6939: 
                   6940: If you do not need *.a static libraries built and installed, then use
                   6941: SHLIBTOOL_OVERRIDE instead.
                   6942: 
                   6943: If your package makes use of the platform-independent library for loading
                   6944: dynamic shared objects, that comes with libtool (libltdl), you should include
                   6945: devel/libltdl/buildlink3.mk.
                   6946: 
                   6947: Some packages use libtool incorrectly so that the package may not work or build
                   6948: in some circumstances. Some of the more common errors are:
                   6949: 
                   6950:   * The inclusion of a shared object (-module) as a dependent library in an
                   6951:     executable or library. This in itself isn't a problem if one of two things
                   6952:     has been done:
                   6953: 
                   6954:      1. The shared object is named correctly, i.e. libfoo.la, not foo.la
                   6955: 
                   6956:      2. The -dlopen option is used when linking an executable.
                   6957: 
                   6958:   * The use of libltdl without the correct calls to initialisation routines.
                   6959:     The function lt_dlinit() should be called and the macro
                   6960:     LTDL_SET_PRELOADED_SYMBOLS included in executables.
                   6961: 
                   6962: 18.3.3. GNU Autoconf/Automake
                   6963: 
                   6964: If a package needs GNU autoconf or automake to be executed to regenerate the
                   6965: configure script and Makefile.in makefile templates, then they should be
                   6966: executed in a pre-configure target.
                   6967: 
                   6968: For packages that need only autoconf:
                   6969: 
                   6970: AUTOCONF_REQD=  2.50            # if default version is not good enough
                   6971: USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
                   6972: ...
                   6973: 
                   6974: pre-configure:
                   6975:         cd ${WRKSRC} && autoconf
                   6976: 
                   6977: ...
                   6978: 
                   6979: 
                   6980: and for packages that need automake and autoconf:
                   6981: 
                   6982: AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
                   6983: USE_TOOLS+=     automake        # use "automake14" for automake-1.4
                   6984: ...
                   6985: 
                   6986: pre-configure:
                   6987:         set -e; cd ${WRKSRC}; \
                   6988:         aclocal; autoheader; automake -a --foreign -i; autoconf
                   6989: 
                   6990: ...
                   6991: 
                   6992: 
                   6993: Packages which use GNU Automake will almost certainly require GNU Make.
                   6994: 
                   6995: There are times when the configure process makes additional changes to the
                   6996: generated files, which then causes the build process to try to re-execute the
                   6997: automake sequence. This is prevented by touching various files in the configure
                   6998: stage. If this causes problems with your package you can set AUTOMAKE_OVERRIDE=
                   6999: NO in the package Makefile.
                   7000: 
                   7001: 18.4. Programming languages
                   7002: 
                   7003: 18.4.1. C, C++, and Fortran
                   7004: 
                   7005: Compilers for the C, C++, and Fortran languages comes with the NetBSD base
                   7006: system. By default, pkgsrc assumes that a package is written in C and will hide
                   7007: all other compilers (via the wrapper framework, see Chapter 13, Buildlink
                   7008: methodology).
                   7009: 
                   7010: To declare which language's compiler a package needs, set the USE_LANGUAGES
                   7011: variable. Allowed values currently are "c", "c++", and "fortran" (and any
                   7012: combination). The default is "c". Packages using GNU configure scripts, even if
                   7013: written in C++, usually need a C compiler for the configure phase.
                   7014: 
                   7015: 18.4.2. Java
                   7016: 
                   7017: If a program is written in Java, use the Java framework in pkgsrc. The package
                   7018: must include ../../mk/java-vm.mk. This Makefile fragment provides the following
                   7019: variables:
                   7020: 
                   7021:   * USE_JAVA defines if a build dependency on the JDK is added. If USE_JAVA is
                   7022:     set to "run", then there is only a runtime dependency on the JDK. The
                   7023:     default is "yes", which also adds a build dependency on the JDK.
                   7024: 
                   7025:   * Set USE_JAVA2 to declare that a package needs a Java2 implementation. The
                   7026:     supported values are "yes", "1.4", and "1.5". "yes" accepts any Java2
                   7027:     implementation, "1.4" insists on versions 1.4 or above, and "1.5" only
                   7028:     accepts versions 1.5 or above. This variable is not set by default.
                   7029: 
                   7030: 18.4.3. Packages containing perl scripts
                   7031: 
                   7032: If your package contains interpreted perl scripts, add "perl" to the USE_TOOLS
                   7033: variable and set REPLACE_PERL to ensure that the proper interpreter path is
                   7034: set. REPLACE_PERL should contain a list of scripts, relative to WRKSRC, that
                   7035: you want adjusted. Every occurrence of */bin/perl will be replaced with the
                   7036: full path to the perl executable.
                   7037: 
                   7038: If a particular version of perl is needed, set the PERL5_REQD variable to the
                   7039: version number. The default is "5.0".
                   7040: 
                   7041: See Section 18.6.5, "Packages installing perl modules" for information about
                   7042: handling perl modules.
                   7043: 
                   7044: 18.4.4. Other programming languages
                   7045: 
                   7046: Currently, there is no special handling for other languages in pkgsrc. If a
                   7047: compiler package provides a buildlink3.mk file, include that, otherwise just
                   7048: add a (build) dependency on the appropriate compiler package.
                   7049: 
                   7050: 18.5. Fixing problems in the build phase
                   7051: 
                   7052: The most common failures when building a package are that some platforms do not
                   7053: provide certain header files, functions or libraries, or they provide the
                   7054: functions in a library that the original package author didn't know. To work
                   7055: around this, you can rewrite the source code in most cases so that it does not
                   7056: use the missing functions or provides a replacement function.
                   7057: 
                   7058: 18.5.1. Compiling C and C++ code conditionally
                   7059: 
                   7060: If a package already comes with a GNU configure script, the preferred way to
                   7061: fix the build failure is to change the configure script, not the code. In the
                   7062: other cases, you can utilize the C preprocessor, which defines certain macros
                   7063: depending on the operating system and hardware architecture it compiles for.
                   7064: These macros can be queried using for example #if defined(__i386). Almost every
                   7065: operating system, hardware architecture and compiler has its own macro. For
                   7066: example, if the macros __GNUC__, __i386__ and __NetBSD__ are all defined, you
                   7067: know that you are using NetBSD on an i386 compatible CPU, and your compiler is
                   7068: GCC.
                   7069: 
                   7070: The list of the following macros for hardware and operating system depends on
                   7071: the compiler that is used. For example, if you want to conditionally compile
                   7072: code on Solaris, don't use __sun__, as the SunPro compiler does not define it.
                   7073: Use __sun instead.
                   7074: 
                   7075: 18.5.1.1. C preprocessor macros to identify the operating system
                   7076: 
                   7077: To distinguish between 4.4 BSD-derived systems and the rest of the world, you
                   7078: should use the following code.
                   7079: 
                   7080: #include <sys/param.h>
                   7081: #if (defined(BSD) && BSD >= 199306)
                   7082: /* BSD-specific code goes here */
                   7083: #else
                   7084: /* non-BSD-specific code goes here */
                   7085: #endif
                   7086: 
                   7087: If this distinction is not fine enough, you can also test for the following
                   7088: macros.
                   7089: 
                   7090: FreeBSD     __FreeBSD__
                   7091: DragonFly   __DragonFly__
                   7092: Interix     __INTERIX
                   7093: IRIX        __sgi (TODO: get a definite source for this)
                   7094: Linux       linux, __linux, __linux__
                   7095: NetBSD      __NetBSD__
                   7096: OpenBSD     __OpenBSD__
                   7097: Solaris     sun, __sun
                   7098: 
                   7099: 18.5.1.2. C preprocessor macros to identify the hardware architecture
                   7100: 
                   7101: i386        i386, __i386, __i386__
                   7102: MIPS        __mips
                   7103: SPARC       sparc, __sparc
                   7104: 
                   7105: 18.5.1.3. C preprocessor macros to identify the compiler
                   7106: 
                   7107: GCC         __GNUC__ (major version), __GNUC_MINOR__
                   7108: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
                   7109: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
                   7110: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
                   7111: 
                   7112: 18.5.2. How to handle compiler bugs
                   7113: 
                   7114: Some source files trigger bugs in the compiler, based on combinations of
                   7115: compiler version and architecture and almost always relation to optimisation
                   7116: being enabled. Common symptoms are gcc internal errors or never finishing
                   7117: compiling a file.
                   7118: 
                   7119: Typically, a workaround involves testing the MACHINE_ARCH and compiler version,
                   7120: disabling optimisation for that combination of file, MACHINE_ARCH and compiler,
                   7121: and documenting it in pkgsrc/doc/HACKS. See that file for a number of examples.
                   7122: 
                   7123: 18.5.3. Undefined reference to "..."
                   7124: 
                   7125: This error message often means that a package did not link to a shared library
                   7126: it needs. The following functions are known to cause this error message over
                   7127: and over.
                   7128: 
                   7129: +-----------------------------------------------------+
                   7130: |        Function         |Library |Affected platforms|
                   7131: |-------------------------+--------+------------------|
                   7132: |accept, bind, connect    |-lsocket|Solaris           |
                   7133: |-------------------------+--------+------------------|
                   7134: |crypt                    |-lcrypt |DragonFly, NetBSD |
                   7135: |-------------------------+--------+------------------|
                   7136: |dlopen, dlsym            |-ldl    |Linux             |
                   7137: |-------------------------+--------+------------------|
                   7138: |gethost*                 |-lnsl   |Solaris           |
                   7139: |-------------------------+--------+------------------|
                   7140: |inet_aton                |-lresolv|Solaris           |
                   7141: |-------------------------+--------+------------------|
                   7142: |nanosleep, sem_*, timer_*|-lrt    |Solaris           |
                   7143: |-------------------------+--------+------------------|
                   7144: |openpty                  |-lutil  |Linux             |
                   7145: +-----------------------------------------------------+
                   7146: 
                   7147: To fix these linker errors, it is often sufficient to say LIBS.OperatingSystem+
                   7148: = -lfoo to the package Makefile and then say bmake clean; bmake.
                   7149: 
                   7150: 18.5.3.1. Special issue: The SunPro compiler
                   7151: 
                   7152: When you are using the SunPro compiler, there is another possibility. That
                   7153: compiler cannot handle the following code:
                   7154: 
                   7155: extern int extern_func(int);
                   7156: 
                   7157: static inline int
                   7158: inline_func(int x)
                   7159: {
                   7160:         return extern_func(x);
                   7161: }
                   7162: 
                   7163: int main(void)
                   7164: {
                   7165:         return 0;
                   7166: }
                   7167: 
                   7168: It generates the code for inline_func even if that function is never used. This
                   7169: code then refers to extern_func, which can usually not be resolved. To solve
                   7170: this problem you can try to tell the package to disable inlining of functions.
                   7171: 
                   7172: 18.5.4. Running out of memory
                   7173: 
                   7174: Sometimes packages fail to build because the compiler runs into an operating
                   7175: system specific soft limit. With the UNLIMIT_RESOURCES variable pkgsrc can be
                   7176: told to unlimit the resources. Currently, the allowed values are "datasize" and
                   7177: "stacksize" (or both). Setting this variable is similar to running the shell
                   7178: builtin ulimit command to raise the maximum data segment size or maximum stack
                   7179: size of a process, respectively, to their hard limits.
                   7180: 
                   7181: 18.6. Fixing problems in the install phase
                   7182: 
                   7183: 18.6.1. Creating needed directories
                   7184: 
                   7185: The BSD-compatible install supplied with some operating systems cannot create
                   7186: more than one directory at a time. As such, you should call ${INSTALL_*_DIR}
                   7187: like this:
                   7188: 
                   7189: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   7190: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
                   7191: 
                   7192: 
                   7193: You can also just append "dir1 dir2" to the INSTALLATION_DIRS variable, which
                   7194: will automatically do the right thing.
                   7195: 
                   7196: 18.6.2. Where to install documentation
                   7197: 
                   7198: In general, documentation should be installed into ${PREFIX}/share/doc/$
                   7199: {PKGBASE} or ${PREFIX}/share/doc/${PKGNAME} (the latter includes the version
                   7200: number of the package).
                   7201: 
                   7202: Many modern packages using GNU autoconf allow to set the directory where HTML
                   7203: documentation is installed with the "--with-html-dir" option. Sometimes using
                   7204: this flag is needed because otherwise the documentation ends up in ${PREFIX}/
                   7205: share/doc/html or other places.
                   7206: 
                   7207: An exception to the above is that library API documentation generated with the
                   7208: textproc/gtk-doc tools, for use by special browsers (devhelp) should be left at
                   7209: their default location, which is ${PREFIX}/share/gtk-doc. Such documentation
                   7210: can be recognized from files ending in .devhelp or .devhelp2. (It is also
                   7211: acceptable to install such files in ${PREFIX}/share/doc/${PKGBASE} or ${PREFIX}
                   7212: /share/doc/${PKGNAME}; the .devhelp* file must be directly in that directory
                   7213: then, no additional subdirectory level is allowed in this case. This is usually
                   7214: achieved by using "--with-html-dir=${PREFIX}/share/doc". ${PREFIX}/share/
                   7215: gtk-doc is preferred though.)
                   7216: 
                   7217: 18.6.3. Installing highscore files
                   7218: 
                   7219: Certain packages, most of them in the games category, install a score file that
                   7220: allows all users on the system to record their highscores. In order for this to
                   7221: work, the binaries need to be installed setgid and the score files owned by the
                   7222: appropriate group and/or owner (traditionally the "games" user/group). The
                   7223: following variables, documented in more detail in mk/defaults/mk.conf, control
                   7224: this behaviour: SETGIDGAME, GAMEDATAMODE, GAMEGRP, GAMEMODE, GAMEOWN.
                   7225: 
                   7226: Note that per default, setgid installation of games is disabled; setting
                   7227: SETGIDGAME=YES will set all the other variables accordingly.
                   7228: 
                   7229: A package should therefor never hard code file ownership or access permissions
                   7230: but rely on INSTALL_GAME and INSTALL_GAME_DATA to set these correctly.
                   7231: 
                   7232: 18.6.4. Packages with hardcoded paths to other interpreters
                   7233: 
                   7234: Your package may also contain scripts with hardcoded paths to other
                   7235: interpreters besides (or as well as) perl. To correct the full pathname to the
                   7236: script interpreter, you need to set the following definitions in your Makefile
                   7237: (we shall use tclsh in this example):
                   7238: 
                   7239: REPLACE_INTERPRETER+=   tcl
                   7240: REPLACE.tcl.old=        .*/bin/tclsh
                   7241: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   7242: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   7243: # relative to ${WRKSRC}, just as in REPLACE_PERL
                   7244: 
                   7245: 
                   7246: Note
                   7247: 
                   7248: Before March 2006, these variables were called _REPLACE.* and _REPLACE_FILES.*.
                   7249: 
                   7250: 18.6.5. Packages installing perl modules
                   7251: 
                   7252: Makefiles of packages providing perl5 modules should include the Makefile
                   7253: fragment ../../lang/perl5/module.mk. It provides a do-configure target for the
                   7254: standard perl configuration for such modules as well as various hooks to tune
                   7255: this configuration. See comments in this file for details.
                   7256: 
                   7257: Perl5 modules will install into different places depending on the version of
                   7258: perl used during the build process. To address this, pkgsrc will append lines
                   7259: to the PLIST corresponding to the files listed in the installed .packlist file
                   7260: generated by most perl5 modules. This is invoked by defining PERL5_PACKLIST to
                   7261: a space-separated list of paths to packlist files, e.g.:
                   7262: 
                   7263: PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
                   7264: 
                   7265: 
                   7266: The variables PERL5_SITELIB, PERL5_SITEARCH, and PERL5_ARCHLIB represent the
                   7267: three locations in which perl5 modules may be installed, and may be used by
                   7268: perl5 packages that don't have a packlist. These three variables are also
                   7269: substituted for in the PLIST.
                   7270: 
                   7271: 18.6.6. Packages installing info files
                   7272: 
                   7273: Some packages install info files or use the "makeinfo" or "install-info"
                   7274: commands. INFO_FILES should be defined in the package Makefile so that INSTALL
                   7275: and DEINSTALL scripts will be generated to handle registration of the info
                   7276: files in the Info directory file. The "install-info" command used for the info
                   7277: files registration is either provided by the system, or by a special purpose
                   7278: package automatically added as dependency if needed.
                   7279: 
                   7280: PKGINFODIR is the directory under ${PREFIX} where info files are primarily
                   7281: located. PKGINFODIR defaults to "info" and can be overridden by the user.
                   7282: 
                   7283: The info files for the package should be listed in the package PLIST; however
                   7284: any split info files need not be listed.
                   7285: 
                   7286: A package which needs the "makeinfo" command at build time must add "makeinfo"
                   7287: to USE_TOOLS in its Makefile. If a minimum version of the "makeinfo" command is
                   7288: needed it should be noted with the TEXINFO_REQD variable in the package
                   7289: Makefile. By default, a minimum version of 3.12 is required. If the system does
                   7290: not provide a makeinfo command or if it does not match the required minimum, a
                   7291: build dependency on the devel/gtexinfo package will be added automatically.
                   7292: 
                   7293: The build and installation process of the software provided by the package
                   7294: should not use the install-info command as the registration of info files is
                   7295: the task of the package INSTALL script, and it must use the appropriate
                   7296: makeinfo command.
                   7297: 
                   7298: To achieve this goal, the pkgsrc infrastructure creates overriding scripts for
                   7299: the install-info and makeinfo commands in a directory listed early in PATH.
                   7300: 
                   7301: The script overriding install-info has no effect except the logging of a
                   7302: message. The script overriding makeinfo logs a message and according to the
                   7303: value of TEXINFO_REQD either runs the appropriate makeinfo command or exit on
                   7304: error.
                   7305: 
                   7306: 18.6.7. Packages installing man pages
                   7307: 
                   7308: All packages that install manual pages should install them into the same
                   7309: directory, so that there is one common place to look for them. In pkgsrc, this
                   7310: place is ${PREFIX}/${PKGMANDIR}, and this expression should be used in
                   7311: packages. The default for PKGMANDIR is "man". Another often-used value is
                   7312: "share/man".
                   7313: 
                   7314: Note
                   7315: 
                   7316: The support for a custom PKGMANDIR is far from complete.
                   7317: 
                   7318: The PLIST files can just use man/ as the top level directory for the man page
                   7319: file entries, and the pkgsrc framework will convert as needed. In all other
                   7320: places, the correct PKGMANDIR must be used.
                   7321: 
                   7322: Packages that are configured with GNU_CONFIGURE set as "yes", by default will
                   7323: use the ./configure --mandir switch to set where the man pages should be
                   7324: installed. The path is GNU_CONFIGURE_MANDIR which defaults to ${PREFIX}/$
                   7325: {PKGMANDIR}.
                   7326: 
                   7327: Packages that use GNU_CONFIGURE but do not use --mandir, can set
                   7328: CONFIGURE_HAS_MANDIR to "no". Or if the ./configure script uses a non-standard
                   7329: use of --mandir, you can set GNU_CONFIGURE_MANDIR as needed.
                   7330: 
                   7331: See Section 12.5, "Man page compression" for information on installation of
                   7332: compressed manual pages.
                   7333: 
                   7334: 18.6.8. Packages installing GConf2 data files
                   7335: 
                   7336: If a package installs .schemas or .entries files, used by GConf2, you need to
                   7337: take some extra steps to make sure they get registered in the database:
                   7338: 
                   7339:  1. Include ../../devel/GConf2/schemas.mk instead of its buildlink3.mk file.
                   7340:     This takes care of rebuilding the GConf2 database at installation and
                   7341:     deinstallation time, and tells the package where to install GConf2 data
                   7342:     files using some standard configure arguments. It also disallows any access
                   7343:     to the database directly from the package.
                   7344: 
                   7345:  2. Ensure that the package installs its .schemas files under ${PREFIX}/share/
                   7346:     gconf/schemas. If they get installed under ${PREFIX}/etc, you will need to
                   7347:     manually patch the package.
                   7348: 
                   7349:  3. Check the PLIST and remove any entries under the etc/gconf directory, as
                   7350:     they will be handled automatically. See Section 8.14, "How do I change the
                   7351:     location of configuration files?" for more information.
                   7352: 
                   7353:  4. Define the GCONF2_SCHEMAS variable in your Makefile with a list of all
                   7354:     .schemas files installed by the package, if any. Names must not contain any
                   7355:     directories in them.
                   7356: 
                   7357:  5. Define the GCONF2_ENTRIES variable in your Makefile with a list of all
                   7358:     .entries files installed by the package, if any. Names must not contain any
                   7359:     directories in them.
                   7360: 
                   7361: 18.6.9. Packages installing scrollkeeper data files
                   7362: 
                   7363: If a package installs .omf files, used by scrollkeeper, you need to take some
                   7364: extra steps to make sure they get registered in the database:
                   7365: 
                   7366:  1. Include ../../textproc/scrollkeeper/omf.mk instead of its buildlink3.mk
                   7367:     file. This takes care of rebuilding the scrollkeeper database at
                   7368:     installation and deinstallation time, and disallows any access to it
                   7369:     directly from the package.
                   7370: 
                   7371:  2. Check the PLIST and remove any entries under the libdata/scrollkeeper
                   7372:     directory, as they will be handled automatically.
                   7373: 
                   7374:  3. Remove the share/omf directory from the PLIST. It will be handled by
                   7375:     scrollkeeper.
                   7376: 
                   7377: 18.6.10. Packages installing X11 fonts
                   7378: 
                   7379: If a package installs font files, you will need to rebuild the fonts database
                   7380: in the directory where they get installed at installation and deinstallation
                   7381: time. This can be automatically done by using the pkginstall framework.
                   7382: 
                   7383: You can list the directories where fonts are installed in the FONTS_DIRS.type
                   7384: variables, where type can be one of "ttf", "type1" or "x11". Also make sure
                   7385: that the database file fonts.dir is not listed in the PLIST.
                   7386: 
                   7387: Note that you should not create new directories for fonts; instead use the
                   7388: standard ones to avoid that the user needs to manually configure his X server
                   7389: to find them.
                   7390: 
                   7391: 18.6.11. Packages installing GTK2 modules
                   7392: 
                   7393: If a package installs GTK2 immodules or loaders, you need to take some extra
                   7394: steps to get them registered in the GTK2 database properly:
                   7395: 
                   7396:  1. Include ../../x11/gtk2/modules.mk instead of its buildlink3.mk file. This
                   7397:     takes care of rebuilding the database at installation and deinstallation
                   7398:     time.
                   7399: 
                   7400:  2. Set GTK2_IMMODULES=YES if your package installs GTK2 immodules.
                   7401: 
                   7402:  3. Set GTK2_LOADERS=YES if your package installs GTK2 loaders.
                   7403: 
                   7404:  4. Patch the package to not touch any of the GTK2 databases directly. These
                   7405:     are:
                   7406: 
                   7407:       * libdata/gtk-2.0/gdk-pixbuf.loaders
                   7408: 
                   7409:       * libdata/gtk-2.0/gtk.immodules
                   7410: 
                   7411:  5. Check the PLIST and remove any entries under the libdata/gtk-2.0 directory,
                   7412:     as they will be handled automatically.
                   7413: 
                   7414: 18.6.12. Packages installing SGML or XML data
                   7415: 
                   7416: If a package installs SGML or XML data files that need to be registered in
                   7417: system-wide catalogs (like DTDs, sub-catalogs, etc.), you need to take some
                   7418: extra steps:
                   7419: 
                   7420:  1. Include ../../textproc/xmlcatmgr/catalogs.mk in your Makefile, which takes
                   7421:     care of registering those files in system-wide catalogs at installation and
                   7422:     deinstallation time.
                   7423: 
                   7424:  2. Set SGML_CATALOGS to the full path of any SGML catalogs installed by the
                   7425:     package.
                   7426: 
                   7427:  3. Set XML_CATALOGS to the full path of any XML catalogs installed by the
                   7428:     package.
                   7429: 
                   7430:  4. Set SGML_ENTRIES to individual entries to be added to the SGML catalog.
                   7431:     These come in groups of three strings; see xmlcatmgr(1) for more
                   7432:     information (specifically, arguments recognized by the 'add' action). Note
                   7433:     that you will normally not use this variable.
                   7434: 
                   7435:  5. Set XML_ENTRIES to individual entries to be added to the XML catalog. These
                   7436:     come in groups of three strings; see xmlcatmgr(1) for more information
                   7437:     (specifically, arguments recognized by the 'add' action). Note that you
                   7438:     will normally not use this variable.
                   7439: 
                   7440: 18.6.13. Packages installing extensions to the MIME database
                   7441: 
                   7442: If a package provides extensions to the MIME database by installing .xml files
                   7443: inside ${PREFIX}/share/mime/packages, you need to take some extra steps to
                   7444: ensure that the database is kept consistent with respect to these new files:
                   7445: 
                   7446:  1. Include ../../databases/shared-mime-info/mimedb.mk (avoid using the
                   7447:     buildlink3.mk file from this same directory, which is reserved for
                   7448:     inclusion from other buildlink3.mk files). It takes care of rebuilding the
                   7449:     MIME database at installation and deinstallation time, and disallows any
                   7450:     access to it directly from the package.
                   7451: 
                   7452:  2. Check the PLIST and remove any entries under the share/mime directory,
                   7453:     except for files saved under share/mime/packages. The former are handled
                   7454:     automatically by the update-mime-database program, but the latter are
                   7455:     package-dependent and must be removed by the package that installed them in
                   7456:     the first place.
                   7457: 
                   7458:  3. Remove any share/mime/* directories from the PLIST. They will be handled by
                   7459:     the shared-mime-info package.
                   7460: 
                   7461: 18.6.14. Packages using intltool
                   7462: 
                   7463: If a package uses intltool during its build, add intltool to the USE_TOOLS,
                   7464: which forces it to use the intltool package provided by pkgsrc, instead of the
                   7465: one bundled with the distribution file.
                   7466: 
                   7467: This tracks intltool's build-time dependencies and uses the latest available
                   7468: version; this way, the package benefits of any bug fixes that may have appeared
                   7469: since it was released.
                   7470: 
                   7471: 18.6.15. Packages installing startup scripts
                   7472: 
                   7473: If a package contains a rc.d script, it won't be copied into the startup
                   7474: directory by default, but you can enable it, by adding the option
                   7475: PKG_RCD_SCRIPTS=YES in /etc/mk.conf. This option will copy the scripts into /
                   7476: etc/rc.d when a package is installed, and it will automatically remove the
                   7477: scripts when the package is deinstalled.
                   7478: 
                   7479: 18.6.16. Packages installing TeX modules
                   7480: 
                   7481: If a package installs TeX packages into the texmf tree, the ls-R database of
                   7482: the tree needs to be updated.
                   7483: 
                   7484: Note
                   7485: 
                   7486: Except the main TeX packages such as teTeX-texmf, packages should install files
                   7487: into PKG_LOCALTEXMFPREFIX, not PKG_TEXMFPREFIX.
                   7488: 
                   7489:  1. Include ../../print/teTeX/module.mk instead of ../../mk/tex.buildlink3.mk.
                   7490:     This takes care of rebuilding the ls-R database at installation and
                   7491:     deinstallation time.
                   7492: 
                   7493:  2. If your package installs files into a texmf tree other than the one at
                   7494:     PKG_LOCALTEXMFPREFIX, set TEXMFDIRS to the list of all texmf trees that
                   7495:     need database update.
                   7496: 
                   7497:     If your package also installs font map files that need to be registered
                   7498:     using updmap, set TEX_FONTMAPS to the list of all such font map files. Then
                   7499:     updmap will be run automatically at installation/deinstallation to enable/
                   7500:     disable font map files for TeX output drivers.
                   7501: 
                   7502:  3. Make sure that none of ls-R databases are included in PLIST, as they will
                   7503:     be removed only by the teTeX-bin package.
                   7504: 
                   7505: 18.6.17. Packages supporting running binaries in emulation
                   7506: 
                   7507: There are some packages that provide libraries and executables for running
                   7508: binaries from a one operating system on a different one (if the latter supports
                   7509: it). One example is running Linux binaries on NetBSD.
                   7510: 
                   7511: The pkgtools/rpm2pkg helps in extracting and packaging Linux rpm packages.
                   7512: 
                   7513: The CHECK_SHLIBS can be set to no to avoid the check-shlibs target, which tests
                   7514: if all libraries for each installed executable can be found by the dynamic
                   7515: linker. Since the standard dynamic linker is run, this fails for emulation
                   7516: packages, because the libraries used by the emulation are not in the standard
                   7517: directories.
                   7518: 
                   7519: 18.6.18. Packages installing hicolor theme icons
                   7520: 
                   7521: If a package installs images under the share/icons/hicolor and/or updates the
                   7522: share/icons/hicolor/icon-theme.cache database, you need to take some extra
                   7523: steps to make sure that the shared theme directory is handled appropriately and
                   7524: that the cache database is rebuilt:
                   7525: 
                   7526:  1. Include ../../graphics/hicolor-icon-theme/buildlink3.mk.
                   7527: 
                   7528:  2. Check the PLIST and remove the entry that refers to the theme cache.
                   7529: 
                   7530:  3. Ensure that the PLIST does not remove the shared icon directories from the
                   7531:     share/icons/hicolor hierarchy because they will be handled automatically.
                   7532: 
                   7533: The best way to verify that the PLIST is correct with respect to the last two
                   7534: points is to regenerate it using make print-PLIST.
                   7535: 
                   7536: 18.6.19. Packages installing desktop files
                   7537: 
                   7538: If a package installs .desktop files under share/applications and these include
                   7539: MIME information, you need to take extra steps to ensure that they are
                   7540: registered into the MIME database:
                   7541: 
                   7542:  1. Include ../../sysutils/desktop-file-utils/desktopdb.mk.
                   7543: 
                   7544:  2. Check the PLIST and remove the entry that refers to the share/applications/
                   7545:     mimeinfo.cache file. It will be handled automatically.
                   7546: 
                   7547: The best way to verify that the PLIST is correct with respect to the last point
                   7548: is to regenerate it using make print-PLIST.
                   7549: 
                   7550: 18.7. Marking packages as having problems
                   7551: 
                   7552: In some cases one does not have the time to solve a problem immediately. There
                   7553: are currently two ways to declare that one knows that a package has problems.
                   7554: 
                   7555:   * The first way is to plainly mark it as broken. For this, one just sets the
                   7556:     variable BROKEN to the reason why the package is broken (similar to the
                   7557:     RESTRICTED variable). A user trying to build the package will immediately
                   7558:     be shown this message, and the build will not be even tried.
                   7559: 
                   7560:   * After each pkgsrc freeze period (a time when the tree is stabilized and a
                   7561:     new pkgsrc branch is cut), the packages that were not building in the
                   7562:     official branch build on the latest NetBSD release will be marked as broken
                   7563:     on that branch. This is done by setting the BROKEN_IN variable to the
                   7564:     branch name (or appending the branch name to it). If a user tries to build
                   7565:     such a package and the build fails, the user gets a message that says that
                   7566:     the package was broken on the respective branch(es).
                   7567: 
                   7568: Both types of packages are removed from pkgsrc in irregular intervals.
                   7569: 
                   7570: Chapter 19. Debugging
                   7571: 
                   7572: To check out all the gotchas when building a package, here are the steps that I
                   7573: do in order to get a package working. Please note this is basically the same as
                   7574: what was explained in the previous sections, only with some debugging aids.
                   7575: 
                   7576:   * Be sure to set PKG_DEVELOPER=1 in /etc/mk.conf
                   7577: 
                   7578:   * Install pkgtools/url2pkg, create a directory for a new package, change into
                   7579:     it, then run url2pkg:
                   7580: 
                   7581:     % mkdir /usr/pkgsrc/category/examplepkg
                   7582:     % cd /usr/pkgsrc/category/examplepkg
                   7583:     % url2pkg http://www.example.com/path/to/distfile.tar.gz
                   7584: 
                   7585:   * Edit the Makefile as requested.
                   7586: 
                   7587:   * Fill in the DESCR file
                   7588: 
                   7589:   * Run make configure
                   7590: 
                   7591:   * Add any dependencies glimpsed from documentation and the configure step to
                   7592:     the package's Makefile.
                   7593: 
                   7594:   * Make the package compile, doing multiple rounds of
                   7595: 
                   7596:     % make
                   7597:     % pkgvi ${WRKSRC}/some/file/that/does/not/compile
                   7598:     % mkpatches
                   7599:     % patchdiff
                   7600:     % mv ${WRKDIR}/.newpatches/* patches
                   7601:     % make mps
                   7602:     % make clean
                   7603: 
                   7604:     Doing this step as non-root user will ensure that no files are modified
                   7605:     that shouldn't be, especially during the build phase. mkpatches, patchdiff
                   7606:     and pkgvi are from the pkgtools/pkgdiff package.
                   7607: 
                   7608:   * Look at the Makefile, fix if necessary; see Section 10.1, "Makefile".
                   7609: 
                   7610:   * Generate a PLIST:
                   7611: 
                   7612:     # make install
                   7613:     # make print-PLIST >PLIST
                   7614:     # make deinstall
                   7615:     # make install
                   7616:     # make deinstall
                   7617: 
                   7618:     You usually need to be root to do this. Look if there are any files left:
                   7619: 
                   7620:     # make print-PLIST
                   7621: 
                   7622:     If this reveals any files that are missing in PLIST, add them.
                   7623: 
                   7624:   * Now that the PLIST is OK, install the package again and make a binary
                   7625:     package:
                   7626: 
                   7627:     # make reinstall
                   7628:     # make package
                   7629: 
                   7630:   * Delete the installed package:
                   7631: 
                   7632:     # pkg_delete examplepkg
                   7633: 
                   7634:   * Repeat the above make print-PLIST command, which shouldn't find anything
                   7635:     now:
                   7636: 
                   7637:     # make print-PLIST
                   7638: 
                   7639:   * Reinstall the binary package:
                   7640: 
                   7641:     # pkg_add .../examplepkg.tgz
                   7642: 
                   7643:   * Play with it. Make sure everything works.
                   7644: 
                   7645:   * Run pkglint from pkgtools/pkglint, and fix the problems it reports:
                   7646: 
                   7647:     # pkglint
                   7648: 
                   7649:   * Submit (or commit, if you have cvs access); see Chapter 20, Submitting and
                   7650:     Committing.
                   7651: 
                   7652: Chapter 20. Submitting and Committing
                   7653: 
                   7654: Table of Contents
                   7655: 
                   7656: 20.1. Submitting binary packages
                   7657: 20.2. Submitting source packages (for non-NetBSD-developers)
                   7658: 20.3. General notes when adding, updating, or removing packages
                   7659: 20.4. Committing: Importing a package into CVS
                   7660: 20.5. Updating a package to a newer version
                   7661: 20.6. Moving a package in pkgsrc
                   7662: 
                   7663: 20.1. Submitting binary packages
                   7664: 
                   7665: Our policy is that we accept binaries only from pkgsrc developers to guarantee
                   7666: that the packages don't contain any trojan horses etc. This is not to annoy
                   7667: anyone but rather to protect our users! You're still free to put up your
                   7668: home-made binary packages and tell the world where to get them. NetBSD
                   7669: developers doing bulk builds and wanting to upload them please see
                   7670: Section 6.3.8, "Uploading results of a bulk build".
                   7671: 
                   7672: 20.2. Submitting source packages (for non-NetBSD-developers)
                   7673: 
                   7674: First, check that your package is complete, compiles and runs well; see
                   7675: Chapter 19, Debugging and the rest of this document. Next, generate an
                   7676: uuencoded gzipped tar(1) archive that contains all files that make up the
                   7677: package. Finally, send this package to the pkgsrc bug tracking system, either
                   7678: with the send-pr(1) command, or if you don't have that, go to the web page
                   7679: http://www.NetBSD.org/Misc/send-pr.html, which contains some instructions and a
                   7680: link to a form, where you can submit packages.
                   7681: 
                   7682: In the form of the problem report, the category should be "pkg", the synopsis
                   7683: should include the package name and version number, and the description field
                   7684: should contain a short description of your package (contents of the COMMENT
                   7685: variable or DESCR file are OK). The uuencoded package data should go into the
                   7686: "fix" field.
                   7687: 
                   7688: If you want to submit several packages, please send a separate PR for each one,
                   7689: it's easier for us to track things that way.
                   7690: 
                   7691: Alternatively, you can also import new packages into pkgsrc-wip ("pkgsrc
                   7692: work-in-progress"); see the homepage at http://pkgsrc-wip.sourceforge.net/ for
                   7693: details.
                   7694: 
                   7695: 20.3. General notes when adding, updating, or removing packages
                   7696: 
                   7697: Please note all package additions, updates, moves, and removals in pkgsrc/doc/
                   7698: CHANGES-YYYY. It's very important to keep this file up to date and conforming
                   7699: to the existing format, because it will be used by scripts to automatically
                   7700: update pages on www.NetBSD.org and other sites. Additionally, check the pkgsrc/
                   7701: doc/TODO file and remove the entry for the package you updated or removed, in
                   7702: case it was mentioned there.
                   7703: 
                   7704: When the PKGREVISION of a package is bumped, the change should appear in pkgsrc
                   7705: /doc/CHANGES-YYYY if it is security related or otherwise relevant. Mass bumps
                   7706: that result from a dependency being updated should not be mentioned. In all
                   7707: other cases it's the developer's decision.
                   7708: 
                   7709: There is a make target that helps in creating proper CHANGES-YYYY entries: make
                   7710: changes-entry. It uses the optional CTYPE and NETBSD_LOGIN_NAME variables. The
                   7711: general usage is to first make sure that your CHANGES-YYYY file is up-to-date
                   7712: (to avoid having to resolve conflicts later-on) and then to cd to the package
                   7713: directory. For package updates, make changes-entry is enough. For new packages,
                   7714: or package moves or removals, set the CTYPE variable on the command line to
                   7715: "Added", "Moved", or "Removed". You can set NETBSD_LOGIN_NAME in /etc/mk.conf
                   7716: if your local login name is not the same as your NetBSD login name. Don't
                   7717: forget to commit the changes to pkgsrc/doc/CHANGES-YYYY!
                   7718: 
                   7719: 20.4. Committing: Importing a package into CVS
                   7720: 
                   7721: This section is only of interest for pkgsrc developers with write access to the
                   7722: pkgsrc repository. Please remember that cvs imports files relative to the
                   7723: current working directory, and that the pathname that you give the cvs import
                   7724: command is so that it knows where to place the files in the repository. Newly
                   7725: created packages should be imported with a vendor tag of "TNF" and a release
                   7726: tag of "pkgsrc-base", e.g:
                   7727: 
                   7728: $ cd .../pkgsrc/category/pkgname
                   7729: $ cvs import pkgsrc/category/pkgname TNF pkgsrc-base
                   7730: 
                   7731: Remember to move the directory from which you imported out of the way, or cvs
                   7732: will complain the next time you "cvs update" your source tree. Also don't
                   7733: forget to add the new package to the category's Makefile.
                   7734: 
                   7735: The commit message of the initial import should include part of the DESCR file,
                   7736: so people reading the mailing lists know what the package is/does.
                   7737: 
                   7738: For new packages, "cvs import" is preferred to "cvs add" because the former
                   7739: gets everything with a single command, and provides a consistent tag.
                   7740: 
                   7741: 20.5. Updating a package to a newer version
                   7742: 
                   7743: Please always put a concise, appropriate and relevant summary of the changes
                   7744: between old and new versions into the commit log when updating a package. There
                   7745: are various reasons for this:
                   7746: 
                   7747:   * A URL is volatile, and can change over time. It may go away completely or
                   7748:     its information may be overwritten by newer information.
                   7749: 
                   7750:   * Having the change information between old and new versions in our CVS
                   7751:     repository is very useful for people who use either cvs or anoncvs.
                   7752: 
                   7753:   * Having the change information between old and new versions in our CVS
                   7754:     repository is very useful for people who read the pkgsrc-changes mailing
                   7755:     list, so that they can make tactical decisions about when to upgrade the
                   7756:     package.
                   7757: 
                   7758: Please also recognize that, just because a new version of a package has been
                   7759: released, it should not automatically be upgraded in the CVS repository. We
                   7760: prefer to be conservative in the packages that are included in pkgsrc -
                   7761: development or beta packages are not really the best thing for most places in
                   7762: which pkgsrc is used. Please use your judgement about what should go into
                   7763: pkgsrc, and bear in mind that stability is to be preferred above new and
                   7764: possibly untested features.
                   7765: 
                   7766: 20.6. Moving a package in pkgsrc
                   7767: 
                   7768:  1. Make a copy of the directory somewhere else.
                   7769: 
                   7770:  2. Remove all CVS dirs.
                   7771: 
                   7772:     Alternatively to the first two steps you can also do:
                   7773: 
                   7774:     % cvs -d user@cvs.NetBSD.org:/cvsroot export -D today pkgsrc/category/package
                   7775: 
                   7776:     and use that for further work.
                   7777: 
                   7778:  3. Fix CATEGORIES and any DEPENDS paths that just did "../package" instead of
                   7779:     "../../category/package".
                   7780: 
                   7781:  4. cvs import the modified package in the new place.
                   7782: 
                   7783:  5. Check if any package depends on it:
                   7784: 
                   7785:     % cd /usr/pkgsrc
                   7786:     % grep /package */*/Makefile* */*/buildlink*
                   7787: 
                   7788:  6. Fix paths in packages from step 5 to point to new location.
                   7789: 
                   7790:  7. cvs rm (-f) the package at the old location.
                   7791: 
                   7792:  8. Remove from oldcategory/Makefile.
                   7793: 
                   7794:  9. Add to newcategory/Makefile.
                   7795: 
                   7796: 10. Commit the changed and removed files:
                   7797: 
                   7798:     % cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile
                   7799: 
                   7800:     (and any packages from step 5, of course).
                   7801: 
                   7802: Chapter 21. Frequently Asked Questions
                   7803: 
                   7804: This section contains the answers to questions that may arise when you are
                   7805: writing a package. If you don't find your question answered here, first have a
                   7806: look in the other chapters, and if you still don't have the answer, ask on the
                   7807: pkgsrc-users mailing list.
                   7808: 
                   7809: 21.1. What is the difference between MAKEFLAGS, .MAKEFLAGS and MAKE_FLAGS?
                   7810: 21.2. What is the difference between MAKE, GMAKE and MAKE_PROGRAM?
                   7811: 21.3. What is the difference between CC, PKG_CC and PKGSRC_COMPILER?
                   7812: 21.4. What is the difference between BUILDLINK_LDFLAGS, BUILDLINK_LDADD and
                   7813:     BUILDLINK_LIBS?
                   7814: 21.5. Why does make show-var VARNAME=BUILDLINK_PREFIX.foo say it's empty?
                   7815: 21.6. What does ${MASTER_SITE_SOURCEFORGE:=package/} mean? I don't understand
                   7816:     the := inside it.
                   7817: 21.7. Which mailing lists are there for package developers?
                   7818: 21.8. Where is the pkgsrc documentation?
                   7819: 21.9. I have a little time to kill. What shall I do?
                   7820: 
                   7821: 21.1. What is the difference between MAKEFLAGS, .MAKEFLAGS and MAKE_FLAGS?
                   7822: 
                   7823:       MAKEFLAGS are the flags passed to the pkgsrc-internal invocations of make
                   7824:       (1), while MAKE_FLAGS are the flags that are passed to the MAKE_PROGRAM
                   7825:       when building the package. [FIXME: What is .MAKEFLAGS for?]
                   7826: 
                   7827: 21.2. What is the difference between MAKE, GMAKE and MAKE_PROGRAM?
                   7828: 
                   7829:       MAKE is the path to the make(1) program that is used in the pkgsrc
                   7830:       infrastructure. GMAKE is the path to GNU Make, but you need to say
                   7831:       USE_TOOLS+=gmake to use that. MAKE_PROGRAM is the path to the Make
                   7832:       program that is used for building the package.
                   7833: 
                   7834: 21.3. What is the difference between CC, PKG_CC and PKGSRC_COMPILER?
                   7835: 
                   7836:       CC is the path to the real C compiler, which can be configured by the
                   7837:       pkgsrc user. PKG_CC is the path to the compiler wrapper. PKGSRC_COMPILER
                   7838:       is not a path to a compiler, but the type of compiler that should be
                   7839:       used. See mk/compiler.mk for more information about the latter variable.
                   7840: 
                   7841: 21.4. What is the difference between BUILDLINK_LDFLAGS, BUILDLINK_LDADD and
                   7842:       BUILDLINK_LIBS?
                   7843: 
                   7844:       [FIXME]
                   7845: 
                   7846: 21.5. Why does make show-var VARNAME=BUILDLINK_PREFIX.foo say it's empty?
                   7847: 
                   7848:       For optimization reasons, some variables are only available in the
                   7849:       "wrapper" phase and later. To "simulate" the wrapper phase, append
                   7850:       PKG_PHASE=wrapper to the above command.
                   7851: 
                   7852: 21.6. What does ${MASTER_SITE_SOURCEFORGE:=package/} mean? I don't understand
                   7853:       the := inside it.
                   7854: 
                   7855:       The := is not really an assignment operator, like you might expect at
                   7856:       first sight. Instead, it is a degenerate form of ${LIST:old_string=
                   7857:       new_string}, which is documented in the make(1) man page and which you
                   7858:       may have seen as in ${SRCS:.c=.o}. In the case of MASTER_SITE_*,
                   7859:       old_string is the empty string and new_string is package/. That's where
                   7860:       the : and the = fall together.
                   7861: 
                   7862: 21.7. Which mailing lists are there for package developers?
                   7863: 
                   7864:       tech-pkg
                   7865: 
                   7866:           This is a list for technical discussions related to pkgsrc
                   7867:           development, e.g. soliciting feedback for changes to pkgsrc
                   7868:           infrastructure, proposed new features, questions related to porting
                   7869:           pkgsrc to a new platform, advice for maintaining a package, patches
                   7870:           that affect many packages, help requests moved from pkgsrc-users when
                   7871:           an infrastructure bug is found, etc.
                   7872: 
                   7873:       pkgsrc-bugs
                   7874: 
                   7875:           All bug reports in category "pkg" sent with send-pr(1) appear here.
                   7876:           Please do not report your bugs here directly; use one of the other
                   7877:           mailing lists.
                   7878: 
                   7879: 21.8. Where is the pkgsrc documentation?
                   7880: 
                   7881:       There are many places where you can find documentation about pkgsrc:
                   7882: 
                   7883:         * The pkgsrc guide (this document) is a collection of chapters that
                   7884:           explain large parts of pkgsrc, but some chapters tend to be outdated.
                   7885:           Which ones they are is hard to say.
                   7886: 
                   7887:         * On the mailing list archives (see http://mail-index.NetBSD.org/), you
                   7888:           can find discussions about certain features, announcements of new
                   7889:           parts of the pkgsrc infrastructure and sometimes even announcements
                   7890:           that a certain feature has been marked as obsolete. The benefit here
                   7891:           is that each message has a date appended to it.
                   7892: 
                   7893:         * Many of the files in the mk/ directory start with a comment that
                   7894:           describes the purpose of the file and how it can be used by the
                   7895:           pkgsrc user and package authors. An easy way to find this
                   7896:           documentation is to run bmake help.
                   7897: 
                   7898:         * The CVS log messages are a rich source of information, but they tend
                   7899:           to be highly abbreviated, especially for actions that occur often.
                   7900:           Some contain a detailed description of what has changed, but they are
                   7901:           geared towards the other pkgsrc developers, not towards an average
                   7902:           pkgsrc user. They also only document changes, so if you don't know
                   7903:           what has been before, these messages may not be worth too much to
                   7904:           you.
                   7905: 
                   7906:         * Some parts of pkgsrc are only "implicitly documented", that is the
                   7907:           documentation exists only in the mind of the developer who wrote the
                   7908:           code. To get this information, use the cvs annotate command to see
                   7909:           who has written it and ask on the tech-pkg mailing list, so that
                   7910:           others can find your questions later (see above). To be sure that the
                   7911:           developer in charge reads the mail, you may CC him or her.
                   7912: 
                   7913: 21.9. I have a little time to kill. What shall I do?
                   7914: 
                   7915:       This is not really an FAQ yet, but here's the answer anyway.
                   7916: 
                   7917:         * Run pkg_chk -N (from the pkgtools/pkg_chk package). It will tell you
                   7918:           about newer versions of installed packages that are available, but
                   7919:           not yet updated in pkgsrc.
                   7920: 
                   7921:         * Browse pkgsrc/doc/TODO ? it contains a list of suggested new packages
                   7922:           and a list of cleanups and enhancements for pkgsrc that would be nice
                   7923:           to have.
                   7924: 
                   7925:         * Review packages for which review was requested on the pkgsrc-wip
                   7926:           review mailing list.
                   7927: 
                   7928: Chapter 22. GNOME packaging and porting
                   7929: 
                   7930: Table of Contents
                   7931: 
                   7932: 22.1. Meta packages
                   7933: 22.2. Packaging a GNOME application
                   7934: 22.3. Updating GNOME to a newer version
                   7935: 22.4. Patching guidelines
                   7936: 
                   7937: Quoting GNOME's web site:
                   7938: 
                   7939:     The GNOME project provides two things: The GNOME desktop environment, an
                   7940:     intuitive and attractive desktop for users, and the GNOME development
                   7941:     platform, an extensive framework for building applications that integrate
                   7942:     into the rest of the desktop.
                   7943: 
                   7944: pkgsrc provides a seamless way to automatically build and install a complete
                   7945: GNOME environment under many different platforms. We can say with confidence
                   7946: that pkgsrc is one of the most advanced build and packaging systems for GNOME
                   7947: due to its included technologies buildlink3, the wrappers and tools framework
                   7948: and automatic configuration file management. Lots of efforts are put into
                   7949: achieving a completely clean deinstallation of installed software components.
                   7950: 
                   7951: Given that pkgsrc is NetBSD's official packaging system, the above also means
                   7952: that great efforts are put into making GNOME work under this operating system.
                   7953: Recently, DragonFly BSD also adopted pkgsrc as its preferred packaging system,
                   7954: contributing lots of portability fixes to make GNOME build and install under
                   7955: it.
                   7956: 
                   7957: This chapter is aimed at pkgsrc developers and other people interested in
                   7958: helping our GNOME porting and packaging efforts. It provides instructions on
                   7959: how to manage the existing packages and some important information regarding
                   7960: their internals.
                   7961: 
                   7962: We need your help!
                   7963: 
                   7964: Should you have some spare cycles to devote to NetBSD, pkgsrc and GNOME and are
                   7965: willing to learn new exciting stuff, please jump straight to the pending work
                   7966: list! There is still a long way to go to get a fully-functional GNOME desktop
                   7967: under NetBSD and we need your help to achieve it!
                   7968: 
                   7969: 22.1. Meta packages
                   7970: 
                   7971: pkgsrc includes three GNOME-related meta packages:
                   7972: 
                   7973:   * meta-pkgs/gnome-base: Provides the core GNOME desktop environment. It only
                   7974:     includes the necessary bits to get it to boot correctly, although it may
                   7975:     lack important functionality for daily operation. The idea behind this
                   7976:     package is to let end users build their own configurations on top of this
                   7977:     one, first installing this meta package to achieve a functional setup and
                   7978:     then adding individual applications.
                   7979: 
                   7980:   * meta-pkgs/gnome: Provides a complete installation of the GNOME platform and
                   7981:     desktop as defined by the GNOME project; this is based on the components
                   7982:     distributed in the platform/x.y/x.y.z/sources and desktop/x.y/x.y.z/sources
                   7983:     directories of the official FTP server. Developer-only tools found in those
                   7984:     directories are not installed unless required by some other component to
                   7985:     work properly. Similarly, packages from the bindings set (bindings/x.y/
                   7986:     x.y.z/sources) are not pulled in unless required as a dependency for an
                   7987:     end-user component. This package "extends" meta-pkgs/gnome-base.
                   7988: 
                   7989:   * meta-pkgs/gnome-devel: Installs all the tools required to build a GNOME
                   7990:     component when fetched from the CVS repository. These are required to let
                   7991:     the autogen.sh scripts work appropriately.
                   7992: 
                   7993: In all these packages, the DEPENDS lines are sorted in a way that eases
                   7994: updates: a package may depend on other packages listed before it but not on any
                   7995: listed after it. It is very important to keep this order to ease updates so...
                   7996: do not change it to alphabetical sorting!
                   7997: 
                   7998: 22.2. Packaging a GNOME application
                   7999: 
                   8000: Almost all GNOME applications are written in C and use a common set of tools as
                   8001: their build system. Things get different with the new bindings to other
                   8002: languages (such as Python), but the following will give you a general idea on
                   8003: the minimum required tools:
                   8004: 
                   8005:   * Almost all GNOME applications use the GNU Autotools as their build system.
                   8006:     As a general rule you will need to tell this to your package:
                   8007: 
                   8008:     GNU_CONFIGURE=yes
                   8009:     USE_LIBTOOL=yes
                   8010:     USE_TOOLS+=gmake
                   8011: 
                   8012:   * If the package uses pkg-config to detect dependencies, add this tool to the
                   8013:     list of required utilities:
                   8014: 
                   8015:     USE_TOOLS+=pkg-config
                   8016: 
                   8017:     Also use pkgtools/verifypc at the end of the build process to ensure that
                   8018:     you did not miss to specify any dependency in your package and that the
                   8019:     version requirements are all correct.
                   8020: 
                   8021:   * If the package uses intltool, be sure to add intltool to the USE_TOOLS to
                   8022:     handle dependencies and to force the package to use the latest available
                   8023:     version.
                   8024: 
                   8025:   * If the package uses gtk-doc (a documentation generation utility), do not
                   8026:     add a dependency on it. The tool is rather big and the distfile should come
                   8027:     with pregenerated documentation anyway; if it does not, it is a bug that
                   8028:     you ought to report. For such packages you should disable gtk-doc (unless
                   8029:     it is the default):
                   8030: 
                   8031:     CONFIGURE_ARGS+=--disable-gtk-doc
                   8032: 
                   8033:     The default location of installed HTML files (share/gtk-doc/<package-name>)
                   8034:     is correct and should not be changed unless the package insists on
                   8035:     installing them somewhere else. Otherwise programs as devhelp will not be
                   8036:     able to open them. You can do that with an entry similar to:
                   8037: 
                   8038:     CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
                   8039: 
                   8040: GNOME uses multiple shared directories and files under the installation prefix
                   8041: to maintain databases. In this context, shared means that those exact same
                   8042: directories and files are used among several different packages, leading to
                   8043: conflicts in the PLIST. pkgsrc currently includes functionality to handle the
                   8044: most common cases, so you have to forget about using @unexec ${RMDIR} lines in
                   8045: your file lists and omitting shared files from them. If you find yourself doing
                   8046: those, your package is most likely incorrect.
                   8047: 
                   8048: The following table lists the common situations that result in using shared
                   8049: directories or files. For each of them, the appropriate solution is given.
                   8050: After applying the solution be sure to regenerate the package's file list with
                   8051: make print-PLIST and ensure it is correct.
                   8052: 
                   8053: Table 22.1. PLIST handling for GNOME packages
                   8054: 
                   8055: +-----------------------------------------------------------------------------+
                   8056: |             If the package...             |             Then...             |
                   8057: |-------------------------------------------+---------------------------------|
                   8058: |                                           |See Section 18.6.9, "Packages    |
                   8059: |Installs OMF files under share/omf.        |installing scrollkeeper data     |
                   8060: |                                           |files".                          |
                   8061: |-------------------------------------------+---------------------------------|
                   8062: |Installs icons under the share/icons/      |See Section 18.6.18, "Packages   |
                   8063: |hicolor hierarchy or updates share/icons/  |installing hicolor theme icons". |
                   8064: |hicolor/icon-theme.cache.                  |                                 |
                   8065: |-------------------------------------------+---------------------------------|
                   8066: |                                           |See Section 18.6.13, "Packages   |
                   8067: |Installs files under share/mime/packages.  |installing extensions to the MIME|
                   8068: |                                           |database".                       |
                   8069: |-------------------------------------------+---------------------------------|
                   8070: |Installs .desktop files under share/       |See Section 18.6.19, "Packages   |
                   8071: |applications and these include MIME        |installing desktop files".       |
                   8072: |information.                               |                                 |
                   8073: +-----------------------------------------------------------------------------+
                   8074: 
                   8075: 
                   8076: 22.3. Updating GNOME to a newer version
                   8077: 
                   8078: When seeing GNOME as a whole, there are two kinds of updates:
                   8079: 
                   8080: Major update
                   8081: 
                   8082:     Given that there is still a very long way for GNOME 3 (if it ever appears),
                   8083:     we consider a major update one that goes from a 2.X version to a 2.Y one,
                   8084:     where Y is even and greater than X. These are hard to achieve because they
                   8085:     introduce lots of changes in the components' code and almost all GNOME
                   8086:     distfiles are updated to newer versions. Some of them can even break API
                   8087:     and ABI compatibility with the previous major version series. As a result,
                   8088:     the update needs to be done all at once to minimize breakage.
                   8089: 
                   8090:     A major update typically consists of around 80 package updates and the
                   8091:     addition of some new ones.
                   8092: 
                   8093: Minor update
                   8094: 
                   8095:     We consider a minor update one that goes from a 2.A.X version to a 2.A.Y
                   8096:     one where Y is greater than X. These are easy to achieve because they do
                   8097:     not update all GNOME components, can be done in an incremental way and do
                   8098:     not break API nor ABI compatibility.
                   8099: 
                   8100:     A minor update typically consists of around 50 package updates, although
                   8101:     the numbers here may vary a lot.
                   8102: 
                   8103: In order to update the GNOME components in pkgsrc to a new stable release
                   8104: (either major or minor), the following steps should be followed:
                   8105: 
                   8106:  1. Get a list of all the tarballs that form the new release by using the
                   8107:     following commands. These will leave the full list of the components's
                   8108:     distfiles into the list.txt file:
                   8109: 
                   8110:     % echo ls "*.tar.bz2" | \
                   8111:         ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   8112:         awk '{ print $9 }' >list.txt
                   8113:     % echo ls "*.tar.bz2" | \
                   8114:         ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   8115:         awk '{ print $9 }' >>list.txt
                   8116: 
                   8117:  2. Open each meta package's Makefile and bump their version to the release you
                   8118:     are updating them to. The three meta packages should be always consistent
                   8119:     with versioning. Obviously remove any PKGREVISIONs that might be in them.
                   8120: 
                   8121:  3. For each meta package, update all its DEPENDS lines to match the latest
                   8122:     versions as shown by the above commands. Do not list any newer version
                   8123:     (even if found in the FTP) because the meta packages are supposed to list
                   8124:     the exact versions that form a specific GNOME release. Exceptions are
                   8125:     permitted here if a newer version solves a serious issue in the overall
                   8126:     desktop experience; these typically come in the form of a revision bump in
                   8127:     pkgsrc, not in newer versions from the developers.
                   8128: 
                   8129:     Packages not listed in the list.txt file should be updated to the latest
                   8130:     version available (if found in pkgsrc). This is the case, for example, of
                   8131:     the dependencies on the GNU Autotools in the meta-pkgs/gnome-devel meta
                   8132:     package.
                   8133: 
                   8134:  4. Generate a patch from the modified meta packages and extract the list of
                   8135:     "new" lines. This will provide you an outline on what packages need to be
                   8136:     updated in pkgsrc and in what order:
                   8137: 
                   8138:     % cvs diff -u gnome-devel gnome-base gnome | grep '^+D' >todo.txt
                   8139: 
                   8140:  5. For major desktop updates it is recommended to zap all your installed
                   8141:     packages and start over from scratch at this point.
                   8142: 
                   8143:  6. Now comes the longest step by far: iterate over the contents of todo.txt
                   8144:     and update the packages listed in it in order. For major desktop updates
                   8145:     none of these should be committed until the entire set is completed because
                   8146:     there are chances of breaking not-yet-updated packages.
                   8147: 
                   8148:  7. Once the packages are up to date and working, commit them to the tree one
                   8149:     by one with appropriate log messages. At the end, commit the three meta
                   8150:     package updates and all the corresponding changes to the doc/CHANGES-<YEAR>
                   8151:     and pkgsrc/doc/TODO files.
                   8152: 
                   8153: 22.4. Patching guidelines
                   8154: 
                   8155: GNOME is a very big component in pkgsrc which approaches 100 packages. Please,
                   8156: it is very important that you always, always, always feed back any portability
                   8157: fixes you do to a GNOME package to the mainstream developers (see
                   8158: Section 10.3.5, "Feedback to the author"). This is the only way to get their
                   8159: attention on portability issues and to ensure that future versions can be built
                   8160: out-of-the box on NetBSD. The less custom patches in pkgsrc, the easier further
                   8161: updates are. Those developers in charge of issuing major GNOME updates will be
                   8162: grateful if you do that.
                   8163: 
                   8164: The most common places to report bugs are the GNOME's Bugzilla and the
                   8165: freedesktop.org's Bugzilla. Not all components use these to track bugs, but
                   8166: most of them do. Do not be short on your reports: always provide detailed
                   8167: explanations of the current failure, how it can be improved to achieve maximum
                   8168: portability and, if at all possible, provide a patch against CVS head. The more
                   8169: verbose you are, the higher chances of your patch being accepted.
                   8170: 
                   8171: Also, please avoid using preprocessor magic to fix portability issues. While
                   8172: the FreeBSD GNOME people are doing a great job in porting GNOME to their
                   8173: operating system, the official GNOME sources are now plagued by conditionals
                   8174: that check for __FreeBSD__ and similar macros. This hurts portability. Please
                   8175: see our patching guidelines (Section 10.3.4, "Patching guidelines") for more
                   8176: details.
                   8177: 
                   8178: Part III. The pkgsrc infrastructure internals
                   8179: 
                   8180: This part of the guide deals with everything from the infrastructure that is
                   8181: behind the interfaces described in the developer's guide. A casual package
                   8182: maintainer should not need anything from this part.
                   8183: 
                   8184: Table of Contents
                   8185: 
                   8186: 23. Design of the pkgsrc infrastructure
                   8187: 
                   8188:     23.1. The meaning of variable definitions
                   8189:     23.2. Avoiding problems before they arise
                   8190:     23.3. Variable evaluation
                   8191: 
                   8192:         23.3.1. At load time
                   8193:         23.3.2. At runtime
                   8194: 
                   8195:     23.4. How can variables be specified?
                   8196:     23.5. Designing interfaces for Makefile fragments
                   8197: 
                   8198:         23.5.1. Procedures with parameters
                   8199:         23.5.2. Actions taken on behalf of parameters
                   8200: 
                   8201:     23.6. The order in which files are loaded
                   8202: 
                   8203:         23.6.1. The order in bsd.prefs.mk
                   8204:         23.6.2. The order in bsd.pkg.mk
                   8205: 
                   8206: 24. Regression tests
                   8207: 
                   8208:     24.1. The regression tests framework
                   8209:     24.2. Running the regression tests
                   8210:     24.3. Adding a new regression test
                   8211: 
                   8212:         24.3.1. Overridable functions
                   8213:         24.3.2. Helper functions
                   8214: 
                   8215: 25. Porting pkgsrc
                   8216: 
                   8217:     25.1. Porting pkgsrc to a new operating system
                   8218:     25.2. Adding support for a new compiler
                   8219: 
                   8220: Chapter 23. Design of the pkgsrc infrastructure
                   8221: 
                   8222: Table of Contents
                   8223: 
                   8224: 23.1. The meaning of variable definitions
                   8225: 23.2. Avoiding problems before they arise
                   8226: 23.3. Variable evaluation
                   8227: 
                   8228:     23.3.1. At load time
                   8229:     23.3.2. At runtime
                   8230: 
                   8231: 23.4. How can variables be specified?
                   8232: 23.5. Designing interfaces for Makefile fragments
                   8233: 
                   8234:     23.5.1. Procedures with parameters
                   8235:     23.5.2. Actions taken on behalf of parameters
                   8236: 
                   8237: 23.6. The order in which files are loaded
                   8238: 
                   8239:     23.6.1. The order in bsd.prefs.mk
                   8240:     23.6.2. The order in bsd.pkg.mk
                   8241: 
                   8242: The pkgsrc infrastructure consists of many small Makefile fragments. Each such
                   8243: fragment needs a properly specified interface. This chapter explains how such
                   8244: an interface looks like.
                   8245: 
                   8246: 23.1. The meaning of variable definitions
                   8247: 
                   8248: Whenever a variable is defined in the pkgsrc infrastructure, the location and
                   8249: the way of definition provide much information about the intended use of that
                   8250: variable. Additionally, more documentation may be found in a header comment or
                   8251: in this pkgsrc guide.
                   8252: 
                   8253: A special file is mk/defaults/mk.conf, which lists all variables that are
                   8254: intended to be user-defined. They are either defined using the ?= operator or
                   8255: they are left undefined because defining them to anything would effectively
                   8256: mean "yes". All these variables may be overridden by the pkgsrc user in the
                   8257: MAKECONF file.
                   8258: 
                   8259: Outside this file, the following conventions apply: Variables that are defined
                   8260: using the ?= operator may be overridden by a package.
                   8261: 
                   8262: Variables that are defined using the = operator may be used read-only at
                   8263: run-time.
                   8264: 
                   8265: Variables whose name starts with an underscore must not be accessed outside the
                   8266: pkgsrc infrastructure at all. They may change without further notice.
                   8267: 
                   8268: Note
                   8269: 
                   8270: These conventions are currently not applied consistently to the complete pkgsrc
                   8271: infrastructure.
                   8272: 
                   8273: 23.2. Avoiding problems before they arise
                   8274: 
                   8275: All variables that contain lists of things should default to being empty. Two
                   8276: examples that do not follow this rule are USE_LANGUAGES and DISTFILES. These
                   8277: variables cannot simply be modified using the += operator in package Makefiles
                   8278: (or other files included by them), since there is no guarantee whether the
                   8279: variable is already set or not, and what its value is. In the case of
                   8280: DISTFILES, the packages "know" the default value and just define it as in the
                   8281: following example.
                   8282: 
                   8283: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
                   8284: 
                   8285: Because of the selection of this default value, the same value appears in many
                   8286: package Makefiles. Similarly for USE_LANGUAGES, but in this case the default
                   8287: value ("c") is so short that it doesn't stand out. Nevertheless it is mentioned
                   8288: in many files.
                   8289: 
                   8290: 23.3. Variable evaluation
                   8291: 
                   8292: 23.3.1. At load time
                   8293: 
                   8294: Variable evaluation takes place either at load time or at runtime, depending on
                   8295: the context in which they occur. The contexts where variables are evaluated at
                   8296: load time are:
                   8297: 
                   8298:   * The right hand side of the := and != operators,
                   8299: 
                   8300:   * Make directives like .if or .for,
                   8301: 
                   8302:   * Dependency lines.
                   8303: 
                   8304: A special exception are references to the iteration variables of .for loops,
                   8305: which are expanded inline, no matter in which context they appear.
                   8306: 
                   8307: As the values of variables may change during load time, care must be taken not
                   8308: to evaluate them by accident. Typical examples for variables that should not be
                   8309: evaluated at load time are DEPENDS and CONFIGURE_ARGS. To make the effect more
                   8310: clear, here is an example:
                   8311: 
                   8312: CONFIGURE_ARGS=         # none
                   8313: CFLAGS=                 -O
                   8314: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
                   8315: 
                   8316: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
                   8317: 
                   8318: CFLAGS+=                -Wall
                   8319: 
                   8320: 
                   8321: This code shows how the use of the := operator can quickly lead to unexpected
                   8322: results. The first paragraph is fairly common code. The second paragraph
                   8323: evaluates the CONFIGURE_ARGS variable, which results in CFLAGS=-O. In the third
                   8324: paragraph, the -Wall is appended to the CFLAGS, but this addition will not
                   8325: appear in CONFIGURE_ARGS. In actual code, the three paragraphs from above
                   8326: typically occur in completely unrelated files.
                   8327: 
                   8328: 23.3.2. At runtime
                   8329: 
                   8330: After all the files have been loaded, the values of the variables cannot be
                   8331: changed anymore. Variables that are used in the shell commands are expanded at
                   8332: this point.
                   8333: 
                   8334: 23.4. How can variables be specified?
                   8335: 
                   8336: There are many ways in which the definition and use of a variable can be
                   8337: restricted in order to detect bugs and violations of the (mostly unwritten)
                   8338: policies. See the pkglint developer's documentation for further details.
                   8339: 
                   8340: 23.5. Designing interfaces for Makefile fragments
                   8341: 
                   8342: Most of the .mk files fall into one of the following classes. Cases where a
                   8343: file falls into more than one class should be avoided as it often leads to
                   8344: subtle bugs.
                   8345: 
                   8346: 23.5.1. Procedures with parameters
                   8347: 
                   8348: In a traditional imperative programming language some of the .mk files could be
                   8349: described as procedures. They take some input parameters and?after inclusion?
                   8350: provide a result in output parameters. Since all variables in Makefiles have
                   8351: global scope care must be taken not to use parameter names that have already
                   8352: another meaning. For example, PKGNAME is a bad choice for a parameter name.
                   8353: 
                   8354: Procedures are completely evaluated at preprocessing time. That is, when
                   8355: calling a procedure all input parameters must be completely resolvable. For
                   8356: example, CONFIGURE_ARGS should never be an input parameter since it is very
                   8357: likely that further text will be added after calling the procedure, which would
                   8358: effectively apply the procedure to only a part of the variable. Also,
                   8359: references to other variables wit will be modified after calling the procedure.
                   8360: 
                   8361: A procedure can declare its output parameters either as suitable for use in
                   8362: preprocessing directives or as only available at runtime. The latter
                   8363: alternative is for variables that contain references to other runtime
                   8364: variables.
                   8365: 
                   8366: Procedures shall be written such that it is possible to call the procedure more
                   8367: than once. That is, the file must not contain multiple-inclusion guards.
                   8368: 
                   8369: Examples for procedures are mk/bsd.options.mk and mk/buildlink3/bsd.builtin.mk.
                   8370: To express that the parameters are evaluated at load time, they should be
                   8371: assigned using the := operator, which should be used only for this purpose.
                   8372: 
                   8373: 23.5.2. Actions taken on behalf of parameters
                   8374: 
                   8375: Action files take some input parameters and may define runtime variables. They
                   8376: shall not define loadtime variables. There are action files that are included
                   8377: implicitly by the pkgsrc infrastructure, while other must be included
                   8378: explicitly.
                   8379: 
                   8380: An example for action files is mk/subst.mk.
                   8381: 
                   8382: 23.6. The order in which files are loaded
                   8383: 
                   8384: Package Makefiles usually consist of a set of variable definitions, and include
                   8385: the file ../../mk/bsd.pkg.mk in the very last line. Before that, they may also
                   8386: include various other *.mk files if they need to query the availability of
                   8387: certain features like the type of compiler or the X11 implementation. Due to
                   8388: the heavy use of preprocessor directives like .if and .for, the order in which
                   8389: the files are loaded matters.
                   8390: 
                   8391: This section describes at which point the various files are loaded and gives
                   8392: reasons for that order.
                   8393: 
                   8394: 23.6.1. The order in bsd.prefs.mk
                   8395: 
                   8396: The very first action in bsd.prefs.mk is to define some essential variables
                   8397: like OPSYS, OS_VERSION and MACHINE_ARCH.
                   8398: 
                   8399: Then, the user settings are loaded from the file specified in MAKECONF. If the
                   8400: bmake command from pkgsrc is used, MAKECONF defaults to ${prefix}/etc/mk.conf.
                   8401: With the native make(1) command on NetBSD, it defaults to /etc/mk.conf. After
                   8402: that, those variables that have not been overridden by the user are loaded from
                   8403: mk/defaults/mk.conf.
                   8404: 
                   8405: After the user settings, the system settings and platform settings are loaded,
                   8406: which may override the user settings.
                   8407: 
                   8408: Then, the tool definitions are loaded. The tool wrappers are not yet in effect.
                   8409: This only happens when building a package, so the proper variables must be used
                   8410: instead of the direct tool names.
                   8411: 
                   8412: As the last steps, some essential variables from the wrapper and the package
                   8413: system flavor are loaded, as well as the variables that have been cached in
                   8414: earlier phases of a package build.
                   8415: 
                   8416: 23.6.2. The order in bsd.pkg.mk
                   8417: 
                   8418: First, bsd.prefs.mk is loaded.
                   8419: 
                   8420: Then, the various *-vars.mk files are loaded, which fill default values for
                   8421: those variables that have not been defined by the package. These variables may
                   8422: later be used even in unrelated files.
                   8423: 
                   8424: Then, the file bsd.pkg.error.mk provides the target error-check that is added
                   8425: as a special dependency to all other targets that use DELAYED_ERROR_MSG or
                   8426: DELAYED_WARNING_MSG.
                   8427: 
                   8428: Then, the package-specific hacks from hacks.mk are included.
                   8429: 
                   8430: Then, various other files follow. Most of them don't have any dependencies on
                   8431: what they need to have included before or after them, though some do.
                   8432: 
                   8433: The code to check PKG_FAIL_REASON and PKG_SKIP_REASON is then executed, which
                   8434: restricts the use of these variables to all the files that have been included
                   8435: before. Appearances in later files will be silently ignored.
                   8436: 
                   8437: Then, the files for the main targets are included, in the order of later
                   8438: execution, though the actual order should not matter.
                   8439: 
                   8440: At last, some more files are included that don't set any interesting variables
                   8441: but rather just define make targets to be executed.
                   8442: 
                   8443: Chapter 24. Regression tests
                   8444: 
                   8445: Table of Contents
                   8446: 
                   8447: 24.1. The regression tests framework
                   8448: 24.2. Running the regression tests
                   8449: 24.3. Adding a new regression test
                   8450: 
                   8451:     24.3.1. Overridable functions
                   8452:     24.3.2. Helper functions
                   8453: 
                   8454: The pkgsrc infrastructure consists of a large codebase, and there are many
                   8455: corners where every little bit of a file is well thought out, making pkgsrc
                   8456: likely to fail as soon as anything is changed near those parts. To prevent most
                   8457: changes from breaking anything, a suite of regression tests should go along
                   8458: with every important part of the pkgsrc infrastructure. This chapter describes
                   8459: how regression tests work in pkgsrc and how you can add new tests.
                   8460: 
                   8461: 24.1. The regression tests framework
                   8462: 
                   8463: 24.2. Running the regression tests
                   8464: 
                   8465: You first need to install the pkgtools/pkg_regress package, which provides the
                   8466: pkg_regress command. Then you can simply run that command, which will run all
                   8467: tests in the regress category.
                   8468: 
                   8469: 24.3. Adding a new regression test
                   8470: 
                   8471: Every directory in the regress category that contains a file called spec is
                   8472: considered a regression test. This file is a shell program that is included by
                   8473: the pkg_regress command. The following functions can be overridden to suit your
                   8474: needs.
                   8475: 
                   8476: 24.3.1. Overridable functions
                   8477: 
                   8478: These functions do not take any parameters. They are all called in "set -e"
                   8479: mode, so you should be careful to check the exitcodes of any commands you run
                   8480: in the test.
                   8481: 
                   8482: do_setup()
                   8483: 
                   8484:     This function prepares the environment for the test. By default it does
                   8485:     nothing.
                   8486: 
                   8487: do_test()
                   8488: 
                   8489:     This function runs the actual test. By default, it calls TEST_MAKE with the
                   8490:     arguments MAKEARGS_TEST and writes its output including error messages into
                   8491:     the file TEST_OUTFILE.
                   8492: 
                   8493: check_result()
                   8494: 
                   8495:     This function is run after the test and is typically used to compare the
                   8496:     actual output from the one that is expected. It can make use of the various
                   8497:     helper functions from the next section.
                   8498: 
                   8499: do_cleanup()
                   8500: 
                   8501:     This function cleans everything up after the test has been run. By default
                   8502:     it does nothing.
                   8503: 
                   8504: 24.3.2. Helper functions
                   8505: 
                   8506: exit_status(expected)
                   8507: 
                   8508:     This function compares the exitcode of the do_test() function with its
                   8509:     first parameter. If they differ, the test will fail.
                   8510: 
                   8511: output_require(regex...)
                   8512: 
                   8513:     This function checks for each of its parameters if the output from do_test
                   8514:     () matches the extended regular expression. If it does not, the test will
                   8515:     fail.
                   8516: 
                   8517: output_prohibit(regex...)
                   8518: 
                   8519:     This function checks for each of its parameters if the output from do_test
                   8520:     () does not match the extended regular expression. If any of the regular
                   8521:     expressions matches, the test will fail.
                   8522: 
                   8523: Chapter 25. Porting pkgsrc
                   8524: 
                   8525: Table of Contents
                   8526: 
                   8527: 25.1. Porting pkgsrc to a new operating system
                   8528: 25.2. Adding support for a new compiler
                   8529: 
                   8530: The pkgsrc system has already been ported to many operating systems, hardware
                   8531: architectures and compilers. This chapter explains the necessary steps to make
                   8532: pkgsrc even more portable.
                   8533: 
                   8534: 25.1. Porting pkgsrc to a new operating system
                   8535: 
                   8536: To port pkgsrc to a new operating system (called MyOS in this example), you
                   8537: need to touch the following files:
                   8538: 
                   8539: pkgtools/bootstrap-mk-files/files/mods/MyOS.sys.mk
                   8540: 
                   8541:     This file contains some basic definitions, for example the name of the C
                   8542:     compiler.
                   8543: 
                   8544: mk/bsd.prefs.mk
                   8545: 
                   8546:     Insert code that defines the variables OPSYS, OS_VERSION, LOWER_OS_VERSION,
                   8547:     LOWER_VENDOR, MACHINE_ARCH, OBJECT_FMT, APPEND_ELF, and the other variables
                   8548:     that appear in this file.
                   8549: 
                   8550: mk/platform/MyOS.mk
                   8551: 
                   8552:     This file contains the platform-specific definitions that are used by
                   8553:     pkgsrc. Start by copying one of the other files and edit it to your needs.
                   8554: 
                   8555: mk/platform/MyOS.pkg.dist
                   8556: 
                   8557:     This file contains a list of directories, together with their permission
                   8558:     bits and ownership. These directories will be created automatically with
                   8559:     every package that explicitly sets USE_MTREE. This feature will be removed.
                   8560: 
                   8561: mk/platform/MyOS.x11.dist
                   8562: 
                   8563:     Just copy one of the pre-existing x11.dist files to your MyOS.x11.dist.
                   8564: 
                   8565: mk/tools/bootstrap.mk
                   8566: 
                   8567:     On some operating systems, the tools that are provided with the base system
                   8568:     are not good enough for pkgsrc. For example, there are many versions of sed
                   8569:     (1) that have a narrow limit on the line length they can process. Therefore
                   8570:     pkgsrc brings its own tools, which can be enabled here.
                   8571: 
                   8572: mk/tools/tools.MyOS.mk
                   8573: 
                   8574:     This file defines the paths to all the tools that are needed by one or the
                   8575:     other package in pkgsrc, as well as by pkgsrc itself. Find out where these
                   8576:     tools are on your platform and add them.
                   8577: 
                   8578: Now, you should be able to build some basic packages, like lang/perl5, shells/
                   8579: bash.
                   8580: 
                   8581: 25.2. Adding support for a new compiler
                   8582: 
                   8583: TODO
                   8584: 
                   8585: Appendix A. A simple example package: bison
                   8586: 
                   8587: Table of Contents
                   8588: 
                   8589: A.1. files
                   8590: 
                   8591:     A.1.1. Makefile
                   8592:     A.1.2. DESCR
                   8593:     A.1.3. PLIST
                   8594:     A.1.4. Checking a package with pkglint
                   8595: 
                   8596: A.2. Steps for building, installing, packaging
                   8597: 
                   8598: We checked to find a piece of software that wasn't in the packages collection,
                   8599: and picked GNU bison. Quite why someone would want to have bison when Berkeley
                   8600: yacc is already present in the tree is beyond us, but it's useful for the
                   8601: purposes of this exercise.
                   8602: 
                   8603: A.1. files
                   8604: 
                   8605: A.1.1. Makefile
                   8606: 
1.2     ! rillig   8607: # $NetBSD$
1.1       dsieger  8608: #
                   8609: 
                   8610: DISTNAME=       bison-1.25
                   8611: CATEGORIES=     devel
                   8612: MASTER_SITES=   ${MASTER_SITE_GNU}
                   8613: 
                   8614: MAINTAINER=     thorpej@NetBSD.org
                   8615: HOMEPAGE=       http://www.gnu.org/software/bison/bison.html
                   8616: COMMENT=        GNU yacc clone
                   8617: 
                   8618: GNU_CONFIGURE=  yes
                   8619: INFO_FILES=     bison.info
                   8620: 
                   8621: .include "../../mk/bsd.pkg.mk"
                   8622: 
                   8623: A.1.2. DESCR
                   8624: 
                   8625: GNU version of yacc.  Can make re-entrant parsers, and numerous other
                   8626: improvements.  Why you would want this when Berkeley yacc(1) is part
                   8627: of the NetBSD source tree is beyond me.
                   8628: 
                   8629: A.1.3. PLIST
                   8630: 
1.2     ! rillig   8631: @comment $NetBSD$
1.1       dsieger  8632: bin/bison
                   8633: man/man1/bison.1.gz
                   8634: share/bison.simple
                   8635: share/bison.hairy
                   8636: 
                   8637: A.1.4. Checking a package with pkglint
                   8638: 
                   8639: The NetBSD package system comes with pkgtools/pkglint which helps to check the
                   8640: contents of these files. After installation it is quite easy to use, just
                   8641: change to the directory of the package you wish to examine and execute pkglint:
                   8642: 
                   8643: $ pkglint
                   8644: looks fine.
                   8645: 
                   8646: Depending on the supplied command line arguments (see pkglint(1)), more checks
                   8647: will be performed. Use e.g. pkglint -Call -Wall for a very thorough check.
                   8648: 
                   8649: A.2. Steps for building, installing, packaging
                   8650: 
                   8651: Create the directory where the package lives, plus any auxiliary directories:
                   8652: 
                   8653: # cd /usr/pkgsrc/lang
                   8654: # mkdir bison
                   8655: # cd bison
                   8656: # mkdir patches
                   8657: 
                   8658: Create Makefile, DESCR and PLIST (see Chapter 10, Package components - files,
                   8659: directories and contents) then continue with fetching the distfile:
                   8660: 
                   8661: # make fetch
                   8662: >> bison-1.25.tar.gz doesn't seem to exist on this system.
                   8663: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   8664: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   8665: ftp: Error retrieving file: 500 Internal error
                   8666: 
                   8667: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   8668: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   8669: ftp: Error retrieving file: 500 Internal error
                   8670: 
                   8671: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   8672: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   8673: Successfully retrieved file.
                   8674: 
                   8675: Generate the checksum of the distfile into distinfo:
                   8676: 
                   8677: # make makedistinfo
                   8678: 
                   8679: Now compile:
                   8680: 
                   8681: # make
                   8682: >> Checksum OK for bison-1.25.tar.gz.
                   8683: ===>  Extracting for bison-1.25
                   8684: ===>  Patching for bison-1.25
                   8685: ===>   Ignoring empty patch directory
                   8686: ===>  Configuring for bison-1.25
                   8687: creating cache ./config.cache
                   8688: checking for gcc... cc
                   8689: checking whether we are using GNU C... yes
                   8690: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   8691: checking how to run the C preprocessor... cc -E
                   8692: checking for minix/config.h... no
                   8693: checking for POSIXized ISC... no
                   8694: checking whether cross-compiling... no
                   8695: checking for ANSI C header files... yes
                   8696: checking for string.h... yes
                   8697: checking for stdlib.h... yes
                   8698: checking for memory.h... yes
                   8699: checking for working const... yes
                   8700: checking for working alloca.h... no
                   8701: checking for alloca... yes
                   8702: checking for strerror... yes
                   8703: updating cache ./config.cache
                   8704: creating ./config.status
                   8705: creating Makefile
                   8706: ===>  Building for bison-1.25
                   8707: 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
                   8708: 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
                   8709: 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
                   8710: 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
                   8711: 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
                   8712: 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
                   8713: 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
                   8714: 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
                   8715: 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
                   8716: 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
                   8717: 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
                   8718: 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
                   8719: 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
                   8720: 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
                   8721: 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
                   8722: 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
                   8723: 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
                   8724: 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
                   8725: 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
                   8726: 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
                   8727: 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
                   8728: 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 getopt.o getopt1.o
                   8729: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   8730: rm -f bison.s1
                   8731: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1
                   8732: 
                   8733: Everything seems OK, so install the files:
                   8734: 
                   8735: # make install
                   8736: >> Checksum OK for bison-1.25.tar.gz.
                   8737: ===>  Installing for bison-1.25
                   8738: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   8739: rm -f /usr/pkg/bin/bison
                   8740: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   8741: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   8742: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   8743: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   8744: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   8745: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   8746: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
                   8747: ===>  Registering installation for bison-1.25
                   8748: 
                   8749: You can now use bison, and also - if you decide so - remove it with pkg_delete
                   8750: bison. Should you decide that you want a binary package, do this now:
                   8751: 
                   8752: # make package
                   8753: >> Checksum OK for bison-1.25.tar.gz.
                   8754: ===>  Building package for bison-1.25
                   8755: Creating package bison-1.25.tgz
                   8756: Registering depends:.
                   8757: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'
                   8758: 
                   8759: Now that you don't need the source and object files any more, clean up:
                   8760: 
                   8761: # make clean
                   8762: ===>  Cleaning for bison-1.25
                   8763: 
                   8764: Appendix B. Build logs
                   8765: 
                   8766: Table of Contents
                   8767: 
                   8768: B.1. Building figlet
                   8769: B.2. Packaging figlet
                   8770: 
                   8771: B.1. Building figlet
                   8772: 
                   8773: # make
                   8774: ===> Checking for vulnerabilities in figlet-2.2.1nb2
                   8775: => figlet221.tar.gz doesn't seem to exist on this system.
                   8776: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   8777: => [172219 bytes]
                   8778: Connected to ftp.plig.net.
                   8779: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   8780: 331 Guest login ok, send your complete e-mail address as password.
                   8781: 230-You are user #5 of 500 simultaneous users allowed.
                   8782: 230-
                   8783: 230-  ___ _             _ _
                   8784: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
                   8785: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   8786: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   8787: 230-         |_|   |_|     |___|         |___|
                   8788: 230-
                   8789: 230-** Welcome to ftp.plig.org **
                   8790: 230-
                   8791: 230-Please note that all transfers from this FTP site are logged. If you
                   8792: 230-do not like this, please disconnect now.
                   8793: 230-
                   8794: 230-This arhive is available via
                   8795: 230-
                   8796: 230-HTTP:  http://ftp.plig.org/
                   8797: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   8798: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   8799: 230-
                   8800: 230-Please email comments, bug reports and requests for packages to be
                   8801: 230-mirrored to ftp-admin@plig.org.
                   8802: 230-
                   8803: 230-
                   8804: 230 Logged in anonymously.
                   8805: Remote system type is UNIX.
                   8806: Using binary mode to transfer files.
                   8807: 200 Type okay.
                   8808: 250 "/pub" is new cwd.
                   8809: 250-"/pub/figlet" is new cwd.
                   8810: 250-
                   8811: 250-Welcome to the figlet archive at ftp.figlet.org
                   8812: 250-
                   8813: 250-    ftp://ftp.figlet.org/pub/figlet/
                   8814: 250-
                   8815: 250-The official FIGlet web page is:
                   8816: 250-    http://www.figlet.org/
                   8817: 250-
                   8818: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   8819: 250-contribute a font or something else, you can email us.
                   8820: 250
                   8821: 250 "/pub/figlet/program" is new cwd.
                   8822: 250 "/pub/figlet/program/unix" is new cwd.
                   8823: local: figlet221.tar.gz remote: figlet221.tar.gz
                   8824: 502 Unimplemented command.
                   8825: 227 Entering Passive Mode (195,40,6,41,246,104)
                   8826: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   8827: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   8828: 226 Transfer completed.
                   8829: 172219 bytes received in 00:02 (75.99 KB/s)
                   8830: 221 Goodbye.
                   8831: => Checksum OK for figlet221.tar.gz.
                   8832: ===> Extracting for figlet-2.2.1nb2
                   8833: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   8834: ===> Patching for figlet-2.2.1nb2
                   8835: ===> Applying pkgsrc patches for figlet-2.2.1nb2
                   8836: ===> Overriding tools for figlet-2.2.1nb2
                   8837: ===> Creating toolchain wrappers for figlet-2.2.1nb2
                   8838: ===> Configuring for figlet-2.2.1nb2
                   8839: ===> Building for figlet-2.2.1nb2
                   8840: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   8841: chmod a+x figlet
                   8842: gcc -O2 -o chkfont chkfont.c
                   8843: => Unwrapping files-to-be-installed.
                   8844: #
                   8845: # make install
                   8846: ===> Checking for vulnerabilities in figlet-2.2.1nb2
                   8847: ===> Installing for figlet-2.2.1nb2
                   8848: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   8849: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   8850: mkdir -p /usr/pkg/share/figlet
                   8851: cp figlet /usr/pkg/bin
                   8852: cp chkfont /usr/pkg/bin
                   8853: chmod 555 figlist showfigfonts
                   8854: cp figlist /usr/pkg/bin
                   8855: cp showfigfonts /usr/pkg/bin
                   8856: cp fonts/*.flf /usr/pkg/share/figlet
                   8857: cp fonts/*.flc /usr/pkg/share/figlet
                   8858: cp figlet.6 /usr/pkg/man/man6
                   8859: ===> Registering installation for figlet-2.2.1nb2
                   8860: #
                   8861: 
                   8862: B.2. Packaging figlet
                   8863: 
                   8864: # make package
                   8865: ===> Checking for vulnerabilities in figlet-2.2.1nb2
                   8866: ===> Packaging figlet-2.2.1nb2
                   8867: ===> Building binary package for figlet-2.2.1nb2
                   8868: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   8869: Using SrcDir value of /usr/pkg
                   8870: Registering depends:.
                   8871: #
                   8872: 
                   8873: Appendix C. Directory layout of the pkgsrc FTP server
                   8874: 
                   8875: Table of Contents
                   8876: 
                   8877: C.1. bootstrap-pkgsrc: Bootstrap kits
                   8878: C.2. distfiles: The distributed source files
                   8879: C.3. iso: Currently empty
                   8880: C.4. misc: Miscellaneous things
                   8881: C.5. packages*: Binary packages
                   8882: C.6. current, pkgsrc-200xQy: source packages
                   8883: 
                   8884: As in other big projects, the directory layout of pkgsrc is quite complex for
                   8885: newbies. This chapter explains where you find things on the FTP server. The
                   8886: base directory on ftp.NetBSD.org is /pub/pkgsrc/. On other servers it may be
                   8887: different, but inside this directory, everything should look the same, no
                   8888: matter on which server you are. This directory contains some subdirectories,
                   8889: which are explained below.
                   8890: 
                   8891: C.1. bootstrap-pkgsrc: Bootstrap kits
                   8892: 
                   8893: For those who only want to manage binary packages on systems other than NetBSD,
                   8894: we provide the package management tools in a separate, small tar file.
                   8895: 
                   8896: C.2. distfiles: The distributed source files
                   8897: 
                   8898: The directory distfiles contains lots of archive files from all pkgsrc
                   8899: packages, which are mirrored here. The subdirectories are called after their
                   8900: package names and are used when the distributed files have names that don't
                   8901: explicitly contain a version number or are otherwise too generic (for example
                   8902: release.tar.gz).
                   8903: 
                   8904: C.3. iso: Currently empty
                   8905: 
                   8906: This directory is currently not in use.
                   8907: 
                   8908: C.4. misc: Miscellaneous things
                   8909: 
                   8910: This directory contains things that individual pkgsrc developers find worth
                   8911: publishing.
                   8912: 
                   8913: C.5. packages*: Binary packages
                   8914: 
                   8915: These directories contain binary packages. Those directories that have a branch
                   8916: name (200xQy) contain packages from that particular branch. The directory
                   8917: packages contains binary packages from pkgsrc-current. (However, this does not
                   8918: necessarily mean that the packages are still current anymore.)
                   8919: 
                   8920: Below the packages* directories are directories that distinguish the packages
                   8921: by operating system and version, the next directory level specifies the
                   8922: hardware architecture.
                   8923: 
                   8924: In each of the platform-specific directories, there is a whole binary packages
                   8925: collection. It has a directory called All which contains all binary packages.
                   8926: Besides that, there are various category directories that contain symbolic
                   8927: links to the real binary packages.
                   8928: 
                   8929: C.6. current, pkgsrc-200xQy: source packages
                   8930: 
                   8931: These directories contain the "real" pkgsrc, that is the files that define how
                   8932: to create binary packages from source archives.
                   8933: 
                   8934: The directory pkgsrc contains a snapshot of the CVS repository, which is
                   8935: updated regularly. The file pkgsrc.tar.gz contains the same as the directory,
                   8936: ready to be downloaded as a whole.
                   8937: 
                   8938: In the directories for the quarterly branches, there is an additional file
                   8939: called pkgsrc-200xQy.tar.gz, which contains the state of pkgsrc when it was
                   8940: branched.
                   8941: 
                   8942: Appendix D. Editing guidelines for the pkgsrc guide
                   8943: 
                   8944: Table of Contents
                   8945: 
                   8946: D.1. Make targets
                   8947: D.2. Procedure
                   8948: 
                   8949: This section contains information on editing the pkgsrc guide itself.
                   8950: 
                   8951: D.1. Make targets
                   8952: 
                   8953: The pkgsrc guide's source code is stored in pkgsrc/doc/guide/files, and several
                   8954: files are created from it:
                   8955: 
                   8956:   * pkgsrc/doc/pkgsrc.txt
                   8957: 
                   8958:   * pkgsrc/doc/pkgsrc.html
                   8959: 
1.2     ! rillig   8960:   * http://www.NetBSD.org/docs/pkgsrc/
1.1       dsieger  8961: 
1.2     ! rillig   8962:   * http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf: The PDF version of the pkgsrc
        !          8963:     guide.
1.1       dsieger  8964: 
1.2     ! rillig   8965:   * http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps: PostScript version of the
        !          8966:     pkgsrc guide.
1.1       dsieger  8967: 
                   8968: D.2. Procedure
                   8969: 
                   8970: The procedure to edit the pkgsrc guide is:
                   8971: 
                   8972:  1. Make sure you have the packages needed to regenerate the pkgsrc guide (and
                   8973:     other XML-based NetBSD documentation) installed. These are meta-pkgs/
                   8974:     netbsd-doc for creating the ASCII and HTML versions, and meta-pkgs/
                   8975:     netbsd-doc-print for the PostScript and PDF versions. You will need both
                   8976:     packages installed, to make sure documentation is consistent across all
                   8977:     formats.
                   8978: 
                   8979:  2. Run cd doc/guide to get to the right directory. All further steps will take
                   8980:     place here.
                   8981: 
                   8982:  3. Edit the XML file(s) in files/.
                   8983: 
                   8984:  4. Run bmake to check the pkgsrc guide for valid XML and to build the final
                   8985:     output files. If you get any errors at this stage, you can just edit the
                   8986:     files, as there are only symbolic links in the working directory, pointing
                   8987:     to the files in files/.
                   8988: 
                   8989:  5. (cd files && cvs commit)
                   8990: 
                   8991:  6. Run bmake clean && bmake to regenerate the output files with the proper RCS
                   8992:     Ids.
                   8993: 
                   8994:  7. Run bmake regen to install and commit the files in both pkgsrc/doc and
                   8995:     htdocs.
                   8996: 
                   8997:     Note
                   8998: 
                   8999:     If you have added, removed or renamed some chapters, you need to
                   9000:     synchronize them using cvs add or cvs delete in the htdocs directory.
                   9001: 

CVSweb <webmaster@jp.NetBSD.org>