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

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

CVSweb <webmaster@jp.NetBSD.org>