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

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: 
1.196     jnemeth    15: Copyright   1994-2021 The NetBSD Foundation, Inc
1.1       dsieger    16: 
1.196     jnemeth    17: $NetBSD: pkgsrc.xml,v 1.39 2021/01/02 08:32:15 jnemeth Exp $
1.1       dsieger    18: 
                     19: Abstract
                     20: 
                     21: pkgsrc is a centralized package management system for Unix-like operating
                     22: systems. This guide provides information for users and developers of pkgsrc. It
                     23: covers installation of binary and source packages, creation of binary and
                     24: source packages and a high-level overview about the infrastructure.
                     25: 
                     26: -------------------------------------------------------------------------------
                     27: 
                     28: Table of Contents
                     29: 
                     30: 1. What is pkgsrc?
                     31: 
                     32:     1.1. Introduction
                     33: 
                     34:         1.1.1. Why pkgsrc?
                     35:         1.1.2. Supported platforms
                     36: 
                     37:     1.2. Overview
                     38:     1.3. Terminology
                     39: 
                     40:         1.3.1. Roles involved in pkgsrc
                     41: 
                     42:     1.4. Typography
                     43: 
                     44: I. The pkgsrc user's guide
                     45: 
1.154     rillig     46:     2. Getting help
                     47:     3. Where to get pkgsrc and how to keep it up-to-date
1.1       dsieger    48: 
1.154     rillig     49:         3.1. Getting pkgsrc for the first time
1.1       dsieger    50: 
1.154     rillig     51:             3.1.1. As tar archive
                     52:             3.1.2. Via anonymous CVS
1.1       dsieger    53: 
1.154     rillig     54:         3.2. Keeping pkgsrc up-to-date
1.1       dsieger    55: 
1.154     rillig     56:             3.2.1. Via tar files
                     57:             3.2.2. Via CVS
1.1       dsieger    58: 
1.154     rillig     59:     4. Using pkgsrc on systems other than NetBSD
1.1       dsieger    60: 
1.154     rillig     61:         4.1. Binary distribution
                     62:         4.2. Bootstrapping pkgsrc
1.1       dsieger    63: 
1.154     rillig     64:     5. Using pkgsrc
1.1       dsieger    65: 
1.154     rillig     66:         5.1. Using binary packages
1.1       dsieger    67: 
1.154     rillig     68:             5.1.1. Finding binary packages
                     69:             5.1.2. Installing binary packages
                     70:             5.1.3. Deinstalling packages
                     71:             5.1.4. Getting information about installed packages
                     72:             5.1.5. Checking for security vulnerabilities in installed packages
                     73:             5.1.6. Finding if newer versions of your installed packages are in
1.1       dsieger    74:                 pkgsrc
1.154     rillig     75:             5.1.7. Other administrative functions
1.1       dsieger    76: 
1.154     rillig     77:         5.2. Building packages from source
1.1       dsieger    78: 
1.154     rillig     79:             5.2.1. Requirements
                     80:             5.2.2. Fetching distfiles
                     81:             5.2.3. How to build and install
1.1       dsieger    82: 
1.154     rillig     83:     6. Configuring pkgsrc
1.1       dsieger    84: 
1.154     rillig     85:         6.1. General configuration
                     86:         6.2. Variables affecting the build process
                     87:         6.3. Variables affecting the installation process
                     88:         6.4. Selecting and configuring the compiler
1.1       dsieger    89: 
1.154     rillig     90:             6.4.1. Selecting the compiler
                     91:             6.4.2. Additional flags to the compiler (CFLAGS)
                     92:             6.4.3. Additional flags to the linker (LDFLAGS)
1.1       dsieger    93: 
1.154     rillig     94:         6.5. Developer/advanced settings
                     95:         6.6. Selecting Build Options
1.1       dsieger    96: 
1.154     rillig     97:     7. Creating binary packages
1.1       dsieger    98: 
1.154     rillig     99:         7.1. Building a single binary package
                    100:         7.2. Settings for creation of binary packages
1.1       dsieger   101: 
1.154     rillig    102:     8. Creating binary packages for everything in pkgsrc (bulk builds)
1.6       rillig    103: 
1.154     rillig    104:         8.1. Preparations
1.180     rillig    105:         8.2. Running a bulk build
1.6       rillig    106: 
1.154     rillig    107:             8.2.1. Configuration
1.6       rillig    108: 
1.154     rillig    109:         8.3. Requirements of a full bulk build
1.178     rillig    110:         8.4. Bulk build variants
1.6       rillig    111: 
1.179     rillig    112:             8.4.1. Detect unknown configure options
                    113:             8.4.2. Detect classes of bugs by forcing compiler warnings
1.181     rillig    114:             8.4.3. Force compiler options only in the build phase
                    115:             8.4.4. Use custom directories
                    116:             8.4.5. Turn warnings into errors
                    117:             8.4.6. Reject packages for which pkglint reports errors
                    118:             8.4.7. Reject packages that contain forbidden strings
                    119:             8.4.8. Reject packages whose self-test fails
                    120:             8.4.9. Reject packages that use undefined shell variables
                    121:             8.4.10. Turn off verbose logging
1.178     rillig    122: 
                    123:         8.5. Creating a multiple CD-ROM packages collection
                    124: 
                    125:             8.5.1. Example of cdpack
1.6       rillig    126: 
1.154     rillig    127:     9. Directory layout of the installed files
1.6       rillig    128: 
1.154     rillig    129:         9.1. File system layout in ${LOCALBASE}
                    130:         9.2. File system layout in ${VARBASE}
1.6       rillig    131: 
1.154     rillig    132:     10. Frequently Asked Questions
1.6       rillig    133: 
1.154     rillig    134:         10.1. Are there any mailing lists for pkg-related discussion?
                    135:         10.2. Utilities for package management (pkgtools)
                    136:         10.3. How to use pkgsrc as non-root
                    137:         10.4. How to resume transfers when fetching distfiles?
                    138:         10.5. How can I install/use modular X.org from pkgsrc?
                    139:         10.6. How to fetch files from behind a firewall
                    140:         10.7. How to fetch files from HTTPS sites
                    141:         10.8. How do I tell make fetch to do passive FTP?
                    142:         10.9. How to fetch all distfiles at once
                    143:         10.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc"
1.24      wiz       144:             mean?
1.154     rillig    145:         10.11. What does "Could not find bsd.own.mk" mean?
                    146:         10.12. Using 'sudo' with pkgsrc
                    147:         10.13. How do I change the location of configuration files?
                    148:         10.14. Automated security checks
                    149:         10.15. Why do some packages ignore my CFLAGS?
                    150:         10.16. A package does not build. What shall I do?
                    151:         10.17. What does "Makefile appears to contain unresolved cvs/rcs/???
1.24      wiz       152:             merge conflicts" mean?
1.1       dsieger   153: 
                    154: II. The pkgsrc developer's guide
                    155: 
1.154     rillig    156:     11. Getting help
1.184     rillig    157:     12. Package components - files, directories and contents
1.1       dsieger   158: 
1.184     rillig    159:         12.1. Makefile
                    160:         12.2. distinfo
                    161:         12.3. patches/*
1.1       dsieger   162: 
1.184     rillig    163:             12.3.1. Structure of a single patch file
                    164:             12.3.2. Creating patch files
                    165:             12.3.3. Sources where the patch files come from
                    166:             12.3.4. Patching guidelines
                    167:             12.3.5. Feedback to the author
1.1       dsieger   168: 
1.184     rillig    169:         12.4. Other mandatory files
                    170:         12.5. Optional files
1.1       dsieger   171: 
1.184     rillig    172:             12.5.1. Files affecting the binary package
                    173:             12.5.2. Files affecting the build process
                    174:             12.5.3. Files affecting nothing at all
1.1       dsieger   175: 
1.184     rillig    176:         12.6. work*
                    177:         12.7. files/*
1.1       dsieger   178: 
1.184     rillig    179:     13. The build process
1.1       dsieger   180: 
1.184     rillig    181:         13.1. Introduction
                    182:         13.2. Program location
                    183:         13.3. Directories used during the build process
                    184:         13.4. Running a phase
                    185:         13.5. The fetch phase
1.1       dsieger   186: 
1.184     rillig    187:             13.5.1. What to fetch and where to get it from
                    188:             13.5.2. How are the files fetched?
1.1       dsieger   189: 
1.184     rillig    190:         13.6. The checksum phase
                    191:         13.7. The extract phase
                    192:         13.8. The patch phase
                    193:         13.9. The tools phase
                    194:         13.10. The wrapper phase
                    195:         13.11. The configure phase
                    196:         13.12. The build phase
                    197:         13.13. The test phase
                    198:         13.14. The install phase
                    199:         13.15. The package phase
                    200:         13.16. Cleaning up
                    201:         13.17. Other helpful targets
1.1       dsieger   202: 
1.184     rillig    203:     14. Creating a new pkgsrc package from scratch
1.1       dsieger   204: 
1.184     rillig    205:         14.1. Common types of packages
1.1       dsieger   206: 
1.184     rillig    207:             14.1.1. Perl modules
                    208:             14.1.2. Python modules and programs
                    209:             14.1.3. R packages
                    210:             14.1.4. TeXlive packages
1.1       dsieger   211: 
1.184     rillig    212:         14.2. Examples
1.1       dsieger   213: 
1.184     rillig    214:             14.2.1. How the www/nvu package came into pkgsrc
1.1       dsieger   215: 
1.184     rillig    216:     15. Programming in Makefiles
1.1       dsieger   217: 
1.184     rillig    218:         15.1. Caveats
                    219:         15.2. Makefile variables
1.1       dsieger   220: 
1.184     rillig    221:             15.2.1. Naming conventions
1.1       dsieger   222: 
1.184     rillig    223:         15.3. Code snippets
1.1       dsieger   224: 
1.184     rillig    225:             15.3.1. Adding things to a list
                    226:             15.3.2. Echoing a string exactly as-is
                    227:             15.3.3. Passing CFLAGS to GNU configure scripts
                    228:             15.3.4. Handling possibly empty variables
1.1       dsieger   229: 
1.184     rillig    230:     16. Options handling
1.1       dsieger   231: 
1.184     rillig    232:         16.1. Global default options
                    233:         16.2. Converting packages to use bsd.options.mk
                    234:         16.3. Option Names
                    235:         16.4. Determining the options of dependencies
1.1       dsieger   236: 
1.184     rillig    237:     17. Tools needed for building or running
1.1       dsieger   238: 
1.184     rillig    239:         17.1. Tools for pkgsrc builds
                    240:         17.2. Tools needed by packages
                    241:         17.3. Tools provided by platforms
1.1       dsieger   242: 
1.184     rillig    243:     18. Buildlink methodology
1.1       dsieger   244: 
1.184     rillig    245:         18.1. Converting packages to use buildlink3
                    246:         18.2. Writing buildlink3.mk files
1.1       dsieger   247: 
1.184     rillig    248:             18.2.1. Anatomy of a buildlink3.mk file
                    249:             18.2.2. Updating BUILDLINK_API_DEPENDS.pkg and
                    250:                 BUILDLINK_ABI_DEPENDS.pkg in buildlink3.mk files
1.1       dsieger   251: 
1.184     rillig    252:         18.3. Writing builtin.mk files
1.1       dsieger   253: 
1.184     rillig    254:             18.3.1. Anatomy of a builtin.mk file
                    255:             18.3.2. Global preferences for native or pkgsrc software
1.1       dsieger   256: 
1.184     rillig    257:     19. PLIST issues
1.1       dsieger   258: 
1.184     rillig    259:         19.1. RCS ID
                    260:         19.2. Semi-automatic PLIST generation
                    261:         19.3. Tweaking output of make print-PLIST
                    262:         19.4. Variable substitution in PLIST
                    263:         19.5. Man page compression
                    264:         19.6. Changing PLIST source with PLIST_SRC
                    265:         19.7. Platform-specific and differing PLISTs
                    266:         19.8. Build-specific PLISTs
                    267:         19.9. Sharing directories between packages
1.1       dsieger   268: 
1.184     rillig    269:     20. The pkginstall framework
1.1       dsieger   270: 
1.184     rillig    271:         20.1. Files and directories outside the installation prefix
1.1       dsieger   272: 
1.184     rillig    273:             20.1.1. Directory manipulation
                    274:             20.1.2. File manipulation
1.1       dsieger   275: 
1.184     rillig    276:         20.2. Configuration files
1.1       dsieger   277: 
1.184     rillig    278:             20.2.1. How PKG_SYSCONFDIR is set
                    279:             20.2.2. Telling the software where configuration files are
                    280:             20.2.3. Patching installations
                    281:             20.2.4. Disabling handling of configuration files
1.1       dsieger   282: 
1.184     rillig    283:         20.3. System startup scripts
1.1       dsieger   284: 
1.184     rillig    285:             20.3.1. Disabling handling of system startup scripts
1.1       dsieger   286: 
1.184     rillig    287:         20.4. System users and groups
                    288:         20.5. System shells
1.1       dsieger   289: 
1.184     rillig    290:             20.5.1. Disabling shell registration
1.1       dsieger   291: 
1.184     rillig    292:         20.6. Fonts
1.1       dsieger   293: 
1.184     rillig    294:             20.6.1. Disabling automatic update of the fonts databases
1.1       dsieger   295: 
1.154     rillig    296:     21. Making your package work
1.1       dsieger   297: 
1.154     rillig    298:         21.1. General operation
1.1       dsieger   299: 
1.154     rillig    300:             21.1.1. How to pull in user-settable variables from mk.conf
                    301:             21.1.2. User interaction
                    302:             21.1.3. Handling licenses
                    303:             21.1.4. Restricted packages
                    304:             21.1.5. Handling dependencies
                    305:             21.1.6. Handling conflicts with other packages
                    306:             21.1.7. Packages that cannot or should not be built
                    307:             21.1.8. Packages which should not be deleted, once installed
                    308:             21.1.9. Handling packages with security problems
                    309:             21.1.10. How to handle incrementing versions when fixing an
1.1       dsieger   310:                 existing package
1.154     rillig    311:             21.1.11. Substituting variable text in the package files (the SUBST
1.1       dsieger   312:                 framework)
                    313: 
1.154     rillig    314:         21.2. The fetch phase
1.1       dsieger   315: 
1.154     rillig    316:             21.2.1. Packages whose distfiles aren't available for plain
1.1       dsieger   317:                 downloading
1.154     rillig    318:             21.2.2. How to handle modified distfiles with the 'old' name
                    319:             21.2.3. Packages hosted on github.com
1.1       dsieger   320: 
1.154     rillig    321:         21.3. The configure phase
1.1       dsieger   322: 
1.154     rillig    323:             21.3.1. Shared libraries - libtool
                    324:             21.3.2. Using libtool on GNU packages that already support libtool
                    325:             21.3.3. GNU Autoconf/Automake
                    326: 
                    327:         21.4. Programming languages
                    328: 
                    329:             21.4.1. C, C++, and Fortran
                    330:             21.4.2. Java
                    331:             21.4.3. Packages containing perl scripts
                    332:             21.4.4. Packages containing shell scripts
                    333:             21.4.5. Other programming languages
                    334: 
                    335:         21.5. The build phase
                    336: 
                    337:             21.5.1. Compiling C and C++ code conditionally
                    338:             21.5.2. How to handle compiler bugs
1.172     rillig    339:             21.5.3. No such file or directory
                    340:             21.5.4. Undefined reference to "..."
                    341:             21.5.5. Running out of memory
1.154     rillig    342: 
                    343:         21.6. The install phase
                    344: 
                    345:             21.6.1. Creating needed directories
                    346:             21.6.2. Where to install documentation
                    347:             21.6.3. Installing highscore files
                    348:             21.6.4. Adding DESTDIR support to packages
                    349:             21.6.5. Packages with hardcoded paths to other interpreters
                    350:             21.6.6. Packages installing perl modules
                    351:             21.6.7. Packages installing info files
                    352:             21.6.8. Packages installing man pages
                    353:             21.6.9. Packages installing GConf data files
                    354:             21.6.10. Packages installing scrollkeeper/rarian data files
                    355:             21.6.11. Packages installing X11 fonts
                    356:             21.6.12. Packages installing GTK2 modules
                    357:             21.6.13. Packages installing SGML or XML data
                    358:             21.6.14. Packages installing extensions to the MIME database
                    359:             21.6.15. Packages using intltool
                    360:             21.6.16. Packages installing startup scripts
                    361:             21.6.17. Packages installing TeX modules
                    362:             21.6.18. Packages supporting running binaries in emulation
                    363:             21.6.19. Packages installing hicolor theme icons
                    364:             21.6.20. Packages installing desktop files
                    365: 
                    366:         21.7. Marking packages as having problems
                    367: 
1.184     rillig    368:     22. GNOME packaging and porting
                    369: 
                    370:         22.1. Meta packages
                    371:         22.2. Packaging a GNOME application
                    372:         22.3. Updating GNOME to a newer version
                    373:         22.4. Patching guidelines
                    374: 
1.154     rillig    375:     23. Submitting and Committing
                    376: 
                    377:         23.1. Submitting binary packages
                    378:         23.2. Submitting source packages (for non-NetBSD-developers)
                    379:         23.3. General notes when adding, updating, or removing packages
                    380:         23.4. Commit Messages
                    381:         23.5. Committing: Adding a package to CVS
                    382:         23.6. Updating a package to a newer version
                    383:         23.7. Renaming a package in pkgsrc
                    384:         23.8. Moving a package in pkgsrc
                    385: 
                    386:     24. Frequently Asked Questions
1.1       dsieger   387: 
                    388: III. The pkgsrc infrastructure internals
                    389: 
1.184     rillig    390:     25. Design of the pkgsrc infrastructure
1.1       dsieger   391: 
1.184     rillig    392:         25.1. The meaning of variable definitions
                    393:         25.2. Avoiding problems before they arise
                    394:         25.3. Variable evaluation
1.1       dsieger   395: 
1.184     rillig    396:             25.3.1. At load time
                    397:             25.3.2. At runtime
1.1       dsieger   398: 
1.184     rillig    399:         25.4. How can variables be specified?
                    400:         25.5. Designing interfaces for Makefile fragments
1.1       dsieger   401: 
1.184     rillig    402:             25.5.1. Procedures with parameters
                    403:             25.5.2. Actions taken on behalf of parameters
1.1       dsieger   404: 
1.184     rillig    405:         25.6. The order in which files are loaded
1.1       dsieger   406: 
1.184     rillig    407:             25.6.1. The order in bsd.prefs.mk
                    408:             25.6.2. The order in bsd.pkg.mk
1.1       dsieger   409: 
1.184     rillig    410:     26. Regression tests
1.1       dsieger   411: 
1.184     rillig    412:         26.1. Running the regression tests
                    413:         26.2. Adding a new regression test
1.1       dsieger   414: 
1.184     rillig    415:             26.2.1. Overridable functions
                    416:             26.2.2. Helper functions
1.1       dsieger   417: 
1.184     rillig    418:     27. Porting pkgsrc
1.1       dsieger   419: 
1.184     rillig    420:         27.1. Porting pkgsrc to a new operating system
1.1       dsieger   421: 
                    422: A. A simple example package: bison
                    423: 
                    424:     A.1. files
                    425: 
                    426:         A.1.1. Makefile
                    427:         A.1.2. DESCR
                    428:         A.1.3. PLIST
                    429:         A.1.4. Checking a package with pkglint
                    430: 
                    431:     A.2. Steps for building, installing, packaging
                    432: 
                    433: B. Build logs
                    434: 
                    435:     B.1. Building figlet
                    436:     B.2. Packaging figlet
                    437: 
                    438: C. Directory layout of the pkgsrc FTP server
                    439: 
1.23      jakllsch  440:     C.1. distfiles: The distributed source files
                    441:     C.2. misc: Miscellaneous things
                    442:     C.3. packages: Binary packages
                    443:     C.4. reports: Bulk build reports
1.148     leot      444:     C.5. current, stable, pkgsrc-20xxQy: source packages
1.1       dsieger   445: 
1.154     rillig    446: D. Help topics
                    447: E. Editing guidelines for the pkgsrc guide
1.1       dsieger   448: 
1.154     rillig    449:     E.1. Make targets
                    450:     E.2. Procedure
1.1       dsieger   451: 
                    452: List of Tables
                    453: 
                    454: 1.1. Platforms supported by pkgsrc
1.184     rillig    455: 12.1. Patching examples
                    456: 22.1. PLIST handling for GNOME packages
1.1       dsieger   457: 
                    458: Chapter 1. What is pkgsrc?
                    459: 
                    460: Table of Contents
                    461: 
                    462: 1.1. Introduction
                    463: 
                    464:     1.1.1. Why pkgsrc?
                    465:     1.1.2. Supported platforms
                    466: 
                    467: 1.2. Overview
                    468: 1.3. Terminology
                    469: 
                    470:     1.3.1. Roles involved in pkgsrc
                    471: 
                    472: 1.4. Typography
                    473: 
                    474: 1.1. Introduction
                    475: 
                    476: There is a lot of software freely available for Unix-based systems, which is
                    477: usually available in form of the source code. Before such software can be used,
                    478: it needs to be configured to the local system, compiled and installed, and this
                    479: is exactly what The NetBSD Packages Collection (pkgsrc) does. pkgsrc also has
                    480: some basic commands to handle binary packages, so that not every user has to
                    481: build the packages for himself, which is a time-costly task.
                    482: 
                    483: pkgsrc currently contains several thousand packages, including:
                    484: 
1.104     sevan     485:   * www/apache24 - The Apache web server
1.1       dsieger   486: 
                    487:   * www/firefox - The Firefox web browser
                    488: 
                    489:   * meta-pkgs/gnome - The GNOME Desktop Environment
                    490: 
1.102     ryoon     491:   * meta-pkgs/kde4 - The K Desktop Environment
1.1       dsieger   492: 
1.108     rillig    493: ? just to name a few.
1.1       dsieger   494: 
                    495: pkgsrc has built-in support for handling varying dependencies, such as pthreads
                    496: and X11, and extended features such as IPv6 support on a range of platforms.
                    497: 
                    498: 1.1.1. Why pkgsrc?
                    499: 
                    500: pkgsrc provides the following key features:
                    501: 
                    502:   * Easy building of software from source as well as the creation and
                    503:     installation of binary packages. The source and latest patches are
                    504:     retrieved from a master or mirror download site, checksum verified, then
                    505:     built on your system. Support for binary-only distributions is available
                    506:     for both native platforms and NetBSD emulated platforms.
                    507: 
                    508:   * All packages are installed in a consistent directory tree, including
                    509:     binaries, libraries, man pages and other documentation.
                    510: 
1.104     sevan     511:   * Tracking of package dependencies automatically, including when performing
                    512:     updates, to ensure required packages are installed. The configuration files
                    513:     of various packages are handled automatically during updates, so local
                    514:     changes are preserved.
1.1       dsieger   515: 
                    516:   * Like NetBSD, pkgsrc is designed with portability in mind and consists of
                    517:     highly portable code. This allows the greatest speed of development when
1.26      spz       518:     porting to a new platform. This portability also ensures that pkgsrc is 
1.1       dsieger   519:     consistent across all platforms.
                    520: 
                    521:   * The installation prefix, acceptable software licenses, international
                    522:     encryption requirements and build-time options for a large number of
                    523:     packages are all set in a simple, central configuration file.
                    524: 
                    525:   * The entire source (not including the distribution files) is freely
                    526:     available under a BSD license, so you may extend and adapt pkgsrc to your
                    527:     needs. Support for local packages and patches is available right out of the
                    528:     box, so you can configure it specifically for your environment.
                    529: 
                    530: The following principles are basic to pkgsrc:
                    531: 
1.198     leot      532:   * "It should only work if it's right." -- That means, if a package contains
1.1       dsieger   533:     bugs, it's better to find them and to complain about them rather than to
                    534:     just install the package and hope that it works. There are numerous checks
1.175     gutterid  535:     in pkgsrc that try to find such bugs: static analysis tools (pkgtools/
1.1       dsieger   536:     pkglint), build-time checks (portability of shell scripts), and
                    537:     post-installation checks (installed files, references to shared libraries,
                    538:     script interpreters).
                    539: 
1.198     leot      540:   * "If it works, it should work everywhere" -- Like NetBSD has been ported to
1.1       dsieger   541:     many hardware architectures, pkgsrc has been ported to many operating
                    542:     systems. Care is taken that packages behave the same on all platforms.
                    543: 
                    544: 1.1.2. Supported platforms
                    545: 
                    546: pkgsrc consists of both a source distribution and a binary distribution for
                    547: these operating systems. After retrieving the required source or binaries, you
                    548: can be up and running with pkgsrc in just minutes!
                    549: 
                    550: pkgsrc was derived from FreeBSD's ports system, and initially developed for
                    551: NetBSD only. Since then, pkgsrc has grown a lot, and now supports the following
                    552: platforms:
                    553: 
                    554: Table 1.1. Platforms supported by pkgsrc
                    555: 
1.92      sevan     556: +-----------------------------------------------------------------------------+
                    557: |               Platform               | Date Support  |        Notes         |
                    558: |                                      |     Added     |                      |
                    559: |--------------------------------------+---------------+----------------------|
                    560: |NetBSD                                |   Aug 1997    |                      |
                    561: |--------------------------------------+---------------+----------------------|
                    562: |Solaris                               |   Mar 1999    |README.Solaris        |
                    563: |--------------------------------------+---------------+----------------------|
                    564: |Linux                                 |   Jun 1999    |README.Linux          |
                    565: |--------------------------------------+---------------+----------------------|
1.191     bacon     566: |Darwin / Mac OS X / OS X / macOS      |   Oct 2001    |README.macOS          |
1.92      sevan     567: |--------------------------------------+---------------+----------------------|
                    568: |FreeBSD                               |   Nov 2002    |README.FreeBSD        |
                    569: |--------------------------------------+---------------+----------------------|
                    570: |OpenBSD                               |   Nov 2002    |README.OpenBSD        |
                    571: |--------------------------------------+---------------+----------------------|
                    572: |IRIX                                  |   Dec 2002    |README.IRIX           |
                    573: |                                      |               |README.IRIX5.3        |
                    574: |--------------------------------------+---------------+----------------------|
                    575: |BSD/OS                                |   Dec 2003    |                      |
                    576: |--------------------------------------+---------------+----------------------|
                    577: |AIX                                   |   Dec 2003    |README.AIX            |
                    578: |--------------------------------------+---------------+----------------------|
                    579: |Interix (Microsoft Windows Services   |   Mar 2004    |README.Interix        |
                    580: |for Unix)                             |               |                      |
                    581: |--------------------------------------+---------------+----------------------|
                    582: |DragonFlyBSD                          |   Oct 2004    |                      |
                    583: |--------------------------------------+---------------+----------------------|
                    584: |OSF/1                                 |   Nov 2004    |README.OSF1           |
                    585: |--------------------------------------+---------------+----------------------|
                    586: |HP-UX                                 |   Apr 2007    |README.HPUX           |
                    587: |--------------------------------------+---------------+----------------------|
                    588: |Haiku                                 |   Sep 2010    |README.Haiku          |
                    589: |--------------------------------------+---------------+----------------------|
                    590: |MirBSD                                |   Jan 2011    |                      |
                    591: |--------------------------------------+---------------+----------------------|
                    592: |Minix3                                |   Nov 2011    |README.Minix3         |
                    593: |--------------------------------------+---------------+----------------------|
                    594: |Cygwin                                |   Mar 2013    |README.Cygwin         |
                    595: |--------------------------------------+---------------+----------------------|
                    596: |GNU/kFreeBSD                          |   Jul 2013    |README.GNUkFreeBSD    |
1.104     sevan     597: |--------------------------------------+---------------+----------------------|
                    598: |Bitrig                                |   Jun 2014    |README.Bitrig         |
1.92      sevan     599: +-----------------------------------------------------------------------------+
1.1       dsieger   600: 
                    601: 
                    602: 1.2. Overview
                    603: 
                    604: This document is divided into three parts. The first, The pkgsrc user's guide,
                    605: describes how one can use one of the packages in the Package Collection, either
                    606: by installing a precompiled binary package, or by building one's own copy using
                    607: the NetBSD package system. The second part, The pkgsrc developer's guide,
                    608: explains how to prepare a package so it can be easily built by other NetBSD
                    609: users without knowing about the package's building details. The third part, The
                    610: pkgsrc infrastructure internals is intended for those who want to understand
                    611: how pkgsrc is implemented.
                    612: 
                    613: This document is available in various formats: HTML, PDF, PS, TXT.
                    614: 
                    615: 1.3. Terminology
                    616: 
                    617: There has been a lot of talk about "ports", "packages", etc. so far. Here is a
                    618: description of all the terminology used within this document.
                    619: 
                    620: Package
                    621: 
                    622:     A set of files and building instructions that describe what's necessary to
                    623:     build a certain piece of software using pkgsrc. Packages are traditionally
1.123     wiz       624:     stored under /usr/pkgsrc, but may be stored in any location, referred to as
                    625:     PKGSRCDIR.
1.1       dsieger   626: 
                    627: The NetBSD package system
                    628: 
                    629:     This is the former name of "pkgsrc". It is part of the NetBSD operating
                    630:     system and can be bootstrapped to run on non-NetBSD operating systems as
                    631:     well. It handles building (compiling), installing, and removing of
                    632:     packages.
                    633: 
                    634: Distfile
                    635: 
                    636:     This term describes the file or files that are provided by the author of
                    637:     the piece of software to distribute his work. All the changes necessary to
                    638:     build on NetBSD are reflected in the corresponding package. Usually the
                    639:     distfile is in the form of a compressed tar-archive, but other types are
                    640:     possible, too. Distfiles are usually stored below /usr/pkgsrc/distfiles.
                    641: 
                    642: Port
                    643: 
                    644:     This is the term used by FreeBSD and OpenBSD people for what we call a
                    645:     package. In NetBSD terminology, "port" refers to a different architecture.
                    646: 
                    647: Precompiled/binary package
                    648: 
                    649:     A set of binaries built with pkgsrc from a distfile and stuffed together in
                    650:     a single .tgz file so it can be installed on machines of the same machine
                    651:     architecture without the need to recompile. Packages are usually generated
                    652:     in /usr/pkgsrc/packages; there is also an archive on ftp.NetBSD.org.
                    653: 
                    654:     Sometimes, this is referred to by the term "package" too, especially in the
                    655:     context of precompiled packages.
                    656: 
                    657: Program
                    658: 
                    659:     The piece of software to be installed which will be constructed from all
                    660:     the files in the distfile by the actions defined in the corresponding
                    661:     package.
                    662: 
                    663: 1.3.1. Roles involved in pkgsrc
                    664: 
                    665: pkgsrc users
                    666: 
                    667:     The pkgsrc users are people who use the packages provided by pkgsrc.
                    668:     Typically they are system administrators. The people using the software
                    669:     that is inside the packages (maybe called "end users") are not covered by
                    670:     the pkgsrc guide.
                    671: 
                    672:     There are two kinds of pkgsrc users: Some only want to install pre-built
                    673:     binary packages. Others build the pkgsrc packages from source, either for
                    674:     installing them directly or for building binary packages themselves. For
                    675:     pkgsrc users Part I, "The pkgsrc user's guide" should provide all necessary
                    676:     documentation.
                    677: 
                    678: package maintainers
                    679: 
                    680:     A package maintainer creates packages as described in Part II, "The pkgsrc
                    681:     developer's guide".
                    682: 
                    683: infrastructure developers
                    684: 
                    685:     These people are involved in all those files that live in the mk/ directory
                    686:     and below. Only these people should need to read through Part III, "The
                    687:     pkgsrc infrastructure internals", though others might be curious, too.
                    688: 
                    689: 1.4. Typography
                    690: 
                    691: When giving examples for commands, shell prompts are used to show if the
                    692: command should/can be issued as root, or if "normal" user privileges are
1.115     sevan     693: sufficient. We use a # for root's shell prompt, a % for users' shell prompt,
                    694: assuming they use the C-shell or tcsh and a $ for bourne shell and derivatives.
1.1       dsieger   695: 
                    696: Part I. The pkgsrc user's guide
                    697: 
                    698: Table of Contents
                    699: 
1.154     rillig    700: 2. Getting help
                    701: 3. Where to get pkgsrc and how to keep it up-to-date
1.1       dsieger   702: 
1.154     rillig    703:     3.1. Getting pkgsrc for the first time
1.1       dsieger   704: 
1.154     rillig    705:         3.1.1. As tar archive
                    706:         3.1.2. Via anonymous CVS
1.1       dsieger   707: 
1.154     rillig    708:     3.2. Keeping pkgsrc up-to-date
1.1       dsieger   709: 
1.154     rillig    710:         3.2.1. Via tar files
                    711:         3.2.2. Via CVS
1.1       dsieger   712: 
1.154     rillig    713: 4. Using pkgsrc on systems other than NetBSD
1.1       dsieger   714: 
1.154     rillig    715:     4.1. Binary distribution
                    716:     4.2. Bootstrapping pkgsrc
1.1       dsieger   717: 
1.154     rillig    718: 5. Using pkgsrc
1.1       dsieger   719: 
1.154     rillig    720:     5.1. Using binary packages
1.1       dsieger   721: 
1.154     rillig    722:         5.1.1. Finding binary packages
                    723:         5.1.2. Installing binary packages
                    724:         5.1.3. Deinstalling packages
                    725:         5.1.4. Getting information about installed packages
                    726:         5.1.5. Checking for security vulnerabilities in installed packages
                    727:         5.1.6. Finding if newer versions of your installed packages are in
1.1       dsieger   728:             pkgsrc
1.154     rillig    729:         5.1.7. Other administrative functions
1.1       dsieger   730: 
1.154     rillig    731:     5.2. Building packages from source
1.1       dsieger   732: 
1.154     rillig    733:         5.2.1. Requirements
                    734:         5.2.2. Fetching distfiles
                    735:         5.2.3. How to build and install
1.1       dsieger   736: 
1.154     rillig    737: 6. Configuring pkgsrc
1.1       dsieger   738: 
1.154     rillig    739:     6.1. General configuration
                    740:     6.2. Variables affecting the build process
                    741:     6.3. Variables affecting the installation process
                    742:     6.4. Selecting and configuring the compiler
1.1       dsieger   743: 
1.154     rillig    744:         6.4.1. Selecting the compiler
                    745:         6.4.2. Additional flags to the compiler (CFLAGS)
                    746:         6.4.3. Additional flags to the linker (LDFLAGS)
1.1       dsieger   747: 
1.154     rillig    748:     6.5. Developer/advanced settings
                    749:     6.6. Selecting Build Options
1.1       dsieger   750: 
1.154     rillig    751: 7. Creating binary packages
1.1       dsieger   752: 
1.154     rillig    753:     7.1. Building a single binary package
                    754:     7.2. Settings for creation of binary packages
1.1       dsieger   755: 
1.154     rillig    756: 8. Creating binary packages for everything in pkgsrc (bulk builds)
1.6       rillig    757: 
1.154     rillig    758:     8.1. Preparations
1.180     rillig    759:     8.2. Running a bulk build
1.6       rillig    760: 
1.154     rillig    761:         8.2.1. Configuration
1.6       rillig    762: 
1.154     rillig    763:     8.3. Requirements of a full bulk build
1.178     rillig    764:     8.4. Bulk build variants
                    765: 
1.179     rillig    766:         8.4.1. Detect unknown configure options
                    767:         8.4.2. Detect classes of bugs by forcing compiler warnings
1.181     rillig    768:         8.4.3. Force compiler options only in the build phase
                    769:         8.4.4. Use custom directories
                    770:         8.4.5. Turn warnings into errors
                    771:         8.4.6. Reject packages for which pkglint reports errors
                    772:         8.4.7. Reject packages that contain forbidden strings
                    773:         8.4.8. Reject packages whose self-test fails
                    774:         8.4.9. Reject packages that use undefined shell variables
                    775:         8.4.10. Turn off verbose logging
1.6       rillig    776: 
1.178     rillig    777:     8.5. Creating a multiple CD-ROM packages collection
                    778: 
                    779:         8.5.1. Example of cdpack
1.6       rillig    780: 
1.154     rillig    781: 9. Directory layout of the installed files
1.6       rillig    782: 
1.154     rillig    783:     9.1. File system layout in ${LOCALBASE}
                    784:     9.2. File system layout in ${VARBASE}
1.6       rillig    785: 
1.154     rillig    786: 10. Frequently Asked Questions
1.6       rillig    787: 
1.154     rillig    788:     10.1. Are there any mailing lists for pkg-related discussion?
                    789:     10.2. Utilities for package management (pkgtools)
                    790:     10.3. How to use pkgsrc as non-root
                    791:     10.4. How to resume transfers when fetching distfiles?
                    792:     10.5. How can I install/use modular X.org from pkgsrc?
                    793:     10.6. How to fetch files from behind a firewall
                    794:     10.7. How to fetch files from HTTPS sites
                    795:     10.8. How do I tell make fetch to do passive FTP?
                    796:     10.9. How to fetch all distfiles at once
                    797:     10.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean?
                    798:     10.11. What does "Could not find bsd.own.mk" mean?
                    799:     10.12. Using 'sudo' with pkgsrc
                    800:     10.13. How do I change the location of configuration files?
                    801:     10.14. Automated security checks
                    802:     10.15. Why do some packages ignore my CFLAGS?
                    803:     10.16. A package does not build. What shall I do?
                    804:     10.17. What does "Makefile appears to contain unresolved cvs/rcs/??? merge
1.24      wiz       805:         conflicts" mean?
1.1       dsieger   806: 
1.154     rillig    807: Chapter 2. Getting help
                    808: 
                    809: To get help when using pkgsrc, the definitive source is this document, the
                    810: pkgsrc guide. If you don't find anything here, there are alternatives:
                    811: 
                    812:   * The built-in pkgsrc help, which is available after bootstrapping pkgsrc.
                    813:     Run bmake help topic=? to get help for any topic, such as a variable name
                    814:     like BUILD_DEFS, a make target like do-build, a missing C or C++ function
                    815:     like strcasecmp or any other topic.
                    816: 
                    817:     The available help topics are listed in Appendix D, Help topics.
                    818: 
1.163     rillig    819:   * To see the value of a single variable, run bmake show-var VARNAME=X.
                    820: 
                    821:   * To see the values of the most common variables, run bmake show-all. These
                    822:     variables are grouped by topic. To see the variables for a single topic,
                    823:     run bmake show-all-topic, for example bmake show-all-fetch.
                    824: 
1.154     rillig    825:   * The pkgsrc-users mailing list, to which you can subscribe and then ask your
                    826:     questions.
                    827: 
                    828:   * The #pkgsrc IRC channel, which is accessible via a web browser or by using
                    829:     a specialized chat program such as XChat. Pick any user name and join the
                    830:     channel #pkgsrc.
                    831: 
                    832: Chapter 3. Where to get pkgsrc and how to keep it up-to-date
1.1       dsieger   833: 
                    834: Table of Contents
                    835: 
1.154     rillig    836: 3.1. Getting pkgsrc for the first time
1.1       dsieger   837: 
1.154     rillig    838:     3.1.1. As tar archive
                    839:     3.1.2. Via anonymous CVS
1.1       dsieger   840: 
1.154     rillig    841: 3.2. Keeping pkgsrc up-to-date
1.1       dsieger   842: 
1.154     rillig    843:     3.2.1. Via tar files
                    844:     3.2.2. Via CVS
1.1       dsieger   845: 
                    846: Before you download and extract the files, you need to decide where you want to
                    847: extract them. When using pkgsrc as root user, pkgsrc is usually installed in /
                    848: usr/pkgsrc. You are though free to install the sources and binary packages
                    849: wherever you want in your filesystem, provided that the pathname does not
                    850: contain white-space or other characters that are interpreted specially by the
                    851: shell and some other programs. A safe bet is to use only letters, digits,
                    852: underscores and dashes.
                    853: 
1.154     rillig    854: 3.1. Getting pkgsrc for the first time
1.1       dsieger   855: 
1.25      wiz       856: Before you download any pkgsrc files, you should decide whether you want the 
1.1       dsieger   857: current branch or the stable branch. The latter is forked on a quarterly basis
                    858: from the current branch and only gets modified for security updates. The names
                    859: of the stable branches are built from the year and the quarter, for example
1.198     leot      860: 2021Q1.
1.1       dsieger   861: 
                    862: The second step is to decide how you want to download pkgsrc. You can get it as
1.24      wiz       863: a tar file or via CVS. Both ways are described here.
1.1       dsieger   864: 
1.52      asau      865: Note that tar archive contains CVS working copy. Thus you can switch to using
                    866: CVS at any later time.
1.1       dsieger   867: 
1.154     rillig    868: 3.1.1. As tar archive
1.52      asau      869: 
1.151     sevan     870: The primary download location for all pkgsrc files is https://cdn.NetBSD.org/
                    871: pub/pkgsrc/ or ftp://ftp.NetBSD.org/pub/pkgsrc/ (it points to the same
                    872: location). There are a number of subdirectories for different purposes, which
                    873: are described in detail in Appendix C, Directory layout of the pkgsrc FTP
                    874: server.
1.1       dsieger   875: 
1.52      asau      876: The tar archive for the current branch is in the directory current and is
1.118     sevan     877: called pkgsrc.tar.gz. It is autogenerated weekly.
1.52      asau      878: 
                    879: To save download time we provide bzip2- and xz-compressed archives which are
                    880: published at pkgsrc.tar.bz2 and pkgsrc.tar.xz respectively.
                    881: 
                    882: You can fetch the same files using FTP.
1.1       dsieger   883: 
1.198     leot      884: The tar file for the stable branch 2021Q1 is in the directory pkgsrc-2021Q1 and
1.59      jnemeth   885: is also called pkgsrc.tar.gz.
1.1       dsieger   886: 
1.136     leot      887: To download the latest pkgsrc stable tarball, run:
1.12      weinem    888: 
1.198     leot      889: $ ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2021Q1/pkgsrc.tar.gz
1.12      weinem    890: 
1.78      snj       891: If you prefer, you can also fetch it using "wget", "curl", or your web browser.
1.52      asau      892: 
1.12      weinem    893: Then, extract it with:
                    894: 
1.78      snj       895: $ tar -xzf pkgsrc.tar.gz -C /usr
1.12      weinem    896: 
                    897: This will create the directory pkgsrc/ in /usr/ and all the package source will
                    898: be stored under /usr/pkgsrc/.
                    899: 
                    900: To download pkgsrc-current, run:
                    901: 
                    902: $ ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz
1.1       dsieger   903: 
1.154     rillig    904: 3.1.2. Via anonymous CVS
1.1       dsieger   905: 
1.24      wiz       906: To fetch a specific pkgsrc stable branch, run:
1.1       dsieger   907: 
1.198     leot      908: $ cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r pkgsrc-2021Q1 -P pkgsrc
1.13      weinem    909: 
1.24      wiz       910: This will create the directory pkgsrc/ in your /usr/ directory and all the
                    911: package source will be stored under /usr/pkgsrc/.
                    912: 
                    913: To fetch the pkgsrc current branch, run:
1.1       dsieger   914: 
1.40      wiz       915: $ cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc
1.1       dsieger   916: 
1.30      dholland  917: Refer to the list of available mirrors to choose a faster CVS mirror, if
                    918: needed.
1.1       dsieger   919: 
1.24      wiz       920: If you get error messages from rsh, you need to set CVS_RSH variable. E.g.:
1.1       dsieger   921: 
1.40      wiz       922: $ cd /usr && env CVS_RSH=ssh cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc
1.1       dsieger   923: 
1.24      wiz       924: Refer to documentation on your command shell how to set CVS_RSH=ssh
                    925: permanently. For Bourne shells, you can set it in your .profile or better
                    926: globally in /etc/profile:
                    927: 
                    928: # set CVS remote shell command
                    929: CVS_RSH=ssh
                    930: export CVS_RSH
1.12      weinem    931: 
1.13      weinem    932: By default, CVS doesn't do things like most people would expect it to do. But
                    933: there is a way to convince CVS, by creating a file called .cvsrc in your home
1.12      weinem    934: directory and saving the following lines to it. This file will save you lots of
                    935: headache and some bug reports, so we strongly recommend it. You can find an
                    936: explanation of this file in the CVS documentation.
1.2       rillig    937: 
                    938: # recommended CVS configuration file from the pkgsrc guide
1.155     sevan     939: cvs -q
1.2       rillig    940: checkout -P
1.4       rillig    941: update -dP
                    942: diff -upN
1.2       rillig    943: rdiff -u
1.24      wiz       944: release -d
1.1       dsieger   945: 
1.154     rillig    946: 3.2. Keeping pkgsrc up-to-date
1.1       dsieger   947: 
                    948: The preferred way to keep pkgsrc up-to-date is via CVS (which also works if you
                    949: have first installed it via a tar file). It saves bandwidth and hard disk
                    950: activity, compared to downloading the tar file again.
                    951: 
1.154     rillig    952: 3.2.1. Via tar files
1.1       dsieger   953: 
                    954: Warning
                    955: 
                    956: When updating from a tar file, you first need to completely remove the old
                    957: pkgsrc directory. Otherwise those files that have been removed from pkgsrc in
                    958: the mean time will not be removed on your local disk, resulting in
                    959: inconsistencies. When removing the old files, any changes that you have done to
                    960: the pkgsrc files will be lost after updating. Therefore updating via CVS is
                    961: strongly recommended.
                    962: 
                    963: Note that by default the distfiles and the binary packages are saved in the
                    964: pkgsrc tree, so don't forget to rescue them before updating. You can also
1.78      snj       965: configure pkgsrc to store distfiles and packages in directories outside the
1.154     rillig    966: pkgsrc tree by setting the DISTDIR and PACKAGES variables. See Chapter 6, 
1.78      snj       967: Configuring pkgsrc for the details.
1.1       dsieger   968: 
                    969: To update pkgsrc from a tar file, download the tar file as explained above.
                    970: Then, make sure that you have not made any changes to the files in the pkgsrc
                    971: directory. Remove the pkgsrc directory and extract the new tar file. Done.
                    972: 
1.154     rillig    973: 3.2.2. Via CVS
1.1       dsieger   974: 
1.26      spz       975: To update pkgsrc via CVS, change to the pkgsrc directory and run cvs:
1.12      weinem    976: 
1.26      spz       977: $ cd /usr/pkgsrc && cvs update -dP
                    978: 
                    979: If you get error messages from rsh, you need to set CVS_RSH variable as
                    980: described above. E.g.:
                    981: 
                    982: $ cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP
1.1       dsieger   983: 
1.154     rillig    984: 3.2.2.1. Switching between different pkgsrc branches
1.1       dsieger   985: 
                    986: When updating pkgsrc, the CVS program keeps track of the branch you selected.
                    987: But if you, for whatever reason, want to switch from the stable branch to the
                    988: current one, you can do it by adding the option "-A" after the "update"
1.25      wiz       989: keyword. To switch from the current branch back to the stable branch, add the "
1.198     leot      990: -rpkgsrc-2021Q1" option.
1.1       dsieger   991: 
1.154     rillig    992: 3.2.2.2. What happens to my changes when updating?
1.1       dsieger   993: 
                    994: When you update pkgsrc, the CVS program will only touch those files that are
                    995: registered in the CVS repository. That means that any packages that you created
                    996: on your own will stay unmodified. If you change files that are managed by CVS,
                    997: later updates will try to merge your changes with those that have been done by
                    998: others. See the CVS manual, chapter "update" for details.
                    999: 
1.154     rillig   1000: Chapter 4. Using pkgsrc on systems other than NetBSD
1.1       dsieger  1001: 
                   1002: Table of Contents
                   1003: 
1.154     rillig   1004: 4.1. Binary distribution
                   1005: 4.2. Bootstrapping pkgsrc
1.1       dsieger  1006: 
1.154     rillig   1007: 4.1. Binary distribution
1.1       dsieger  1008: 
1.154     rillig   1009: See Section 5.1, "Using binary packages".
1.1       dsieger  1010: 
1.154     rillig   1011: 4.2. Bootstrapping pkgsrc
1.1       dsieger  1012: 
1.44      asau     1013: pkgsrc can be bootstrapped for use in two different modes: privileged and
                   1014: unprivileged one. In unprivileged mode in contrast to privileged one all
1.45      asau     1015: programs are installed under one particular user and cannot utilise privileged
1.44      asau     1016: operations (packages don't create special users and all special file
                   1017: permissions like setuid are ignored).
                   1018: 
1.1       dsieger  1019: Installing the bootstrap kit from source should be as simple as:
                   1020: 
1.60      asau     1021: # env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc
1.1       dsieger  1022: # cd pkgsrc/bootstrap
                   1023: # ./bootstrap
                   1024: 
                   1025: 
1.44      asau     1026: To bootstrap in unprivileged mode pass "--unprivileged" flag to bootstrap
                   1027: 
                   1028: By default, in privileged mode pkgsrc uses /usr/pkg for prefix where programs
1.118     sevan    1029: will be installed in, and /usr/pkg/pkgdb for the package database directory
                   1030: where pkgsrc will do its internal bookkeeping, /var is used as varbase, where
1.44      asau     1031: packages install their persistent data. In unprivileged mode pkgsrc uses ~/pkg
1.118     sevan    1032: for prefix, ~/pkg/pkgdb for the package database, and ~/pkg/var for varbase.
1.44      asau     1033: 
                   1034: You can change default layout using command-line arguments. Run "./bootstrap
                   1035: --help" to get details.
1.1       dsieger  1036: 
                   1037: Note
                   1038: 
                   1039: The bootstrap installs a bmake tool. Use this bmake when building via pkgsrc.
                   1040: For examples in this guide, use bmake instead of "make".
                   1041: 
1.44      asau     1042: Note
                   1043: 
                   1044: It is possible to bootstrap multiple instances of pkgsrc using non-intersecting
                   1045: directories. Use bmake corresponding to the installation you're working with to
                   1046: build and install packages.
                   1047: 
1.154     rillig   1048: Chapter 5. Using pkgsrc
1.1       dsieger  1049: 
                   1050: Table of Contents
                   1051: 
1.154     rillig   1052: 5.1. Using binary packages
1.1       dsieger  1053: 
1.154     rillig   1054:     5.1.1. Finding binary packages
                   1055:     5.1.2. Installing binary packages
                   1056:     5.1.3. Deinstalling packages
                   1057:     5.1.4. Getting information about installed packages
                   1058:     5.1.5. Checking for security vulnerabilities in installed packages
                   1059:     5.1.6. Finding if newer versions of your installed packages are in pkgsrc
                   1060:     5.1.7. Other administrative functions
                   1061: 
                   1062: 5.2. Building packages from source
                   1063: 
                   1064:     5.2.1. Requirements
                   1065:     5.2.2. Fetching distfiles
                   1066:     5.2.3. How to build and install
1.1       dsieger  1067: 
                   1068: Basically, there are two ways of using pkgsrc. The first is to only install the
                   1069: package tools and to use binary packages that someone else has prepared. This
                   1070: is the "pkg" in pkgsrc. The second way is to install the "src" of pkgsrc, too.
                   1071: Then you are able to build your own packages, and you can still use binary
                   1072: packages from someone else.
                   1073: 
1.154     rillig   1074: 5.1. Using binary packages
1.1       dsieger  1075: 
1.151     sevan    1076: On the cdn.NetBSD.org site and mirrors, there are collections of binary
1.9       rillig   1077: packages, ready to be installed. These binary packages have been built using
                   1078: the default settings for the directories, that is:
                   1079: 
                   1080:   * /usr/pkg for LOCALBASE, where most of the files are installed,
                   1081: 
                   1082:   * /usr/pkg/etc for configuration files,
                   1083: 
                   1084:   * /var for VARBASE, where those files are installed that may change after
                   1085:     installation.
                   1086: 
                   1087: If you cannot use these directories for whatever reasons (maybe because you're
                   1088: not root), you cannot use these binary packages, but have to build the packages
1.154     rillig   1089: yourself, which is explained in Section 4.2, "Bootstrapping pkgsrc".
1.1       dsieger  1090: 
1.154     rillig   1091: 5.1.1. Finding binary packages
1.1       dsieger  1092: 
1.5       weinem   1093: To install binary packages, you first need to know from where to get them. The
                   1094: first place where you should look is on the main pkgsrc FTP server in the
                   1095: directory /pub/pkgsrc/packages.
                   1096: 
                   1097: This directory contains binary packages for multiple platforms. First, select
                   1098: your operating system. (Ignore the directories with version numbers attached to
                   1099: it, they just exist for legacy reasons.) Then, select your hardware
                   1100: architecture, and in the third step, the OS version and the "version" of
1.9       rillig   1101: pkgsrc.
                   1102: 
                   1103: In this directory, you often find a file called bootstrap.tar.gz which contains
                   1104: the package management tools. If the file is missing, it is likely that your
                   1105: operating system already provides those tools. Download the file and extract it
                   1106: in the / directory. It will create the directories /usr/pkg (containing the
1.118     sevan    1107: tools for managing binary packages and the database of installed packages).
1.1       dsieger  1108: 
1.154     rillig   1109: 5.1.2. Installing binary packages
1.1       dsieger  1110: 
1.85      wiz      1111: In the directory from the last section, there is a subdirectory called All/,
1.9       rillig   1112: which contains all the binary packages that are available for the platform,
                   1113: excluding those that may not be distributed via FTP or CDROM (depending on
1.24      wiz      1114: which medium you are using).
1.9       rillig   1115: 
                   1116: To install packages directly from an FTP or HTTP server, run the following
                   1117: commands in a Bourne-compatible shell (be sure to su to root first):
                   1118: 
                   1119: # PATH="/usr/pkg/sbin:$PATH"
1.179     rillig   1120: 
                   1121: # PKG_PATH="http://cdn.NetBSD.org/pub/pkgsrc/packages"
1.169     rillig   1122: # PKG_PATH="$PKG_PATH/OPSYS/ARCH/VERSIONS/All/"
1.9       rillig   1123: # export PATH PKG_PATH
                   1124: 
                   1125: Instead of URLs, you can also use local paths, for example if you are
                   1126: installing from a set of CDROMs, DVDs or an NFS-mounted repository. If you want
                   1127: to install packages from multiple sources, you can separate them by a semicolon
                   1128: in PKG_PATH.
                   1129: 
                   1130: After these preparations, installing a package is very easy:
                   1131: 
1.118     sevan    1132: # pkg_add libreoffice
                   1133: # pkg_add ap24-php71-*
1.1       dsieger  1134: 
                   1135: Note that any prerequisite packages needed to run the package in question will
                   1136: be installed, too, assuming they are present where you install from.
                   1137: 
1.25      wiz      1138: Adding packages might install vulnerable packages. Thus you should run 
1.24      wiz      1139: pkg_admin audit regularly, especially after installing new packages, and verify
                   1140: that the vulnerabilities are acceptable for your configuration.
1.1       dsieger  1141: 
                   1142: After you've installed packages, be sure to have /usr/pkg/bin and /usr/pkg/sbin
                   1143: in your PATH so you can actually start the just installed program.
                   1144: 
1.154     rillig   1145: 5.1.3. Deinstalling packages
1.1       dsieger  1146: 
                   1147: To deinstall a package, it does not matter whether it was installed from source
                   1148: code or from a binary package. The pkg_delete command does not know it anyway.
                   1149: To delete a package, you can just run pkg_delete package-name. The package name
                   1150: can be given with or without version number. Wildcards can also be used to
                   1151: deinstall a set of packages, for example *emacs*. Be sure to include them in
                   1152: quotes, so that the shell does not expand them before pkg_delete sees them.
                   1153: 
                   1154: The -r option is very powerful: it removes all the packages that require the
                   1155: package in question and then removes the package itself. For example:
                   1156: 
                   1157: # pkg_delete -r jpeg
                   1158: 
                   1159: 
                   1160: will remove jpeg and all the packages that used it; this allows upgrading the
                   1161: jpeg package.
                   1162: 
1.154     rillig   1163: 5.1.4. Getting information about installed packages
1.1       dsieger  1164: 
                   1165: The pkg_info shows information about installed packages or binary package
                   1166: files.
                   1167: 
1.154     rillig   1168: 5.1.5. Checking for security vulnerabilities in installed packages
1.1       dsieger  1169: 
1.164     leot     1170: The pkgsrc Security Team and Packages Groups maintain a list of known security
                   1171: vulnerabilities to packages which are (or have been) included in pkgsrc. The
1.179     rillig   1172: list is available from the NetBSD FTP site at http://ftp.NetBSD.org/pub/NetBSD/
                   1173: packages/vulns/pkg-vulnerabilities.
1.1       dsieger  1174: 
1.23      jakllsch 1175: Through pkg_admin fetch-pkg-vulnerabilities, this list can be downloaded
                   1176: automatically, and a security audit of all packages installed on a system can
                   1177: take place.
                   1178: 
                   1179: There are two components to auditing. The first step, pkg_admin
                   1180: fetch-pkg-vulnerabilities, is for downloading the list of vulnerabilities from
                   1181: the NetBSD FTP site. The second step, pkg_admin audit, checks to see if any of
                   1182: your installed packages are vulnerable. If a package is vulnerable, you will
                   1183: see output similar to the following:
1.1       dsieger  1184: 
                   1185: Package samba-2.0.9 has a local-root-shell vulnerability, see
1.174     leot     1186:     https://www.samba.org/samba/whatsnew/macroexploit.html
1.1       dsieger  1187: 
1.23      jakllsch 1188: You may wish to have the vulnerabilities file downloaded daily so that it
                   1189: remains current. This may be done by adding an appropriate entry to the root
                   1190: users crontab(5) entry. For example the entry
                   1191: 
1.121     sevan    1192: # Download vulnerabilities file
1.118     sevan    1193: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1.121     sevan    1194: # Audit the installed packages and email results to root
                   1195: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
                   1196:             root >/dev/null 2>&1
1.118     sevan    1197: 
                   1198: 
                   1199: will update the vulnerability list every day at 3AM, followed by an audit at
                   1200: 3:09AM. The result of the audit are then emailed to root. On NetBSD this may be
                   1201: accomplished instead by adding the following line to /etc/daily.conf:
                   1202: 
                   1203: fetch_pkg_vulnerabilities=YES
                   1204: 
1.23      jakllsch 1205: 
1.118     sevan    1206: to fetch the vulnerability list from the daily security script. The system is
                   1207: set to audit the packages by default but can be set explicitly, if desired (not
1.123     wiz      1208: required), by adding the following line to /etc/security.conf:
1.23      jakllsch 1209: 
1.118     sevan    1210: check_pkg_vulnerabilities=YES
1.23      jakllsch 1211: 
                   1212: 
1.118     sevan    1213: see daily.conf(5) and security.conf(5) for more details.
1.1       dsieger  1214: 
1.154     rillig   1215: 5.1.6. Finding if newer versions of your installed packages are in pkgsrc
1.1       dsieger  1216: 
1.12      weinem   1217: Install pkgtools/lintpkgsrc and run lintpkgsrc with the "-i" argument to check
                   1218: if your packages are up-to-date, e.g.
1.1       dsieger  1219: 
                   1220: % lintpkgsrc -i
                   1221: ...
                   1222: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   1223: 
                   1224: 
                   1225: You can then use make update to update the package on your system and rebuild
                   1226: any dependencies.
                   1227: 
1.154     rillig   1228: 5.1.7. Other administrative functions
1.1       dsieger  1229: 
                   1230: The pkg_admin executes various administrative functions on the package system.
                   1231: 
1.154     rillig   1232: 5.2. Building packages from source
1.1       dsieger  1233: 
                   1234: After obtaining pkgsrc, the pkgsrc directory now contains a set of packages,
1.25      wiz      1235: organized into categories. You can browse the online index of packages, or run 
1.1       dsieger  1236: make readme from the pkgsrc directory to build local README.html files for all
                   1237: packages, viewable with any web browser such as www/lynx or www/firefox.
                   1238: 
                   1239: The default prefix for installed packages is /usr/pkg. If you wish to change
                   1240: this, you should do so by setting LOCALBASE in mk.conf. You should not try to
                   1241: use multiple different LOCALBASE definitions on the same system (inside a
                   1242: chroot is an exception).
                   1243: 
                   1244: The rest of this chapter assumes that the package is already in pkgsrc. If it
                   1245: is not, see Part II, "The pkgsrc developer's guide" for instructions how to
                   1246: create your own packages.
                   1247: 
1.154     rillig   1248: 5.2.1. Requirements
1.1       dsieger  1249: 
                   1250: To build packages from source, you need a working C compiler. On NetBSD, you
                   1251: need to install the "comp" and the "text" distribution sets. If you want to
                   1252: build X11-related packages, the "xbase" and "xcomp" distribution sets are
                   1253: required, too.
                   1254: 
1.154     rillig   1255: 5.2.2. Fetching distfiles
1.1       dsieger  1256: 
                   1257: The first step for building a package is downloading the distfiles (i.e. the
                   1258: unmodified source). If they have not yet been downloaded, pkgsrc will fetch
                   1259: them automatically.
                   1260: 
                   1261: If you have all files that you need in the distfiles directory, you don't need
                   1262: to connect. If the distfiles are on CD-ROM, you can mount the CD-ROM on /cdrom
                   1263: and add:
                   1264: 
                   1265: DISTDIR=/cdrom/pkgsrc/distfiles
                   1266: 
                   1267: to your mk.conf.
                   1268: 
                   1269: By default a list of distribution sites will be randomly intermixed to prevent
                   1270: huge load on servers which holding popular packages (for example,
                   1271: SourceForge.net mirrors). Thus, every time when you need to fetch yet another
                   1272: distfile all the mirrors will be tried in new (random) order. You can turn this
                   1273: feature off by setting MASTER_SORT_RANDOM=NO (for PKG_DEVELOPERs it's already
                   1274: disabled).
                   1275: 
                   1276: You can overwrite some of the major distribution sites to fit to sites that are
                   1277: close to your own. By setting one or two variables you can modify the order in
                   1278: which the master sites are accessed. MASTER_SORT contains a whitespace
                   1279: delimited list of domain suffixes. MASTER_SORT_REGEX is even more flexible, it
                   1280: contains a whitespace delimited list of regular expressions. It has higher
                   1281: priority than MASTER_SORT. Have a look at pkgsrc/mk/defaults/mk.conf to find
                   1282: some examples. This may save some of your bandwidth and time.
                   1283: 
                   1284: You can change these settings either in your shell's environment, or, if you
1.4       rillig   1285: want to keep the settings, by editing the mk.conf file, and adding the
1.1       dsieger  1286: definitions there.
                   1287: 
1.132     wiz      1288: If a package depends on many other packages (such as meta-pkgs/kde4), the build
1.1       dsieger  1289: process may alternate between periods of downloading source, and compiling. To
                   1290: ensure you have all the source downloaded initially you can run the command:
                   1291: 
                   1292: % make fetch-list | sh
                   1293: 
                   1294: which will output and run a set of shell commands to fetch the necessary files
                   1295: into the distfiles directory. You can also choose to download the files
                   1296: manually.
                   1297: 
1.154     rillig   1298: 5.2.3. How to build and install
1.1       dsieger  1299: 
                   1300: Once the software has downloaded, any patches will be applied, then it will be
                   1301: compiled for you. This may take some time depending on your computer, and how
                   1302: many other packages the software depends on and their compile time.
                   1303: 
                   1304: Note
                   1305: 
                   1306: If using bootstrap or pkgsrc on a non-NetBSD system, use the pkgsrc bmake
                   1307: command instead of "make" in the examples in this guide.
                   1308: 
                   1309: For example, type
                   1310: 
                   1311: % cd misc/figlet
                   1312: % make
                   1313: 
                   1314: 
                   1315: at the shell prompt to build the various components of the package.
                   1316: 
                   1317: The next stage is to actually install the newly compiled program onto your
                   1318: system. Do this by entering:
                   1319: 
                   1320: % make install
                   1321: 
                   1322: 
                   1323: while you are still in the directory for whatever package you are installing.
                   1324: 
                   1325: Installing the package on your system may require you to be root. However,
                   1326: pkgsrc has a just-in-time-su feature, which allows you to only become root for
                   1327: the actual installation step.
                   1328: 
                   1329: That's it, the software should now be installed and setup for use. You can now
                   1330: enter:
                   1331: 
                   1332: % make clean
                   1333: 
                   1334: 
                   1335: to remove the compiled files in the work directory, as you shouldn't need them
                   1336: any more. If other packages were also added to your system (dependencies) to
                   1337: allow your program to compile, you can tidy these up also with the command:
                   1338: 
                   1339: % make clean-depends
                   1340: 
                   1341: 
                   1342: Taking the figlet utility as an example, we can install it on our system by
                   1343: building as shown in Appendix B, Build logs.
                   1344: 
                   1345: The program is installed under the default root of the packages tree - /usr/
                   1346: pkg. Should this not conform to your tastes, set the LOCALBASE variable in your
                   1347: environment, and it will use that value as the root of your packages tree. So,
                   1348: to use /usr/local, set LOCALBASE=/usr/local in your environment. Please note
                   1349: that you should use a directory which is dedicated to packages and not shared
                   1350: with other programs (i.e., do not try and use LOCALBASE=/usr). Also, you should
                   1351: not try to add any of your own files or directories (such as src/, obj/, or
                   1352: pkgsrc/) below the LOCALBASE tree. This is to prevent possible conflicts
                   1353: between programs and other files installed by the package system and whatever
                   1354: else may have been installed there.
                   1355: 
1.4       rillig   1356: Some packages look in mk.conf to alter some configuration options at build
1.1       dsieger  1357: time. Have a look at pkgsrc/mk/defaults/mk.conf to get an overview of what will
                   1358: be set there by default. Environment variables such as LOCALBASE can be set in
1.4       rillig   1359: mk.conf to save having to remember to set them each time you want to use
1.1       dsieger  1360: pkgsrc.
                   1361: 
                   1362: Occasionally, people want to "look under the covers" to see what is going on
                   1363: when a package is building or being installed. This may be for debugging
                   1364: purposes, or out of simple curiosity. A number of utility values have been
                   1365: added to help with this.
                   1366: 
                   1367:  1. If you invoke the make(1) command with PKG_DEBUG_LEVEL=2, then a huge
                   1368:     amount of information will be displayed. For example,
                   1369: 
                   1370:     make patch PKG_DEBUG_LEVEL=2
                   1371: 
1.25      wiz      1372:     will show all the commands that are invoked, up to and including the "patch
                   1373:     " stage.
1.1       dsieger  1374: 
                   1375:  2. If you want to know the value of a certain make(1) definition, then the
                   1376:     VARNAME definition should be used, in conjunction with the show-var target.
                   1377:     e.g. to show the expansion of the make(1) variable LOCALBASE:
                   1378: 
                   1379:     % make show-var VARNAME=LOCALBASE
                   1380:     /usr/pkg
                   1381:     %
                   1382: 
                   1383: 
                   1384: If you want to install a binary package that you've either created yourself
                   1385: (see next section), that you put into pkgsrc/packages manually or that is
                   1386: located on a remote FTP server, you can use the "bin-install" target. This
                   1387: target will install a binary package - if available - via pkg_add(1), else do a
                   1388: make package. The list of remote FTP sites searched is kept in the variable
                   1389: BINPKG_SITES, which defaults to ftp.NetBSD.org. Any flags that should be added
                   1390: to pkg_add(1) can be put into BIN_INSTALL_FLAGS. See pkgsrc/mk/defaults/mk.conf
                   1391: for more details.
                   1392: 
                   1393: A final word of warning: If you set up a system that has a non-standard setting
                   1394: for LOCALBASE, be sure to set that before any packages are installed, as you
                   1395: cannot use several directories for the same purpose. Doing so will result in
                   1396: pkgsrc not being able to properly detect your installed packages, and fail
                   1397: miserably. Note also that precompiled binary packages are usually built with
                   1398: the default LOCALBASE of /usr/pkg, and that you should not install any if you
                   1399: use a non-standard LOCALBASE.
                   1400: 
1.154     rillig   1401: Chapter 6. Configuring pkgsrc
1.1       dsieger  1402: 
                   1403: Table of Contents
                   1404: 
1.154     rillig   1405: 6.1. General configuration
                   1406: 6.2. Variables affecting the build process
                   1407: 6.3. Variables affecting the installation process
                   1408: 6.4. Selecting and configuring the compiler
                   1409: 
                   1410:     6.4.1. Selecting the compiler
                   1411:     6.4.2. Additional flags to the compiler (CFLAGS)
                   1412:     6.4.3. Additional flags to the linker (LDFLAGS)
1.1       dsieger  1413: 
1.154     rillig   1414: 6.5. Developer/advanced settings
                   1415: 6.6. Selecting Build Options
1.1       dsieger  1416: 
                   1417: The whole pkgsrc system is configured in a single file, usually called mk.conf.
                   1418: In which directory pkgsrc looks for that file depends on the installation. On
                   1419: NetBSD, when you use make(1) from the base system, it is in the directory /etc
                   1420: /. In all other cases the default location is ${PREFIX}/etc/, depending on
                   1421: where you told the bootstrap program to install the binary packages.
                   1422: 
                   1423: The format of the configuration file is that of the usual BSD-style Makefiles.
                   1424: The whole pkgsrc configuration is done by setting variables in this file. Note
                   1425: that you can define all kinds of variables, and no special error checking (for
1.112     rillig   1426: example for spelling mistakes) takes place.
1.1       dsieger  1427: 
1.154     rillig   1428: 6.1. General configuration
1.1       dsieger  1429: 
1.112     rillig   1430: The following variables apply to all pkgsrc packages. A complete list of the
                   1431: variables that can be configured by the user is available in mk/defaults/
                   1432: mk.conf, together with some comments that describe each variable's intent.
1.1       dsieger  1433: 
                   1434:   * LOCALBASE: Where packages will be installed. The default is /usr/pkg. Do
                   1435:     not mix binary packages with different LOCALBASEs!
                   1436: 
                   1437:   * CROSSBASE: Where "cross" category packages will be installed. The default
                   1438:     is ${LOCALBASE}/cross.
                   1439: 
1.84      wiz      1440:   * X11BASE: Where X11 is installed on the system. The default is /usr/X11R7.
1.1       dsieger  1441: 
                   1442:   * DISTDIR: Where to store the downloaded copies of the original source
                   1443:     distributions used for building pkgsrc packages. The default is $
                   1444:     {PKGSRCDIR}/distfiles.
                   1445: 
                   1446:   * PKG_DBDIR: Where the database about installed packages is stored. The
1.118     sevan    1447:     default is /usr/pkg/pkgdb.
1.1       dsieger  1448: 
                   1449:   * MASTER_SITE_OVERRIDE: If set, override the packages' MASTER_SITES with this
                   1450:     value.
                   1451: 
                   1452:   * MASTER_SITE_BACKUP: Backup location(s) for distribution files and patch
                   1453:     files if not found locally or in ${MASTER_SITES} or ${PATCH_SITES}
1.118     sevan    1454:     respectively. The defaults is ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/$
1.1       dsieger  1455:     {DIST_SUBDIR}/.
                   1456: 
                   1457:   * BINPKG_SITES: List of sites carrying binary pkgs. rel and arch are replaced
                   1458:     with OS release ("2.0", etc.) and architecture ("mipsel", etc.).
                   1459: 
1.23      jakllsch 1460:   * ACCEPTABLE_LICENSES: List of acceptable licenses. License names are
                   1461:     case-sensitive. Whenever you try to build a package whose license is not in
                   1462:     this list, you will get an error message. If the license condition is
                   1463:     simple enough, the error message will include specific instructions on how
                   1464:     to change this variable.
1.1       dsieger  1465: 
1.154     rillig   1466: 6.2. Variables affecting the build process
1.1       dsieger  1467: 
                   1468:   * PACKAGES: The top level directory for the binary packages. The default is $
                   1469:     {PKGSRCDIR}/packages.
                   1470: 
                   1471:   * WRKOBJDIR: The top level directory where, if defined, the separate working
                   1472:     directories will get created, and symbolically linked to from ${WRKDIR}
                   1473:     (see below). This is useful for building packages on several architectures,
                   1474:     then ${PKGSRCDIR} can be NFS-mounted while ${WRKOBJDIR} is local to every
                   1475:     architecture. (It should be noted that PKGSRCDIR should not be set by the
1.198     leot     1476:     user -- it is an internal definition which refers to the root of the pkgsrc
1.1       dsieger  1477:     tree. It is possible to have many pkgsrc tree instances.)
                   1478: 
                   1479:   * LOCALPATCHES: Directory for local patches that aren't part of pkgsrc. See
1.184     rillig   1480:     Section 12.3, "patches/*" for more information.
1.1       dsieger  1481: 
                   1482:   * PKGMAKECONF: Location of the mk.conf file used by a package's BSD-style
                   1483:     Makefile. If this is not set, MAKECONF is set to /dev/null to avoid picking
                   1484:     up settings used by builds in /usr/src.
                   1485: 
1.154     rillig   1486: 6.3. Variables affecting the installation process
1.1       dsieger  1487: 
1.198     leot     1488:   * PKGSRC_KEEP_BIN_PKGS: By default, binary packages of built packages are
1.150     leot     1489:     preserved in ${PACKAGES}/All. Setting this variable to "no" prevents this.
1.1       dsieger  1490: 
1.107     jnemeth  1491: Packages have to support installation into a subdirectory of WRKDIR. This
                   1492: allows a package to be built, before the actual filesystem is touched. DESTDIR
                   1493: support exists in two variations:
1.4       rillig   1494: 
                   1495:   * Basic DESTDIR support means that the package installation and packaging is
                   1496:     still run as root.
                   1497: 
                   1498:   * Full DESTDIR support can run the complete build, installation and packaging
                   1499:     as normal user. Root privileges are only needed to add packages.
                   1500: 
                   1501: With basic DESTDIR support, make clean needs to be run as root.
                   1502: 
1.17      imil     1503: Considering the foo/bar package, DESTDIR full support can be tested using the
                   1504: following commands
                   1505: 
                   1506: $ id
                   1507: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
                   1508: $ mkdir $HOME/packages
                   1509: $ cd $PKGSRCDIR/foo/bar
                   1510: 
                   1511: Verify DESTDIR full support, no root privileges should be needed
                   1512: 
1.66      asau     1513: $ make stage-install
1.17      imil     1514: 
                   1515: Create a package without root privileges
                   1516: 
1.66      asau     1517: $ make PACKAGES=$HOME/packages package
1.17      imil     1518: 
                   1519: For the following command, you must be able to gain root privileges using su(1)
                   1520: 
1.66      asau     1521: $ make PACKAGES=$HOME/packages install
1.17      imil     1522: 
                   1523: Then, as a simple user
                   1524: 
                   1525: $ make clean
                   1526: 
1.154     rillig   1527: 6.4. Selecting and configuring the compiler
1.4       rillig   1528: 
1.154     rillig   1529: 6.4.1. Selecting the compiler
1.1       dsieger  1530: 
                   1531: By default, pkgsrc will use GCC to build packages. This may be overridden by
                   1532: setting the following variables in /etc/mk.conf:
                   1533: 
                   1534: PKGSRC_COMPILER:
                   1535: 
                   1536:     This is a list of values specifying the chain of compilers to invoke when
                   1537:     building packages. Valid values are:
                   1538: 
1.66      asau     1539:       + ccc: Compaq C Compilers (Tru64)
                   1540: 
                   1541:       + ccache: compiler cache (chainable)
                   1542: 
                   1543:       + clang: Clang C and Objective-C compiler
                   1544: 
1.42      asau     1545:       + distcc: distributed C/C++ (chainable)
1.1       dsieger  1546: 
1.66      asau     1547:       + f2c: Fortran 77 to C compiler (chainable)
                   1548: 
                   1549:       + icc: Intel C++ Compiler (Linux)
                   1550: 
                   1551:       + ido: SGI IRIS Development Option cc (IRIX 5)
1.1       dsieger  1552: 
1.42      asau     1553:       + gcc: GNU C/C++ Compiler
1.1       dsieger  1554: 
1.66      asau     1555:       + hp: HP-UX C/aC++ compilers
                   1556: 
1.42      asau     1557:       + mipspro: Silicon Graphics, Inc. MIPSpro (n32/n64)
1.1       dsieger  1558: 
1.66      asau     1559:       + mipspro-ucode: Silicon Graphics, Inc. MIPSpro (o32)
1.1       dsieger  1560: 
1.42      asau     1561:       + sunpro: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio
1.1       dsieger  1562: 
1.118     sevan    1563:       + xlc: IBM's XL C/C++ compiler suite
1.66      asau     1564: 
1.1       dsieger  1565:     The default is "gcc". You can use ccache and/or distcc with an appropriate
                   1566:     PKGSRC_COMPILER setting, e.g. "ccache gcc". This variable should always be
                   1567:     terminated with a value for a real compiler. Note that only one real
                   1568:     compiler should be listed (e.g. "sunpro gcc" is not allowed).
                   1569: 
                   1570: GCC_REQD:
                   1571: 
                   1572:     This specifies the minimum version of GCC to use when building packages. If
                   1573:     the system GCC doesn't satisfy this requirement, then pkgsrc will build and
                   1574:     install one of the GCC packages to use instead.
                   1575: 
1.153     leot     1576: PYTHON_VERSION_DEFAULT:
1.114     maya     1577: 
                   1578:     Specifies which version of python to use when several options are
                   1579:     available.
                   1580: 
                   1581: PKGSRC_FORTRAN:
                   1582: 
1.176     gutterid 1583:     Specifies the Fortran compiler to use. The default is gfortran.
1.114     maya     1584: 
                   1585: GFORTRAN_VERSION:
                   1586: 
                   1587:     If PKGSRC_FORTRAN= gfortran is used, this option specifies which version to
                   1588:     use.
                   1589: 
1.154     rillig   1590: 6.4.2. Additional flags to the compiler (CFLAGS)
1.1       dsieger  1591: 
                   1592: If you wish to set the CFLAGS variable, please make sure to use the += operator
                   1593: instead of the = operator:
                   1594: 
                   1595: CFLAGS+=        -your -flags
                   1596: 
                   1597: Using CFLAGS= (i.e. without the "+") may lead to problems with packages that
1.16      jnemeth  1598: need to add their own flags. You may want to take a look at the devel/cpuflags
1.24      wiz      1599: package if you're interested in optimization specifically for the current CPU.
1.1       dsieger  1600: 
1.154     rillig   1601: 6.4.3. Additional flags to the linker (LDFLAGS)
1.1       dsieger  1602: 
                   1603: If you want to pass flags to the linker, both in the configure step and the
                   1604: build step, you can do this in two ways. Either set LDFLAGS or LIBS. The
                   1605: difference between the two is that LIBS will be appended to the command line,
                   1606: while LDFLAGS come earlier. LDFLAGS is pre-loaded with rpath settings for ELF
                   1607: machines depending on the setting of USE_IMAKE or the inclusion of mk/
                   1608: x11.buildlink3.mk. As with CFLAGS, if you do not wish to override these
                   1609: settings, use the += operator:
                   1610: 
                   1611: LDFLAGS+=        -your -linkerflags
                   1612: 
1.154     rillig   1613: 6.5. Developer/advanced settings
1.1       dsieger  1614: 
                   1615:   * PKG_DEVELOPER: Run some sanity checks that package developers want:
                   1616: 
1.42      asau     1617:       + make sure patches apply with zero fuzz
1.1       dsieger  1618: 
1.42      asau     1619:       + run check-shlibs to see that all binaries will find their shared libs.
1.1       dsieger  1620: 
                   1621:   * PKG_DEBUG_LEVEL: The level of debugging output which is displayed whilst
                   1622:     making and installing the package. The default value for this is 0, which
                   1623:     will not display the commands as they are executed (normal, default, quiet
                   1624:     operation); the value 1 will display all shell commands before their
                   1625:     invocation, and the value 2 will display both the shell commands before
1.112     rillig   1626:     their invocation, as well as their actual execution progress with set -x.
1.1       dsieger  1627: 
1.154     rillig   1628: 6.6. Selecting Build Options
1.1       dsieger  1629: 
                   1630: Some packages have build time options, usually to select between different
                   1631: dependencies, enable optional support for big dependencies or enable
                   1632: experimental features.
                   1633: 
                   1634: To see which options, if any, a package supports, and which options are
                   1635: mutually exclusive, run make show-options, for example:
                   1636: 
                   1637:     The following options are supported by this package:
                   1638:         ssl      Enable SSL support.
                   1639:     Exactly one of the following gecko options is required:
                   1640:         firefox  Use firefox as gecko rendering engine.
                   1641:         mozilla  Use mozilla as gecko rendering engine.
                   1642:     At most one of the following database options may be selected:
                   1643:         mysql    Enable support for MySQL database.
                   1644:         pgsql    Enable support for PostgreSQL database.
                   1645: 
                   1646:     These options are enabled by default: firefox
                   1647:     These options are currently enabled: mozilla ssl
                   1648: 
1.4       rillig   1649: The following variables can be defined in mk.conf to select which options to
                   1650: enable for a package: PKG_DEFAULT_OPTIONS, which can be used to select or
1.1       dsieger  1651: disable options for all packages that support them, and PKG_OPTIONS.pkgbase,
                   1652: which can be used to select or disable options specifically for package pkgbase
                   1653: . Options listed in these variables are selected, options preceded by "-" are
                   1654: disabled. A few examples:
                   1655: 
1.4       rillig   1656: $ grep "PKG.*OPTION" mk.conf
1.1       dsieger  1657: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   1658: PKG_OPTIONS.kdebase=    debug -sasl
                   1659: PKG_OPTIONS.apache=     suexec
                   1660: 
1.11      rillig   1661: It is important to note that options that were specifically suggested by the
1.19      snj      1662: package maintainer must be explicitly removed if you do not wish to include the
                   1663: option. If you are unsure you can view the current state with make show-options
                   1664: .
1.11      rillig   1665: 
1.1       dsieger  1666: The following settings are consulted in the order given, and the last setting
                   1667: that selects or disables an option is used:
                   1668: 
                   1669:  1. the default options as suggested by the package maintainer
                   1670: 
                   1671:  2. the options implied by the settings of legacy variables (see below)
                   1672: 
                   1673:  3. PKG_DEFAULT_OPTIONS
                   1674: 
                   1675:  4. PKG_OPTIONS.pkgbase
                   1676: 
                   1677: For groups of mutually exclusive options, the last option selected is used, all
                   1678: others are automatically disabled. If an option of the group is explicitly
                   1679: disabled, the previously selected option, if any, is used. It is an error if no
                   1680: option from a required group of options is selected, and building the package
                   1681: will fail.
                   1682: 
                   1683: Before the options framework was introduced, build options were selected by
1.4       rillig   1684: setting a variable (often named USE_FOO) in mk.conf for each option. To ease
                   1685: transition to the options framework for the user, these legacy variables are
                   1686: converted to the appropriate options setting (PKG_OPTIONS.pkgbase)
                   1687: automatically. A warning is issued to prompt the user to update mk.conf to use
                   1688: the options framework directly. Support for the legacy variables will be
1.1       dsieger  1689: removed eventually.
                   1690: 
1.154     rillig   1691: Chapter 7. Creating binary packages
1.1       dsieger  1692: 
                   1693: Table of Contents
                   1694: 
1.154     rillig   1695: 7.1. Building a single binary package
                   1696: 7.2. Settings for creation of binary packages
1.1       dsieger  1697: 
1.154     rillig   1698: 7.1. Building a single binary package
1.1       dsieger  1699: 
                   1700: Once you have built and installed a package, you can create a binary package
                   1701: which can be installed on another system with pkg_add(1). This saves having to
                   1702: build the same package on a group of hosts and wasting CPU time. It also
                   1703: provides a simple means for others to install your package, should you
                   1704: distribute it.
                   1705: 
                   1706: To create a binary package, change into the appropriate directory in pkgsrc,
                   1707: and run make package:
                   1708: 
1.112     rillig   1709: $ cd misc/figlet
                   1710: $ make package
1.1       dsieger  1711: 
                   1712: This will build and install your package (if not already done), and then build
                   1713: a binary package from what was installed. You can then use the pkg_* tools to
                   1714: manipulate it. Binary packages are created by default in /usr/pkgsrc/packages,
                   1715: in the form of a gzipped tar file. See Section B.2, "Packaging figlet" for a
                   1716: continuation of the above misc/figlet example.
                   1717: 
1.154     rillig   1718: See Chapter 23, Submitting and Committing for information on how to submit such
1.1       dsieger  1719: a binary package.
                   1720: 
1.154     rillig   1721: 7.2. Settings for creation of binary packages
1.1       dsieger  1722: 
1.184     rillig   1723: See Section 13.17, "Other helpful targets".
1.6       rillig   1724: 
1.154     rillig   1725: Chapter 8. Creating binary packages for everything in pkgsrc (bulk builds)
1.6       rillig   1726: 
                   1727: Table of Contents
                   1728: 
1.154     rillig   1729: 8.1. Preparations
1.180     rillig   1730: 8.2. Running a bulk build
1.6       rillig   1731: 
1.154     rillig   1732:     8.2.1. Configuration
1.6       rillig   1733: 
1.154     rillig   1734: 8.3. Requirements of a full bulk build
1.178     rillig   1735: 8.4. Bulk build variants
                   1736: 
1.179     rillig   1737:     8.4.1. Detect unknown configure options
                   1738:     8.4.2. Detect classes of bugs by forcing compiler warnings
1.181     rillig   1739:     8.4.3. Force compiler options only in the build phase
                   1740:     8.4.4. Use custom directories
                   1741:     8.4.5. Turn warnings into errors
                   1742:     8.4.6. Reject packages for which pkglint reports errors
                   1743:     8.4.7. Reject packages that contain forbidden strings
                   1744:     8.4.8. Reject packages whose self-test fails
                   1745:     8.4.9. Reject packages that use undefined shell variables
                   1746:     8.4.10. Turn off verbose logging
1.6       rillig   1747: 
1.178     rillig   1748: 8.5. Creating a multiple CD-ROM packages collection
                   1749: 
                   1750:     8.5.1. Example of cdpack
1.6       rillig   1751: 
1.175     gutterid 1752: For a number of reasons, you may want to build binary packages for a large
                   1753: selected set of packages in pkgsrc, or even for all pkgsrc packages. For
1.71      wiz      1754: instance, when you have multiple machines that should run the same software, it
                   1755: is wasted time if they all build their packages themselves from source. Or you
                   1756: may want to build a list of packages you want and check them before deploying
1.175     gutterid 1757: onto production systems. There is a way of getting a set of binary packages:
                   1758: the bulk build system, or pbulk ("p" stands for "parallel"). This chapter
                   1759: describes how to set it up.
1.71      wiz      1760: 
1.154     rillig   1761: 8.1. Preparations
1.71      wiz      1762: 
                   1763: First of all, you have to decide whether you build all packages or a limited
                   1764: set of them. Full bulk builds usually consume a lot more resources, both space
1.175     gutterid 1765: and time, than builds for some practical sets of packages. A number of
                   1766: particularly heavy packages exist that are not actually interesting to a wide
                   1767: audience. (The approximate resource consumption for a full bulk build is given
                   1768: in section Section 8.3, "Requirements of a full bulk build".) For limited bulk
                   1769: builds you need to make a list of packages you want to build. Note that all
                   1770: their dependencies will be built, so you don't need to track them manually.
1.71      wiz      1771: 
                   1772: During bulk builds various packages are installed and deinstalled in /usr/pkg
                   1773: (or whatever LOCALBASE is), so make sure that you don't need any package during
1.112     rillig   1774: the builds. Essentially, you should provide a fresh system, either a chroot
1.71      wiz      1775: environment or something even more restrictive, depending on what the operating
                   1776: system provides, or dedicate the whole physical machine. As a useful side
                   1777: effect this makes sure that bulk builds cannot break anything in your system.
                   1778: There have been numerous cases where certain packages tried to install files
                   1779: outside the LOCALBASE or wanted to edit some files in /etc.
1.6       rillig   1780: 
1.180     rillig   1781: 8.2. Running a bulk build
1.6       rillig   1782: 
1.180     rillig   1783: Running a bulk build works roughly as follows:
1.15      rillig   1784: 
                   1785:   * First, build the pbulk infrastructure in a fresh pkgsrc location.
                   1786: 
                   1787:   * Then, build each of the packages from a clean installation directory using
                   1788:     the infrastructure.
                   1789: 
1.154     rillig   1790: 8.2.1. Configuration
1.6       rillig   1791: 
1.112     rillig   1792: To simplify configuration, we provide the helper script mk/pbulk/pbulk.sh.
1.6       rillig   1793: 
1.68      asau     1794: In order to use it, prepare a clear system (real one, chroot environment, jail,
                   1795: zone, virtual machine). Configure network access to fetch distribution files.
1.112     rillig   1796: Create a user with name "pbulk".
1.68      asau     1797: 
                   1798: Fetch and extract pkgsrc. Use a command like one of these:
                   1799: 
1.151     sevan    1800: # (cd /usr && ftp -o - https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)
                   1801: # (cd /usr && fetch -o - https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)
1.72      wiz      1802: # (cd /usr && cvs -Q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot get -P pkgsrc)
1.68      asau     1803: 
                   1804: Or any other way that fits (e.g., curl, wget).
                   1805: 
                   1806: Deploy and configure pbulk tools, e.g.:
                   1807: 
1.118     sevan    1808: # sh pbulk.sh -n # use native make, no bootstrap kit needed (for use on NetBSD)
1.68      asau     1809: # sh pbulk.sh -n -c mk.conf.frag # native, apply settings from given mk.conf fragment
                   1810: # sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build
                   1811: 
                   1812: Note
                   1813: 
                   1814: mk.conf.frag is a fragment of mk.conf that contains settings you want to apply
                   1815: to packages you build. For instance,
                   1816: 
1.112     rillig   1817: PKG_DEVELOPER=          yes     # perform more checks
                   1818: X11_TYPE=               modular # use pkgsrc X11
                   1819: SKIP_LICENSE_CHECK=     yes     # accept all licences (useful
                   1820:                                 # when building all packages)
1.68      asau     1821: 
                   1822: If configured for limited list, replace the list in /usr/pbulk/etc/pbulk.list
1.112     rillig   1823: with your list of packages, one per line without empty lines or comments. E.g.:
1.68      asau     1824: 
                   1825: www/firefox
                   1826: mail/thunderbird
                   1827: misc/libreoffice4
                   1828: 
1.69      asau     1829: At this point you can also review configuration in /usr/pbulk/etc and make
                   1830: final amendments, if wanted.
                   1831: 
1.68      asau     1832: Start it:
                   1833: 
                   1834: # /usr/pbulk/bin/bulkbuild
                   1835: 
                   1836: After it finishes, you'll have /mnt filled with distribution files, binary
                   1837: packages, and reports, plain text summary in /mnt/bulklog/meta/report.txt
                   1838: 
                   1839: Note
                   1840: 
                   1841: The pbulk.sh script does not cover all possible use cases. While being ready to
                   1842: run, it serves as a good starting point to understand and build more complex
                   1843: setups. The script is kept small enough for better understanding.
                   1844: 
                   1845: Note
                   1846: 
                   1847: The pbulk.sh script supports running unprivileged bulk build and helps
                   1848: configuring distributed bulk builds.
1.15      rillig   1849: 
1.154     rillig   1850: 8.3. Requirements of a full bulk build
1.71      wiz      1851: 
                   1852: A complete bulk build requires lots of disk space. Some of the disk space can
                   1853: be read-only, some other must be writable. Some can be on remote filesystems
                   1854: (such as NFS) and some should be local. Some can be temporary filesystems,
                   1855: others must survive a sudden reboot.
                   1856: 
                   1857:   * 40 GB for the distfiles (read-write, remote, temporary)
                   1858: 
                   1859:   * 30 GB for the binary packages (read-write, remote, permanent)
                   1860: 
                   1861:   * 1 GB for the pkgsrc tree (read-only, remote, permanent)
                   1862: 
                   1863:   * 5 GB for LOCALBASE (read-write, local, temporary)
                   1864: 
                   1865:   * 10 GB for the log files (read-write, remote, permanent)
                   1866: 
                   1867:   * 5 GB for temporary files (read-write, local, temporary)
                   1868: 
1.178     rillig   1869: 8.4. Bulk build variants
                   1870: 
                   1871: To ensure that pkgsrc packages work in different configurations, it makes sense
                   1872: to run non-default bulk builds from time to time. This section lists some ideas
                   1873: for bulk builds that intentionally let packages fail if they don't follow the
                   1874: pkgsrc style.
                   1875: 
1.179     rillig   1876: 8.4.1. Detect unknown configure options
1.178     rillig   1877: 
                   1878: Add the following line to mk.conf.
                   1879: 
                   1880: GNU_CONFIGURE_STRICT=   yes
                   1881: 
                   1882: When a package fails this additional check, the most common cause is that the
                   1883: configure option was valid for an older version of the package but does not
                   1884: apply anymore. In that case, just remove it.
                   1885: 
1.179     rillig   1886: 8.4.2. Detect classes of bugs by forcing compiler warnings
1.178     rillig   1887: 
                   1888: The job of a compiler is not restricted to producing executable code, most
1.179     rillig   1889: compilers also detect typical programming mistakes. The pkgsrc compiler
                   1890: wrappers make it easy to force compiler options when the package is built. This
                   1891: can be used to find typical bugs across all packages that are in pkgsrc. By
                   1892: reporting these bugs upstream, the packages will be more reliable with the next
                   1893: updates.
1.178     rillig   1894: 
1.179     rillig   1895: Add some of the following lines to mk.conf:
1.178     rillig   1896: 
                   1897: CFLAGS+=        -Werror=char-subscripts
1.179     rillig   1898: CFLAGS+=        -Werror=implicit-function-declaration
1.178     rillig   1899: 
1.179     rillig   1900: When a package fails to build using these stricter compiler options, document
                   1901: the circumstances in which the compiler produced the error message. This
                   1902: includes:
1.178     rillig   1903: 
                   1904:   * The platform (MACHINE_PLATFORM)
                   1905: 
                   1906:   * The source file
                   1907: 
                   1908:   * An excerpt of the code. GCC and Clang already do this as part of the
                   1909:     diagnostic.
                   1910: 
1.179     rillig   1911:   * The exact error message from the compiler.
1.178     rillig   1912: 
1.179     rillig   1913: If a package produces these error messages, but the package is fine, record
                   1914: this in your local mk.conf, like this, to skip this check in the next builds:
1.178     rillig   1915: 
1.179     rillig   1916: .if ${PKGPATH} == category/package
1.178     rillig   1917: # Version ${VERSION} failed on ${MACHINE_PLATFORM}:
                   1918: # error message
                   1919: # code
1.179     rillig   1920: # Reason why the code does not need to be fixed.
1.178     rillig   1921: BUILDLINK_TRANSFORM+=   rm:-Werror=char-subscripts
1.179     rillig   1922: .endif
1.178     rillig   1923: 
                   1924: If the error messages from the compiler are valid and the code needs to be
1.179     rillig   1925: fixed, prepare a local patch (see LOCALPATCHES) and report the bug to the
                   1926: upstream authors of the package, providing them with the information you
                   1927: collected above.
1.178     rillig   1928: 
1.179     rillig   1929: Patches that are not essential for the package to work should only be reported
                   1930: upstream but not committed to pkgsrc, to make future updates easier.
                   1931: 
1.181     rillig   1932: 8.4.3. Force compiler options only in the build phase
                   1933: 
                   1934: When adding custom compiler flags via CFLAGS, these apply to all phases of the
                   1935: package build process. Especially in the configure phase, adding -Werror leads
                   1936: to wrong decisions. The GNU configure scripts feed many small test programs to
                   1937: the C compiler to see whether certain headers are available, functions are
                   1938: defined in a library and programs can be run. In many cases these programs
                   1939: would not survive a strict compiler run with -Wall -Wextra -Werror.
                   1940: 
                   1941: The pkgsrc infrastructure is flexible enough to support compiler options being
                   1942: added between the configure and build phases. It's a little more complicated
                   1943: than the other examples in this section but still easy enough.
                   1944: 
                   1945: The basic idea is to use the pkgsrc compiler wrapper to inject the desired
                   1946: compiler options. The compiler wrapper's original task is to hide unwanted
                   1947: directories of include files and to normalize compiler options. It does this by
                   1948: wrapping the compiler command and rewriting the command line. To see this in
                   1949: action, run bmake patch in a package directory and examine the work/.cwrappers/
                   1950: config directory. It contains individual configurations for the C compiler and
                   1951: the related tools. The plan is to find a hook between the configure and build
                   1952: phases, and to modify these configuration files at that point.
                   1953: 
                   1954: To find this hook, have a look at mk/build/build.mk, which contains among
                   1955: others the pre-build-checks-hook. The word checks doesn't quite fit, but the
                   1956: pre-build-hook sounds good enough.
                   1957: 
                   1958: The code to be included in mk.conf is:
                   1959: 
                   1960: # Just a few example options.
                   1961: BUILD_ONLY_CFLAGS=      -Wall -Werror -O2 -DTEMPDIR='"/tmp"'
                   1962: 
                   1963: .if ${BUILD_ONLY_CFLAGS:U:M*}
                   1964: pre-build-checks-hook: add-build-only-cflags
                   1965: 
                   1966: add-build-only-cflags: .PHONY
                   1967:         ${RUN} cd ${CWRAPPERS_CONFIG_DIR};      \
                   1968:         ${TEST} ! -f ${.TARGET} || exit 0;      \
                   1969:         for flag in ${BUILD_ONLY_CFLAGS}; do    \
                   1970:                 ${ECHO} "append=$$flag" >> cc;  \
                   1971:         done;                                   \
                   1972:         > ${.TARGET}
                   1973: .endif
                   1974: 
                   1975: (When editing the mk.conf, make sure that the commands of the
                   1976: add-build-only-cflags target are indented with a tab, not with spaces.)
                   1977: 
                   1978: The condition in the .if statement contains the :U modifier to prevent parse
                   1979: errors if the variable should be undefined, possibly because it is only defined
                   1980: for a subset of the packages. The :M* modifier ensures that there is at least
                   1981: one compiler option, to prevent a syntax error in the shell parser.
                   1982: 
                   1983: The code around the ${.TARGET} variable ensures that the additional compiler
                   1984: options are only appended once, even if bmake build is run multiple times. To
                   1985: do this, it creates a marker file.
                   1986: 
                   1987: To verify that this setup works, run bmake configure in a package directory. Up
                   1988: to now, everything works as usual. Examine the directory work/.cwrappers/config
                   1989: to see that the compiler options from BUILD_ONLY_CFLAGS are not yet added to
                   1990: the file cc. Examine the tail of the work/.work.log file to see that the normal
                   1991: compiler options are used.
                   1992: 
                   1993: Now run bmake build. This will append the options to the file cc and will
                   1994: create the marker file in the same directory. After that, the build starts as
                   1995: usual, but with the added compiler options. Examine the tail of the file work
                   1996: /.work.log to see that the lines starting with [*] don't contain the compiler
                   1997: options, but the corresponding lines starting with <.> do end with these
                   1998: options.
                   1999: 
                   2000: Building packages using this setup variant and fixing the resulting bugs is the
                   2001: same as in Section 8.4.2, "Detect classes of bugs by forcing compiler warnings"
                   2002: .
                   2003: 
                   2004: 8.4.4. Use custom directories
1.178     rillig   2005: 
                   2006: Some directories like PREFIX, VARBASE, PKG_SYSCONFDIR, PKGMANDIR, PKG_INFODIR
                   2007: can be configured in pkgsrc. Set these to arbitrary paths during bootstrap or
                   2008: afterwards in mk.conf.
                   2009: 
                   2010: PREFIX=         /a-random-uuid
                   2011: PKG_SYSCONFDIR= /a-random-uuid
                   2012: VARBASE=        /a-random-uuid
                   2013: PKGMANDIR=      a-random-uuid
                   2014: PKG_INFODIR=    a-random-uuid
                   2015: 
1.181     rillig   2016: 8.4.5. Turn warnings into errors
1.178     rillig   2017: 
                   2018: When building a package, warnings are typically ignored since they just flow by
                   2019: and do not cause the build to fail immediately. To find these warnings,
                   2020: redefine them to errors in mk.conf.
                   2021: 
                   2022: DELAYED_WARNING_MSG=    ${DELAYED_ERROR_MSG} "(was warning)"
                   2023: WARNING_MSG=            ${FAIL_MSG} "(was warning)"
                   2024: 
                   2025: (There are many more classes of warnings in pkgsrc, and most of them can be
                   2026: redefined with a simple definition like above.
                   2027: 
1.179     rillig   2028: If a package suggests to add USE_TOOLS+=perl to the package Makefile, research
1.178     rillig   2029: whether the package actually needs Perl. If it does, add USE_TOOLS+=perl to the
                   2030: package Makefile, and if it doesn't, add TOOLS_BROKEN+=perl.
                   2031: 
1.181     rillig   2032: 8.4.6. Reject packages for which pkglint reports errors
1.178     rillig   2033: 
                   2034: Using pkglint as part of the regular build process is mostly a waste of time.
                   2035: If you want to fix some of the warnings, just run pkglint recursively on the
                   2036: whole pkgsrc tree. This will take a few minutes (up to 10), which is much
                   2037: faster than a complete bulk build.
                   2038: 
1.181     rillig   2039: 8.4.7. Reject packages that contain forbidden strings
1.178     rillig   2040: 
                   2041: To ensure that the binary packages don't contain references to the build
                   2042: directory, there is already CHECK_WRKREF. If that variable includes the item
                   2043: extra, it is possible to define additional patterns that must not appear in any
                   2044: installed file. This is specified in mk.conf.
                   2045: 
                   2046: CHECK_WRKREF=                   extra
                   2047: CHECK_WRKREF_EXTRA_DIRS+=       /usr/local
                   2048: CHECK_WRKREF_EXTRA_DIRS+=       /usr/pkg
                   2049: CHECK_WRKREF_EXTRA_DIRS+=       @[A-Z][A-Z]*@
                   2050: 
                   2051: The above patterns will probably generate many false positives, therefore the
                   2052: results need to be taken with a grain of salt.
                   2053: 
1.181     rillig   2054: 8.4.8. Reject packages whose self-test fails
1.178     rillig   2055: 
                   2056: To run the test suites that come with each package, add this line to mk.conf.
                   2057: 
                   2058: PKGSRC_RUN_TEST=        yes
                   2059: 
                   2060: Be prepared that even the most basic packages fail this test. When doing a bulk
                   2061: build with this, it will often abort in the early phase where the packages are
                   2062: scanned for their dependencies since there are cyclic dependencies. There is
                   2063: still a lot to do in this area.
                   2064: 
1.181     rillig   2065: 8.4.9. Reject packages that use undefined shell variables
1.178     rillig   2066: 
                   2067: To catch typos in the shell snippets from the Makefile fragments, add the -u
                   2068: flag to most of the commands by adding this line to mk.conf.
                   2069: 
                   2070: RUN=    @set -eu;
                   2071: 
1.181     rillig   2072: After that, ensure that none of the bulk build log files (even those for
                   2073: successfully built packages) contains the string parameter not set or whatever
                   2074: error message the command sh -ceu '$undefined' outputs.
                   2075: 
1.178     rillig   2076: See mk/misc/common.mk for the existing definition.
                   2077: 
1.181     rillig   2078: 8.4.10. Turn off verbose logging
1.178     rillig   2079: 
                   2080: The build logs of a package are often quite long. This allows error messages or
                   2081: other interesting details to hide between the noise. To make the actual error
                   2082: message stand out more, add these lines to mk.conf.
                   2083: 
                   2084: GNU_CONFIGURE_QUIET=    yes
                   2085: MAKE_FLAGS+=            -s
                   2086: 
                   2087: The -s option works for both GNU Make and BSD Make. On exotic platforms with
                   2088: their own make, it may be a little different.
                   2089: 
                   2090: 8.5. Creating a multiple CD-ROM packages collection
1.1       dsieger  2091: 
                   2092: After your pkgsrc bulk-build has completed, you may wish to create a CD-ROM set
                   2093: of the resulting binary packages to assist in installing packages on other
                   2094: machines. The pkgtools/cdpack package provides a simple tool for creating the
                   2095: ISO 9660 images. cdpack arranges the packages on the CD-ROMs in a way that
                   2096: keeps all the dependencies for a given package on the same CD as that package.
                   2097: 
1.178     rillig   2098: 8.5.1. Example of cdpack
1.1       dsieger  2099: 
                   2100: Complete documentation for cdpack is found in the cdpack(1) man page. The
                   2101: following short example assumes that the binary packages are left in /usr/
                   2102: pkgsrc/packages/All and that sufficient disk space exists in /u2 to hold the
                   2103: ISO 9660 images.
                   2104: 
                   2105: # mkdir /u2/images
                   2106: # pkg_add /usr/pkgsrc/packages/All/cdpack
                   2107: # cdpack /usr/pkgsrc/packages/All /u2/images
                   2108: 
                   2109: 
                   2110: If you wish to include a common set of files (COPYRIGHT, README, etc.) on each
                   2111: CD in the collection, then you need to create a directory which contains these
1.175     gutterid 2112: files, e.g.:
1.1       dsieger  2113: 
                   2114: # mkdir /tmp/common
                   2115: # echo "This is a README" > /tmp/common/README
                   2116: # echo "Another file" > /tmp/common/COPYING
                   2117: # mkdir /tmp/common/bin
                   2118: # echo "#!/bin/sh" > /tmp/common/bin/myscript
                   2119: # echo "echo Hello world" >> /tmp/common/bin/myscript
                   2120: # chmod 755 /tmp/common/bin/myscript
                   2121: 
                   2122: 
                   2123: Now create the images:
                   2124: 
                   2125: # cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images
                   2126: 
                   2127: Each image will contain README, COPYING, and bin/myscript in their root
                   2128: directories.
                   2129: 
1.154     rillig   2130: Chapter 9. Directory layout of the installed files
1.1       dsieger  2131: 
                   2132: Table of Contents
                   2133: 
1.154     rillig   2134: 9.1. File system layout in ${LOCALBASE}
                   2135: 9.2. File system layout in ${VARBASE}
1.1       dsieger  2136: 
                   2137: The files that are installed by pkgsrc are organized in a way that is similar
                   2138: to what you find in the /usr directory of the base system. But some details are
                   2139: different. This is because pkgsrc initially came from FreeBSD and had adopted
                   2140: its file system hierarchy. Later it was largely influenced by NetBSD. But no
                   2141: matter which operating system you are using pkgsrc with, you can expect the
                   2142: same layout for pkgsrc.
                   2143: 
                   2144: There are mainly four root directories for pkgsrc, which are all configurable
                   2145: in the bootstrap/bootstrap script. When pkgsrc has been installed as root, the
                   2146: default locations are:
                   2147: 
                   2148: LOCALBASE=              /usr/pkg
                   2149: PKG_SYSCONFBASE=        /usr/pkg/etc
                   2150: VARBASE=                /var
1.119     sevan    2151: PKG_DBDIR=              /usr/pkg/pkgdb
1.1       dsieger  2152: 
                   2153: In unprivileged mode (when pkgsrc has been installed as any other user), the
                   2154: default locations are:
                   2155: 
                   2156: LOCALBASE=              ${HOME}/pkg
                   2157: PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   2158: VARBASE=                ${HOME}/pkg/var
1.119     sevan    2159: PKG_DBDIR=              ${HOME}/pkg/pkgdb
1.1       dsieger  2160: 
                   2161: What these four directories are for, and what they look like is explained
                   2162: below.
                   2163: 
1.25      wiz      2164:   * LOCALBASE corresponds to the /usr directory in the base system. It is the "
                   2165:     main" directory where the files are installed and contains the well-known
1.1       dsieger  2166:     subdirectories like bin, include, lib, share and sbin.
                   2167: 
                   2168:   * VARBASE corresponds to /var in the base system. Some programs (especially
                   2169:     games, network daemons) need write access to it during normal operation.
                   2170: 
                   2171:   * PKG_SYSCONFDIR corresponds to /etc in the base system. It contains
                   2172:     configuration files of the packages, as well as pkgsrc's mk.conf itself.
                   2173: 
1.154     rillig   2174: 9.1. File system layout in ${LOCALBASE}
1.1       dsieger  2175: 
                   2176: The following directories exist in a typical pkgsrc installation in $
                   2177: {LOCALBASE}.
                   2178: 
                   2179: bin
                   2180: 
                   2181:     Contains executable programs that are intended to be directly used by the
                   2182:     end user.
                   2183: 
                   2184: emul
                   2185: 
                   2186:     Contains files for the emulation layers of various other operating systems,
                   2187:     especially for NetBSD.
                   2188: 
                   2189: etc (the usual location of ${PKG_SYSCONFDIR})
                   2190: 
                   2191:     Contains the configuration files.
                   2192: 
                   2193: include
                   2194: 
                   2195:     Contains headers for the C and C++ programming languages.
                   2196: 
                   2197: info
                   2198: 
                   2199:     Contains GNU info files of various packages.
                   2200: 
                   2201: lib
                   2202: 
                   2203:     Contains shared and static libraries.
                   2204: 
                   2205: libdata
                   2206: 
                   2207:     Contains data files that don't change after installation. Other data files
                   2208:     belong into ${VARBASE}.
                   2209: 
                   2210: libexec
                   2211: 
                   2212:     Contains programs that are not intended to be used by end users, such as
                   2213:     helper programs or network daemons.
                   2214: 
                   2215: libexec/cgi-bin
                   2216: 
                   2217:     Contains programs that are intended to be executed as CGI scripts by a web
                   2218:     server.
                   2219: 
                   2220: man (the usual value of ${PKGMANDIR})
                   2221: 
                   2222:     Contains brief documentation in form of manual pages.
                   2223: 
                   2224: sbin
                   2225: 
                   2226:     Contains programs that are intended to be used only by the super-user.
                   2227: 
                   2228: share
                   2229: 
                   2230:     Contains platform-independent data files that don't change after
                   2231:     installation.
                   2232: 
                   2233: share/doc
                   2234: 
                   2235:     Contains documentation files provided by the packages.
                   2236: 
                   2237: share/examples
                   2238: 
                   2239:     Contains example files provided by the packages. Among others, the original
                   2240:     configuration files are saved here and copied to ${PKG_SYSCONFDIR} during
                   2241:     installation.
                   2242: 
                   2243: share/examples/rc.d
                   2244: 
                   2245:     Contains the original files for rc.d scripts.
                   2246: 
                   2247: var (the usual location of ${VARBASE})
                   2248: 
                   2249:     Contains files that may be modified after installation.
                   2250: 
1.154     rillig   2251: 9.2. File system layout in ${VARBASE}
1.1       dsieger  2252: 
                   2253: db/pkg (the usual location of ${PKG_DBDIR})
                   2254: 
                   2255:     Contains information about the currently installed packages.
                   2256: 
                   2257: games
                   2258: 
                   2259:     Contains highscore files.
                   2260: 
                   2261: log
                   2262: 
                   2263:     Contains log files.
                   2264: 
                   2265: run
                   2266: 
                   2267:     Contains informational files about daemons that are currently running.
                   2268: 
1.154     rillig   2269: Chapter 10. Frequently Asked Questions
1.1       dsieger  2270: 
                   2271: Table of Contents
                   2272: 
1.154     rillig   2273: 10.1. Are there any mailing lists for pkg-related discussion?
                   2274: 10.2. Utilities for package management (pkgtools)
                   2275: 10.3. How to use pkgsrc as non-root
                   2276: 10.4. How to resume transfers when fetching distfiles?
                   2277: 10.5. How can I install/use modular X.org from pkgsrc?
                   2278: 10.6. How to fetch files from behind a firewall
                   2279: 10.7. How to fetch files from HTTPS sites
                   2280: 10.8. How do I tell make fetch to do passive FTP?
                   2281: 10.9. How to fetch all distfiles at once
                   2282: 10.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean?
                   2283: 10.11. What does "Could not find bsd.own.mk" mean?
                   2284: 10.12. Using 'sudo' with pkgsrc
                   2285: 10.13. How do I change the location of configuration files?
                   2286: 10.14. Automated security checks
                   2287: 10.15. Why do some packages ignore my CFLAGS?
                   2288: 10.16. A package does not build. What shall I do?
                   2289: 10.17. What does "Makefile appears to contain unresolved cvs/rcs/??? merge
1.24      wiz      2290:     conflicts" mean?
1.1       dsieger  2291: 
                   2292: This section contains hints, tips & tricks on special things in pkgsrc that we
                   2293: didn't find a better place for in the previous chapters, and it contains items
                   2294: for both pkgsrc users and developers.
                   2295: 
1.154     rillig   2296: 10.1. Are there any mailing lists for pkg-related discussion?
1.1       dsieger  2297: 
                   2298: The following mailing lists may be of interest to pkgsrc users:
                   2299: 
                   2300:   * pkgsrc-users: This is a general purpose list for most issues regarding
                   2301:     pkgsrc, regardless of platform, e.g. soliciting user help for pkgsrc
                   2302:     configuration, unexpected build failures, using particular packages,
                   2303:     upgrading pkgsrc installations, questions regarding the pkgsrc release
                   2304:     branches, etc. General announcements or proposals for changes that impact
                   2305:     the pkgsrc user community, e.g. major infrastructure changes, new features,
                   2306:     package removals, etc., may also be posted.
                   2307: 
                   2308:   * pkgsrc-bulk: A list where the results of pkgsrc bulk builds are sent and
                   2309:     discussed.
                   2310: 
                   2311:   * pkgsrc-changes: This list is for those who are interested in getting a
                   2312:     commit message for every change committed to pkgsrc. It is also available
                   2313:     in digest form, meaning one daily message containing all commit messages
                   2314:     for changes to the package source tree in that 24 hour period.
                   2315: 
                   2316: To subscribe, do:
                   2317: 
                   2318: % echo subscribe listname | mail majordomo@NetBSD.org
                   2319: 
1.174     leot     2320: Archives for all these mailing lists are available from https://
1.1       dsieger  2321: mail-index.NetBSD.org/.
                   2322: 
1.154     rillig   2323: 10.2. Utilities for package management (pkgtools)
1.1       dsieger  2324: 
                   2325: The directory pkgsrc/pkgtools contains a number of useful utilities for both
                   2326: users and developers of pkgsrc. This section attempts only to make the reader
1.121     sevan    2327: aware of some of the utilities and when they might be useful, and not to
                   2328: duplicate the documentation that comes with each package.
1.1       dsieger  2329: 
                   2330: Utilities used by pkgsrc (automatically installed when needed):
                   2331: 
                   2332:   * pkgtools/x11-links: Symlinks for use by buildlink.
                   2333: 
                   2334: OS tool augmentation (automatically installed when needed):
                   2335: 
1.121     sevan    2336:   * pkgtools/digest: Calculates various kinds of checksums (including SHA3).
1.1       dsieger  2337: 
                   2338:   * pkgtools/libnbcompat: Compatibility library for pkgsrc tools.
                   2339: 
                   2340:   * pkgtools/mtree: Installed on non-BSD systems due to lack of native mtree.
                   2341: 
                   2342:   * pkgtools/pkg_install: Up-to-date replacement for /usr/sbin/pkg_install, or
                   2343:     for use on operating systems where pkg_install is not present.
                   2344: 
                   2345: Utilities used by pkgsrc (not automatically installed):
                   2346: 
                   2347:   * pkgtools/pkg_tarup: Create a binary package from an already-installed
                   2348:     package. Used by make replace to save the old package.
                   2349: 
                   2350:   * pkgtools/dfdisk: Adds extra functionality to pkgsrc, allowing it to fetch
                   2351:     distfiles from multiple locations. It currently supports the following
                   2352:     methods: multiple CD-ROMs and network FTP/HTTP connections.
                   2353: 
                   2354:   * devel/cpuflags: Determine the best compiler flags to optimise code for your
1.24      wiz      2355:     current CPU and compiler.
1.1       dsieger  2356: 
                   2357: Utilities for keeping track of installed packages, being up to date, etc:
                   2358: 
1.65      wiz      2359:   * pkgtools/pkgin: A package update tool similar to apt(1). Download, install,
                   2360:     and upgrade binary packages easily.
                   2361: 
1.1       dsieger  2362:   * pkgtools/pkg_chk: Reports on packages whose installed versions do not match
                   2363:     the latest pkgsrc entries.
                   2364: 
                   2365:   * pkgtools/pkgdep: Makes dependency graphs of packages, to aid in choosing a
                   2366:     strategy for updating.
                   2367: 
                   2368:   * pkgtools/pkgdepgraph: Makes graphs from the output of pkgtools/pkgdep (uses
                   2369:     graphviz).
                   2370: 
1.12      weinem   2371:   * pkgtools/pkglint: The pkglint(1) program checks a pkgsrc entry for errors.
                   2372: 
                   2373:   * pkgtools/lintpkgsrc: The lintpkgsrc(1) program does various checks on the
                   2374:     complete pkgsrc system.
1.1       dsieger  2375: 
                   2376:   * pkgtools/pkgsurvey: Report what packages you have installed.
                   2377: 
                   2378: Utilities for people maintaining or creating individual packages:
                   2379: 
                   2380:   * pkgtools/pkgdiff: Automate making and maintaining patches for a package
                   2381:     (includes pkgdiff, pkgvi, mkpatches, etc.).
                   2382: 
1.65      wiz      2383:   * pkgtools/url2pkg: Aids in converting to pkgsrc.
1.1       dsieger  2384: 
                   2385: Utilities for people maintaining pkgsrc (or: more obscure pkg utilities)
                   2386: 
                   2387:   * pkgtools/pkg_comp: Build packages in a chrooted area.
                   2388: 
                   2389:   * pkgtools/libkver: Spoof kernel version for chrooted cross builds.
                   2390: 
1.154     rillig   2391: 10.3. How to use pkgsrc as non-root
1.1       dsieger  2392: 
1.108     rillig   2393: To install packages from source as a non-root user, download pkgsrc as
1.154     rillig   2394: described in Chapter 3, Where to get pkgsrc and how to keep it up-to-date, cd
1.108     rillig   2395: into that directory and run the command ./bootstrap/bootstrap --unprivileged.
                   2396: 
                   2397: This will install the binary part of pkgsrc to ~/pkg and put the pkgsrc
                   2398: configuration mk.conf into ~/pkg/etc.
                   2399: 
                   2400: For more details, see mk/unprivileged.mk.
1.1       dsieger  2401: 
1.154     rillig   2402: 10.4. How to resume transfers when fetching distfiles?
1.1       dsieger  2403: 
                   2404: By default, resuming transfers in pkgsrc is disabled, but you can enable this
1.4       rillig   2405: feature by adding the option PKG_RESUME_TRANSFERS=YES into mk.conf. If, during
                   2406: a fetch step, an incomplete distfile is found, pkgsrc will try to resume it.
1.1       dsieger  2407: 
1.61      wiz      2408: You can also use a different program than the platform default program by
                   2409: changing the FETCH_USING variable. You can specify the program by using of ftp,
                   2410: fetch, wget or curl. Alternatively, fetching can be disabled by using the value
                   2411: manual. A value of custom disables the system defaults and dependency tracking
                   2412: for the fetch program. In that case you have to provide FETCH_CMD,
                   2413: FETCH_BEFORE_ARGS, FETCH_RESUME_ARGS, FETCH_OUTPUT_ARGS, FETCH_AFTER_ARGS.
1.1       dsieger  2414: 
1.16      jnemeth  2415: For example, if you want to use wget to download, you'll have to use something
                   2416: like:
1.1       dsieger  2417: 
1.16      jnemeth  2418: FETCH_USING=    wget
1.1       dsieger  2419: 
1.154     rillig   2420: 10.5. How can I install/use modular X.org from pkgsrc?
1.1       dsieger  2421: 
1.4       rillig   2422: If you want to use modular X.org from pkgsrc instead of your system's own X11
                   2423: (/usr/X11R6, /usr/openwin, ...) you will have to add the following line into
1.1       dsieger  2424: mk.conf:
                   2425: 
1.4       rillig   2426: X11_TYPE=modular
1.1       dsieger  2427: 
1.154     rillig   2428: 10.6. How to fetch files from behind a firewall
1.1       dsieger  2429: 
                   2430: If you are sitting behind a firewall which does not allow direct connections to
                   2431: Internet hosts (i.e. non-NAT), you may specify the relevant proxy hosts. This
                   2432: is done using an environment variable in the form of a URL, e.g. in Amdahl, the
                   2433: machine "orpheus.amdahl.com" is one of the firewalls, and it uses port 80 as
                   2434: the proxy port number. So the proxy environment variables are:
                   2435: 
                   2436: ftp_proxy=ftp://orpheus.amdahl.com:80/
                   2437: http_proxy=http://orpheus.amdahl.com:80/
                   2438: 
1.154     rillig   2439: 10.7. How to fetch files from HTTPS sites
1.65      wiz      2440: 
                   2441: Some fetch tools are not prepared to support HTTPS by default (for example, the
                   2442: one in NetBSD 6.0), or the one installed by the pkgsrc bootstrap (to avoid an
                   2443: openssl dependency that low in the dependency graph).
                   2444: 
                   2445: Usually you won't notice, because distribution files are mirrored weekly to "
                   2446: ftp.NetBSD.org", but that might not be often enough if you are following
                   2447: pkgsrc-current. In that case, set FETCH_USING in your mk.conf file to "curl" or
                   2448: "wget", which are both compiled with HTTPS support by default. Of course, these
                   2449: tools need to be installed before you can use them this way.
                   2450: 
1.154     rillig   2451: 10.8. How do I tell make fetch to do passive FTP?
1.1       dsieger  2452: 
                   2453: This depends on which utility is used to retrieve distfiles. From bsd.pkg.mk,
                   2454: FETCH_CMD is assigned the first available command from the following list:
                   2455: 
                   2456:   * ${LOCALBASE}/bin/ftp
                   2457: 
                   2458:   * /usr/bin/ftp
                   2459: 
                   2460: On a default NetBSD installation, this will be /usr/bin/ftp, which
                   2461: automatically tries passive connections first, and falls back to active
                   2462: connections if the server refuses to do passive. For the other tools, add the
1.4       rillig   2463: following to your mk.conf file: PASSIVE_FETCH=1.
1.1       dsieger  2464: 
                   2465: Having that option present will prevent /usr/bin/ftp from falling back to
                   2466: active transfers.
                   2467: 
1.154     rillig   2468: 10.9. How to fetch all distfiles at once
1.1       dsieger  2469: 
                   2470: You would like to download all the distfiles in a single batch from work or
                   2471: university, where you can't run a make fetch. There is an archive of distfiles
                   2472: on ftp.NetBSD.org, but downloading the entire directory may not be appropriate.
                   2473: 
                   2474: The answer here is to do a make fetch-list in /usr/pkgsrc or one of its
                   2475: subdirectories, carry the resulting list to your machine at work/school and use
                   2476: it there. If you don't have a NetBSD-compatible ftp(1) (like tnftp) at work,
                   2477: don't forget to set FETCH_CMD to something that fetches a URL:
                   2478: 
                   2479: At home:
                   2480: 
                   2481: % cd /usr/pkgsrc
                   2482: % make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh
                   2483: % scp /tmp/fetch.sh work:/tmp
                   2484: 
                   2485: At work:
                   2486: 
                   2487: % sh /tmp/fetch.sh
                   2488: 
                   2489: then tar up /tmp/distfiles and take it home.
                   2490: 
                   2491: If you have a machine running NetBSD, and you want to get all distfiles (even
                   2492: ones that aren't for your machine architecture), you can do so by using the
                   2493: above-mentioned make fetch-list approach, or fetch the distfiles directly by
                   2494: running:
                   2495: 
                   2496: % make mirror-distfiles
                   2497: 
                   2498: If you even decide to ignore NO_{SRC,BIN}_ON_{FTP,CDROM}, then you can get
                   2499: everything by running:
                   2500: 
                   2501: % make fetch NO_SKIP=yes
                   2502: 
1.154     rillig   2503: 10.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean?
1.1       dsieger  2504: 
                   2505: When compiling the pkgtools/pkg_install package, you get the error from make
                   2506: that it doesn't know how to make /usr/share/tmac/tmac.andoc? This indicates
                   2507: that you don't have installed the "text" set (nroff, ...) from the NetBSD base
                   2508: distribution on your machine. It is recommended to do that to format man pages.
                   2509: 
                   2510: In the case of the pkgtools/pkg_install package, you can get away with setting
1.4       rillig   2511: NOMAN=YES either in the environment or in mk.conf.
1.1       dsieger  2512: 
1.154     rillig   2513: 10.11. What does "Could not find bsd.own.mk" mean?
1.1       dsieger  2514: 
                   2515: You didn't install the compiler set, comp.tgz, when you installed your NetBSD
                   2516: machine. Please get and install it, by extracting it in /:
                   2517: 
                   2518: # cd /
                   2519: # tar --unlink -zxvpf .../comp.tgz
                   2520: 
                   2521: comp.tgz is part of every NetBSD release. Get the one that corresponds to your
                   2522: release (determine via uname -r).
                   2523: 
1.154     rillig   2524: 10.12. Using 'sudo' with pkgsrc
1.1       dsieger  2525: 
                   2526: When installing packages as non-root user and using the just-in-time su(1)
                   2527: feature of pkgsrc, it can become annoying to type in the root password for each
                   2528: required package installed. To avoid this, the sudo package can be used, which
                   2529: does password caching over a limited time. To use it, install sudo (either as
1.4       rillig   2530: binary package or from security/sudo) and then put the following into your
                   2531: mk.conf, somewhere after the definition of the LOCALBASE variable:
1.1       dsieger  2532: 
                   2533: .if exists(${LOCALBASE}/bin/sudo)
                   2534: SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
                   2535: .endif
                   2536: 
1.154     rillig   2537: 10.13. How do I change the location of configuration files?
1.1       dsieger  2538: 
                   2539: As the system administrator, you can choose where configuration files are
                   2540: installed. The default settings make all these files go into ${PREFIX}/etc or
                   2541: some of its subdirectories; this may be suboptimal depending on your
                   2542: expectations (e.g., a read-only, NFS-exported PREFIX with a need of per-machine
                   2543: configuration of the provided packages).
                   2544: 
                   2545: In order to change the defaults, you can modify the PKG_SYSCONFBASE variable
1.4       rillig   2546: (in mk.conf) to point to your preferred configuration directory; some common
                   2547: examples include /etc or /etc/pkg.
1.1       dsieger  2548: 
                   2549: Furthermore, you can change this value on a per-package basis by setting the
                   2550: PKG_SYSCONFDIR.${PKG_SYSCONFVAR} variable. PKG_SYSCONFVAR's value usually
                   2551: matches the name of the package you would like to modify, that is, the contents
                   2552: of PKGBASE.
                   2553: 
                   2554: Note that after changing these settings, you must rebuild and reinstall any
                   2555: affected packages.
                   2556: 
1.154     rillig   2557: 10.14. Automated security checks
1.1       dsieger  2558: 
                   2559: Please be aware that there can often be bugs in third-party software, and some
                   2560: of these bugs can leave a machine vulnerable to exploitation by attackers. In
                   2561: an effort to lessen the exposure, the NetBSD packages team maintains a database
                   2562: of known-exploits to packages which have at one time been included in pkgsrc.
                   2563: The database can be downloaded automatically, and a security audit of all
1.14      jmcneill 2564: packages installed on a system can take place. To do this, refer to the
                   2565: following two tools (installed as part of the pkgtools/pkg_install package):
1.1       dsieger  2566: 
1.21      snj      2567:  1. pkg_admin fetch-pkg-vulnerabilities, an easy way to download a list of the
                   2568:     security vulnerabilities information. This list is kept up to date by the
1.26      spz      2569:     pkgsrc security team, and is distributed from the NetBSD ftp server:
1.1       dsieger  2570: 
1.177     leot     2571:     https://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities
1.1       dsieger  2572: 
1.21      snj      2573:  2. pkg_admin audit, an easy way to audit the current machine, checking each
1.24      wiz      2574:     known vulnerability. If a vulnerable package is installed, it will be shown
                   2575:     by output to stdout, including a description of the type of vulnerability,
                   2576:     and a URL containing more information.
1.1       dsieger  2577: 
1.154     rillig   2578: Use of these tools is strongly recommended! See Section 5.1.5, "Checking for
1.121     sevan    2579: security vulnerabilities in installed packages" for instructions on how to
                   2580: automate checking and reporting.
                   2581: 
                   2582: If this database is installed, pkgsrc builds will use it to perform a security
                   2583: check before building any package.
1.1       dsieger  2584: 
1.154     rillig   2585: 10.15. Why do some packages ignore my CFLAGS?
1.1       dsieger  2586: 
                   2587: When you add your own preferences to the CFLAGS variable in your mk.conf, these
                   2588: flags are passed in environment variables to the ./configure scripts and to
                   2589: make(1). Some package authors ignore the CFLAGS from the environment variable
                   2590: by overriding them in the Makefiles of their package.
                   2591: 
                   2592: Currently there is no solution to this problem. If you really need the package
                   2593: to use your CFLAGS you should run make patch in the package directory and then
                   2594: inspect any Makefile and Makefile.in for whether they define CFLAGS explicitly.
                   2595: Usually you can remove these lines. But be aware that some "smart" programmers
                   2596: write so bad code that it only works for the specific combination of CFLAGS
                   2597: they have chosen.
                   2598: 
1.172     rillig   2599: To find out where the CFLAGS are ignored, add the following lines to mk.conf:
                   2600: 
                   2601: CPPFLAGS+=              -Dpkgsrc___CPPFLAGS
                   2602: CFLAGS+=                -Dpkgsrc___CFLAGS
                   2603: CXXFLAGS+=              -Dpkgsrc___CXXFLAGS
                   2604: 
                   2605: Then run bmake show-all-configure show-all-build to see whether the above flags
                   2606: are passed to the actual build commands in general.
                   2607: 
                   2608: To find out whether the flags are passed to individual compiler commands, have
                   2609: a look at the file work/.work.log. In most cases, the flags from the original
                   2610: command lines (the lines starting with [*]) are passed unmodified to the actual
                   2611: compiler (the lines starting with <.>). If the flag is missing from the actual
                   2612: compiler command, it must have been removed by the pkgsrc compiler wrappers.
                   2613: 
1.154     rillig   2614: 10.16. A package does not build. What shall I do?
1.1       dsieger  2615: 
                   2616:  1. Make sure that your copy of pkgsrc is consistent. A case that occurs often
                   2617:     is that people only update pkgsrc in parts, because of performance reasons.
                   2618:     Since pkgsrc is one large system, not a collection of many small systems,
                   2619:     there are sometimes changes that only work when the whole pkgsrc tree is
                   2620:     updated.
                   2621: 
1.25      wiz      2622:  2. Make sure that you don't have any CVS conflicts. Search for "<<<<<<" or "
                   2623:     >>>>>>" in all your pkgsrc files.
1.1       dsieger  2624: 
1.25      wiz      2625:  3. Make sure that you don't have old copies of the packages extracted. Run 
1.1       dsieger  2626:     make clean clean-depends to verify this.
                   2627: 
1.108     rillig   2628:  4. If you are a package developer who wants to invest some work, have a look
1.154     rillig   2629:     at Chapter 21, Making your package work.
1.108     rillig   2630: 
                   2631:  5. If the problem still exists, write a mail to the pkgsrc-users mailing list.
1.1       dsieger  2632: 
1.154     rillig   2633: 10.17. What does "Makefile appears to contain unresolved cvs/rcs/??? merge
1.1       dsieger  2634: conflicts" mean?
                   2635: 
                   2636: You have modified a file from pkgsrc, and someone else has modified that same
                   2637: file afterwards in the CVS repository. Both changes are in the same region of
                   2638: the file, so when you updated pkgsrc, the cvs command marked the conflicting
                   2639: changes in the file. Because of these markers, the file is no longer a valid
                   2640: Makefile.
                   2641: 
                   2642: Have a look at that file, and if you don't need your local changes anymore, you
                   2643: can remove that file and run cvs -q update -dP in that directory to download
                   2644: the current version.
                   2645: 
                   2646: Part II. The pkgsrc developer's guide
                   2647: 
                   2648: This part of the book deals with creating and modifying packages. It starts
                   2649: with a "HOWTO"-like guide on creating a new package. The remaining chapters are
                   2650: more like a reference manual for pkgsrc.
                   2651: 
                   2652: Table of Contents
                   2653: 
1.154     rillig   2654: 11. Getting help
1.184     rillig   2655: 12. Package components - files, directories and contents
1.1       dsieger  2656: 
1.184     rillig   2657:     12.1. Makefile
                   2658:     12.2. distinfo
                   2659:     12.3. patches/*
1.1       dsieger  2660: 
1.184     rillig   2661:         12.3.1. Structure of a single patch file
                   2662:         12.3.2. Creating patch files
                   2663:         12.3.3. Sources where the patch files come from
                   2664:         12.3.4. Patching guidelines
                   2665:         12.3.5. Feedback to the author
1.1       dsieger  2666: 
1.184     rillig   2667:     12.4. Other mandatory files
                   2668:     12.5. Optional files
1.1       dsieger  2669: 
1.184     rillig   2670:         12.5.1. Files affecting the binary package
                   2671:         12.5.2. Files affecting the build process
                   2672:         12.5.3. Files affecting nothing at all
1.1       dsieger  2673: 
1.184     rillig   2674:     12.6. work*
                   2675:     12.7. files/*
1.1       dsieger  2676: 
1.184     rillig   2677: 13. The build process
1.1       dsieger  2678: 
1.184     rillig   2679:     13.1. Introduction
                   2680:     13.2. Program location
                   2681:     13.3. Directories used during the build process
                   2682:     13.4. Running a phase
                   2683:     13.5. The fetch phase
1.1       dsieger  2684: 
1.184     rillig   2685:         13.5.1. What to fetch and where to get it from
                   2686:         13.5.2. How are the files fetched?
1.1       dsieger  2687: 
1.184     rillig   2688:     13.6. The checksum phase
                   2689:     13.7. The extract phase
                   2690:     13.8. The patch phase
                   2691:     13.9. The tools phase
                   2692:     13.10. The wrapper phase
                   2693:     13.11. The configure phase
                   2694:     13.12. The build phase
                   2695:     13.13. The test phase
                   2696:     13.14. The install phase
                   2697:     13.15. The package phase
                   2698:     13.16. Cleaning up
                   2699:     13.17. Other helpful targets
1.1       dsieger  2700: 
1.184     rillig   2701: 14. Creating a new pkgsrc package from scratch
1.1       dsieger  2702: 
1.184     rillig   2703:     14.1. Common types of packages
1.1       dsieger  2704: 
1.184     rillig   2705:         14.1.1. Perl modules
                   2706:         14.1.2. Python modules and programs
                   2707:         14.1.3. R packages
                   2708:         14.1.4. TeXlive packages
1.1       dsieger  2709: 
1.184     rillig   2710:     14.2. Examples
1.1       dsieger  2711: 
1.184     rillig   2712:         14.2.1. How the www/nvu package came into pkgsrc
1.1       dsieger  2713: 
1.184     rillig   2714: 15. Programming in Makefiles
1.1       dsieger  2715: 
1.184     rillig   2716:     15.1. Caveats
                   2717:     15.2. Makefile variables
1.1       dsieger  2718: 
1.184     rillig   2719:         15.2.1. Naming conventions
1.1       dsieger  2720: 
1.184     rillig   2721:     15.3. Code snippets
1.1       dsieger  2722: 
1.184     rillig   2723:         15.3.1. Adding things to a list
                   2724:         15.3.2. Echoing a string exactly as-is
                   2725:         15.3.3. Passing CFLAGS to GNU configure scripts
                   2726:         15.3.4. Handling possibly empty variables
1.1       dsieger  2727: 
1.184     rillig   2728: 16. Options handling
1.1       dsieger  2729: 
1.184     rillig   2730:     16.1. Global default options
                   2731:     16.2. Converting packages to use bsd.options.mk
                   2732:     16.3. Option Names
                   2733:     16.4. Determining the options of dependencies
1.1       dsieger  2734: 
1.184     rillig   2735: 17. Tools needed for building or running
1.1       dsieger  2736: 
1.184     rillig   2737:     17.1. Tools for pkgsrc builds
                   2738:     17.2. Tools needed by packages
                   2739:     17.3. Tools provided by platforms
1.1       dsieger  2740: 
1.184     rillig   2741: 18. Buildlink methodology
1.1       dsieger  2742: 
1.184     rillig   2743:     18.1. Converting packages to use buildlink3
                   2744:     18.2. Writing buildlink3.mk files
1.1       dsieger  2745: 
1.184     rillig   2746:         18.2.1. Anatomy of a buildlink3.mk file
                   2747:         18.2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS.
                   2748:             pkg in buildlink3.mk files
1.1       dsieger  2749: 
1.184     rillig   2750:     18.3. Writing builtin.mk files
1.1       dsieger  2751: 
1.184     rillig   2752:         18.3.1. Anatomy of a builtin.mk file
                   2753:         18.3.2. Global preferences for native or pkgsrc software
1.1       dsieger  2754: 
1.184     rillig   2755: 19. PLIST issues
1.1       dsieger  2756: 
1.184     rillig   2757:     19.1. RCS ID
                   2758:     19.2. Semi-automatic PLIST generation
                   2759:     19.3. Tweaking output of make print-PLIST
                   2760:     19.4. Variable substitution in PLIST
                   2761:     19.5. Man page compression
                   2762:     19.6. Changing PLIST source with PLIST_SRC
                   2763:     19.7. Platform-specific and differing PLISTs
                   2764:     19.8. Build-specific PLISTs
                   2765:     19.9. Sharing directories between packages
1.1       dsieger  2766: 
1.184     rillig   2767: 20. The pkginstall framework
1.1       dsieger  2768: 
1.184     rillig   2769:     20.1. Files and directories outside the installation prefix
1.1       dsieger  2770: 
1.184     rillig   2771:         20.1.1. Directory manipulation
                   2772:         20.1.2. File manipulation
1.1       dsieger  2773: 
1.184     rillig   2774:     20.2. Configuration files
1.1       dsieger  2775: 
1.184     rillig   2776:         20.2.1. How PKG_SYSCONFDIR is set
                   2777:         20.2.2. Telling the software where configuration files are
                   2778:         20.2.3. Patching installations
                   2779:         20.2.4. Disabling handling of configuration files
1.1       dsieger  2780: 
1.184     rillig   2781:     20.3. System startup scripts
1.1       dsieger  2782: 
1.184     rillig   2783:         20.3.1. Disabling handling of system startup scripts
1.1       dsieger  2784: 
1.184     rillig   2785:     20.4. System users and groups
                   2786:     20.5. System shells
1.1       dsieger  2787: 
1.184     rillig   2788:         20.5.1. Disabling shell registration
1.1       dsieger  2789: 
1.184     rillig   2790:     20.6. Fonts
1.1       dsieger  2791: 
1.184     rillig   2792:         20.6.1. Disabling automatic update of the fonts databases
1.1       dsieger  2793: 
1.154     rillig   2794: 21. Making your package work
1.1       dsieger  2795: 
1.154     rillig   2796:     21.1. General operation
1.1       dsieger  2797: 
1.154     rillig   2798:         21.1.1. How to pull in user-settable variables from mk.conf
                   2799:         21.1.2. User interaction
                   2800:         21.1.3. Handling licenses
                   2801:         21.1.4. Restricted packages
                   2802:         21.1.5. Handling dependencies
                   2803:         21.1.6. Handling conflicts with other packages
                   2804:         21.1.7. Packages that cannot or should not be built
                   2805:         21.1.8. Packages which should not be deleted, once installed
                   2806:         21.1.9. Handling packages with security problems
                   2807:         21.1.10. How to handle incrementing versions when fixing an existing
1.1       dsieger  2808:             package
1.154     rillig   2809:         21.1.11. Substituting variable text in the package files (the SUBST
1.1       dsieger  2810:             framework)
                   2811: 
1.154     rillig   2812:     21.2. The fetch phase
1.1       dsieger  2813: 
1.154     rillig   2814:         21.2.1. Packages whose distfiles aren't available for plain downloading
                   2815:         21.2.2. How to handle modified distfiles with the 'old' name
                   2816:         21.2.3. Packages hosted on github.com
                   2817: 
                   2818:     21.3. The configure phase
                   2819: 
                   2820:         21.3.1. Shared libraries - libtool
                   2821:         21.3.2. Using libtool on GNU packages that already support libtool
                   2822:         21.3.3. GNU Autoconf/Automake
                   2823: 
                   2824:     21.4. Programming languages
                   2825: 
                   2826:         21.4.1. C, C++, and Fortran
                   2827:         21.4.2. Java
                   2828:         21.4.3. Packages containing perl scripts
                   2829:         21.4.4. Packages containing shell scripts
                   2830:         21.4.5. Other programming languages
                   2831: 
                   2832:     21.5. The build phase
                   2833: 
                   2834:         21.5.1. Compiling C and C++ code conditionally
                   2835:         21.5.2. How to handle compiler bugs
1.172     rillig   2836:         21.5.3. No such file or directory
                   2837:         21.5.4. Undefined reference to "..."
                   2838:         21.5.5. Running out of memory
1.154     rillig   2839: 
                   2840:     21.6. The install phase
                   2841: 
                   2842:         21.6.1. Creating needed directories
                   2843:         21.6.2. Where to install documentation
                   2844:         21.6.3. Installing highscore files
                   2845:         21.6.4. Adding DESTDIR support to packages
                   2846:         21.6.5. Packages with hardcoded paths to other interpreters
                   2847:         21.6.6. Packages installing perl modules
                   2848:         21.6.7. Packages installing info files
                   2849:         21.6.8. Packages installing man pages
                   2850:         21.6.9. Packages installing GConf data files
                   2851:         21.6.10. Packages installing scrollkeeper/rarian data files
                   2852:         21.6.11. Packages installing X11 fonts
                   2853:         21.6.12. Packages installing GTK2 modules
                   2854:         21.6.13. Packages installing SGML or XML data
                   2855:         21.6.14. Packages installing extensions to the MIME database
                   2856:         21.6.15. Packages using intltool
                   2857:         21.6.16. Packages installing startup scripts
                   2858:         21.6.17. Packages installing TeX modules
                   2859:         21.6.18. Packages supporting running binaries in emulation
                   2860:         21.6.19. Packages installing hicolor theme icons
                   2861:         21.6.20. Packages installing desktop files
                   2862: 
                   2863:     21.7. Marking packages as having problems
                   2864: 
1.184     rillig   2865: 22. GNOME packaging and porting
                   2866: 
                   2867:     22.1. Meta packages
                   2868:     22.2. Packaging a GNOME application
                   2869:     22.3. Updating GNOME to a newer version
                   2870:     22.4. Patching guidelines
                   2871: 
1.154     rillig   2872: 23. Submitting and Committing
                   2873: 
                   2874:     23.1. Submitting binary packages
                   2875:     23.2. Submitting source packages (for non-NetBSD-developers)
                   2876:     23.3. General notes when adding, updating, or removing packages
                   2877:     23.4. Commit Messages
                   2878:     23.5. Committing: Adding a package to CVS
                   2879:     23.6. Updating a package to a newer version
                   2880:     23.7. Renaming a package in pkgsrc
                   2881:     23.8. Moving a package in pkgsrc
                   2882: 
                   2883: 24. Frequently Asked Questions
                   2884: 
                   2885: Chapter 11. Getting help
                   2886: 
                   2887: To get help when developing pkgsrc, the definitive source is this document, the
                   2888: pkgsrc guide. If you don't find anything here, there are alternatives:
                   2889: 
                   2890:   * The built-in pkgsrc help, which is available after bootstrapping pkgsrc.
                   2891:     Run bmake help topic=? to get help for any topic, such as a variable name
                   2892:     like BUILD_DEFS, a make target like do-build, a missing C or C++ function
                   2893:     like strcasecmp or any other topic.
                   2894: 
                   2895:     The available help topics are listed in Appendix D, Help topics.
                   2896: 
1.163     rillig   2897:   * To see the value of a single variable, run bmake show-var VARNAME=X.
                   2898: 
                   2899:   * To see the values of the most common variables, run bmake show-all. These
                   2900:     variables are grouped by topic. To see the variables for a single topic,
                   2901:     run bmake show-all-topic, for example bmake show-all-fetch.
                   2902: 
1.154     rillig   2903:   * The tech-pkg mailing list, to which you can subscribe and then ask your
                   2904:     questions.
                   2905: 
                   2906:   * The #pkgsrc IRC channel, which is accessible via a web browser or by using
                   2907:     a specialized chat program such as XChat. Pick any user name and join the
                   2908:     channel #pkgsrc.
1.1       dsieger  2909: 
1.184     rillig   2910: Chapter 12. Package components - files, directories and contents
1.1       dsieger  2911: 
                   2912: Table of Contents
                   2913: 
1.184     rillig   2914: 12.1. Makefile
                   2915: 12.2. distinfo
                   2916: 12.3. patches/*
                   2917: 
                   2918:     12.3.1. Structure of a single patch file
                   2919:     12.3.2. Creating patch files
                   2920:     12.3.3. Sources where the patch files come from
                   2921:     12.3.4. Patching guidelines
                   2922:     12.3.5. Feedback to the author
                   2923: 
                   2924: 12.4. Other mandatory files
                   2925: 12.5. Optional files
                   2926: 
                   2927:     12.5.1. Files affecting the binary package
                   2928:     12.5.2. Files affecting the build process
                   2929:     12.5.3. Files affecting nothing at all
1.1       dsieger  2930: 
1.184     rillig   2931: 12.6. work*
                   2932: 12.7. files/*
1.1       dsieger  2933: 
1.184     rillig   2934: Whenever you're preparing a package, there are a number of files involved which
                   2935: are described in the following sections.
1.1       dsieger  2936: 
1.184     rillig   2937: 12.1. Makefile
1.1       dsieger  2938: 
1.184     rillig   2939: Building, installation and creation of a binary package are all controlled by
                   2940: the package's Makefile. The Makefile describes various things about a package,
                   2941: for example from where to get it, how to configure, build, and install it.
1.1       dsieger  2942: 
1.184     rillig   2943: A package Makefile contains several sections that describe the package.
1.1       dsieger  2944: 
1.184     rillig   2945: In the first section there are the following variables, which should appear
                   2946: exactly in the order given here. The order and grouping of the variables is
                   2947: mostly historical and has no further meaning.
1.1       dsieger  2948: 
1.184     rillig   2949:   * DISTNAME is the basename of the distribution file to be downloaded from the
                   2950:     package's website.
1.1       dsieger  2951: 
1.184     rillig   2952:   * PKGNAME is the name of the package, as used by pkgsrc. You need to provide
                   2953:     it if DISTNAME (which is the default) is not a good name for the package in
                   2954:     pkgsrc or DISTNAME is not provided (no distribution file is required).
                   2955:     Usually it is the pkgsrc directory name together with the version number.
                   2956:     It must match the regular expression ^[A-Za-z0-9][A-Za-z0-9-_.+]*$, that
                   2957:     is, it starts with a letter or digit, and contains only letters, digits,
                   2958:     dashes, underscores, dots and plus signs.
1.26      spz      2959: 
1.184     rillig   2960:   * CATEGORIES is a list of categories which the package fits in. You can
                   2961:     choose any of the top-level directories of pkgsrc for it.
1.1       dsieger  2962: 
1.184     rillig   2963:     Currently the following values are available for CATEGORIES. If more than
                   2964:     one is used, they need to be separated by spaces:
1.1       dsieger  2965: 
1.184     rillig   2966:     archivers     cross         geography     meta-pkgs     security
                   2967:     audio         databases     graphics      misc          shells
                   2968:     benchmarks    devel         ham           multimedia    sysutils
                   2969:     biology       editors       inputmethod   net           textproc
                   2970:     cad           emulators     lang          news          time
                   2971:     chat          finance       mail          parallel      wm
                   2972:     comms         fonts         math          pkgtools      www
                   2973:     converters    games         mbone         print         x11
1.1       dsieger  2974: 
1.184     rillig   2975:   * MASTER_SITES, DYNAMIC_MASTER_SITES, DIST_SUBDIR, EXTRACT_SUFX and DISTFILES
                   2976:     are discussed in detail in Section 13.5, "The fetch phase".
1.1       dsieger  2977: 
1.184     rillig   2978: The second section contains information about separately downloaded patches, if
                   2979: any.
1.1       dsieger  2980: 
1.184     rillig   2981:   * PATCHFILES: Name(s) of additional files that contain distribution patches.
                   2982:     There is no default. pkgsrc will look for them at PATCH_SITES. They will
                   2983:     automatically be uncompressed before patching if the names end with .gz or
                   2984:     .Z.
1.1       dsieger  2985: 
1.184     rillig   2986:   * PATCH_SITES: Primary location(s) for distribution patch files (see
                   2987:     PATCHFILES above) if not found locally.
1.1       dsieger  2988: 
1.184     rillig   2989:   * PATCH_DIST_STRIP: an argument to patch(1) that sets the pathname strip
                   2990:     count to help find the correct files to patch. It defaults to -p0.
1.1       dsieger  2991: 
1.184     rillig   2992: The third section contains the following variables.
1.1       dsieger  2993: 
1.184     rillig   2994:   * MAINTAINER is the email address of the person who feels responsible for
                   2995:     this package, and who is most likely to look at problems or questions
                   2996:     regarding this package which have been reported with send-pr(1). Other
                   2997:     developers may contact the MAINTAINER before making changes to the package,
                   2998:     but are not required to do so. When packaging a new program, set MAINTAINER
                   2999:     to yourself. If you really can't maintain the package for future updates,
                   3000:     set it to <pkgsrc-users@NetBSD.org>.
1.1       dsieger  3001: 
1.184     rillig   3002:   * OWNER should be used instead of MAINTAINER when you do not want other
                   3003:     developers to update or change the package without contacting you first. A
                   3004:     package Makefile should contain one of MAINTAINER or OWNER, but not both.
1.1       dsieger  3005: 
1.184     rillig   3006:   * HOMEPAGE is a URL where users can find more information about the package.
1.1       dsieger  3007: 
1.184     rillig   3008:   * COMMENT is a one-line description of the package (should not include the
                   3009:     package name).
1.1       dsieger  3010: 
1.184     rillig   3011:   * LICENSE indicates the license(s) applicable for the package. See
                   3012:     Section 21.1.3, "Handling licenses" for further details.
1.1       dsieger  3013: 
1.184     rillig   3014: Other variables that affect the build:
1.1       dsieger  3015: 
1.184     rillig   3016:   * WRKSRC: The directory where the interesting distribution files of the
                   3017:     package are found. The default is ${WRKDIR}/${DISTNAME}, which works for
                   3018:     most packages.
1.1       dsieger  3019: 
1.184     rillig   3020:     If a package doesn't create a subdirectory for itself (most GNU software
                   3021:     does, for instance), but extracts itself in the current directory, you
                   3022:     should set WRKSRC=${WRKDIR}.
1.1       dsieger  3023: 
1.184     rillig   3024:     If a package doesn't create a subdirectory with the name of DISTNAME but
                   3025:     some different name, set WRKSRC to point to the proper name in ${WRKDIR},
                   3026:     for example WRKSRC=${WRKDIR}/${DISTNAME}/unix. See lang/tcl and x11/tk for
                   3027:     other examples.
1.17      imil     3028: 
1.184     rillig   3029:     The name of the working directory created by pkgsrc is taken from the
                   3030:     WRKDIR_BASENAME variable. By default, its value is work. If you want to use
                   3031:     the same pkgsrc tree for building different kinds of binary packages, you
                   3032:     can change the variable according to your needs. Two other variables handle
                   3033:     common cases of setting WRKDIR_BASENAME individually. If OBJHOSTNAME is
                   3034:     defined in mk.conf, the first component of the host's name is attached to
                   3035:     the directory name. If OBJMACHINE is defined, the platform name is
                   3036:     attached, which might look like work.i386 or work.sparc.
1.17      imil     3037: 
1.184     rillig   3038: Please pay attention to the following gotchas:
1.17      imil     3039: 
1.184     rillig   3040:   * Add MANCOMPRESSED if man pages are installed in compressed form by the
                   3041:     package. For packages using BSD-style makefiles which honor MANZ, there is
                   3042:     MANCOMPRESSED_IF_MANZ.
1.17      imil     3043: 
1.184     rillig   3044:   * Replace /usr/local with "${PREFIX}" in all files (see patches, below).
1.103     wiz      3045: 
1.184     rillig   3046:   * If the package installs any info files, see Section 21.6.7, "Packages
                   3047:     installing info files".
1.103     wiz      3048: 
1.184     rillig   3049: 12.2. distinfo
1.17      imil     3050: 
1.184     rillig   3051: The distinfo file contains the message digest, or checksum, of each distfile
                   3052: needed for the package. This ensures that the distfiles retrieved from the
                   3053: Internet have not been corrupted during transfer or altered by a malign force
                   3054: to introduce a security hole. To provide maximum security, all distfiles are
                   3055: protected using three different message digest algorithms (SHA1, RMD160,
                   3056: SHA512), as well as the file size.
1.17      imil     3057: 
1.184     rillig   3058: The distinfo file also contains the checksums for all the patches found in the
                   3059: patches directory (see Section 12.3, "patches/*"). These checksums ensure that
                   3060: patches are only applied intentionally and that they don't accidentally change,
                   3061: e.g. when merging different changes together. They also make sure that new
                   3062: patches are actually added to CVS and old ones are removed. Too see whether the
                   3063: patches and the distinfo file match, run pkglint after changing the patches.
1.17      imil     3064: 
1.184     rillig   3065: To regenerate the distinfo file, use the make distinfo command.
1.17      imil     3066: 
1.184     rillig   3067: Some packages have different sets of distfiles depending on the platform, for
                   3068: example lang/openjdk8. These are kept in the same distinfo file and care should
                   3069: be taken when upgrading such a package to ensure distfile information is not
                   3070: lost.
1.17      imil     3071: 
1.184     rillig   3072: 12.3. patches/*
1.63      wiz      3073: 
1.184     rillig   3074: Some packages don't work out-of-the box on the various platforms that are
                   3075: supported by pkgsrc. These packages need to be patched to make them work. The
                   3076: patch files can be found in the patches/ directory.
1.17      imil     3077: 
1.184     rillig   3078: In the patch phase, these patches are applied to the files in WRKSRC directory
                   3079: after extracting them, in alphabetic order.
1.160     brook    3080: 
1.184     rillig   3081: 12.3.1. Structure of a single patch file
1.160     brook    3082: 
1.184     rillig   3083: The patch-* files should be in diff -bu format, and apply without a fuzz to
                   3084: avoid problems. (To force patches to apply with fuzz you can set
                   3085: PATCH_FUZZ_FACTOR=-F2). Furthermore, each patch should contain only changes for
                   3086: a single file, and no file should be patched by more than one patch file. This
                   3087: helps to keep future modifications simple.
1.160     brook    3088: 
1.184     rillig   3089: Each patch file is structured as follows: In the first line, there is the RCS
                   3090: Id of the patch itself. The second line should be empty for aesthetic reasons.
                   3091: After that, there should be a comment for each change that the patch does.
                   3092: There are a number of standard cases:
1.160     brook    3093: 
1.184     rillig   3094:   * Patches for commonly known vulnerabilities should mention the vulnerability
                   3095:     ID (CAN, CVE).
1.160     brook    3096: 
1.184     rillig   3097:   * Patches that change source code should mention the platform and other
                   3098:     environment (for example, the compiler) that the patch is needed for.
1.160     brook    3099: 
1.184     rillig   3100: The patch should be commented so that any developer who knows the code of the
                   3101: application can make some use of the patch. Special care should be taken for
                   3102: the upstream developers, since we generally want that they accept our patches,
                   3103: so we have less work in the future.
1.160     brook    3104: 
1.184     rillig   3105: 12.3.2. Creating patch files
1.160     brook    3106: 
1.184     rillig   3107: One important thing to mention is to pay attention that no RCS IDs get stored
                   3108: in the patch files, as these will cause problems when later checked into the
                   3109: NetBSD CVS tree. Use the pkgdiff command from the pkgtools/pkgdiff package to
                   3110: avoid these problems.
1.160     brook    3111: 
1.184     rillig   3112: For even more automation, we recommend using mkpatches from the same package to
                   3113: make a whole set of patches. You just have to backup files before you edit them
                   3114: to filename.orig, e.g. with cp -p filename filename.orig or, easier, by using 
                   3115: pkgvi again from the same package. If you upgrade a package this way, you can
                   3116: easily compare the new set of patches with the previously existing one with 
                   3117: patchdiff. The files in patches are replaced by new files, so carefully check
                   3118: if you want to take all the changes.
1.160     brook    3119: 
1.184     rillig   3120: When you have finished a package, remember to generate the checksums for the
                   3121: patch files by using the make makepatchsum command, see Section 12.2,
                   3122: "distinfo".
1.1       dsieger  3123: 
1.184     rillig   3124: When adding a patch that corrects a problem in the distfile (rather than e.g.
                   3125: enforcing pkgsrc's view of where man pages should go), send the patch as a bug
                   3126: report to the maintainer. This benefits non-pkgsrc users of the package, and
                   3127: usually makes it possible to remove the patch in future version.
1.1       dsieger  3128: 
1.184     rillig   3129: The file names of the patch files are usually of the form patch-
                   3130: path_to_file__with__underscores.c. Many packages still use the previous
                   3131: convention patch-[a-z][a-z], but new patches should be of the form containing
                   3132: the filename. mkpatches included in pkgtools/pkgdiff takes care of the name
                   3133: automatically.
1.1       dsieger  3134: 
1.184     rillig   3135: 12.3.3. Sources where the patch files come from
1.1       dsieger  3136: 
1.184     rillig   3137: If you want to share patches between multiple packages in pkgsrc, e.g. because
                   3138: they use the same distfiles, set PATCHDIR to the path where the patch files can
                   3139: be found, e.g.:
1.1       dsieger  3140: 
1.184     rillig   3141: PATCHDIR=       ../../editors/xemacs/patches
1.1       dsieger  3142: 
1.184     rillig   3143: Patch files that are distributed by the author or other maintainers can be
                   3144: listed in PATCHFILES.
1.1       dsieger  3145: 
1.184     rillig   3146: If it is desired to store any patches that should not be committed into pkgsrc,
                   3147: they can be kept outside the pkgsrc tree in the $LOCALPATCHES directory. The
                   3148: directory tree there is expected to have the same "category/package" structure
                   3149: as pkgsrc, and patches are expected to be stored inside these dirs (also known
                   3150: as $LOCALPATCHES/$PKGPATH). For example, if you want to keep a private patch
                   3151: for pkgsrc/graphics/png, keep it in $LOCALPATCHES/graphics/png/mypatch. All
                   3152: files in the named directory are expected to be patch files, and they are
                   3153: applied after pkgsrc patches are applied.
1.1       dsieger  3154: 
1.184     rillig   3155: 12.3.4. Patching guidelines
1.1       dsieger  3156: 
1.184     rillig   3157: When fixing a portability issue in the code do not use preprocessor magic to
                   3158: check for the current operating system nor platform. Doing so hurts portability
                   3159: to other platforms because the OS-specific details are not abstracted
                   3160: appropriately.
1.1       dsieger  3161: 
1.184     rillig   3162: The general rule to follow is: instead of checking for the operating system the
                   3163: application is being built on, check for the specific features you need. For
                   3164: example, instead of assuming that kqueue is available under NetBSD and using
                   3165: the __NetBSD__ macro to conditionalize kqueue support, add a check that detects
1.198     leot     3166: kqueue itself -- yes, this generally involves patching the configure script.
1.184     rillig   3167: There is absolutely nothing that prevents some OSes from adopting interfaces
                   3168: from other OSes (e.g. Linux implementing kqueue), something that the above
                   3169: checks cannot take into account.
1.1       dsieger  3170: 
1.184     rillig   3171: Of course, checking for features generally involves more work on the
                   3172: developer's side, but the resulting changes are cleaner and there are chances
                   3173: they will work on many other platforms. Not to mention that there are higher
                   3174: chances of being later integrated into the mainstream sources. Remember: It
                   3175: doesn't work unless it is right!
1.1       dsieger  3176: 
1.184     rillig   3177: Some typical examples:
1.121     sevan    3178: 
1.184     rillig   3179: Table 12.1. Patching examples
1.1       dsieger  3180: 
1.184     rillig   3181: +-------------------------------------------------------------------------------------------+
                   3182: |  Where  |        Incorrect         |                       Correct                        |
                   3183: |---------+--------------------------+------------------------------------------------------|
                   3184: |         |case ${target_os} in      |                                                      |
                   3185: |configure|netbsd*) have_kvm=yes ;;  |AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)|
                   3186: |script   |*)       have_kvm=no  ;;  |                                                      |
                   3187: |         |esac                      |                                                      |
                   3188: |---------+--------------------------+------------------------------------------------------|
                   3189: |C source |#if defined(__NetBSD__)   |#if defined(HAVE_SYS_EVENT_H)                         |
                   3190: |file     |#  include <sys/event.h>  |#  include <sys/event.h>                              |
                   3191: |         |#endif                    |#endif                                                |
                   3192: |---------+--------------------------+------------------------------------------------------|
                   3193: |         |int                       |int                                                   |
                   3194: |         |monitor_file(...)         |monitor_file(...)                                     |
                   3195: |         |{                         |{                                                     |
                   3196: |         |#if defined(__NetBSD__)   |#if defined(HAVE_KQUEUE)                              |
                   3197: |C source |        int fd = kqueue();|        int fd = kqueue();                            |
                   3198: |file     |        ...               |        ...                                           |
                   3199: |         |#else                     |#else                                                 |
                   3200: |         |        ...               |        ...                                           |
                   3201: |         |#endif                    |#endif                                                |
                   3202: |         |}                         |}                                                     |
                   3203: +-------------------------------------------------------------------------------------------+
1.1       dsieger  3204: 
                   3205: 
1.184     rillig   3206: 12.3.5. Feedback to the author
1.1       dsieger  3207: 
1.184     rillig   3208: Always, always, always feed back any portability fixes or improvements you do
                   3209: to a package to the mainstream developers. This is the only way to get their
                   3210: attention on portability issues and to ensure that future versions can be built
                   3211: out-of-the box on NetBSD. Furthermore, any user that gets newer distfiles will
                   3212: get the fixes straight from the packaged code.
1.1       dsieger  3213: 
1.184     rillig   3214: This generally involves cleaning up the patches (because sometimes the patches
                   3215: that are added to pkgsrc are quick hacks), filing bug reports in the
                   3216: appropriate trackers for the projects and working with the mainstream authors
                   3217: to accept your changes. It is extremely important that you do it so that the
                   3218: packages in pkgsrc are kept simple and thus further changes can be done without
                   3219: much hassle.
1.1       dsieger  3220: 
1.184     rillig   3221: When you have done this, please add a URL to the upstream bug report to the
                   3222: patch comment.
1.1       dsieger  3223: 
1.184     rillig   3224: Support the idea of free software!
1.1       dsieger  3225: 
1.184     rillig   3226: 12.4. Other mandatory files
1.1       dsieger  3227: 
1.184     rillig   3228: DESCR
1.1       dsieger  3229: 
1.184     rillig   3230:     A multi-line description of the piece of software. This should include any
                   3231:     credits where they are due. Please bear in mind that others do not share
                   3232:     your sense of humour (or spelling idiosyncrasies), and that others will
                   3233:     read everything that you write here.
1.1       dsieger  3234: 
1.184     rillig   3235: PLIST
1.1       dsieger  3236: 
1.184     rillig   3237:     This file governs the files that are installed on your system: all the
                   3238:     binaries, manual pages, etc. There are other directives which may be
                   3239:     entered in this file, to control the creation and deletion of directories,
                   3240:     and the location of inserted files. See Chapter 19, PLIST issues for more
                   3241:     information.
1.1       dsieger  3242: 
1.184     rillig   3243: 12.5. Optional files
1.1       dsieger  3244: 
1.184     rillig   3245: 12.5.1. Files affecting the binary package
1.1       dsieger  3246: 
1.184     rillig   3247: INSTALL
1.1       dsieger  3248: 
1.184     rillig   3249:     This shell script is invoked twice by pkg_add(1). First time after package
                   3250:     extraction and before files are moved in place, the second time after the
                   3251:     files to install are moved in place. This can be used to do any custom
                   3252:     procedures not possible with @exec commands in PLIST. See pkg_add(1) and
                   3253:     pkg_create(1) for more information. See also Section 20.1, "Files and
                   3254:     directories outside the installation prefix". Please note that you can
                   3255:     modify variables in it easily by using FILES_SUBST in the package's
                   3256:     Makefile:
1.1       dsieger  3257: 
1.184     rillig   3258:     FILES_SUBST+=  SOMEVAR="somevalue"
1.1       dsieger  3259: 
1.184     rillig   3260:     replaces "@SOMEVAR@" with "somevalue" in the INSTALL. By default,
                   3261:     substitution is performed for PREFIX, LOCALBASE, X11BASE, VARBASE, and a
                   3262:     few others, type make help topic=FILES_SUBST for a complete list.
1.1       dsieger  3263: 
1.184     rillig   3264: DEINSTALL
1.1       dsieger  3265: 
1.184     rillig   3266:     This script is executed before and after any files are removed. It is this
                   3267:     script's responsibility to clean up any additional messy details around the
                   3268:     package's installation, since all pkg_delete knows is how to delete the
                   3269:     files created in the original distribution. See pkg_delete(1) and
                   3270:     pkg_create(1) for more information. The same methods to replace variables
                   3271:     can be used as for the INSTALL file.
1.1       dsieger  3272: 
1.184     rillig   3273: MESSAGE
1.1       dsieger  3274: 
1.198     leot     3275:     This file is displayed after installation of the package. While this was
                   3276:     used often in the past, it has two problems: the display will be missed if
                   3277:     many packages are intalled at once, and the person installing the package
                   3278:     and the one using or configuring it may be different. It should therefore
                   3279:     be used only in exceptional circumstances where lasting negative
                   3280:     consequences would result from someone not reading it.
                   3281: 
                   3282:     MESSAGE should not be used for:
                   3283: 
                   3284:       + exhortations to read the documentation
                   3285: 
                   3286:       + reminders to install rc.d files and set variables
                   3287: 
                   3288:       + anything that should be explained in the installation/configuration
                   3289:         documentation that should come with the package
                   3290: 
                   3291:     If the documentation provided by upstream needs enhancing, create e.g.
                   3292:     files/README.pkgsrc and install it in the package's documentation
                   3293:     directory.
                   3294: 
                   3295:     Note that MESSAGE is shown for all operating systems and all init systems.
                   3296:     If a MESSAGE is necessary, it should be narrowed to only those operating
                   3297:     systems and init systems to which it applies.
                   3298: 
                   3299:     Note that you can modify variables in it easily by using MESSAGE_SUBST in
                   3300:     the package's Makefile:
1.1       dsieger  3301: 
1.184     rillig   3302:     MESSAGE_SUBST+=  SOMEVAR="somevalue"
1.1       dsieger  3303: 
1.184     rillig   3304:     replaces "${SOMEVAR}" with "somevalue" in MESSAGE. By default, substitution
                   3305:     is performed for PKGNAME, PKGBASE, PREFIX, LOCALBASE, X11BASE,
                   3306:     PKG_SYSCONFDIR, ROOT_GROUP, and ROOT_USER.
1.1       dsieger  3307: 
1.184     rillig   3308:     You can display a different or additional files by setting the MESSAGE_SRC
                   3309:     variable. Its default is MESSAGE, if the file exists.
1.1       dsieger  3310: 
1.184     rillig   3311: ALTERNATIVES
1.1       dsieger  3312: 
1.184     rillig   3313:     This file is used by the alternatives framework. It creates, configures,
                   3314:     and destroys generic wrappers used to run programs with similar interfaces.
                   3315:     See pkg_alternatives(8) from pkgtools/pkg_alternatives for more
                   3316:     information.
1.1       dsieger  3317: 
1.184     rillig   3318:     Each line of the file contains two filenames, first the wrapper and then
                   3319:     the alternative provided by the package. Both paths are relative to PREFIX.
1.1       dsieger  3320: 
1.184     rillig   3321: 12.5.2. Files affecting the build process
1.1       dsieger  3322: 
1.184     rillig   3323: Makefile.common
1.1       dsieger  3324: 
1.184     rillig   3325:     This file contains arbitrary things that could also go into a Makefile, but
                   3326:     its purpose is to be used by more than one package. This file should only
                   3327:     be used when the packages that will use the file are known in advance. For
                   3328:     other purposes it is often better to write a *.mk file and give it a good
                   3329:     name that describes what it does.
1.1       dsieger  3330: 
1.184     rillig   3331: buildlink3.mk
1.1       dsieger  3332: 
1.184     rillig   3333:     This file contains the dependency information for the buildlink3 framework
                   3334:     (see Chapter 18, Buildlink methodology).
1.1       dsieger  3335: 
1.184     rillig   3336: hacks.mk
1.1       dsieger  3337: 
1.184     rillig   3338:     This file contains workarounds for compiler bugs and similar things. It is
                   3339:     included automatically by the pkgsrc infrastructure, so you don't need an
                   3340:     extra .include line for it.
1.1       dsieger  3341: 
1.184     rillig   3342: options.mk
1.1       dsieger  3343: 
1.184     rillig   3344:     This file contains the code for the package-specific options (see
                   3345:     Chapter 16, Options handling) that can be selected by the user. If a
                   3346:     package has only one or two options, it is equally acceptable to put the
                   3347:     code directly into the Makefile.
1.1       dsieger  3348: 
1.184     rillig   3349: 12.5.3. Files affecting nothing at all
1.1       dsieger  3350: 
1.184     rillig   3351: README*
1.1       dsieger  3352: 
1.184     rillig   3353:     These files do not take place in the creation of a package and thus are
                   3354:     purely informative to the package developer.
1.1       dsieger  3355: 
1.184     rillig   3356: TODO
1.1       dsieger  3357: 
1.184     rillig   3358:     This file contains things that need to be done to make the package even
                   3359:     better.
1.1       dsieger  3360: 
1.184     rillig   3361: 12.6. work*
1.1       dsieger  3362: 
1.184     rillig   3363: When you type make, the distribution files are unpacked into the directory
                   3364: denoted by WRKDIR. It can be removed by running make clean. Besides the
                   3365: sources, this directory is also used to keep various timestamp files. The
                   3366: directory gets removed completely on clean. The default is ${.CURDIR}/work or $
                   3367: {.CURDIR}/work.${MACHINE_ARCH} if OBJMACHINE is set.
1.1       dsieger  3368: 
1.184     rillig   3369: 12.7. files/*
1.80      wiz      3370: 
1.184     rillig   3371: If you have any files that you wish to be placed in the package prior to
                   3372: configuration or building, you can place these files here and use a ${CP}
                   3373: command in the "post-extract" target to achieve this.
1.1       dsieger  3374: 
1.184     rillig   3375: If you want to share files in this way with other packages, set the FILESDIR
                   3376: variable to point to the other package's files directory, e.g.:
1.1       dsieger  3377: 
1.184     rillig   3378: FILESDIR=       ../../editors/xemacs/files
1.14      jmcneill 3379: 
1.184     rillig   3380: Chapter 13. The build process
1.1       dsieger  3381: 
1.184     rillig   3382: Table of Contents
1.1       dsieger  3383: 
1.184     rillig   3384: 13.1. Introduction
                   3385: 13.2. Program location
                   3386: 13.3. Directories used during the build process
                   3387: 13.4. Running a phase
                   3388: 13.5. The fetch phase
                   3389: 
                   3390:     13.5.1. What to fetch and where to get it from
                   3391:     13.5.2. How are the files fetched?
                   3392: 
                   3393: 13.6. The checksum phase
                   3394: 13.7. The extract phase
                   3395: 13.8. The patch phase
                   3396: 13.9. The tools phase
                   3397: 13.10. The wrapper phase
                   3398: 13.11. The configure phase
                   3399: 13.12. The build phase
                   3400: 13.13. The test phase
                   3401: 13.14. The install phase
                   3402: 13.15. The package phase
                   3403: 13.16. Cleaning up
                   3404: 13.17. Other helpful targets
1.1       dsieger  3405: 
1.184     rillig   3406: 13.1. Introduction
1.122     leot     3407: 
1.184     rillig   3408: This chapter gives a detailed description on how a package is built. Building a
                   3409: package is separated into different phases (for example fetch, build, install),
                   3410: all of which are described in the following sections. Each phase is split into
                   3411: so-called stages, which take the name of the containing phase, prefixed by one
                   3412: of pre-, do- or post-. (Examples are pre-configure, post-build.) Most of the
                   3413: actual work is done in the do-* stages.
1.1       dsieger  3414: 
1.184     rillig   3415: Never override the regular targets (like fetch), if you have to, override the
                   3416: do-* ones instead.
1.1       dsieger  3417: 
1.184     rillig   3418: The basic steps for building a program are always the same. First the program's
                   3419: source (distfile) must be brought to the local system and then extracted. After
                   3420: any pkgsrc-specific patches to compile properly are applied, the software can
                   3421: be configured, then built (usually by compiling), and finally the generated
                   3422: binaries, etc. can be put into place on the system.
1.1       dsieger  3423: 
1.184     rillig   3424: To get more details about what is happening at each step, you can set the
                   3425: PKG_VERBOSE variable, or the PATCH_DEBUG variable if you are just interested in
                   3426: more details about the patch step.
1.1       dsieger  3427: 
1.184     rillig   3428: 13.2. Program location
1.1       dsieger  3429: 
1.184     rillig   3430: Before outlining the process performed by the NetBSD package system in the next
                   3431: section, here's a brief discussion on where programs are installed, and which
                   3432: variables influence this.
1.1       dsieger  3433: 
1.184     rillig   3434: The automatic variable PREFIX indicates where all files of the final program
                   3435: shall be installed. It is usually set to LOCALBASE (/usr/pkg), or CROSSBASE for
                   3436: pkgs in the cross category. The value of PREFIX needs to be put into the
                   3437: various places in the program's source where paths to these files are encoded.
                   3438: See Section 12.3, "patches/*" and Section 21.3.1, "Shared libraries - libtool"
                   3439: for more details.
1.1       dsieger  3440: 
1.184     rillig   3441: When choosing which of these variables to use, follow the following rules:
1.1       dsieger  3442: 
1.184     rillig   3443:   * PREFIX always points to the location where the current pkg will be
                   3444:     installed. When referring to a pkg's own installation path, use "${PREFIX}"
                   3445:     .
1.1       dsieger  3446: 
1.184     rillig   3447:   * LOCALBASE is where all non-X11 pkgs are installed. If you need to construct
                   3448:     a -I or -L argument to the compiler to find includes and libraries
                   3449:     installed by another non-X11 pkg, use "${LOCALBASE}". The name LOCALBASE
                   3450:     stems from FreeBSD, which installed all packages in /usr/local. As pkgsrc
                   3451:     leaves /usr/local for the system administrator, this variable is a
                   3452:     misnomer.
1.1       dsieger  3453: 
1.184     rillig   3454:   * X11BASE is where the actual X11 distribution (from xsrc, etc.) is
                   3455:     installed. When looking for standard X11 includes (not those installed by a
                   3456:     package), use "${X11BASE}".
1.1       dsieger  3457: 
1.184     rillig   3458:   * X11-based packages using imake must set USE_IMAKE to be installed correctly
                   3459:     under LOCALBASE.
1.1       dsieger  3460: 
1.184     rillig   3461:   * Within ${PREFIX}, packages should install files according to hier(7), with
                   3462:     the exception that manual pages go into ${PREFIX}/man, not ${PREFIX}/share/
                   3463:     man.
1.1       dsieger  3464: 
1.184     rillig   3465: 13.3. Directories used during the build process
1.2       rillig   3466: 
1.184     rillig   3467: When building a package, various directories are used to store source files,
                   3468: temporary files, pkgsrc-internal files, and so on. These directories are
                   3469: explained here.
1.1       dsieger  3470: 
1.184     rillig   3471: Some of the directory variables contain relative pathnames. There are two
                   3472: common base directories for these relative directories: PKGSRCDIR/PKGPATH is
                   3473: used for directories that are pkgsrc-specific. WRKSRC is used for directories
                   3474: inside the package itself.
1.1       dsieger  3475: 
1.184     rillig   3476: PKGSRCDIR
1.1       dsieger  3477: 
1.184     rillig   3478:     This is an absolute pathname that points to the pkgsrc root directory.
                   3479:     Generally, you don't need it.
1.1       dsieger  3480: 
1.184     rillig   3481: PKGDIR
1.1       dsieger  3482: 
1.184     rillig   3483:     This is an absolute pathname that points to the current package.
1.1       dsieger  3484: 
1.184     rillig   3485: PKGPATH
1.1       dsieger  3486: 
1.184     rillig   3487:     This is a pathname relative to PKGSRCDIR that points to the current
                   3488:     package.
1.1       dsieger  3489: 
1.184     rillig   3490: WRKDIR
1.1       dsieger  3491: 
1.184     rillig   3492:     This is an absolute pathname pointing to the directory where all work takes
                   3493:     place. The distfiles are extracted to this directory. It also contains
                   3494:     temporary directories and log files used by the various pkgsrc frameworks,
                   3495:     like buildlink or the wrappers.
1.1       dsieger  3496: 
1.184     rillig   3497: WRKSRC
1.1       dsieger  3498: 
1.184     rillig   3499:     This is an absolute pathname pointing to the directory where the distfiles
                   3500:     are extracted. It is usually a direct subdirectory of WRKDIR, and often
                   3501:     it's the only directory entry that isn't hidden. This variable may be
                   3502:     changed by a package Makefile.
1.1       dsieger  3503: 
1.184     rillig   3504: The CREATE_WRKDIR_SYMLINK definition takes either the value yes or no and
                   3505: defaults to no. It indicates whether a symbolic link to the WRKDIR is to be
                   3506: created in the pkgsrc entry's directory. If users would like to have their
                   3507: pkgsrc trees behave in a read-only manner, then the value of
                   3508: CREATE_WRKDIR_SYMLINK should be set to no.
1.1       dsieger  3509: 
1.184     rillig   3510: 13.4. Running a phase
1.1       dsieger  3511: 
1.184     rillig   3512: You can run a particular phase by typing make phase, where phase is the name of
                   3513: the phase. This will automatically run all phases that are required for this
                   3514: phase. The default phase is build, that is, when you run make without
                   3515: parameters in a package directory, the package will be built, but not
                   3516: installed.
1.1       dsieger  3517: 
1.184     rillig   3518: 13.5. The fetch phase
1.1       dsieger  3519: 
1.184     rillig   3520: The first step in building a package is to fetch the distribution files
                   3521: (distfiles) from the sites that are providing them. This is the task of the 
                   3522: fetch phase.
1.25      wiz      3523: 
1.184     rillig   3524: 13.5.1. What to fetch and where to get it from
1.1       dsieger  3525: 
1.184     rillig   3526: In simple cases, MASTER_SITES defines all URLs from where the distfile, whose
                   3527: name is derived from the DISTNAME variable, is fetched. The more complicated
                   3528: cases are described below.
1.1       dsieger  3529: 
1.184     rillig   3530: The variable DISTFILES specifies the list of distfiles that have to be fetched.
                   3531: Its value defaults to ${DEFAULT_DISTFILES} and its value is ${DISTNAME}$
                   3532: {EXTRACT_SUFX}, so that most packages don't need to define it at all.
                   3533: EXTRACT_SUFX is .tar.gz by default, but can be changed freely. Note that if
                   3534: your package requires additional distfiles to the default one, you cannot just
                   3535: append the additional filenames using the += operator, but you have write for
                   3536: example:
1.1       dsieger  3537: 
1.184     rillig   3538: DISTFILES=      ${DEFAULT_DISTFILES} additional-files.tar.gz
1.1       dsieger  3539: 
1.184     rillig   3540: Each distfile is fetched from a list of sites, usually MASTER_SITES. If the
                   3541: package has multiple DISTFILES or multiple PATCHFILES from different sites, you
                   3542: can set SITES.distfile to the list of URLs where the file distfile (including
                   3543: the suffix) can be found.
1.1       dsieger  3544: 
1.184     rillig   3545: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   3546: DISTFILES+=     foo-file.tar.gz
                   3547: SITES.foo-file.tar.gz= \
                   3548: https://www.somewhere.com/somehow/ \
                   3549: https://www.somewhereelse.com/mirror/somehow/
1.1       dsieger  3550: 
1.184     rillig   3551: When actually fetching the distfiles, each item from MASTER_SITES or SITES.*
                   3552: gets the name of each distfile appended to it, without an intermediate slash.
                   3553: Therefore, all site values have to end with a slash or other separator
                   3554: character. This allows for example to set MASTER_SITES to a URL of a CGI script
                   3555: that gets the name of the distfile as a parameter. In this case, the definition
                   3556: would look like:
1.1       dsieger  3557: 
1.184     rillig   3558: MASTER_SITES=   https://www.example.com/download.cgi?file=
1.1       dsieger  3559: 
1.184     rillig   3560: The exception to this rule are URLs starting with a dash. In that case the URL
                   3561: is taken as is, fetched and the result stored under the name of the distfile.
                   3562: You can use this style for the case when the download URL style does not match
                   3563: the above common case. For example, if permanent download URL is a redirector
                   3564: to the real download URL, or the download file name is offered by an HTTP
                   3565: Content-Disposition header. In the following example, foo-1.0.0.tar.gz will be
                   3566: created instead of the default v1.0.0.tar.gz.
1.1       dsieger  3567: 
1.184     rillig   3568: DISTNAME=       foo-1.0.0
                   3569: MASTER_SITES=   -https://www.example.com/archive/v1.0.0.tar.gz
1.29      wiz      3570: 
1.184     rillig   3571: There are some predefined values for MASTER_SITES, which can be used in
                   3572: packages. The names of the variables should speak for themselves.
1.29      wiz      3573: 
1.184     rillig   3574: MASTER_SITE_APACHE          MASTER_SITE_BACKUP
                   3575: MASTER_SITE_CRATESIO        MASTER_SITE_CYGWIN
                   3576: MASTER_SITE_DEBIAN          MASTER_SITE_FREEBSD
                   3577: MASTER_SITE_FREEBSD_LOCAL   MASTER_SITE_GENTOO
                   3578: MASTER_SITE_GITHUB          MASTER_SITE_GNOME
                   3579: MASTER_SITE_GNU             MASTER_SITE_GNUSTEP
                   3580: MASTER_SITE_HASKELL_HACKAGE MASTER_SITE_IFARCHIVE
                   3581: MASTER_SITE_KDE             MASTER_SITE_MOZILLA
                   3582: MASTER_SITE_MOZILLA_ALL     MASTER_SITE_MYSQL
                   3583: MASTER_SITE_NETLIB          MASTER_SITE_OPENBSD
                   3584: MASTER_SITE_OPENOFFICE      MASTER_SITE_OSDN
                   3585: MASTER_SITE_PERL_CPAN       MASTER_SITE_PGSQL
                   3586: MASTER_SITE_PYPI            MASTER_SITE_RUBYGEMS
                   3587: MASTER_SITE_R_CRAN          MASTER_SITE_SOURCEFORGE
                   3588: MASTER_SITE_SUNSITE         MASTER_SITE_SUSE
                   3589: MASTER_SITE_TEX_CTAN        MASTER_SITE_XCONTRIB
                   3590: MASTER_SITE_XEMACS          MASTER_SITE_XORG
1.1       dsieger  3591: 
1.184     rillig   3592: Some explanations for the less self-explaining ones: MASTER_SITE_BACKUP
                   3593: contains backup sites for packages that are maintained in ftp://ftp.NetBSD.org/
                   3594: pub/pkgsrc/distfiles/${DIST_SUBDIR}. MASTER_SITE_LOCAL contains local package
                   3595: source distributions that are maintained in ftp://ftp.NetBSD.org/pub/pkgsrc/
                   3596: distfiles/LOCAL_PORTS/.
1.1       dsieger  3597: 
1.184     rillig   3598: If you choose one of these predefined sites, you may want to specify a
                   3599: subdirectory of that site. Since these macros may expand to more than one
                   3600: actual site, you must use the following construct to specify a subdirectory:
1.1       dsieger  3601: 
1.184     rillig   3602: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   3603: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
1.1       dsieger  3604: 
1.184     rillig   3605: Note the trailing slash after the subdirectory name.
1.1       dsieger  3606: 
1.184     rillig   3607: 13.5.2. How are the files fetched?
1.1       dsieger  3608: 
1.184     rillig   3609: The fetch phase makes sure that all the distfiles exist in a local directory
                   3610: (DISTDIR, which can be set by the pkgsrc user). If the files do not exist, they
                   3611: are fetched using commands of the form
1.1       dsieger  3612: 
1.184     rillig   3613: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
1.1       dsieger  3614: 
1.184     rillig   3615: where ${site} varies through several possibilities in turn: first,
                   3616: MASTER_SITE_OVERRIDE is tried, then the sites specified in either SITES.file if
                   3617: defined, else MASTER_SITES or PATCH_SITES, as applies, then finally the value
                   3618: of MASTER_SITE_BACKUP. The order of all except the first and the last can be
                   3619: optionally sorted by the user, via setting either MASTER_SORT_RANDOM, and
                   3620: MASTER_SORT_AWK or MASTER_SORT_REGEX.
1.1       dsieger  3621: 
1.184     rillig   3622: The specific command and arguments used depend on the FETCH_USING parameter.
                   3623: The example above is for FETCH_USING=custom.
1.66      asau     3624: 
1.184     rillig   3625: The distfiles mirror run by the NetBSD Foundation uses the mirror-distfiles
                   3626: target to mirror the distfiles, if they are freely distributable. Packages
                   3627: setting NO_SRC_ON_FTP (usually to "${RESTRICTED}") will not have their
                   3628: distfiles mirrored.
1.1       dsieger  3629: 
1.184     rillig   3630: 13.6. The checksum phase
1.1       dsieger  3631: 
1.184     rillig   3632: After the distfile(s) are fetched, their checksum is generated and compared
                   3633: with the checksums stored in the distinfo file. If the checksums don't match,
                   3634: the build is aborted. This is to ensure the same distfile is used for building,
                   3635: and that the distfile wasn't changed, e.g. by some malign force, deliberately
                   3636: changed distfiles on the master distribution site or network lossage.
1.1       dsieger  3637: 
1.184     rillig   3638: 13.7. The extract phase
1.1       dsieger  3639: 
1.184     rillig   3640: When the distfiles are present on the local system, they need to be extracted,
                   3641: as they usually come in the form of some compressed archive format.
1.1       dsieger  3642: 
1.184     rillig   3643: By default, all DISTFILES are extracted. If you only need some of them, you can
                   3644: set the EXTRACT_ONLY variable to the list of those files.
1.1       dsieger  3645: 
1.184     rillig   3646: Extracting the files is usually done by a little program, mk/extract/extract,
                   3647: which already knows how to extract various archive formats, so most likely you
                   3648: will not need to change anything here. But if you need, the following variables
                   3649: may help you:
1.1       dsieger  3650: 
1.184     rillig   3651: EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}
1.1       dsieger  3652: 
1.184     rillig   3653:     Use these variables to override the default options for an extract command,
                   3654:     which are defined in mk/extract/extract.
1.1       dsieger  3655: 
1.184     rillig   3656: EXTRACT_USING
1.1       dsieger  3657: 
1.184     rillig   3658:     This variable can be set to bsdtar, gtar, nbtar (which is the default
                   3659:     value), pax, or an absolute pathname pointing to the command with which tar
                   3660:     archives should be extracted. It is preferred to choose bsdtar over gtar if
                   3661:     NetBSD's pax-as-tar is not good enough.
1.1       dsieger  3662: 
1.184     rillig   3663: If the extract program doesn't serve your needs, you can also override the
                   3664: EXTRACT_CMD variable, which holds the command used for extracting the files.
                   3665: This command is executed in the ${WRKSRC} directory. During execution of this
                   3666: command, the shell variable extract_file holds the absolute pathname of the
                   3667: file that is going to be extracted.
1.1       dsieger  3668: 
1.184     rillig   3669: And if that still does not suffice, you can override the do-extract target in
                   3670: the package Makefile.
1.1       dsieger  3671: 
1.184     rillig   3672: 13.8. The patch phase
1.1       dsieger  3673: 
1.184     rillig   3674: After extraction, all the patches named by the PATCHFILES, those present in the
                   3675: patches subdirectory of the package as well as in $LOCALPATCHES/$PKGPATH (e.g.
                   3676: /usr/local/patches/graphics/png) are applied. Patchfiles ending in .Z or .gz
                   3677: are uncompressed before they are applied, files ending in .orig or .rej are
                   3678: ignored. Any special options to patch(1) can be handed in PATCH_DIST_ARGS. See
                   3679: Section 12.3, "patches/*" for more details.
1.1       dsieger  3680: 
1.184     rillig   3681: By default patch(1) is given special arguments to make it fail if the expected
                   3682: text from the patch context is not found in the patched file. If that happens,
                   3683: fix the patch file by comparing it with the actual text in the file to be
                   3684: patched.
1.1       dsieger  3685: 
1.184     rillig   3686: 13.9. The tools phase
1.1       dsieger  3687: 
1.184     rillig   3688: This is covered in Chapter 17, Tools needed for building or running.
1.1       dsieger  3689: 
1.184     rillig   3690: 13.10. The wrapper phase
1.1       dsieger  3691: 
1.184     rillig   3692: This phase creates wrapper programs for the compilers and linkers. The
                   3693: following variables can be used to tweak the wrappers.
1.1       dsieger  3694: 
1.184     rillig   3695: ECHO_WRAPPER_MSG
1.1       dsieger  3696: 
1.184     rillig   3697:     The command used to print progress messages. Does nothing by default. Set
                   3698:     to ${ECHO} to see the progress messages.
1.1       dsieger  3699: 
1.184     rillig   3700: WRAPPER_DEBUG
1.1       dsieger  3701: 
1.184     rillig   3702:     This variable can be set to yes (default) or no, depending on whether you
                   3703:     want additional information in the wrapper log file.
1.1       dsieger  3704: 
1.184     rillig   3705: WRAPPER_UPDATE_CACHE
1.1       dsieger  3706: 
1.184     rillig   3707:     This variable can be set to yes or no, depending on whether the wrapper
                   3708:     should use its cache, which will improve the speed. The default value is
                   3709:     yes, but is forced to no if the platform does not support it.
1.1       dsieger  3710: 
1.184     rillig   3711: WRAPPER_REORDER_CMDS
1.1       dsieger  3712: 
1.184     rillig   3713:     A list of reordering commands. A reordering command has the form reorder:l:
                   3714:     lib1:lib2. It ensures that that -llib1 occurs before -llib2.
1.1       dsieger  3715: 
1.184     rillig   3716: 13.11. The configure phase
1.1       dsieger  3717: 
1.184     rillig   3718: Most pieces of software need information on the header files, system calls, and
                   3719: library routines which are available on the platform they run on. The process
                   3720: of determining this information is known as configuration, and is usually
                   3721: automated. In most cases, a script is supplied with the distfiles, and its
                   3722: invocation results in generation of header files, Makefiles, etc.
1.1       dsieger  3723: 
1.184     rillig   3724: If the package contains a configure script, this can be invoked by setting
                   3725: HAS_CONFIGURE to "yes". If the configure script is a GNU autoconf script, you
1.187     rillig   3726: should set GNU_CONFIGURE to "yes" instead.
1.1       dsieger  3727: 
1.187     rillig   3728: In the do-configure stage, a rough equivalent of the following command is run.
                   3729: See mk/configure/configure.mk, target do-configure-script for the exact
                   3730: definition.
                   3731: 
                   3732: .for dir in ${CONFIGURE_DIRS}
                   3733:         cd ${WRKSRC} && cd ${dir} \
                   3734:         && env ${CONFIGURE_ENV} \
                   3735:             ${CONFIG_SHELL} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
1.184     rillig   3736: .endfor
1.1       dsieger  3737: 
1.184     rillig   3738: CONFIGURE_DIRS (default: ".") is a list of pathnames relative to WRKSRC. In
                   3739: each of these directories, the configure script is run with the environment
                   3740: CONFIGURE_ENV and arguments CONFIGURE_ARGS. The variables CONFIGURE_ENV,
                   3741: CONFIGURE_SCRIPT (default: "./configure") and CONFIGURE_ARGS may all be changed
                   3742: by the package.
1.1       dsieger  3743: 
1.184     rillig   3744: If the program uses the Perl way of configuration (mainly Perl modules, but not
                   3745: only), i.e. a file called Makefile.PL, it should include ../../lang/perl5/
                   3746: module.mk. To set any parameter for Makefile.PL use the MAKE_PARAMS variable
                   3747: (e.g., MAKE_PARAMS+=foo=bar
1.1       dsieger  3748: 
1.184     rillig   3749: If the program uses an Imakefile for configuration, the appropriate steps can
                   3750: be invoked by setting USE_IMAKE to "yes". If you only need xmkmf, add it to
                   3751: USE_TOOLS. You can add variables to xmkmf's environment by adding them to the
                   3752: SCRIPTS_ENV variable.
1.1       dsieger  3753: 
1.184     rillig   3754: If the program uses cmake for configuration, the appropriate steps can be
                   3755: invoked by setting USE_CMAKE to "yes". You can add variables to cmake's
                   3756: environment by adding them to the CONFIGURE_ENV variable and arguments to cmake
                   3757: by adding them to the CMAKE_ARGS variable. The top directory argument is given
                   3758: by the CMAKE_ARG_PATH variable, that defaults to "." (relative to
                   3759: CONFIGURE_DIRS)
1.1       dsieger  3760: 
1.184     rillig   3761: If there is no configure step at all, set NO_CONFIGURE to "yes".
1.1       dsieger  3762: 
1.184     rillig   3763: 13.12. The build phase
1.1       dsieger  3764: 
1.187     rillig   3765: For building a package, a rough equivalent of the following code is executed;
                   3766: see mk/build/build.mk, target do-build for the exact definition.
1.154     rillig   3767: 
1.187     rillig   3768: .for dir in ${BUILD_DIRS}
                   3769:         cd ${WRKSRC} && cd ${dir} \
1.184     rillig   3770:         && env ${MAKE_ENV} \
1.187     rillig   3771:             ${MAKE_PROGRAM} ${MAKE_FLAGS} ${BUILD_MAKE_FLAGS} \
1.184     rillig   3772:                 -f ${MAKE_FILE} \
                   3773:                 ${BUILD_TARGET}
                   3774: .endfor
1.1       dsieger  3775: 
1.184     rillig   3776: BUILD_DIRS (default: ".") is a list of pathnames relative to WRKSRC. In each of
                   3777: these directories, MAKE_PROGRAM is run with the environment MAKE_ENV and
                   3778: arguments BUILD_MAKE_FLAGS. The variables MAKE_ENV, BUILD_MAKE_FLAGS, MAKE_FILE
                   3779: and BUILD_TARGET may all be changed by the package.
1.1       dsieger  3780: 
1.184     rillig   3781: The default value of MAKE_PROGRAM is "gmake" if USE_TOOLS contains "gmake", "
                   3782: make" otherwise. The default value of MAKE_FILE is "Makefile", and BUILD_TARGET
                   3783: defaults to "all".
1.1       dsieger  3784: 
1.184     rillig   3785: If there is no build step at all, set NO_BUILD to "yes".
1.1       dsieger  3786: 
1.184     rillig   3787: 13.13. The test phase
1.1       dsieger  3788: 
1.184     rillig   3789: [TODO]
1.1       dsieger  3790: 
1.184     rillig   3791: 13.14. The install phase
1.1       dsieger  3792: 
1.184     rillig   3793: Once the build stage has completed, the final step is to install the software
                   3794: in public directories, so users can access the programs and files.
1.1       dsieger  3795: 
1.187     rillig   3796: In the install phase, a rough equivalent of the following code is executed; see
                   3797: mk/install/install.mk, target do-install for the exact definition.
                   3798: Additionally, before and after this code, several consistency checks are run
                   3799: against the files-to-be-installed, see mk/check/*.mk for details.
                   3800: 
                   3801: .for dir in ${INSTALL_DIRS}
                   3802:         cd ${WRKSRC} && cd ${dir} \
                   3803:         && env ${INSTALL_ENV} ${MAKE_ENV} \
                   3804:             ${MAKE_PROGRAM} ${MAKE_FLAGS} ${INSTALL_MAKE_FLAGS} \
                   3805:                 -f ${MAKE_FILE} ${INSTALL_TARGET}
1.184     rillig   3806: .endfor
1.1       dsieger  3807: 
1.184     rillig   3808: The variable's meanings are analogous to the ones in the build phase.
                   3809: INSTALL_DIRS defaults to BUILD_DIRS. INSTALL_TARGET is "install" by default,
                   3810: plus "install.man" if USE_IMAKE is defined and NO_INSTALL_MANPAGES is not
                   3811: defined.
1.1       dsieger  3812: 
1.184     rillig   3813: In the install phase, the following variables are useful. They are all
                   3814: variations of the install(1) command that have the owner, group and permissions
                   3815: preset. INSTALL is the plain install command. The specialized variants,
                   3816: together with their intended use, are:
1.1       dsieger  3817: 
1.184     rillig   3818: INSTALL_PROGRAM_DIR
1.1       dsieger  3819: 
1.184     rillig   3820:     directories that contain binaries
1.1       dsieger  3821: 
1.184     rillig   3822: INSTALL_SCRIPT_DIR
1.1       dsieger  3823: 
1.184     rillig   3824:     directories that contain scripts
1.1       dsieger  3825: 
1.184     rillig   3826: INSTALL_LIB_DIR
1.1       dsieger  3827: 
1.184     rillig   3828:     directories that contain shared and static libraries
1.1       dsieger  3829: 
1.184     rillig   3830: INSTALL_DATA_DIR
1.108     rillig   3831: 
1.184     rillig   3832:     directories that contain data files
1.108     rillig   3833: 
1.184     rillig   3834: INSTALL_MAN_DIR
1.108     rillig   3835: 
1.184     rillig   3836:     directories that contain man pages
1.108     rillig   3837: 
1.184     rillig   3838: INSTALL_GAME_DIR
1.108     rillig   3839: 
1.184     rillig   3840:     directories that contain data files for games
1.108     rillig   3841: 
1.184     rillig   3842: INSTALL_PROGRAM
1.108     rillig   3843: 
1.184     rillig   3844:     binaries that can be stripped from debugging symbols
1.108     rillig   3845: 
1.184     rillig   3846: INSTALL_SCRIPT
1.108     rillig   3847: 
1.184     rillig   3848:     binaries that cannot be stripped
1.108     rillig   3849: 
1.184     rillig   3850: INSTALL_GAME
1.108     rillig   3851: 
1.184     rillig   3852:     game binaries
1.108     rillig   3853: 
1.184     rillig   3854: INSTALL_LIB
1.108     rillig   3855: 
1.184     rillig   3856:     shared and static libraries
1.108     rillig   3857: 
1.184     rillig   3858: INSTALL_DATA
1.108     rillig   3859: 
1.184     rillig   3860:     data files
1.1       dsieger  3861: 
1.184     rillig   3862: INSTALL_GAME_DATA
1.1       dsieger  3863: 
1.184     rillig   3864:     data files for games
1.108     rillig   3865: 
1.184     rillig   3866: INSTALL_MAN
1.108     rillig   3867: 
1.184     rillig   3868:     man pages
1.1       dsieger  3869: 
1.184     rillig   3870: Some other variables are:
1.1       dsieger  3871: 
1.184     rillig   3872: INSTALL_UNSTRIPPED
1.1       dsieger  3873: 
1.184     rillig   3874:     If set to yes, do not run strip(1) when installing binaries. Any debugging
                   3875:     sections and symbols present in binaries will be preserved.
1.1       dsieger  3876: 
1.184     rillig   3877: INSTALLATION_DIRS
1.1       dsieger  3878: 
1.184     rillig   3879:     A list of directories relative to PREFIX that are created by pkgsrc at the
                   3880:     beginning of the install phase. The package is supposed to create all
                   3881:     needed directories itself before installing files to it and list all other
                   3882:     directories here.
1.1       dsieger  3883: 
1.184     rillig   3884: In the rare cases that a package shouldn't install anything, set NO_INSTALL to 
                   3885: "yes". This is mostly relevant for packages in the regress category.
1.1       dsieger  3886: 
1.184     rillig   3887: 13.15. The package phase
1.121     sevan    3888: 
1.184     rillig   3889: Once the install stage has completed, a binary package of the installed files
                   3890: can be built. These binary packages can be used for quick installation without
                   3891: previous compilation, e.g. by the make bin-install or by using pkg_add.
1.1       dsieger  3892: 
1.184     rillig   3893: By default, the binary packages are created in ${PACKAGES}/All and symlinks are
                   3894: created in ${PACKAGES}/category, one for each category in the CATEGORIES
                   3895: variable. PACKAGES defaults to pkgsrc/packages.
1.1       dsieger  3896: 
1.184     rillig   3897: 13.16. Cleaning up
1.1       dsieger  3898: 
1.184     rillig   3899: Once you're finished with a package, you can clean the work directory by
                   3900: running make clean. If you want to clean the work directories of all
                   3901: dependencies too, use make clean-depends.
1.1       dsieger  3902: 
1.184     rillig   3903: 13.17. Other helpful targets
1.1       dsieger  3904: 
1.184     rillig   3905: pre/post-*
1.1       dsieger  3906: 
1.184     rillig   3907:     For any of the main targets described in the previous section (configure,
                   3908:     build, install, etc.), two auxiliary targets exist with "pre-" and "post-"
                   3909:     used as a prefix for the main target's name. These targets are invoked
                   3910:     before and after the main target is called, allowing extra configuration or
                   3911:     installation steps be performed from a package's Makefile, for example,
                   3912:     which a program's configure script or install target omitted.
                   3913: 
                   3914:     About 5% of the pkgsrc packages define their custom post-extract target,
                   3915:     another 5% define pre-configure, and 10% define post-install. The other pre
                   3916:     /post-* targets are defined even less often.
1.1       dsieger  3917: 
1.184     rillig   3918: do-*
1.182     leot     3919: 
1.184     rillig   3920:     Should one of the main targets do the wrong thing, and should there be no
                   3921:     variable to fix this, you can redefine it with the do-* target. (Note that
                   3922:     redefining the target itself instead of the do-* target is a bad idea, as
                   3923:     the pre-* and post-* targets won't be called anymore, etc.)
1.1       dsieger  3924: 
1.184     rillig   3925:     About 15% of the pkgsrc packages override the default do-install, the other
                   3926:     do-* targets are overridden even less often.
1.1       dsieger  3927: 
1.184     rillig   3928: reinstall
1.1       dsieger  3929: 
1.184     rillig   3930:     If you did a make install and you noticed some file was not installed
                   3931:     properly, you can repeat the installation with this target, which will
                   3932:     ignore the "already installed" flag.
1.1       dsieger  3933: 
1.184     rillig   3934:     This is the default value of DEPENDS_TARGET except in the case of make
                   3935:     update and make package, where the defaults are "package" and "update",
                   3936:     respectively.
1.1       dsieger  3937: 
1.184     rillig   3938: deinstall
1.1       dsieger  3939: 
1.184     rillig   3940:     This target does a pkg_delete(1) in the current directory, effectively
                   3941:     de-installing the package. The following variables can be used to tune the
                   3942:     behaviour:
1.1       dsieger  3943: 
1.184     rillig   3944:     PKG_VERBOSE
1.1       dsieger  3945: 
1.184     rillig   3946:         Add a "-v" to the pkg_delete(1) command.
1.1       dsieger  3947: 
1.184     rillig   3948:     DEINSTALLDEPENDS
1.1       dsieger  3949: 
1.184     rillig   3950:         Remove all packages that require (depend on) the given package. This
                   3951:         can be used to remove any packages that may have been pulled in by a
                   3952:         given package, e.g. if make deinstall DEINSTALLDEPENDS=1 is done in
                   3953:         pkgsrc/x11/kde, this is likely to remove whole KDE. Works by adding "-R
                   3954:         " to the pkg_delete(1) command line.
1.1       dsieger  3955: 
1.184     rillig   3956: bin-install
1.1       dsieger  3957: 
1.184     rillig   3958:     Install a binary package from local disk and via FTP from a list of sites
                   3959:     (see the BINPKG_SITES variable), and do a make package if no binary package
                   3960:     is available anywhere. The arguments given to pkg_add can be set via
                   3961:     BIN_INSTALL_FLAGS e.g., to do verbose operation, etc.
1.1       dsieger  3962: 
1.184     rillig   3963: install-clean
1.1       dsieger  3964: 
1.184     rillig   3965:     This target removes the state files for the "install" and later phases so
                   3966:     that the "install" target may be re-invoked. This can be used after editing
                   3967:     the PLIST to install the package without rebuilding it.
1.1       dsieger  3968: 
1.184     rillig   3969: build-clean
1.18      mishka   3970: 
1.184     rillig   3971:     This target removes the state files for the "build" and later phases so
                   3972:     that the "build" target may be re-invoked.
1.18      mishka   3973: 
1.184     rillig   3974: update
1.18      mishka   3975: 
1.184     rillig   3976:     This target causes the current package to be updated to the latest version.
                   3977:     The package and all depending packages first get de-installed, then current
                   3978:     versions of the corresponding packages get compiled and installed. This is
                   3979:     similar to manually noting which packages are currently installed, then
                   3980:     performing a series of make deinstall and make install (or whatever
                   3981:     UPDATE_TARGET is set to) for these packages.
1.18      mishka   3982: 
1.184     rillig   3983:     You can use the "update" target to resume package updating in case a
                   3984:     previous make update was interrupted for some reason. However, in this
                   3985:     case, make sure you don't call make clean or otherwise remove the list of
                   3986:     dependent packages in WRKDIR. Otherwise, you lose the ability to
                   3987:     automatically update the current package along with the dependent packages
                   3988:     you have installed.
1.121     sevan    3989: 
1.184     rillig   3990:     Resuming an interrupted make update will only work as long as the package
                   3991:     tree remains unchanged. If the source code for one of the packages to be
                   3992:     updated has been changed, resuming make update will most certainly fail!
1.1       dsieger  3993: 
1.184     rillig   3994:     The following variables can be used either on the command line or in
                   3995:     mk.conf to alter the behaviour of make update:
1.1       dsieger  3996: 
1.184     rillig   3997:     UPDATE_TARGET
1.1       dsieger  3998: 
1.184     rillig   3999:         Install target to recursively use for the updated package and the
                   4000:         dependent packages. Defaults to DEPENDS_TARGET if set, "install"
                   4001:         otherwise for make update. Other good targets are "package" or "
                   4002:         bin-install". Do not set this to "update" or you will get stuck in an
                   4003:         endless loop!
1.1       dsieger  4004: 
1.184     rillig   4005:     NOCLEAN
1.1       dsieger  4006: 
1.184     rillig   4007:         Don't clean up after updating. Useful if you want to leave the work
                   4008:         sources of the updated packages around for inspection or other
                   4009:         purposes. Be sure you eventually clean up the source tree (see the "
                   4010:         clean-update" target below) or you may run into troubles with old
                   4011:         source code still lying around on your next make or make update.
1.1       dsieger  4012: 
1.184     rillig   4013:     REINSTALL
1.1       dsieger  4014: 
1.184     rillig   4015:         Deinstall each package before installing (making DEPENDS_TARGET). This
                   4016:         may be necessary if the "clean-update" target (see below) was called
                   4017:         after interrupting a running make update.
1.1       dsieger  4018: 
1.184     rillig   4019:     DEPENDS_TARGET
1.1       dsieger  4020: 
1.184     rillig   4021:         Allows you to disable recursion and hardcode the target for packages.
                   4022:         The default is "update" for the update target, facilitating a recursive
                   4023:         update of prerequisite packages. Only set DEPENDS_TARGET if you want to
                   4024:         disable recursive updates. Use UPDATE_TARGET instead to just set a
                   4025:         specific target for each package to be installed during make update
                   4026:         (see above).
1.1       dsieger  4027: 
1.184     rillig   4028: clean-update
1.1       dsieger  4029: 
1.184     rillig   4030:     Clean the source tree for all packages that would get updated if make
                   4031:     update was called from the current directory. This target should not be
                   4032:     used if the current package (or any of its depending packages) have already
                   4033:     been de-installed (e.g., after calling make update) or you may lose some
                   4034:     packages you intended to update. As a rule of thumb: only use this target 
                   4035:     before the first time you run make update and only if you have a dirty
                   4036:     package tree (e.g., if you used NOCLEAN).
1.86      wiz      4037: 
1.184     rillig   4038:     If you are unsure about whether your tree is clean, you can either perform
                   4039:     a make clean at the top of the tree, or use the following sequence of
                   4040:     commands from the directory of the package you want to update (before
                   4041:     running make update for the first time, otherwise you lose all the packages
                   4042:     you wanted to update!):
1.86      wiz      4043: 
1.184     rillig   4044:     # make clean-update
                   4045:     # make clean CLEANDEPENDS=YES
                   4046:     # make update
1.86      wiz      4047: 
                   4048: 
1.184     rillig   4049:     The following variables can be used either on the command line or in
                   4050:     mk.conf to alter the behaviour of make clean-update:
1.86      wiz      4051: 
1.184     rillig   4052:     CLEAR_DIRLIST
1.86      wiz      4053: 
1.184     rillig   4054:         After make clean, do not reconstruct the list of directories to update
                   4055:         for this package. Only use this if make update successfully installed
                   4056:         all packages you wanted to update. Normally, this is done automatically
                   4057:         on make update, but may have been suppressed by the NOCLEAN variable
                   4058:         (see above).
1.1       dsieger  4059: 
1.184     rillig   4060: replace
1.1       dsieger  4061: 
1.184     rillig   4062:     Update the installation of the current package. This differs from update in
                   4063:     that it does not replace dependent packages. You will need to install
                   4064:     pkgtools/pkg_tarup for this target to work.
1.1       dsieger  4065: 
1.184     rillig   4066:     Be careful when using this target! There are no guarantees that dependent
                   4067:     packages will still work, in particular they will most certainly break if
                   4068:     you make replace a library package whose shared library major version
                   4069:     changed between your installed version and the new one. For this reason,
                   4070:     this target is not officially supported and only recommended for advanced
                   4071:     users.
1.1       dsieger  4072: 
1.184     rillig   4073: info
1.1       dsieger  4074: 
1.184     rillig   4075:     This target invokes pkg_info(1) for the current package. You can use this
                   4076:     to check which version of a package is installed.
1.86      wiz      4077: 
1.184     rillig   4078: index
1.1       dsieger  4079: 
1.184     rillig   4080:     This is a top-level command, i.e. it should be used in the pkgsrc
                   4081:     directory. It creates a database of all packages in the local pkgsrc tree,
                   4082:     including dependencies, comment, maintainer, and some other useful
                   4083:     information. Individual entries are created by running make describe in the
                   4084:     packages' directories. This index file is saved as pkgsrc/INDEX. It can be
                   4085:     displayed in verbose format by running make print-index. You can search in
                   4086:     it with make search key=something. You can extract a list of all packages
                   4087:     that depend on a particular one by running make show-deps PKG=somepackage.
1.1       dsieger  4088: 
1.184     rillig   4089:     Running this command takes a very long time, some hours even on fast
                   4090:     machines!
1.1       dsieger  4091: 
1.184     rillig   4092: readme
1.1       dsieger  4093: 
1.199     nia      4094:     This target generates a index.html file, which can be viewed using a
1.184     rillig   4095:     browser such as www/firefox or www/links. The generated files contain
                   4096:     references to any packages which are in the PACKAGES directory on the local
                   4097:     host. The generated files can be made to refer to URLs based on
                   4098:     FTP_PKG_URL_HOST and FTP_PKG_URL_DIR. For example, if I wanted to generate
1.199     nia      4099:     index.html files which pointed to binary packages on the local machine, in
1.184     rillig   4100:     the directory /usr/packages, set FTP_PKG_URL_HOST=file://localhost and
                   4101:     FTP_PKG_URL_DIR=/usr/packages. The ${PACKAGES} directory and its
                   4102:     subdirectories will be searched for all the binary packages.
1.1       dsieger  4103: 
1.184     rillig   4104:     The target can be run at the toplevel or in category directories, in which
                   4105:     case it descends recursively.
1.1       dsieger  4106: 
1.184     rillig   4107: readme-all
1.1       dsieger  4108: 
1.184     rillig   4109:     This is a top-level command, run it in pkgsrc. Use this target to create a
                   4110:     file README-all.html which contains a list of all packages currently
                   4111:     available in the NetBSD Packages Collection, together with the category
                   4112:     they belong to and a short description. This file is compiled from the
1.199     nia      4113:     pkgsrc/*/index.html files, so be sure to run this after a make readme.
1.1       dsieger  4114: 
1.184     rillig   4115: cdrom-readme
1.1       dsieger  4116: 
1.184     rillig   4117:     This is very much the same as the "readme" target (see above), but is to be
                   4118:     used when generating a pkgsrc tree to be written to a CD-ROM. This target
1.199     nia      4119:     also produces index.html files, and can be made to refer to URLs based on
1.184     rillig   4120:     CDROM_PKG_URL_HOST and CDROM_PKG_URL_DIR.
1.1       dsieger  4121: 
1.184     rillig   4122: show-distfiles
1.1       dsieger  4123: 
1.184     rillig   4124:     This target shows which distfiles and patchfiles are needed to build the
                   4125:     package (ALLFILES, which contains all DISTFILES and PATCHFILES, but not
                   4126:     patches/*).
1.1       dsieger  4127: 
1.184     rillig   4128: show-downlevel
1.1       dsieger  4129: 
1.184     rillig   4130:     This target shows nothing if the package is not installed. If a version of
                   4131:     this package is installed, but is not the version provided in this version
                   4132:     of pkgsrc, then a warning message is displayed. This target can be used to
                   4133:     show which of your installed packages are downlevel, and so the old
                   4134:     versions can be deleted, and the current ones added.
1.1       dsieger  4135: 
1.184     rillig   4136: show-pkgsrc-dir
1.1       dsieger  4137: 
1.184     rillig   4138:     This target shows the directory in the pkgsrc hierarchy from which the
                   4139:     package can be built and installed. This may not be the same directory as
                   4140:     the one from which the package was installed. This target is intended to be
                   4141:     used by people who may wish to upgrade many packages on a single host, and
                   4142:     can be invoked from the top-level pkgsrc Makefile by using the "
                   4143:     show-host-specific-pkgs" target.
1.1       dsieger  4144: 
1.184     rillig   4145: show-installed-depends
1.1       dsieger  4146: 
1.184     rillig   4147:     This target shows which installed packages match the current package's
                   4148:     DEPENDS. Useful if out of date dependencies are causing build problems.
1.1       dsieger  4149: 
1.184     rillig   4150: print-build-depends-list
1.1       dsieger  4151: 
1.184     rillig   4152:     This target shows the list of packages that the current package depends on
                   4153:     for building.
1.1       dsieger  4154: 
1.184     rillig   4155: print-run-depends-list
1.1       dsieger  4156: 
1.184     rillig   4157:     This target shows the list of packages that the current package depends on
                   4158:     for running.
1.1       dsieger  4159: 
1.184     rillig   4160: check-shlibs
1.1       dsieger  4161: 
1.184     rillig   4162:     After a package is installed, check all its binaries and (on ELF platforms)
                   4163:     shared libraries to see if they find the shared libs they need. Run by
                   4164:     default if PKG_DEVELOPER is set in mk.conf.
1.1       dsieger  4165: 
1.184     rillig   4166: print-PLIST
1.1       dsieger  4167: 
1.184     rillig   4168:     After a "make install" from a new or upgraded pkg, this prints out an
                   4169:     attempt to generate a new PLIST from a find -newer work/.extract_done. An
                   4170:     attempt is made to care for shared libs etc., but it is strongly
                   4171:     recommended to review the result before putting it into PLIST. On upgrades,
                   4172:     it's useful to diff the output of this command against an already existing
                   4173:     PLIST file.
1.1       dsieger  4174: 
1.184     rillig   4175:     If the package installs files via tar(1) or other methods that don't update
                   4176:     file access times, be sure to add these files manually to your PLIST, as
                   4177:     the "find -newer" command used by this target won't catch them!
1.56      ryoon    4178: 
1.184     rillig   4179:     See Section 19.3, "Tweaking output of make print-PLIST" for more
                   4180:     information on this target.
1.1       dsieger  4181: 
1.184     rillig   4182: Chapter 14. Creating a new pkgsrc package from scratch
1.1       dsieger  4183: 
1.184     rillig   4184: Table of Contents
1.1       dsieger  4185: 
1.184     rillig   4186: 14.1. Common types of packages
1.1       dsieger  4187: 
1.184     rillig   4188:     14.1.1. Perl modules
                   4189:     14.1.2. Python modules and programs
                   4190:     14.1.3. R packages
                   4191:     14.1.4. TeXlive packages
1.1       dsieger  4192: 
1.184     rillig   4193: 14.2. Examples
1.1       dsieger  4194: 
1.184     rillig   4195:     14.2.1. How the www/nvu package came into pkgsrc
1.1       dsieger  4196: 
1.184     rillig   4197: When you find a package that is not yet in pkgsrc, you most likely have a URL
                   4198: from where you can download the source code. Starting with this URL, creating a
                   4199: package involves only a few steps.
1.1       dsieger  4200: 
1.184     rillig   4201:  1. In your mk.conf, set PKG_DEVELOPER=yes to enable the basic quality checks.
1.1       dsieger  4202: 
1.184     rillig   4203:  2. Install the package meta-pkgs/pkg_developer, which among others will
                   4204:     install the utilities url2pkg, pkglint, pkgvi and mkpatches:
1.1       dsieger  4205: 
1.184     rillig   4206:     $ cd /usr/pkgsrc
                   4207:     $ (cd meta-pkgs/pkg_developer && bmake update)
1.1       dsieger  4208: 
1.184     rillig   4209:  3. Choose one of the top-level directories as the category in which you want
                   4210:     to place your package. You can also create a directory of your own (maybe
                   4211:     called local). In that category directory, create another directory for
                   4212:     your package and change into it:
1.1       dsieger  4213: 
1.184     rillig   4214:     $ mkdir category/package
                   4215:     $ cd category/package
1.1       dsieger  4216: 
1.184     rillig   4217:  4. Run the program url2pkg, which will ask you for a URL. Enter the URL of the
                   4218:     distribution file (in most cases a .tar.gz file) and watch how the basic
                   4219:     ingredients of your package are created automatically. The distribution
                   4220:     file is extracted automatically to fill in some details in the Makefile
                   4221:     that would otherwise have to be done manually:
1.1       dsieger  4222: 
1.184     rillig   4223:     $ url2pkg https://www.example.org/packages/package-1.0.tar.gz
1.1       dsieger  4224: 
1.184     rillig   4225:  5. Examine the extracted files to determine the dependencies of your package.
                   4226:     Ideally, this is mentioned in some README file, but things may differ. For
                   4227:     each of these dependencies, look where it exists in pkgsrc, and if there is
                   4228:     a file called buildlink3.mk in that directory, add a line to your package
                   4229:     Makefile which includes that file just before the last line. If the
                   4230:     buildlink3.mk file does not exist, it must be created first. The
                   4231:     buildlink3.mk file makes sure that the package's include files and
                   4232:     libraries are provided.
1.1       dsieger  4233: 
1.184     rillig   4234:     If you just need binaries from a package, add a DEPENDS line to the
                   4235:     Makefile, which specifies the version of the dependency and where it can be
                   4236:     found in pkgsrc. This line should be placed in the third paragraph. If the
                   4237:     dependency is only needed for building the package, but not when using it,
                   4238:     use TOOL_DEPENDS or BUILD_DEPENDS instead of DEPENDS. The difference
                   4239:     between TOOL_DEPENDS and BUILD_DEPENDS occurs when cross-compiling:
                   4240:     TOOL_DEPENDS are native packages, i.e. packages for the architecture where
                   4241:     the package is built; BUILD_DEPENDS are target packages, i.e. packages for
                   4242:     the architecture for which the package is built. There is also
                   4243:     TEST_DEPENDS, which is used to specify a dependency used only for testing
                   4244:     the resulting package built, using the upstream project's included test
                   4245:     suite. Your package may then look like this:
1.1       dsieger  4246: 
1.184     rillig   4247:     [...]
1.1       dsieger  4248: 
1.184     rillig   4249:     TOOL_DEPENDS+=  libxslt-[0-9]*:../../textproc/libxslt
                   4250:     DEPENDS+=       screen-[0-9]*:../../misc/screen
                   4251:     DEPENDS+=       screen>=4.0:../../misc/screen
1.1       dsieger  4252: 
1.184     rillig   4253:     [...]
1.1       dsieger  4254: 
1.184     rillig   4255:     .include "../../category/package/buildlink3.mk"
                   4256:     .include "../../devel/glib2/buildlink3.mk"
                   4257:     .include "../../mk/bsd.pkg.mk"
1.1       dsieger  4258: 
1.184     rillig   4259:  6. Run pkglint to see what things still need to be done to make your package a
                   4260:     "good" one. If you don't know what pkglint's warnings want to tell you, try
                   4261:     pkglint --explain or pkglint -e, which outputs additional explanations.
1.1       dsieger  4262: 
1.184     rillig   4263:  7. In many cases the package is not yet ready to build. You can find
                   4264:     instructions for the most common cases in the next section, Section 14.1,
                   4265:     "Common types of packages". After you have followed the instructions over
                   4266:     there, you can hopefully continue here.
1.1       dsieger  4267: 
1.184     rillig   4268:  8. Run bmake clean to clean the working directory from the extracted files.
                   4269:     Besides these files, a lot of cache files and other system information has
                   4270:     been saved in the working directory, which may become wrong after you
                   4271:     edited the Makefile.
1.1       dsieger  4272: 
1.184     rillig   4273:  9. Now, run bmake to build the package. For the various things that can go
                   4274:     wrong in this phase, consult Chapter 21, Making your package work.
1.1       dsieger  4275: 
1.184     rillig   4276:     If the extracted files from the package need to be fixed, run multiple
                   4277:     rounds of these commands:
1.1       dsieger  4278: 
1.184     rillig   4279:     $ make
                   4280:     $ pkgvi ${WRKSRC}/some/file/that/does/not/compile
                   4281:     $ mkpatches
                   4282:     $ make mps
                   4283:     $ make clean
1.1       dsieger  4284: 
1.184     rillig   4285: 10. When the package builds fine, the next step is to install the package. Run 
                   4286:     bmake install and hope that everything works.
1.1       dsieger  4287: 
1.184     rillig   4288: 11. Up to now, the file PLIST, which contains a list of the files that are
                   4289:     installed by the package, is nearly empty. Run bmake print-PLIST >PLIST to
                   4290:     generate a probably correct list. Check the file using your preferred text
                   4291:     editor to see if the list of files looks plausible.
1.1       dsieger  4292: 
1.184     rillig   4293: 12. Run pkglint again to see if the generated PLIST contains garbage or not.
1.1       dsieger  4294: 
1.184     rillig   4295: 13. When you ran bmake install, the package had been registered in the database
                   4296:     of installed files, but with an empty list of files. To fix this, run bmake
                   4297:     deinstall and bmake install again. Now the package is registered with the
                   4298:     list of files from PLIST.
1.48      wiz      4299: 
1.184     rillig   4300: 14. Run bmake package to create a binary package from the set of installed
                   4301:     files.
1.48      wiz      4302: 
1.184     rillig   4303: 15. Run bmake clean update to run everything from above again in a single step,
                   4304:     making sure that the PLIST is correct and the whole package is created as
                   4305:     intended.
1.48      wiz      4306: 
1.184     rillig   4307: 16. Run pkglint to see if there's anything left to do.
1.48      wiz      4308: 
1.184     rillig   4309: 17. Commit the package to pkgsrc-wip or main pkgsrc; see Chapter 23, Submitting
                   4310:     and Committing.
1.50      wiz      4311: 
1.184     rillig   4312: 14.1. Common types of packages
1.1       dsieger  4313: 
1.184     rillig   4314: 14.1.1. Perl modules
1.1       dsieger  4315: 
1.184     rillig   4316: Simple Perl modules are handled automatically by url2pkg, including
                   4317: dependencies.
1.1       dsieger  4318: 
1.184     rillig   4319: 14.1.2. Python modules and programs
1.1       dsieger  4320: 
1.184     rillig   4321: Python modules and programs packages are easily created using a set of
                   4322: predefined variables.
1.1       dsieger  4323: 
1.184     rillig   4324: If some Python versions are not supported by the software, set the
                   4325: PYTHON_VERSIONS_INCOMPATIBLE variable to the Python versions that are not
                   4326: supported, e.g.
1.1       dsieger  4327: 
1.184     rillig   4328: PYTHON_VERSIONS_INCOMPATIBLE=       27
1.1       dsieger  4329: 
1.184     rillig   4330: If the packaged software is a Python module, include one of ../../lang/python/
                   4331: egg.mk, ../../lang/python/distutils.mk, or ../../lang/python/extension.mk.
1.1       dsieger  4332: 
1.184     rillig   4333: Most Python packages use either "distutils" or easy-setup/setuptools ("eggs").
                   4334: If the packaged software is using setuptools, you only need to include "../../
                   4335: lang/python/egg.mk". Otherwise, if the software uses "distutils", include "..
                   4336: /../lang/python/distutils.mk", so pkgsrc will use this framework. "distutils"
                   4337: uses a script called setup.py; if the "distutils" driver is not called
                   4338: setup.py, set the PYSETUP variable to the name of the script.
1.1       dsieger  4339: 
1.184     rillig   4340: Either way, the package directory should be called "py-software" and PKGNAME
                   4341: should be set to "${PYPKGPREFIX}-${DISTNAME}", e.g.
1.1       dsieger  4342: 
1.184     rillig   4343: DISTNAME=   foopymodule-1.2.10
                   4344: PKGNAME=    ${PYPKGPREFIX}-${DISTNAME}
1.1       dsieger  4345: 
1.184     rillig   4346: If it is an application, include "../../lang/python/application.mk". In order
                   4347: to correctly set the path to the Python interpreter, use the REPLACE_PYTHON
                   4348: variable and set it to the list of files (paths relative to WRKSRC) that must
                   4349: be corrected. For example:
1.1       dsieger  4350: 
1.184     rillig   4351: REPLACE_PYTHON=   *.py
1.1       dsieger  4352: 
1.184     rillig   4353: Some Python modules have separate distributions for Python-2.x and Python-3.x
                   4354: support. In pkgsrc this is handled by the versioned_dependencies.mk file. Set
                   4355: PYTHON_VERSIONED_DEPENDENCIES to the list of packages that should be depended
                   4356: upon and include "../../lang/python/versioned_dependencies.mk", then the pkgsrc
                   4357: infrastructure will depend on the appropriate package version. For example:
1.1       dsieger  4358: 
1.184     rillig   4359: PYTHON_VERSIONED_DEPENDENCIES=dialog
1.1       dsieger  4360: 
1.184     rillig   4361: Look inside versioned_dependencies.mk for a list of supported packages.
1.1       dsieger  4362: 
1.184     rillig   4363: 14.1.3. R packages
1.1       dsieger  4364: 
1.184     rillig   4365: Simple R packages from CRAN are handled automatically by R2pkg, which is
                   4366: available in pkgtools/R2pkg. Individual packages (and optionally their
                   4367: dependencies) may be created and updated. R packages generally follow the same
                   4368: form, and most of the relevant information needed is contained in a DESCRIPTION
                   4369: file as part of each R package on CRAN. Consequently, R2pkg downloads that
                   4370: information and creates or updates a package in the canonical form. The
                   4371: resulting package should be reviewed for correctness.
1.1       dsieger  4372: 
1.184     rillig   4373: 14.1.4. TeXlive packages
1.1       dsieger  4374: 
1.184     rillig   4375: TeXlive packages from CTAN are handled automatically by texlive2pkg, which is
                   4376: available in pkgtools/texlive2pkg.
1.1       dsieger  4377: 
1.184     rillig   4378: If the TeXlive package name is not known, it may be useful to search CTAN. A "
                   4379: Contained in" field on the package page typically identifies the basename of
                   4380: the package file in the TeXlive archive.
1.1       dsieger  4381: 
1.184     rillig   4382: If the TeXlive package name is known, download the files from the TeXlive
                   4383: archive. For package foo, you will need to download foo.tar.xz. Most TeXlive
                   4384: packages also have associated documentation packages, so download
                   4385: foo.doc.tar.xz at the same time. These files should be placed in the
                   4386: appropriate category directory, which is often but not always print. Then run
                   4387: the following command in the category directory.
1.1       dsieger  4388: 
1.184     rillig   4389: texlive2pkg foo.tar.xz foo.doc.tar.xz
1.1       dsieger  4390: 
1.184     rillig   4391: This will create two packages, tex-foo and tex-foo-doc. Be sure to check that
                   4392: both packages are correct.
1.1       dsieger  4393: 
1.184     rillig   4394: Finally, CTAN currently does not include version information in package
                   4395: filenames and changes their contents periodically when updates occur.
                   4396: Consequently, pkgsrc avoids downloading distfiles directly from CTAN and
                   4397: instead relies on the pkgsrc archives. For each new or updated TeXlive package,
                   4398: e.g., the main one and the corresponding documentation, upload the distfiles
                   4399: with the following command in each package directory.
1.1       dsieger  4400: 
1.184     rillig   4401: make upload-distfiles
1.117     sevan    4402: 
1.184     rillig   4403: 14.2. Examples
1.117     sevan    4404: 
1.184     rillig   4405: 14.2.1. How the www/nvu package came into pkgsrc
1.1       dsieger  4406: 
1.184     rillig   4407: 14.2.1.1. The initial package
1.1       dsieger  4408: 
1.184     rillig   4409: Looking at the file pkgsrc/doc/TODO, I saw that the "nvu" package has not yet
                   4410: been imported into pkgsrc. As the description says it has to do with the web,
                   4411: the obvious choice for the category is "www".
1.1       dsieger  4412: 
1.184     rillig   4413: $ mkdir www/nvu
                   4414: $ cd www/nvu
1.1       dsieger  4415: 
1.184     rillig   4416: The web site says that the sources are available as a tar file, so I fed that
                   4417: URL to the url2pkg program:
1.1       dsieger  4418: 
1.184     rillig   4419: $ url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.1       dsieger  4420: 
1.184     rillig   4421: My editor popped up, and I added a PKGNAME line below the DISTNAME line, as the
                   4422: package name should not have the word "sources" in it. I also filled in the
                   4423: MAINTAINER, HOMEPAGE and COMMENT fields. Then the package Makefile looked like
                   4424: that:
1.1       dsieger  4425: 
1.184     rillig   4426: # $NetBSD $
                   4427: #
1.1       dsieger  4428: 
1.184     rillig   4429: DISTNAME=       nvu-1.0-sources
                   4430: PKGNAME=        nvu-1.0
                   4431: CATEGORIES=     www
                   4432: MASTER_SITES=   http://cvs.nvu.com/download/
                   4433: EXTRACT_SUFX=   .tar.bz2
1.1       dsieger  4434: 
1.184     rillig   4435: MAINTAINER=     rillig@NetBSD.org
                   4436: HOMEPAGE=       http://cvs.nvu.com/
                   4437: COMMENT=        Web Authoring System
1.1       dsieger  4438: 
1.184     rillig   4439: # url2pkg-marker (please do not remove this line.)
                   4440: .include "../../mk/bsd.pkg.mk"
1.1       dsieger  4441: 
1.184     rillig   4442: On the first line of output above, an artificial space has been added between
                   4443: NetBSD and $, this is a workaround to prevent CVS expanding to the filename of
                   4444: the guide.
1.1       dsieger  4445: 
1.184     rillig   4446: Then, I quit the editor and watched pkgsrc downloading a large source archive:
1.1       dsieger  4447: 
1.184     rillig   4448: url2pkg> Running "make makesum" ...
                   4449: => Required installed package digest>=20010302: digest-20060826 found
                   4450: => Fetching nvu-1.0-sources.tar.bz2
                   4451: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   4452: 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
                   4453: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   4454: url2pkg> Running "make extract" ...
                   4455: => Required installed package digest>=20010302: digest-20060826 found
                   4456: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   4457: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   4458: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
                   4459: ===> Installing dependencies for nvu-1.0
                   4460: ===> Overriding tools for nvu-1.0
                   4461: ===> Extracting for nvu-1.0
                   4462: url2pkg> Adjusting the Makefile.
1.1       dsieger  4463: 
1.184     rillig   4464: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.1       dsieger  4465: 
1.184     rillig   4466: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.1       dsieger  4467: 
1.184     rillig   4468: 14.2.1.2. Fixing all kinds of problems to make the package work
1.1       dsieger  4469: 
1.184     rillig   4470: Now that the package has been extracted, let's see what's inside it. The
                   4471: package has a README.txt, but that only says something about mozilla, so it's
                   4472: probably useless for seeing what dependencies this package has. But since there
                   4473: is a GNU configure script in the package, let's hope that it will complain
                   4474: about everything it needs.
1.1       dsieger  4475: 
1.184     rillig   4476: $ bmake
                   4477: => Required installed package digest>=20010302: digest-20060826 found
                   4478: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   4479: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   4480: ===> Patching for nvu-1.0
                   4481: ===> Creating toolchain wrappers for nvu-1.0
                   4482: ===> Configuring for nvu-1.0
                   4483: [...]
                   4484: configure: error: Perl 5.004 or higher is required.
                   4485: [...]
                   4486: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   4487: [...]
1.1       dsieger  4488: 
1.184     rillig   4489: That worked quite well. So I opened the package Makefile in my editor, and
                   4490: since it already has a USE_TOOLS line, I just appended "perl" to it. Since the
                   4491: dependencies of the package have changed now, and since a perl wrapper is
                   4492: automatically installed in the "tools" phase, I need to build the package from
                   4493: scratch.
1.1       dsieger  4494: 
1.184     rillig   4495: $ bmake clean
                   4496: ===> Cleaning for nvu-1.0
                   4497: $ bmake
                   4498: [...]
                   4499: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   4500: GNU Make.  You will not be able to build Mozilla without GNU Make.
                   4501: [...]
1.1       dsieger  4502: 
1.184     rillig   4503: So I added "gmake" to the USE_TOOLS line and tried again (from scratch).
1.1       dsieger  4504: 
1.184     rillig   4505: [...]
                   4506: checking for GTK - version >= 1.2.0... no
                   4507: *** Could not run GTK test program, checking why...
                   4508: [...]
1.1       dsieger  4509: 
1.184     rillig   4510: Now to the other dependencies. The first question is: Where is the GTK package
                   4511: hidden in pkgsrc?
1.1       dsieger  4512: 
1.184     rillig   4513: $ echo ../../*/gtk*
                   4514: [many packages ...]
                   4515: $ echo ../../*/gtk
                   4516: ../../x11/gtk
                   4517: $ echo ../../*/gtk2
                   4518: ../../x11/gtk2
                   4519: $ echo ../../*/gtk2/bui*
                   4520: ../../x11/gtk2/buildlink3.mk
1.1       dsieger  4521: 
1.184     rillig   4522: The first try was definitely too broad. The second one had exactly one result,
                   4523: which is very good. But there is one pitfall with GNOME packages. Before GNOME
                   4524: 2 had been released, there were already many GNOME 1 packages in pkgsrc. To be
                   4525: able to continue to use these packages, the GNOME 2 packages were imported as
                   4526: separate packages, and their names usually have a "2" appended. So I checked
                   4527: whether this was the case here, and indeed it was.
1.1       dsieger  4528: 
1.184     rillig   4529: Since the GTK2 package has a buildlink3.mk file, adding the dependency is very
                   4530: easy. I just inserted an .include line before the last line of the package
                   4531: Makefile, so that it now looks like this:
1.1       dsieger  4532: 
1.184     rillig   4533: [...]
                   4534: .include "../../x11/gtk2/buildlink3.mk"
                   4535: .include "../../mk/bsd.pkg.mk
1.1       dsieger  4536: 
1.184     rillig   4537: After another bmake clean && bmake, the answer was:
1.108     rillig   4538: 
1.184     rillig   4539: [...]
                   4540: checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   4541: checking for GTK - version >= 1.2.0... no
                   4542: *** Could not run GTK test program, checking why...
                   4543: *** The test program failed to compile or link. See the file config.log for the
                   4544: *** exact error that occured. This usually means GTK was incorrectly installed
                   4545: *** or that you have moved GTK since it was installed. In the latter case, you
                   4546: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   4547: configure: error: Test for GTK failed.
                   4548: [...]
1.1       dsieger  4549: 
1.184     rillig   4550: In this particular case, the assumption that "every package prefers GNOME 2"
                   4551: had been wrong. The first of the lines above told me that this package really
                   4552: wanted to have the GNOME 1 version of GTK. If the package had looked for GTK2,
                   4553: it would have looked for pkg-config instead of gtk-config. So I changed the x11
                   4554: /gtk2 to x11/gtk in the package Makefile, and tried again.
1.1       dsieger  4555: 
1.184     rillig   4556: [...]
                   4557: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\"  [...]
                   4558: In file included from xpidl.c:42:
                   4559: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   4560: In file included from xpidl.c:42:
                   4561: xpidl.h:132: error: parse error before "IDL_ns"
                   4562: [...]
1.1       dsieger  4563: 
1.184     rillig   4564: The package still does not find all of its dependencies. Now the question is:
                   4565: Which package provides the libIDL/IDL.h header file?
1.1       dsieger  4566: 
1.184     rillig   4567: $ echo ../../*/*idl*
                   4568: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   4569: $ echo ../../*/*IDL*
                   4570: ../../net/libIDL
1.1       dsieger  4571: 
1.184     rillig   4572: Let's take the one from the second try. So I included the ../../net/libIDL/
                   4573: buildlink3.mk file and tried again. But the error didn't change. After digging
                   4574: through some of the code, I concluded that the build process of the package was
                   4575: broken and couldn't have ever worked, but since the Mozilla source tree is
                   4576: quite large, I didn't want to fix it. So I added the following to the package
                   4577: Makefile and tried again:
1.1       dsieger  4578: 
1.184     rillig   4579: CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
                   4580: BUILDLINK_TRANSFORM+=   l:IDL:IDL-2
1.1       dsieger  4581: 
1.184     rillig   4582: The latter line is needed because the package expects the library libIDL.so,
                   4583: but only libIDL-2.so is available. So I told the compiler wrapper to rewrite
                   4584: that on the fly.
1.1       dsieger  4585: 
1.184     rillig   4586: The next problem was related to a recent change of the FreeType interface. I
                   4587: looked up in www/seamonkey which patch files were relevant for this issue and
                   4588: copied them to the patches directory. Then I retried, fixed the patches so that
                   4589: they applied cleanly and retried again. This time, everything worked.
1.1       dsieger  4590: 
1.184     rillig   4591: 14.2.1.3. Installing the package
1.1       dsieger  4592: 
1.184     rillig   4593: $ bmake CHECK_FILES=no install
                   4594: [...]
                   4595: $ bmake print-PLIST >PLIST
                   4596: $ bmake deinstall
                   4597: $ bmake install
1.1       dsieger  4598: 
1.184     rillig   4599: Chapter 15. Programming in Makefiles
1.1       dsieger  4600: 
1.184     rillig   4601: Table of Contents
1.1       dsieger  4602: 
1.184     rillig   4603: 15.1. Caveats
                   4604: 15.2. Makefile variables
1.1       dsieger  4605: 
1.184     rillig   4606:     15.2.1. Naming conventions
1.1       dsieger  4607: 
1.184     rillig   4608: 15.3. Code snippets
1.1       dsieger  4609: 
1.184     rillig   4610:     15.3.1. Adding things to a list
                   4611:     15.3.2. Echoing a string exactly as-is
                   4612:     15.3.3. Passing CFLAGS to GNU configure scripts
                   4613:     15.3.4. Handling possibly empty variables
1.1       dsieger  4614: 
1.184     rillig   4615: Pkgsrc consists of many Makefile fragments, each of which forms a well-defined
                   4616: part of the pkgsrc system. Using the make(1) system as a programming language
                   4617: for a big system like pkgsrc requires some discipline to keep the code correct
                   4618: and understandable.
1.1       dsieger  4619: 
1.184     rillig   4620: The basic ingredients for Makefile programming are variables and shell
                   4621: commands. Among these shell commands may even be more complex ones like awk(1)
                   4622: programs. To make sure that every shell command runs as intended it is
                   4623: necessary to quote all variables correctly when they are used.
1.1       dsieger  4624: 
1.184     rillig   4625: This chapter describes some patterns that appear quite often in Makefiles,
                   4626: including the pitfalls that come along with them.
1.1       dsieger  4627: 
1.184     rillig   4628: 15.1. Caveats
1.1       dsieger  4629: 
1.184     rillig   4630:   * When you are creating a file as a target of a rule, always write the data
                   4631:     to a temporary file first and finally rename that file. Otherwise there
                   4632:     might occur an error in the middle of generating the file, and when the
                   4633:     user runs make(1) for the second time, the file exists and will not be
                   4634:     regenerated properly. Example:
1.1       dsieger  4635: 
1.184     rillig   4636:     wrong:
                   4637:             @echo "line 1" > ${.TARGET}
                   4638:             @echo "line 2" >> ${.TARGET}
                   4639:             @false
1.1       dsieger  4640: 
1.184     rillig   4641:     correct:
                   4642:             @echo "line 1" > ${.TARGET}.tmp
                   4643:             @echo "line 2" >> ${.TARGET}.tmp
                   4644:             @false
                   4645:             @mv ${.TARGET}.tmp ${.TARGET}
1.1       dsieger  4646: 
1.184     rillig   4647:     When you run make wrong twice, the file wrong will exist, although there
                   4648:     was an error message in the first run. On the other hand, running make
                   4649:     correct gives an error message twice, as expected.
1.1       dsieger  4650: 
1.184     rillig   4651:     You might remember that make(1) sometimes removes ${.TARGET} in case of
                   4652:     error, but this only happens when it is interrupted, for example by
                   4653:     pressing Ctrl+C. This does not happen when one of the commands fails (like
                   4654:     false(1) above).
1.1       dsieger  4655: 
1.184     rillig   4656: 15.2. Makefile variables
1.1       dsieger  4657: 
1.184     rillig   4658: Makefile variables contain strings that can be processed using the five
                   4659: operators =, +=, ?=, := and !=, which are described in the make(1) man page.
1.1       dsieger  4660: 
1.184     rillig   4661: When a variable's value is parsed from a Makefile, the hash character # and the
                   4662: backslash character \ are handled specially. If a backslash is the last
                   4663: character in a line, that backslash is removed from the line and the line
                   4664: continues with the next line of the file.
1.1       dsieger  4665: 
1.184     rillig   4666: The # character starts a comment that reaches until the end of the line. To get
                   4667: an actual # character, such as in a URL, write \# instead.
1.1       dsieger  4668: 
1.184     rillig   4669: The evaluation of variables either happens immediately or lazy. It happens
                   4670: immediately when the variable occurs on the right-hand side of the := or the !=
                   4671: operator, in a .if condition or a .for loop. In the other cases, it is
                   4672: evaluated lazily.
1.1       dsieger  4673: 
1.184     rillig   4674: Some of the modifiers split the string into words and then operate on the
                   4675: words, others operate on the string as a whole. When a string is split into
                   4676: words, double quotes and single quotes are interpreted as delimiters, just like
                   4677: in sh(1).
1.1       dsieger  4678: 
1.184     rillig   4679: 15.2.1. Naming conventions
1.1       dsieger  4680: 
1.184     rillig   4681:   * All variable names starting with an underscore are reserved for use by the
                   4682:     pkgsrc infrastructure. They shall not be used by packages.
1.1       dsieger  4683: 
1.184     rillig   4684:   * In .for loops you should use lowercase variable names for the iteration
                   4685:     variables.
1.1       dsieger  4686: 
1.184     rillig   4687:   * All list variables should have a plural name, such as PKG_OPTIONS or
                   4688:     DISTFILES.
1.1       dsieger  4689: 
1.184     rillig   4690: 15.3. Code snippets
1.1       dsieger  4691: 
1.184     rillig   4692: 15.3.1. Adding things to a list
1.1       dsieger  4693: 
1.184     rillig   4694: When adding a string that possibly contains whitespace or quotes to a list
                   4695: (example 1), it must be quoted using the :Q modifier.
1.1       dsieger  4696: 
1.184     rillig   4697: When adding another list to a list (example 2), it must not be quoted, since
                   4698: its elements are already quoted.
1.1       dsieger  4699: 
1.184     rillig   4700: STRING=         foo * bar `date`
                   4701: LIST=           # empty
                   4702: ANOTHER_LIST=   a=b c=d
1.1       dsieger  4703: 
1.184     rillig   4704: LIST+=          ${STRING:Q}       # 1
                   4705: LIST+=          ${ANOTHER_LIST}   # 2
1.1       dsieger  4706: 
1.184     rillig   4707: 15.3.2. Echoing a string exactly as-is
1.1       dsieger  4708: 
1.184     rillig   4709: Echoing a string containing special characters needs special work.
1.1       dsieger  4710: 
1.184     rillig   4711: STRING=         foo bar <    > * `date` $$HOME ' "
                   4712: EXAMPLE_ENV=    string=${STRING:Q} x=multiple\ quoted\ words
1.1       dsieger  4713: 
1.184     rillig   4714: all:
                   4715:         echo ${STRING}                  # 1
                   4716:         echo ${STRING:Q}                # 2
                   4717:         printf '%s\n' ${STRING:Q}''     # 3
                   4718:         env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"'   # 4
1.1       dsieger  4719: 
1.184     rillig   4720: Example 1 leads to a syntax error in the shell, as the characters are just
                   4721: copied.
1.1       dsieger  4722: 
1.184     rillig   4723: Example 2 quotes the string so that the shell interprets it correctly. But the
                   4724: echo command may additionally interpret strings with a leading dash or those
                   4725: containing backslashes.
1.1       dsieger  4726: 
1.184     rillig   4727: Example 3 can handle arbitrary strings, since printf(1) only interprets the
                   4728: format string, but not the next argument. The trailing single quotes handle the
                   4729: case when the string is empty. In that case, the :Q modifier would result in an
                   4730: empty string too, which would then be skipped by the shell. For printf(1) this
                   4731: doesn't make a difference, but other programs may care.
1.1       dsieger  4732: 
1.184     rillig   4733: In example 4, the EXAMPLE_ENV does not need to be quoted because the quoting
                   4734: has already been done when adding elements to the list.
1.1       dsieger  4735: 
1.184     rillig   4736: 15.3.3. Passing CFLAGS to GNU configure scripts
1.1       dsieger  4737: 
1.184     rillig   4738: When passing CFLAGS or similar variables to a GNU-style configure script
                   4739: (especially those that call other configure scripts), it must not have leading
                   4740: or trailing whitespace, since otherwise the configure script gets confused. To
                   4741: trim leading and trailing whitespace, use the :M modifier, as in the following
                   4742: example:
1.1       dsieger  4743: 
1.184     rillig   4744: CPPFLAGS=               # empty
                   4745: CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX}\"
                   4746: CPPFLAGS+=              ${MY_CPPFLAGS}
1.1       dsieger  4747: 
1.184     rillig   4748: CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
1.1       dsieger  4749: 
1.184     rillig   4750: all:
                   4751:         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
                   4752:         echo x${CONFIGURE_ARGS:Q}x      # properly trimmed
1.1       dsieger  4753: 
1.184     rillig   4754: In this example, CPPFLAGS has both leading and trailing whitespace because the
                   4755: += operator always adds a space.
1.1       dsieger  4756: 
1.184     rillig   4757: 15.3.4. Handling possibly empty variables
1.1       dsieger  4758: 
1.184     rillig   4759: When a possibly empty variable is used in a shell program, it may lead to a
                   4760: syntax error.
1.1       dsieger  4761: 
1.184     rillig   4762: EGFILES=        # empty
1.1       dsieger  4763: 
1.184     rillig   4764: install-examples:   # produces a syntax error in the shell
                   4765:         for egfile in ${EGFILES}; do            \
                   4766:                 echo "Installing $$egfile";     \
                   4767:         done
1.1       dsieger  4768: 
1.184     rillig   4769: The shell only sees the text for egfile in ; do, since ${EGFILES} is replaced
                   4770: with an empty string by make(1). To fix this syntax error, use one of the
                   4771: snippets below.
1.1       dsieger  4772: 
1.184     rillig   4773: EMPTY=          # empty
1.1       dsieger  4774: 
1.184     rillig   4775: install-examples:
                   4776:         for egfile in ${EGFILES} ""; do         \
                   4777:                 [ -n "$$egfile" ] || continue;  \
                   4778:                 echo "Installing $$egfile";     \
                   4779:         done
1.1       dsieger  4780: 
1.184     rillig   4781: In this case, an empty string is appended to the iteration list (to prevent the
                   4782: syntax error) and filtered out later.
1.1       dsieger  4783: 
1.184     rillig   4784: EGFILES=        # empty
1.1       dsieger  4785: 
1.184     rillig   4786: install-examples:
                   4787: .for egfile in ${EGFILES}
                   4788:         echo "Installing ${egfile}"
                   4789: .endfor
1.1       dsieger  4790: 
1.184     rillig   4791: If one of the filenames contains special characters, it should be enclosed in
                   4792: single or double quotes.
1.1       dsieger  4793: 
1.184     rillig   4794: To have a shell command test whether a make variable is empty, use the
                   4795: following code: ${TEST} -z ${POSSIBLY_EMPTY:Q}"".
1.1       dsieger  4796: 
1.184     rillig   4797: Chapter 16. Options handling
1.1       dsieger  4798: 
                   4799: Table of Contents
                   4800: 
1.184     rillig   4801: 16.1. Global default options
                   4802: 16.2. Converting packages to use bsd.options.mk
                   4803: 16.3. Option Names
                   4804: 16.4. Determining the options of dependencies
1.1       dsieger  4805: 
                   4806: Many packages have the ability to be built to support different sets of
                   4807: features. bsd.options.mk is a framework in pkgsrc that provides generic
                   4808: handling of those options that determine different ways in which the packages
                   4809: can be built. It's possible for the user to specify exactly which sets of
                   4810: options will be built into a package or to allow a set of global default
                   4811: options apply.
                   4812: 
1.7       rillig   4813: There are two broad classes of behaviors that one might want to control via
                   4814: options. One is whether some particular feature is enabled in a program that
                   4815: will be built anyway, often by including or not including a dependency on some
                   4816: other package. The other is whether or not an additional program will be built
                   4817: as part of the package. Generally, it is better to make a split package for
                   4818: such additional programs instead of using options, because it enables binary
                   4819: packages to be built which can then be added separately. For example, the foo
                   4820: package might have minimal dependencies (those packages without which foo
                   4821: doesn't make sense), and then the foo-gfoo package might include the GTK
                   4822: frontend program gfoo. This is better than including a gtk option to foo that
                   4823: adds gfoo, because either that option is default, in which case binary users
                   4824: can't get foo without gfoo, or not default, in which case they can't get gfoo.
                   4825: With split packages, they can install foo without having GTK, and later decide
                   4826: to install gfoo (pulling in GTK at that time). This is an advantage to source
                   4827: users too, avoiding the need for rebuilds.
                   4828: 
                   4829: Plugins with widely varying dependencies should usually be split instead of
                   4830: options.
                   4831: 
                   4832: It is often more work to maintain split packages, especially if the upstream
                   4833: package does not support this. The decision of split vs. option should be made
                   4834: based on the likelihood that users will want or object to the various pieces,
                   4835: the size of the dependencies that are included, and the amount of work.
                   4836: 
                   4837: A further consideration is licensing. Non-free parts, or parts that depend on
                   4838: non-free dependencies (especially plugins) should almost always be split if
                   4839: feasible.
                   4840: 
1.184     rillig   4841: 16.1. Global default options
1.1       dsieger  4842: 
                   4843: Global default options are listed in PKG_DEFAULT_OPTIONS, which is a list of
                   4844: the options that should be built into every package if that option is
1.4       rillig   4845: supported. This variable should be set in mk.conf.
1.1       dsieger  4846: 
1.184     rillig   4847: 16.2. Converting packages to use bsd.options.mk
1.1       dsieger  4848: 
                   4849: The following example shows how bsd.options.mk should be used by the
                   4850: hypothetical ``wibble'' package, either in the package Makefile, or in a file,
                   4851: e.g. options.mk, that is included by the main package Makefile.
                   4852: 
                   4853: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   4854: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   4855: PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   4856: PKG_OPTIONS_GROUP.database=     mysql pgsql
                   4857: PKG_SUGGESTED_OPTIONS=          wibble-foo
                   4858: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   4859: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
                   4860: 
                   4861: .include "../../mk/bsd.prefs.mk"
                   4862: 
                   4863: # this package was previously named wibble2
                   4864: .if defined(PKG_OPTIONS.wibble2)
                   4865: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   4866: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
                   4867:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
                   4868: .endif
                   4869: 
                   4870: .include "../../mk/bsd.options.mk"
                   4871: 
                   4872: # Package-specific option-handling
                   4873: 
                   4874: ###
                   4875: ### FOO support
                   4876: ###
                   4877: .if !empty(PKG_OPTIONS:Mwibble-foo)
                   4878: CONFIGURE_ARGS+=    --enable-foo
                   4879: .endif
                   4880: 
                   4881: ###
                   4882: ### LDAP support
                   4883: ###
                   4884: .if !empty(PKG_OPTIONS:Mldap)
                   4885: .  include "../../databases/openldap-client/buildlink3.mk"
                   4886: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
                   4887: .endif
                   4888: 
                   4889: ###
                   4890: ### database support
                   4891: ###
                   4892: .if !empty(PKG_OPTIONS:Mmysql)
                   4893: .  include "../../mk/mysql.buildlink3.mk"
                   4894: .endif
                   4895: .if !empty(PKG_OPTIONS:Mpgsql)
                   4896: .  include "../../mk/pgsql.buildlink3.mk"
                   4897: .endif
                   4898: 
                   4899: The first section contains the information about which build options are
                   4900: supported by the package, and any default options settings if needed.
                   4901: 
                   4902:  1. PKG_OPTIONS_VAR is the name of the make(1) variable that the user can set
                   4903:     to override the default options. It should be set to PKG_OPTIONS.pkgbase.
                   4904:     Do not set it to PKG_OPTIONS.${PKGBASE}, since PKGBASE is not defined at
                   4905:     the point where the options are processed.
                   4906: 
                   4907:  2. PKG_SUPPORTED_OPTIONS is a list of build options supported by the package.
                   4908: 
                   4909:  3. PKG_OPTIONS_OPTIONAL_GROUPS is a list of names of groups of mutually
                   4910:     exclusive options. The options in each group are listed in
                   4911:     PKG_OPTIONS_GROUP.groupname. The most specific setting of any option from
                   4912:     the group takes precedence over all other options in the group. Options
                   4913:     from the groups will be automatically added to PKG_SUPPORTED_OPTIONS.
                   4914: 
                   4915:  4. PKG_OPTIONS_REQUIRED_GROUPS is like PKG_OPTIONS_OPTIONAL_GROUPS, but
                   4916:     building the packages will fail if no option from the group is selected.
                   4917: 
                   4918:  5. PKG_OPTIONS_NONEMPTY_SETS is a list of names of sets of options. At least
                   4919:     one option from each set must be selected. The options in each set are
                   4920:     listed in PKG_OPTIONS_SET.setname. Options from the sets will be
                   4921:     automatically added to PKG_SUPPORTED_OPTIONS. Building the package will
                   4922:     fail if no option from the set is selected.
                   4923: 
                   4924:  6. PKG_SUGGESTED_OPTIONS is a list of build options which are enabled by
                   4925:     default.
                   4926: 
                   4927:  7. PKG_OPTIONS_LEGACY_VARS is a list of "USE_VARIABLE:option" pairs that map
1.4       rillig   4928:     legacy mk.conf variables to their option counterparts. Pairs should be
1.1       dsieger  4929:     added with "+=" to keep the listing of global legacy variables. A warning
                   4930:     will be issued if the user uses a legacy variable.
                   4931: 
                   4932:  8. PKG_OPTIONS_LEGACY_OPTS is a list of "old-option:new-option" pairs that map
                   4933:     options that have been renamed to their new counterparts. Pairs should be
                   4934:     added with "+=" to keep the listing of global legacy options. A warning
                   4935:     will be issued if the user uses a legacy option.
                   4936: 
                   4937:  9. PKG_LEGACY_OPTIONS is a list of options implied by deprecated variables
                   4938:     used. This can be used for cases that neither PKG_OPTIONS_LEGACY_VARS nor
                   4939:     PKG_OPTIONS_LEGACY_OPTS can handle, e. g. when PKG_OPTIONS_VAR is renamed.
                   4940: 
                   4941: 10. PKG_OPTIONS_DEPRECATED_WARNINGS is a list of warnings about deprecated
                   4942:     variables or options used, and what to use instead.
                   4943: 
                   4944: A package should never modify PKG_DEFAULT_OPTIONS or the variable named in
                   4945: PKG_OPTIONS_VAR. These are strictly user-settable. To suggest a default set of
                   4946: options, use PKG_SUGGESTED_OPTIONS.
                   4947: 
                   4948: PKG_OPTIONS_VAR must be defined before including bsd.options.mk. If none of
                   4949: PKG_SUPPORTED_OPTIONS, PKG_OPTIONS_OPTIONAL_GROUPS, and
                   4950: PKG_OPTIONS_REQUIRED_GROUPS are defined (as can happen with platform-specific
                   4951: options if none of them is supported on the current platform), PKG_OPTIONS is
                   4952: set to the empty list and the package is otherwise treated as not using the
                   4953: options framework.
                   4954: 
                   4955: After the inclusion of bsd.options.mk, the variable PKG_OPTIONS contains the
                   4956: list of selected build options, properly filtered to remove unsupported and
                   4957: duplicate options.
                   4958: 
                   4959: The remaining sections contain the logic that is specific to each option. The
                   4960: correct way to check for an option is to check whether it is listed in
                   4961: PKG_OPTIONS:
                   4962: 
                   4963: .if !empty(PKG_OPTIONS:Moption)
                   4964: 
1.184     rillig   4965: 16.3. Option Names
1.1       dsieger  4966: 
                   4967: Options that enable similar features in different packages (like optional
                   4968: support for a library) should use a common name in all packages that support it
                   4969: (like the name of the library). If another package already has an option with
                   4970: the same meaning, use the same name.
                   4971: 
                   4972: Options that enable features specific to one package, where it's unlikely that
                   4973: another (unrelated) package has the same (or a similar) optional feature,
                   4974: should use a name prefixed with pkgname-.
                   4975: 
                   4976: If a group of related packages share an optional feature specific to that
                   4977: group, prefix it with the name of the "main" package (e. g.
                   4978: djbware-errno-hack).
                   4979: 
                   4980: For new options, add a line to mk/defaults/options.description. Lines have two
                   4981: fields, separated by tab. The first field is the option name, the second its
                   4982: description. The description should be a whole sentence (starting with an
                   4983: uppercase letter and ending with a period) that describes what enabling the
                   4984: option does. E. g. "Enable ispell support." The file is sorted by option names.
                   4985: 
1.184     rillig   4986: 16.4. Determining the options of dependencies
1.7       rillig   4987: 
                   4988: When writing buildlink3.mk files, it is often necessary to list different
                   4989: dependencies based on the options with which the package was built. For
                   4990: querying these options, the file pkgsrc/mk/pkg-build-options.mk should be used.
                   4991: A typical example looks like this:
                   4992: 
                   4993: pkgbase := libpurple
                   4994: .include "../../mk/pkg-build-options.mk"
                   4995: 
                   4996: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
                   4997: ...
                   4998: .endif
                   4999: 
                   5000: Including pkg-build-options.mk here will set the variable
                   5001: PKG_BUILD_OPTIONS.libpurple to the build options of the libpurple package,
                   5002: which can then be queried like PKG_OPTIONS in the options.mk file. See the file
                   5003: pkg-build-options.mk for more details.
                   5004: 
1.184     rillig   5005: Chapter 17. Tools needed for building or running
                   5006: 
                   5007: Table of Contents
                   5008: 
                   5009: 17.1. Tools for pkgsrc builds
                   5010: 17.2. Tools needed by packages
                   5011: 17.3. Tools provided by platforms
                   5012: 
                   5013: The USE_TOOLS definition is used both internally by pkgsrc and also for
                   5014: individual packages to define what commands are needed for building a package
                   5015: (like TOOL_DEPENDS) or for later run-time of an installed packaged (such as
                   5016: DEPENDS). If the native system provides an adequate tool, then in many cases, a
                   5017: pkgsrc package will not be used.
                   5018: 
                   5019: When building a package, the replacement tools are made available in a
                   5020: directory (as symlinks or wrapper scripts) that is early in the executable
                   5021: search path. Just like the buildlink system, this helps with consistent builds.
                   5022: 
                   5023: A tool may be needed to help build a specific package. For example, perl, GNU
                   5024: make (gmake) or yacc may be needed.
                   5025: 
                   5026: Also a tool may be needed, for example, because the native system's supplied
                   5027: tool may be inefficient for building a package with pkgsrc. For example, a
                   5028: package may need GNU awk, bison (instead of yacc) or a better sed.
                   5029: 
                   5030: The tools used by a package can be listed by running make show-tools.
                   5031: 
                   5032: 17.1. Tools for pkgsrc builds
                   5033: 
                   5034: The default set of tools used by pkgsrc is defined in bsd.pkg.mk. This includes
                   5035: standard Unix tools, such as: cat, awk, chmod, test, and so on. These can be
                   5036: seen by running: make show-var VARNAME=USE_TOOLS.
                   5037: 
                   5038: If a package needs a specific program to build then the USE_TOOLS variable can
                   5039: be used to define the tools needed.
                   5040: 
                   5041: 17.2. Tools needed by packages
                   5042: 
                   5043: In the following examples, the :run means that it is needed at run-time (and
                   5044: becomes a DEPENDS). The default is a build dependency which can be set with
                   5045: :build. (So in this example, it is the same as gmake:build and
                   5046: pkg-config:build.)
                   5047: 
                   5048: USE_TOOLS+=     gmake perl:run pkg-config
                   5049: 
                   5050: When using the tools framework, a TOOLS_PATH.foo variable is defined which
                   5051: contains the full path to the appropriate tool. For example, TOOLS_PATH.bash
                   5052: could be "/bin/bash" on Linux systems.
                   5053: 
                   5054: If you always need a pkgsrc version of the tool at run-time, then just use
                   5055: DEPENDS instead.
                   5056: 
                   5057: 17.3. Tools provided by platforms
                   5058: 
                   5059: When improving or porting pkgsrc to a new platform, have a look at (or create)
                   5060: the corresponding platform specific make file fragment under pkgsrc/mk/tools/
                   5061: tools.${OPSYS}.mk which defines the name of the common tools. For example:
                   5062: 
                   5063: .if exists(/usr/bin/bzcat)
                   5064: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   5065: .elif exists(/usr/bin/bzip2)
                   5066: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   5067: .endif
                   5068: 
                   5069: TOOLS_PLATFORM.true?=           true                    # shell builtin
                   5070: 
                   5071: Chapter 18. Buildlink methodology
1.1       dsieger  5072: 
                   5073: Table of Contents
                   5074: 
1.184     rillig   5075: 18.1. Converting packages to use buildlink3
                   5076: 18.2. Writing buildlink3.mk files
                   5077: 
                   5078:     18.2.1. Anatomy of a buildlink3.mk file
                   5079:     18.2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS.pkg in
                   5080:         buildlink3.mk files
                   5081: 
                   5082: 18.3. Writing builtin.mk files
                   5083: 
                   5084:     18.3.1. Anatomy of a builtin.mk file
                   5085:     18.3.2. Global preferences for native or pkgsrc software
                   5086: 
                   5087: Buildlink is a framework in pkgsrc that controls what headers and libraries are
                   5088: seen by a package's configure and build processes. This is implemented in a two
                   5089: step process:
                   5090: 
                   5091:  1. Symlink headers and libraries for dependencies into BUILDLINK_DIR, which by
                   5092:     default is a subdirectory of WRKDIR.
                   5093: 
                   5094:  2. Create wrapper scripts that are used in place of the normal compiler tools
                   5095:     that translate -I${LOCALBASE}/include and -L${LOCALBASE}/lib into
                   5096:     references to BUILDLINK_DIR. The wrapper scripts also make native compiler
                   5097:     on some operating systems look like GCC, so that packages that expect GCC
                   5098:     won't require modifications to build with those native compilers.
                   5099: 
                   5100: This normalizes the environment in which a package is built so that the package
                   5101: may be built consistently despite what other software may be installed. Please
                   5102: note that the normal system header and library paths, e.g. /usr/include, /usr/
                   5103: lib, etc., are always searched -- buildlink3 is designed to insulate the
                   5104: package build from non-system-supplied software.
                   5105: 
                   5106: 18.1. Converting packages to use buildlink3
1.1       dsieger  5107: 
1.184     rillig   5108: The process of converting packages to use the buildlink3 framework ("bl3ifying"
                   5109: ) is fairly straightforward. The things to keep in mind are:
1.1       dsieger  5110: 
1.184     rillig   5111:  1. Ensure that the build always calls the wrapper scripts instead of the
                   5112:     actual toolchain. Some packages are tricky, and the only way to know for
                   5113:     sure is the check ${WRKDIR}/.work.log to see if the wrappers are being
                   5114:     invoked.
1.1       dsieger  5115: 
1.184     rillig   5116:  2. Don't override PREFIX from within the package Makefile, e.g. Java VMs,
                   5117:     standalone shells, etc., because the code to symlink files into $
                   5118:     {BUILDLINK_DIR} looks for files relative to "pkg_info -qp pkgname".
1.1       dsieger  5119: 
1.184     rillig   5120:  3. Remember that only the buildlink3.mk files that you list in a package's
                   5121:     Makefile are added as dependencies for that package.
1.1       dsieger  5122: 
1.184     rillig   5123: If a dependency on a particular package is required for its libraries and
                   5124: headers, then we replace:
1.1       dsieger  5125: 
1.184     rillig   5126: DEPENDS+=       foo>=1.1.0:../../category/foo
1.1       dsieger  5127: 
1.184     rillig   5128: with
1.1       dsieger  5129: 
1.184     rillig   5130: .include "../../category/foo/buildlink3.mk"
1.1       dsieger  5131: 
1.184     rillig   5132: The buildlink3.mk files usually define the required dependencies. If you need a
                   5133: newer version of the dependency when using buildlink3.mk files, then you can
                   5134: define it in your Makefile; for example:
1.1       dsieger  5135: 
1.184     rillig   5136: BUILDLINK_API_DEPENDS.foo+=   foo>=1.1.0
                   5137: .include "../../category/foo/buildlink3.mk"
1.1       dsieger  5138: 
1.184     rillig   5139: There are several buildlink3.mk files in pkgsrc/mk that handle special package
                   5140: issues:
1.1       dsieger  5141: 
1.184     rillig   5142:   * bdb.buildlink3.mk chooses either the native or a pkgsrc Berkeley DB
                   5143:     implementation based on the values of BDB_ACCEPTED and BDB_DEFAULT.
1.1       dsieger  5144: 
1.184     rillig   5145:   * curses.buildlink3.mk: If the system comes with neither Curses nor NCurses,
                   5146:     this will take care to install the devel/ncurses package.
1.1       dsieger  5147: 
1.184     rillig   5148:   * krb5.buildlink3.mk uses the value of KRB5_ACCEPTED to choose between adding
                   5149:     a dependency on Heimdal or MIT-krb5 for packages that require a Kerberos 5
                   5150:     implementation.
1.1       dsieger  5151: 
1.184     rillig   5152:   * motif.buildlink3.mk checks for a system-provided Motif installation or adds
                   5153:     a dependency on x11/lesstif or x11/motif. The user can set MOTIF_TYPE to "
                   5154:     dt", "lesstif" or "motif" to choose which Motif version will be used.
1.1       dsieger  5155: 
1.184     rillig   5156:   * readline.buildlink3.mk checks for a system-provided GNU readline or
                   5157:     editline (libedit) installation, or adds a dependency on devel/readline,
                   5158:     devel/editline. The user can set READLINE_DEFAULT to choose readline
                   5159:     implementation. If your package really needs GNU readline library, its
                   5160:     Makefile should include devel/readline/buildlink3.mk instead of
                   5161:     readline.buildlink3.mk.
1.1       dsieger  5162: 
1.184     rillig   5163:   * oss.buildlink3.mk defines several variables that may be used by packages
                   5164:     that use the Open Sound System (OSS) API.
1.1       dsieger  5165: 
1.184     rillig   5166:   * pgsql.buildlink3.mk will accept any of the Postgres versions in the
                   5167:     variable PGSQL_VERSIONS_ACCEPTED and default to the version
                   5168:     PGSQL_VERSION_DEFAULT. See the file for more information.
1.1       dsieger  5169: 
1.184     rillig   5170:   * pthread.buildlink3.mk uses the value of PTHREAD_OPTS and checks for native
                   5171:     pthreads or adds a dependency on devel/pth as needed.
1.1       dsieger  5172: 
1.184     rillig   5173:   * xaw.buildlink3.mk uses the value of XAW_TYPE to choose a particular Athena
                   5174:     widgets library.
1.1       dsieger  5175: 
1.184     rillig   5176: The comments in those buildlink3.mk files provide a more complete description
                   5177: of how to use them properly.
1.1       dsieger  5178: 
1.184     rillig   5179: 18.2. Writing buildlink3.mk files
1.1       dsieger  5180: 
1.184     rillig   5181: A package's buildlink3.mk file is included by Makefiles to indicate the need to
                   5182: compile and link against header files and libraries provided by the package. A
                   5183: buildlink3.mk file should always provide enough information to add the correct
                   5184: type of dependency relationship and include any other buildlink3.mk files that
                   5185: it needs to find headers and libraries that it needs in turn.
1.1       dsieger  5186: 
1.184     rillig   5187: To generate an initial buildlink3.mk file for further editing, Rene Hexel's
                   5188: pkgtools/createbuildlink package is highly recommended. For most packages, the
                   5189: following command will generate a good starting point for buildlink3.mk files:
1.1       dsieger  5190: 
1.184     rillig   5191: % cd pkgsrc/category/pkgdir
                   5192: % createbuildlink >buildlink3.mk
1.1       dsieger  5193: 
                   5194: 
1.184     rillig   5195: 18.2.1. Anatomy of a buildlink3.mk file
1.1       dsieger  5196: 
1.184     rillig   5197: The following real-life example buildlink3.mk is taken from pkgsrc/graphics/
                   5198: tiff:
1.14      jmcneill 5199: 
1.184     rillig   5200: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1       dsieger  5201: 
1.184     rillig   5202: BUILDLINK_TREE+=        tiff
1.1       dsieger  5203: 
1.184     rillig   5204: .if !defined(TIFF_BUILDLINK3_MK)
                   5205: TIFF_BUILDLINK3_MK:=
1.1       dsieger  5206: 
1.184     rillig   5207: BUILDLINK_API_DEPENDS.tiff+=    tiff>=3.6.1
                   5208: BUILDLINK_ABI_DEPENDS.tiff+=    tiff>=3.7.2nb1
                   5209: BUILDLINK_PKGSRCDIR.tiff?=      ../../graphics/tiff
1.1       dsieger  5210: 
1.184     rillig   5211: .include "../../devel/zlib/buildlink3.mk"
                   5212: .include "../../graphics/jpeg/buildlink3.mk"
                   5213: .endif # TIFF_BUILDLINK3_MK
1.1       dsieger  5214: 
1.184     rillig   5215: BUILDLINK_TREE+=        -tiff
1.1       dsieger  5216: 
1.184     rillig   5217: The header and footer manipulate BUILDLINK_TREE, which is common across all
                   5218: buildlink3.mk files and is used to track the dependency tree.
1.1       dsieger  5219: 
1.184     rillig   5220: The main section is protected from multiple inclusion and controls how the
                   5221: dependency on pkg is added. Several important variables are set in the section:
1.1       dsieger  5222: 
1.185     wiz      5223:   * BUILDLINK_API_DEPENDS.pkg is the dependency version recorded in the
1.184     rillig   5224:     installed package; this should always be set using += to ensure that we're
                   5225:     appending to any pre-existing list of values. This variable should be set
1.185     wiz      5226:     to the last version of the package that had an backwards-incompatible API
1.184     rillig   5227:     change.
1.1       dsieger  5228: 
1.184     rillig   5229:   * BUILDLINK_PKGSRCDIR.pkg is the location of the pkg pkgsrc directory.
1.1       dsieger  5230: 
1.184     rillig   5231:   * BUILDLINK_DEPMETHOD.pkg (not shown above) controls whether we use
                   5232:     BUILD_DEPENDS or DEPENDS to add the dependency on pkg. The build dependency
                   5233:     is selected by setting BUILDLINK_DEPMETHOD.pkg to "build". By default, the
                   5234:     full dependency is used.
1.1       dsieger  5235: 
1.184     rillig   5236:   * BUILDLINK_INCDIRS.pkg and BUILDLINK_LIBDIRS.pkg (not shown above) are lists
                   5237:     of subdirectories of ${BUILDLINK_PREFIX.pkg} to add to the header and
                   5238:     library search paths. These default to "include" and "lib" respectively.
1.1       dsieger  5239: 
1.184     rillig   5240:   * BUILDLINK_CPPFLAGS.pkg (not shown above) is the list of preprocessor flags
                   5241:     to add to CPPFLAGS, which are passed on to the configure and build phases.
                   5242:     The "-I" option should be avoided and instead be handled using
                   5243:     BUILDLINK_INCDIRS.pkg as above.
1.66      asau     5244: 
1.184     rillig   5245: The following variables are all optionally defined within this second section
                   5246: (protected against multiple inclusion) and control which package files are
                   5247: symlinked into ${BUILDLINK_DIR} and how their names are transformed during the
                   5248: symlinking:
1.23      jakllsch 5249: 
1.184     rillig   5250:   * BUILDLINK_FILES.pkg (not shown above) is a shell glob pattern relative to $
                   5251:     {BUILDLINK_PREFIX.pkg} to be symlinked into ${BUILDLINK_DIR}, e.g. include/
                   5252:     *.h.
1.1       dsieger  5253: 
1.184     rillig   5254:   * BUILDLINK_FILES_CMD.pkg (not shown above) is a shell pipeline that outputs
                   5255:     to stdout a list of files relative to ${BUILDLINK_PREFIX.pkg}. The
                   5256:     resulting files are to be symlinked into ${BUILDLINK_DIR}. By default, this
                   5257:     takes the +CONTENTS of a pkg and filters it through $
                   5258:     {BUILDLINK_CONTENTS_FILTER.pkg}.
1.1       dsieger  5259: 
1.184     rillig   5260:   * BUILDLINK_CONTENTS_FILTER.pkg (not shown above) is a filter command that
                   5261:     filters +CONTENTS input into a list of files relative to $
                   5262:     {BUILDLINK_PREFIX.pkg} on stdout. By default, BUILDLINK_CONTENTS_FILTER.pkg
                   5263:     outputs the contents of the include and lib directories in the package
                   5264:     +CONTENTS.
1.1       dsieger  5265: 
1.184     rillig   5266:   * BUILDLINK_FNAME_TRANSFORM.pkg (not shown above) is a list of sed arguments
                   5267:     used to transform the name of the source filename into a destination
                   5268:     filename, e.g. -e "s|/curses.h|/ncurses.h|g".
1.1       dsieger  5269: 
1.184     rillig   5270: This section can additionally include any buildlink3.mk needed for pkg's
                   5271: library dependencies. Including these buildlink3.mk files means that the
                   5272: headers and libraries for these dependencies are also symlinked into $
                   5273: {BUILDLINK_DIR} whenever the pkg buildlink3.mk file is included. Dependencies
                   5274: are only added for directly include buildlink3.mk files.
1.1       dsieger  5275: 
1.184     rillig   5276: When providing a buildlink3.mk and including other buildlink3.mk files in it,
                   5277: please only add necessary ones, i.e., those whose libraries or header files are
                   5278: automatically exposed when the package is use.
1.1       dsieger  5279: 
1.184     rillig   5280: In particular, if only an executable (bin/foo) is linked against a library,
                   5281: that library does not need to be propagated in the buildlink3.mk file.
1.1       dsieger  5282: 
1.184     rillig   5283: The following steps should help you decide if a buildlink3.mk file needs to be
                   5284: included:
1.1       dsieger  5285: 
1.184     rillig   5286:   * Look at the installed header files: What headers do they include? The
                   5287:     packages providing these files must be buildlinked.
1.1       dsieger  5288: 
1.184     rillig   5289:   * Run ldd on all installed libraries and look against what other libraries
                   5290:     they link. Some of the packages providing these probably need to be
                   5291:     buildlinked; however, it's not automatic, since e.g. GTK on some systems
                   5292:     pulls in the X libraries, so they will show up in the ldd output, while on
                   5293:     others (like OS X) it won't. ldd output can thus only be used as a hint.
1.1       dsieger  5294: 
1.184     rillig   5295: 18.2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS.pkg in
                   5296: buildlink3.mk files
1.16      jnemeth  5297: 
1.185     wiz      5298: Both variables set lower bounds for a version of this package. The two
                   5299: variables differ in that one describes source compatibility (API) and the other
                   5300: binary compatibility (ABI). The difference is that a change in the API breaks
                   5301: compilation of programs while changes in the ABI stop compiled programs from
                   5302: running.
                   5303: 
                   5304: The BUILDLINK_API_DEPENDS.pkg variable in a buildlink3.mk should be changed
                   5305: very rarely. (One possible scenario: If all packages using this package need a
                   5306: higher version than defined in the buildlink3.mk, BUILDLINK_API_DEPENDS.pkg
                   5307: could be updated to that higher version.)
                   5308: 
                   5309: On the other hand, changes to BUILDLINK_ABI_DEPENDS.pkg are more common. The
                   5310: variable will need to be updated every time the major version of one of its
                   5311: shared libraries is changed, or any other change where a binary built against
                   5312: the previous version of the package will not run against the new version any
                   5313: longer.
                   5314: 
                   5315: In such a case, the package's BUILDLINK_ABI_DEPENDS.pkg must be increased to
                   5316: require the new package version. Then the PKGREVISION of all packages foo that
                   5317: depend on this package need to be increased, and if they have buildlink3.mk
                   5318: files, BUILDLINK_ABI_DEPENDS.foo in their buildlink3.mk files must be increased
                   5319: to the new version as well. This is required so that a package will pull in the
                   5320: versions of the packages that use the new ABI and that the packages'
                   5321: PKGREVISIONs uniquely identify the packages built against the new ABI. The
                   5322: pkgtools/revbump package can help with these updates.
1.1       dsieger  5323: 
1.184     rillig   5324: See Section 21.1.5, "Handling dependencies" for more information about
1.185     wiz      5325: dependencies on other packages, including the BUILDLINK_API_DEPENDS
                   5326: definitions.
1.1       dsieger  5327: 
1.184     rillig   5328: Please take careful consideration before adjusting BUILDLINK_API_DEPENDS.pkg or
1.185     wiz      5329: BUILDLINK_ABI_DEPENDS.pkg in a buildlink3.mk file as we don't want to cause
                   5330: unneeded package deletions and rebuilds. In many cases, new versions of
                   5331: packages work just fine with older dependencies.
1.1       dsieger  5332: 
1.184     rillig   5333: Also it is not needed to set BUILDLINK_ABI_DEPENDS.pkg when it is identical to
                   5334: BUILDLINK_API_DEPENDS.pkg.
1.1       dsieger  5335: 
1.184     rillig   5336: 18.3. Writing builtin.mk files
1.1       dsieger  5337: 
1.184     rillig   5338: Some packages in pkgsrc install headers and libraries that coincide with
                   5339: headers and libraries present in the base system. Aside from a buildlink3.mk
                   5340: file, these packages should also include a builtin.mk file that includes the
                   5341: necessary checks to decide whether using the built-in software or the pkgsrc
                   5342: software is appropriate.
1.1       dsieger  5343: 
1.184     rillig   5344: The only requirements of a builtin.mk file for pkg are:
1.1       dsieger  5345: 
1.184     rillig   5346:  1. It should set USE_BUILTIN.pkg to either "yes" or "no" after it is included.
1.1       dsieger  5347: 
1.184     rillig   5348:  2. It should not override any USE_BUILTIN.pkg which is already set before the
                   5349:     builtin.mk file is included.
1.1       dsieger  5350: 
1.184     rillig   5351:  3. It should be written to allow multiple inclusion. This is very important
                   5352:     and takes careful attention to Makefile coding.
1.1       dsieger  5353: 
1.184     rillig   5354: 18.3.1. Anatomy of a builtin.mk file
1.1       dsieger  5355: 
1.184     rillig   5356: The following is the recommended template for builtin.mk files:
1.1       dsieger  5357: 
1.184     rillig   5358: .if !defined(IS_BUILTIN.foo)
                   5359: #
                   5360: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   5361: # genuinely exists in the system or not.
                   5362: #
                   5363: IS_BUILTIN.foo?=        no
1.1       dsieger  5364: 
1.184     rillig   5365: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   5366: # version can be determined.
                   5367: #
                   5368: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   5369: BUILTIN_PKG.foo?=       foo-1.0
                   5370: .  endif
                   5371: .endif  # IS_BUILTIN.foo
1.1       dsieger  5372: 
1.184     rillig   5373: .if !defined(USE_BUILTIN.foo)
                   5374: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   5375: .  if defined(BUILTIN_PKG.foo)
                   5376: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   5377: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   5378: USE_BUILTIN.foo!=                                                       \
                   5379:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
                   5380:         && ${ECHO} "yes" || ${ECHO} "no"
                   5381: .      endif
                   5382: .    endfor
                   5383: .  endif
                   5384: .endif  # USE_BUILTIN.foo
1.1       dsieger  5385: 
1.184     rillig   5386: CHECK_BUILTIN.foo?=     no
                   5387: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   5388: #
                   5389: # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   5390: # "yes" or "no".
                   5391: #
                   5392: .endif  # CHECK_BUILTIN.foo
1.1       dsieger  5393: 
1.184     rillig   5394: The first section sets IS_BUILTIN.pkg depending on if pkg really exists in the
                   5395: base system. This should not be a base system software with similar
                   5396: functionality to pkg; it should only be "yes" if the actual package is included
                   5397: as part of the base system. This variable is only used internally within the
                   5398: builtin.mk file.
1.1       dsieger  5399: 
1.184     rillig   5400: The second section sets BUILTIN_PKG.pkg to the version of pkg in the base
                   5401: system if it exists (if IS_BUILTIN.pkg is "yes"). This variable is only used
                   5402: internally within the builtin.mk file.
1.1       dsieger  5403: 
1.184     rillig   5404: The third section sets USE_BUILTIN.pkg and is required in all builtin.mk files.
                   5405: The code in this section must make the determination whether the built-in
                   5406: software is adequate to satisfy the dependencies listed in
                   5407: BUILDLINK_API_DEPENDS.pkg. This is typically done by comparing BUILTIN_PKG.pkg
                   5408: against each of the dependencies in BUILDLINK_API_DEPENDS.pkg. USE_BUILTIN.pkg 
                   5409: must be set to the correct value by the end of the builtin.mk file. Note that
                   5410: USE_BUILTIN.pkg may be "yes" even if IS_BUILTIN.pkg is "no" because we may make
                   5411: the determination that the built-in version of the software is similar enough
                   5412: to be used as a replacement.
1.1       dsieger  5413: 
1.184     rillig   5414: The last section is guarded by CHECK_BUILTIN.pkg, and includes code that uses
                   5415: the value of USE_BUILTIN.pkg set in the previous section. This typically
                   5416: includes, e.g., adding additional dependency restrictions and listing
                   5417: additional files to symlink into ${BUILDLINK_DIR} (via BUILDLINK_FILES.pkg).
1.1       dsieger  5418: 
1.184     rillig   5419: 18.3.2. Global preferences for native or pkgsrc software
1.1       dsieger  5420: 
1.184     rillig   5421: When building packages, it's possible to choose whether to set a global
                   5422: preference for using either the built-in (native) version or the pkgsrc version
                   5423: of software to satisfy a dependency. This is controlled by setting
                   5424: PREFER_PKGSRC and PREFER_NATIVE. These variables take values of either "yes", "
                   5425: no", or a list of packages. PREFER_PKGSRC tells pkgsrc to use the pkgsrc
                   5426: versions of software, while PREFER_NATIVE tells pkgsrc to use the built-in
                   5427: versions. Preferences are determined by the most specific instance of the
                   5428: package in either PREFER_PKGSRC or PREFER_NATIVE. If a package is specified in
                   5429: neither or in both variables, then PREFER_PKGSRC has precedence over
                   5430: PREFER_NATIVE. For example, to require using pkgsrc versions of software for
                   5431: all but the most basic bits on a NetBSD system, you can set:
1.1       dsieger  5432: 
1.184     rillig   5433: PREFER_PKGSRC=  yes
                   5434: PREFER_NATIVE=  getopt skey tcp_wrappers
1.1       dsieger  5435: 
1.184     rillig   5436: A package must have a builtin.mk file to be listed in PREFER_NATIVE, otherwise
                   5437: it is simply ignored in that list.
1.1       dsieger  5438: 
1.191     bacon    5439: PREFER_PKGSRC and PREFER_NATIVE should be set during bootstrap to ensure that
                   5440: the bootstrap process does not use inapropriate native tools as dependencies
                   5441: for core packages.
                   5442: 
                   5443: # ./bootstrap --prefer-pkgsrc yes --prefer-native openssl
                   5444: 
                   5445: Switching between settings globally at a later date can introduce complications
                   5446: with dependency resolution. This is caused by packages built with the opposite
                   5447: preference being installed alongside each other. Hence, any changes to these
                   5448: variables after bootstrap will necessitate rebuilding all packages depending on
                   5449: one whose preference has been changed. This is not trivial and should be
                   5450: avoided.
                   5451: 
                   5452: When using pkgsrc on Linux systems, there is high risk of "leakage", where
                   5453: programs installed by pkgsrc may inadvertently use a command or library not
                   5454: installed by pkgsrc, e.g. those installed by yum or apt. Such foreign
                   5455: dependencies may be installed, removed, or upgraded to a version incompatible
                   5456: with the pkgsrc package at any time, causing pkgsrc packages to subsequently
                   5457: malfunction. Pkgsrc cannot prevent this, as it has no control over other
                   5458: package managers. Another potential problem is that under Redhat Enterprise and
                   5459: related Linux systems, yum packages are only patched and never upgraded, so
                   5460: eventually they may become too outdated for use by pkgsrc. Even intentionally
                   5461: using foreign dependencies, not considered leakage, can lead to these problems,
                   5462: so it is generally discouraged. In order to minimize such problems,
                   5463: PREFER_PKGSRC defaults to "yes" on Linux systems. This ensures that pkgsrc is
                   5464: aware of any changes to dependency packages and can rebuild or upgrade the
                   5465: entire dependency tree as needed. This default can be overridden by setting
                   5466: --prefer-pkgsrc to "no" or a list of packages, or by setting --prefer-native to
                   5467: "yes".
1.1       dsieger  5468: 
1.184     rillig   5469: Chapter 19. PLIST issues
1.1       dsieger  5470: 
1.184     rillig   5471: Table of Contents
1.1       dsieger  5472: 
1.184     rillig   5473: 19.1. RCS ID
                   5474: 19.2. Semi-automatic PLIST generation
                   5475: 19.3. Tweaking output of make print-PLIST
                   5476: 19.4. Variable substitution in PLIST
                   5477: 19.5. Man page compression
                   5478: 19.6. Changing PLIST source with PLIST_SRC
                   5479: 19.7. Platform-specific and differing PLISTs
                   5480: 19.8. Build-specific PLISTs
                   5481: 19.9. Sharing directories between packages
1.1       dsieger  5482: 
1.184     rillig   5483: The PLIST file contains a package's "packing list", i.e. a list of files that
                   5484: belong to the package (relative to the ${PREFIX} directory it's been installed
                   5485: in) plus some additional statements - see the pkg_create(1) man page for a full
                   5486: list. This chapter addresses some issues that need attention when dealing with
                   5487: the PLIST file (or files, see below!).
1.1       dsieger  5488: 
1.184     rillig   5489: 19.1. RCS ID
1.1       dsieger  5490: 
1.184     rillig   5491: Be sure to add a RCS ID line as the first thing in any PLIST file you write:
1.1       dsieger  5492: 
1.184     rillig   5493: @comment $NetBSD $
1.1       dsieger  5494: 
1.184     rillig   5495: An artificial space has been added between NetBSD and $, this is a workaround
                   5496: here to prevent CVS expanding to the filename of the guide. When adding the RCS
                   5497: ID the space should be omitted.
1.38      wiz      5498: 
1.184     rillig   5499: 19.2. Semi-automatic PLIST generation
1.1       dsieger  5500: 
1.184     rillig   5501: You can use the make print-PLIST command to output a PLIST that matches any new
                   5502: files since the package was extracted. See Section 13.17, "Other helpful
                   5503: targets" for more information on this target.
1.11      rillig   5504: 
1.184     rillig   5505: 19.3. Tweaking output of make print-PLIST
1.1       dsieger  5506: 
1.184     rillig   5507: The PRINT_PLIST_AWK variable takes a set of AWK patterns and actions that are
                   5508: used to filter the output of print-PLIST. You can append any chunk of AWK
                   5509: scripting you like to it, but be careful with quoting.
1.1       dsieger  5510: 
1.184     rillig   5511: For example, to get all files inside the libdata/foo directory removed from the
                   5512: resulting PLIST:
1.1       dsieger  5513: 
1.184     rillig   5514: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
1.1       dsieger  5515: 
1.185     wiz      5516: The PRINT_PLIST_AWK transformations are evaluated after the file list and
                   5517: directory list are sorted. EARLY_PRINT_PLIST_AWK is like PRINT_PLIST_AWK except
                   5518: it operates before the file list and directory list are sorted.
                   5519: 
1.184     rillig   5520: 19.4. Variable substitution in PLIST
1.1       dsieger  5521: 
1.184     rillig   5522: A number of variables are substituted automatically in PLISTs when a package is
                   5523: installed on a system. This includes the following variables:
1.1       dsieger  5524: 
1.184     rillig   5525: ${MACHINE_ARCH}, ${MACHINE_GNU_ARCH}
1.1       dsieger  5526: 
1.184     rillig   5527:     Some packages like emacs and perl embed information about which
                   5528:     architecture they were built on into the pathnames where they install their
                   5529:     files. To handle this case, PLIST will be preprocessed before actually
                   5530:     used, and the symbol "${MACHINE_ARCH}" will be replaced by what uname -p
                   5531:     gives. The same is done if the string ${MACHINE_GNU_ARCH} is embedded in
                   5532:     PLIST somewhere - use this on packages that have GNU autoconf-created
                   5533:     configure scripts.
1.1       dsieger  5534: 
1.184     rillig   5535:     Legacy note
1.1       dsieger  5536: 
1.184     rillig   5537:     There used to be a symbol "$ARCH" that was replaced by the output of uname
                   5538:     -m, but that's no longer supported and has been removed.
1.1       dsieger  5539: 
1.184     rillig   5540: ${OPSYS}, ${LOWER_OPSYS}, ${OS_VERSION}
1.1       dsieger  5541: 
1.184     rillig   5542:     Some packages want to embed the OS name and version into some paths. To do
                   5543:     this, use these variables in the PLIST:
1.1       dsieger  5544: 
1.184     rillig   5545:       + ${OPSYS} - output of "uname -s"
1.1       dsieger  5546: 
1.184     rillig   5547:       + ${LOWER_OPSYS} - lowercase common name (eg. "solaris")
1.1       dsieger  5548: 
1.184     rillig   5549:       + ${OS_VERSION} - "uname -r"
1.1       dsieger  5550: 
1.184     rillig   5551: For a list of values which are replaced by default, the output of make help
                   5552: topic=PLIST_SUBST as well as searching the pkgsrc/mk directory with grep for
                   5553: PLIST_SUBST should help.
1.1       dsieger  5554: 
1.184     rillig   5555: If you want to change other variables not listed above, you can add variables
                   5556: and their expansions to this variable in the following way, similar to
                   5557: MESSAGE_SUBST (see Section 12.5, "Optional files"):
1.1       dsieger  5558: 
1.184     rillig   5559: PLIST_SUBST+=   SOMEVAR="somevalue"
1.1       dsieger  5560: 
1.184     rillig   5561: This replaces all occurrences of "${SOMEVAR}" in the PLIST with "somevalue".
1.1       dsieger  5562: 
1.184     rillig   5563: The PLIST_VARS variable can be used to simplify the common case of
                   5564: conditionally including some PLIST entries. It can be done by adding
                   5565: PLIST_VARS+=foo and setting the corresponding PLIST.foo variable to yes if the
                   5566: entry should be included. This will substitute "${PLIST.foo}" in the PLIST with
                   5567: either """" or ""@comment "". For example, in Makefile:
1.1       dsieger  5568: 
1.184     rillig   5569: PLIST_VARS+=    foo
                   5570: .if condition
                   5571: PLIST.foo=      yes
                   5572: .else
1.1       dsieger  5573: 
1.184     rillig   5574: And then in PLIST:
1.1       dsieger  5575: 
1.184     rillig   5576: @comment $NetBSD $
                   5577: bin/bar
                   5578: man/man1/bar.1
                   5579: ${PLIST.foo}bin/foo
                   5580: ${PLIST.foo}man/man1/foo.1
                   5581: ${PLIST.foo}share/bar/foo.data
1.1       dsieger  5582: 
1.184     rillig   5583: An artificial space has been added between NetBSD and $, this is a workaround
                   5584: here to prevent CVS expanding to the filename of the guide. When adding the RCS
1.195     gutterid 5585: ID the space should be omitted.
1.1       dsieger  5586: 
1.184     rillig   5587: 19.5. Man page compression
1.1       dsieger  5588: 
1.184     rillig   5589: Man pages should be installed in compressed form if MANZ is set (in
                   5590: bsd.own.mk), and uncompressed otherwise. To handle this in the PLIST file, the
                   5591: suffix ".gz" is appended/removed automatically for man pages according to MANZ
                   5592: and MANCOMPRESSED being set or not, see above for details. This modification of
                   5593: the PLIST file is done on a copy of it, not PLIST itself.
1.100     leot     5594: 
1.184     rillig   5595: 19.6. Changing PLIST source with PLIST_SRC
1.100     leot     5596: 
1.184     rillig   5597: To use one or more files as source for the PLIST used in generating the binary
                   5598: package, set the variable PLIST_SRC to the names of that file(s). The files are
                   5599: later concatenated using cat(1), and the order of things is important. The
                   5600: default for PLIST_SRC is ${PKGDIR}/PLIST.
1.1       dsieger  5601: 
1.184     rillig   5602: 19.7. Platform-specific and differing PLISTs
1.1       dsieger  5603: 
1.184     rillig   5604: Some packages decide to install a different set of files based on the operating
                   5605: system being used. These differences can be automatically handled by using the
                   5606: following files:
1.1       dsieger  5607: 
1.184     rillig   5608:   * PLIST.common
1.1       dsieger  5609: 
1.184     rillig   5610:   * PLIST.${OPSYS}
1.1       dsieger  5611: 
1.184     rillig   5612:   * PLIST.${MACHINE_ARCH}
1.1       dsieger  5613: 
1.184     rillig   5614:   * PLIST.${OPSYS}-${MACHINE_ARCH}
1.1       dsieger  5615: 
1.184     rillig   5616:   * PLIST.common_end
1.1       dsieger  5617: 
1.184     rillig   5618: 19.8. Build-specific PLISTs
1.1       dsieger  5619: 
1.184     rillig   5620: Some packages decide to generate hard-to-guess file names during installation
                   5621: that are hard to wire down.
1.1       dsieger  5622: 
1.184     rillig   5623: In such cases, you can set the GENERATE_PLIST variable to shell code terminated
                   5624: (with a semicolon) that will output PLIST entries which will be appended to the
                   5625: PLIST
1.1       dsieger  5626: 
1.184     rillig   5627: You can find one example in editors/xemacs:
1.1       dsieger  5628: 
1.184     rillig   5629: GENERATE_PLIST+=        ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
1.1       dsieger  5630: 
1.184     rillig   5631: which will append something like bin/xemacs-21.4.23-54e8ea71.dmp to the PLIST.
1.1       dsieger  5632: 
1.184     rillig   5633: 19.9. Sharing directories between packages
1.1       dsieger  5634: 
1.184     rillig   5635: A "shared directory" is a directory where multiple (and unrelated) packages
                   5636: install files. These directories were problematic because you had to add
                   5637: special tricks in the PLIST to conditionally remove them, or have some
                   5638: centralized package handle them.
1.106     tnn      5639: 
1.184     rillig   5640: In pkgsrc, it is now easy: Each package should create directories and install
                   5641: files as needed; pkg_delete will remove any directories left empty after
                   5642: uninstalling a package.
1.106     tnn      5643: 
1.184     rillig   5644: If a package needs an empty directory to work, create the directory during
                   5645: installation as usual, and also add an entry to the PLIST:
1.1       dsieger  5646: 
1.184     rillig   5647: @pkgdir path/to/empty/directory
1.1       dsieger  5648: 
1.184     rillig   5649: or take a look at MAKE_DIRS and OWN_DIRS.
1.1       dsieger  5650: 
1.184     rillig   5651: Chapter 20. The pkginstall framework
1.1       dsieger  5652: 
1.184     rillig   5653: Table of Contents
1.1       dsieger  5654: 
1.184     rillig   5655: 20.1. Files and directories outside the installation prefix
1.1       dsieger  5656: 
1.184     rillig   5657:     20.1.1. Directory manipulation
                   5658:     20.1.2. File manipulation
1.1       dsieger  5659: 
1.184     rillig   5660: 20.2. Configuration files
1.1       dsieger  5661: 
1.184     rillig   5662:     20.2.1. How PKG_SYSCONFDIR is set
                   5663:     20.2.2. Telling the software where configuration files are
                   5664:     20.2.3. Patching installations
                   5665:     20.2.4. Disabling handling of configuration files
1.1       dsieger  5666: 
1.184     rillig   5667: 20.3. System startup scripts
1.1       dsieger  5668: 
1.184     rillig   5669:     20.3.1. Disabling handling of system startup scripts
1.1       dsieger  5670: 
1.184     rillig   5671: 20.4. System users and groups
                   5672: 20.5. System shells
1.1       dsieger  5673: 
1.184     rillig   5674:     20.5.1. Disabling shell registration
1.1       dsieger  5675: 
1.184     rillig   5676: 20.6. Fonts
1.1       dsieger  5677: 
1.184     rillig   5678:     20.6.1. Disabling automatic update of the fonts databases
1.1       dsieger  5679: 
1.184     rillig   5680: This chapter describes the framework known as pkginstall, whose key features
                   5681: are:
1.1       dsieger  5682: 
1.184     rillig   5683:   * Generic installation and manipulation of directories and files outside the
                   5684:     pkgsrc-handled tree, LOCALBASE.
1.1       dsieger  5685: 
1.184     rillig   5686:   * Automatic handling of configuration files during installation, provided
                   5687:     that packages are correctly designed.
1.1       dsieger  5688: 
1.184     rillig   5689:   * Generation and installation of system startup scripts.
1.1       dsieger  5690: 
1.184     rillig   5691:   * Registration of system users and groups.
1.1       dsieger  5692: 
1.184     rillig   5693:   * Registration of system shells.
1.1       dsieger  5694: 
1.184     rillig   5695:   * Automatic updating of fonts databases.
1.1       dsieger  5696: 
1.184     rillig   5697: The following sections inspect each of the above points in detail.
1.1       dsieger  5698: 
1.184     rillig   5699: You may be thinking that many of the things described here could be easily done
                   5700: with simple code in the package's post-installation target (post-install). This
                   5701: is incorrect, as the code in them is only executed when building from source.
                   5702: Machines using binary packages could not benefit from it at all (as the code
                   5703: itself could be unavailable). Therefore, the only way to achieve any of the
                   5704: items described above is by means of the installation scripts, which are
                   5705: automatically generated by pkginstall.
1.1       dsieger  5706: 
1.184     rillig   5707: 20.1. Files and directories outside the installation prefix
1.95      wiz      5708: 
1.184     rillig   5709: As you already know, the PLIST file holds a list of files and directories that
                   5710: belong to a package. The names used in it are relative to the installation
                   5711: prefix (${PREFIX}), which means that it cannot register files outside this
                   5712: directory (absolute path names are not allowed). Despite this restriction, some
                   5713: packages need to install files outside this location; e.g., under ${VARBASE} or
                   5714: ${PKG_SYSCONFDIR}. The only way to achieve this is to create such files during
                   5715: installation time by using installation scripts.
1.95      wiz      5716: 
1.184     rillig   5717: The generic installation scripts are shell scripts that can contain arbitrary
                   5718: code. The list of scripts to execute is taken from the INSTALL_FILE variable,
                   5719: which defaults to INSTALL. A similar variable exists for package removal
                   5720: (DEINSTALL_FILE, whose default is DEINSTALL). These scripts can run arbitrary
                   5721: commands, so they have the potential to create and manage files anywhere in the
                   5722: file system.
1.95      wiz      5723: 
1.184     rillig   5724: Using these general installation files is not recommended, but may be needed in
                   5725: some special cases. One reason for avoiding them is that the user has to trust
                   5726: the packager that there is no unwanted or simply erroneous code included in the
                   5727: installation script. Also, previously there were many similar scripts for the
                   5728: same functionality, and fixing a common error involved finding and changing all
                   5729: of them.
1.95      wiz      5730: 
1.184     rillig   5731: The pkginstall framework offers another, standardized way. It provides generic
                   5732: scripts to abstract the manipulation of such files and directories based on
                   5733: variables set in the package's Makefile. The rest of this section describes
                   5734: these variables.
1.1       dsieger  5735: 
1.184     rillig   5736: 20.1.1. Directory manipulation
1.1       dsieger  5737: 
1.184     rillig   5738: The following variables can be set to request the creation of directories
                   5739: anywhere in the file system:
1.1       dsieger  5740: 
1.184     rillig   5741:   * MAKE_DIRS and OWN_DIRS contain a list of directories that should be created
                   5742:     and should attempt to be destroyed by the installation scripts. The
                   5743:     difference between the two is that the latter prompts the administrator to
                   5744:     remove any directories that may be left after deinstallation (because they
                   5745:     were not empty), while the former does not. Example:
1.1       dsieger  5746: 
1.184     rillig   5747:     MAKE_DIRS+=             ${VARBASE}/foo/private
1.1       dsieger  5748: 
1.184     rillig   5749:   * MAKE_DIRS_PERMS and OWN_DIRS_PERMS contain a list of tuples describing
                   5750:     which directories should be created and should attempt to be destroyed by
                   5751:     the installation scripts. Each tuple holds the following values, separated
                   5752:     by spaces: the directory name, its owner, its group and its numerical mode.
                   5753:     For example:
1.1       dsieger  5754: 
1.184     rillig   5755:     MAKE_DIRS_PERMS+=       ${VARBASE}/foo/private \
                   5756:                             ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1       dsieger  5757: 
1.184     rillig   5758:     The difference between the two is exactly the same as their non-PERMS
                   5759:     counterparts.
1.1       dsieger  5760: 
1.184     rillig   5761: 20.1.2. File manipulation
1.1       dsieger  5762: 
1.184     rillig   5763: Creating non-empty files outside the installation prefix is tricky because the
                   5764: PLIST forces all files to be inside it. To overcome this problem, the only
                   5765: solution is to extract the file in the known place (i.e., inside the
                   5766: installation prefix) and copy it to the appropriate location during
                   5767: installation (done by the installation scripts generated by pkginstall). We
                   5768: will call the former the master file in the following paragraphs, which
                   5769: describe the variables that can be used to automatically and consistently
                   5770: handle files outside the installation prefix:
1.1       dsieger  5771: 
1.184     rillig   5772:   * CONF_FILES and REQD_FILES are pairs of master and target files. During
                   5773:     installation time, the master file is copied to the target one if and only
                   5774:     if the latter does not exist. Upon deinstallation, the target file is
                   5775:     removed provided that it was not modified by the installation.
1.1       dsieger  5776: 
1.184     rillig   5777:     The difference between the two is that the latter prompts the administrator
                   5778:     to remove any files that may be left after deinstallation (because they
                   5779:     were not empty), while the former does not.
1.1       dsieger  5780: 
1.184     rillig   5781:   * CONF_FILES_PERMS and REQD_FILES_PERMS contain tuples describing master
                   5782:     files as well as their target locations. For each of them, it also
                   5783:     specifies their owner, their group and their numeric permissions, in this
                   5784:     order. For example:
1.1       dsieger  5785: 
1.184     rillig   5786:     REQD_FILES_PERMS+=      ${PREFIX}/share/somefile ${VARBASE}/somefile \
                   5787:                             ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1       dsieger  5788: 
1.184     rillig   5789:     The difference between the two is exactly the same as their non-PERMS
                   5790:     counterparts.
1.1       dsieger  5791: 
1.184     rillig   5792: 20.2. Configuration files
1.1       dsieger  5793: 
1.184     rillig   5794: Configuration files are special in the sense that they are installed in their
                   5795: own specific directory, PKG_SYSCONFDIR, and need special treatment during
                   5796: installation (most of which is automated by pkginstall). The main concept you
                   5797: must bear in mind is that files marked as configuration files are automatically
                   5798: copied to the right place (somewhere inside PKG_SYSCONFDIR) during installation
                   5799: if and only if they didn't exist before. Similarly, they will not be removed if
                   5800: they have local modifications. This ensures that administrators never lose any
                   5801: custom changes they may have made.
1.1       dsieger  5802: 
1.184     rillig   5803: 20.2.1. How PKG_SYSCONFDIR is set
1.1       dsieger  5804: 
1.184     rillig   5805: As said before, the PKG_SYSCONFDIR variable specifies where configuration files
                   5806: shall be installed. Its contents are set based upon the following variables:
1.1       dsieger  5807: 
1.184     rillig   5808:   * PKG_SYSCONFBASE: The configuration's root directory. Defaults to ${PREFIX}/
                   5809:     etc although it may be overridden by the user to point to his preferred
                   5810:     location (e.g., /etc, /etc/pkg, etc.). Packages must not use it directly.
1.1       dsieger  5811: 
1.184     rillig   5812:   * PKG_SYSCONFSUBDIR: A subdirectory of PKG_SYSCONFBASE under which the
                   5813:     configuration files for the package being built shall be installed. The
                   5814:     definition of this variable only makes sense in the package's Makefile
                   5815:     (i.e., it is not user-customizable).
1.1       dsieger  5816: 
1.184     rillig   5817:     As an example, consider the Apache package, www/apache24, which places its
                   5818:     configuration files under the httpd/ subdirectory of PKG_SYSCONFBASE. This
                   5819:     should be set in the package Makefile.
1.1       dsieger  5820: 
1.184     rillig   5821:   * PKG_SYSCONFVAR: Specifies the name of the variable that holds this
                   5822:     package's configuration directory (if different from PKG_SYSCONFBASE). It
                   5823:     defaults to PKGBASE's value, and is always prefixed with PKG_SYSCONFDIR.
1.1       dsieger  5824: 
1.184     rillig   5825:   * PKG_SYSCONFDIR.${PKG_SYSCONFVAR}: Holds the directory where the
                   5826:     configuration files for the package identified by PKG_SYSCONFVAR's shall be
                   5827:     placed.
1.1       dsieger  5828: 
1.184     rillig   5829: Based on the above variables, pkginstall determines the value of
                   5830: PKG_SYSCONFDIR, which is the only variable that can be used within a package to
                   5831: refer to its configuration directory. The algorithm used to set its value is
                   5832: basically the following:
1.1       dsieger  5833: 
1.184     rillig   5834:  1. If PKG_SYSCONFDIR.${PKG_SYSCONFVAR} is set, its value is used.
1.1       dsieger  5835: 
1.184     rillig   5836:  2. If the previous variable is not defined but PKG_SYSCONFSUBDIR is set in the
                   5837:     package's Makefile, the resulting value is ${PKG_SYSCONFBASE}/$
                   5838:     {PKG_SYSCONFSUBDIR}.
1.1       dsieger  5839: 
1.184     rillig   5840:  3. Otherwise, it is set to ${PKG_SYSCONFBASE}.
1.1       dsieger  5841: 
1.184     rillig   5842: It is worth mentioning that ${PKG_SYSCONFDIR} is automatically added to
                   5843: OWN_DIRS. See Section 20.1.1, "Directory manipulation" what this means. This
                   5844: does not apply to subdirectories of ${PKG_SYSCONFDIR}, they still have to be
                   5845: created with OWN_DIRS or MAKE_DIRS.
1.1       dsieger  5846: 
1.184     rillig   5847: 20.2.2. Telling the software where configuration files are
1.1       dsieger  5848: 
1.184     rillig   5849: Given that pkgsrc (and users!) expect configuration files to be in a known
                   5850: place, you need to teach each package where it shall install its files. In some
                   5851: cases you will have to patch the package Makefiles to achieve it. If you are
                   5852: lucky, though, it may be as easy as passing an extra flag to the configuration
                   5853: script; this is the case of GNU Autoconf- generated files:
1.1       dsieger  5854: 
1.184     rillig   5855: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1       dsieger  5856: 
1.184     rillig   5857: Note that this specifies where the package has to look for its configuration
                   5858: files, not where they will be originally installed (although the difference is
                   5859: never explicit, unfortunately).
1.1       dsieger  5860: 
1.184     rillig   5861: 20.2.3. Patching installations
1.1       dsieger  5862: 
1.184     rillig   5863: As said before, pkginstall automatically handles configuration files. This
                   5864: means that the packages themselves must not touch the contents of $
                   5865: {PKG_SYSCONFDIR} directly. Bad news is that many software installation scripts
                   5866: will, out of the box, mess with the contents of that directory. So what is the
                   5867: correct procedure to fix this issue?
1.1       dsieger  5868: 
1.184     rillig   5869: You must teach the package (usually by manually patching it) to install any
                   5870: configuration files under the examples hierarchy, share/examples/${PKGBASE}/.
                   5871: This way, the PLIST registers them and the administrator always has the
                   5872: original copies available.
1.1       dsieger  5873: 
1.184     rillig   5874: Once the required configuration files are in place (i.e., under the examples
                   5875: hierarchy), the pkginstall framework can use them as master copies during the
                   5876: package installation to update what is in ${PKG_SYSCONFDIR}. To achieve this,
                   5877: the variables CONF_FILES and CONF_FILES_PERMS are used. Check out
                   5878: Section 20.1.2, "File manipulation" for information about their syntax and
                   5879: their purpose. Here is an example, taken from the mail/mutt package:
1.1       dsieger  5880: 
1.184     rillig   5881: EGDIR=        ${PREFIX}/share/doc/mutt/samples
                   5882: CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1       dsieger  5883: 
1.184     rillig   5884: Note that the EGDIR variable is specific to that package and has no meaning
                   5885: outside it.
1.1       dsieger  5886: 
1.184     rillig   5887: 20.2.4. Disabling handling of configuration files
1.1       dsieger  5888: 
1.184     rillig   5889: The automatic copying of config files can be toggled by setting the environment
                   5890: variable PKG_CONFIG prior to package installation.
1.1       dsieger  5891: 
1.184     rillig   5892: 20.3. System startup scripts
1.1       dsieger  5893: 
1.184     rillig   5894: System startup scripts are special files because they must be installed in a
                   5895: place known by the underlying OS, usually outside the installation prefix.
                   5896: Therefore, the same rules described in Section 20.1, "Files and directories
                   5897: outside the installation prefix" apply, and the same solutions can be used.
                   5898: However, pkginstall provides a special mechanism to handle these files.
1.1       dsieger  5899: 
1.184     rillig   5900: In order to provide system startup scripts, the package has to:
1.1       dsieger  5901: 
1.184     rillig   5902:  1. Store the script inside ${FILESDIR}, with the .sh suffix appended.
                   5903:     Considering the print/cups package as an example, it has a cupsd.sh in its
                   5904:     files directory.
1.95      wiz      5905: 
1.184     rillig   5906:  2. Tell pkginstall to handle it, appending the name of the script, without its
                   5907:     extension, to the RCD_SCRIPTS variable. Continuing the previous example:
1.95      wiz      5908: 
1.184     rillig   5909:     RCD_SCRIPTS+=   cupsd
1.95      wiz      5910: 
1.184     rillig   5911: Once this is done, pkginstall will do the following steps for each script in an
                   5912: automated fashion:
1.95      wiz      5913: 
1.184     rillig   5914:  1. Process the file found in the files directory applying all the
                   5915:     substitutions described in the FILES_SUBST variable.
1.1       dsieger  5916: 
1.184     rillig   5917:  2. Copy the script from the files directory to the examples hierarchy, $
                   5918:     {PREFIX}/share/examples/rc.d/. Note that this master file must be
                   5919:     explicitly registered in the PLIST.
1.1       dsieger  5920: 
1.184     rillig   5921:  3. Add code to the installation scripts to copy the startup script from the
                   5922:     examples hierarchy into the system-wide startup scripts directory.
1.1       dsieger  5923: 
1.184     rillig   5924: 20.3.1. Disabling handling of system startup scripts
1.1       dsieger  5925: 
1.184     rillig   5926: The automatic copying of config files can be toggled by setting the environment
                   5927: variable PKG_RCD_SCRIPTS prior to package installation. Note that the scripts
                   5928: will be always copied inside the examples hierarchy, ${PREFIX}/share/examples/
                   5929: rc.d/, no matter what the value of this variable is.
1.1       dsieger  5930: 
1.184     rillig   5931: 20.4. System users and groups
1.1       dsieger  5932: 
1.184     rillig   5933: If a package needs to create special users and/or groups during installation,
                   5934: it can do so by using the pkginstall framework.
1.1       dsieger  5935: 
1.184     rillig   5936: Users can be created by adding entries to the PKG_USERS variable. Each entry
                   5937: has the following syntax:
1.1       dsieger  5938: 
1.184     rillig   5939: user:group
1.1       dsieger  5940: 
1.184     rillig   5941: Further specification of user details may be done by setting per-user
                   5942: variables. PKG_UID.user is the numeric UID for the user. PKG_GECOS.user is the
                   5943: user's description or comment. PKG_HOME.user is the user's home directory, and
                   5944: defaults to /nonexistent if not specified. PKG_SHELL.user is the user's shell,
                   5945: and defaults to /sbin/nologin if not specified.
1.1       dsieger  5946: 
1.184     rillig   5947: Similarly, groups can be created by adding entries to the PKG_GROUPS variable,
                   5948: whose syntax is:
1.1       dsieger  5949: 
1.184     rillig   5950: group
1.1       dsieger  5951: 
1.184     rillig   5952: The numeric GID of the group may be set by defining PKG_GID.group.
1.1       dsieger  5953: 
1.184     rillig   5954: If a package needs to create the users and groups at an earlier stage, then it
                   5955: can set USERGROUP_PHASE to either configure,build, or pre-install to indicate
                   5956: the phase before which the users and groups are created. In this case, the
                   5957: numeric UIDs and GIDs of the created users and groups are automatically
                   5958: hardcoded into the final installation scripts.
1.1       dsieger  5959: 
1.184     rillig   5960: 20.5. System shells
1.1       dsieger  5961: 
1.184     rillig   5962: Packages that install system shells should register them in the shell database,
                   5963: /etc/shells, to make things easier to the administrator. This must be done from
                   5964: the installation scripts to keep binary packages working on any system.
                   5965: pkginstall provides an easy way to accomplish this task.
1.1       dsieger  5966: 
1.184     rillig   5967: When a package provides a shell interpreter, it has to set the PKG_SHELL
                   5968: variable to its absolute file name. This will add some hooks to the
                   5969: installation scripts to handle it. Consider the following example, taken from
                   5970: shells/zsh:
1.1       dsieger  5971: 
1.184     rillig   5972: PKG_SHELL=      ${PREFIX}/bin/zsh
1.1       dsieger  5973: 
1.184     rillig   5974: 20.5.1. Disabling shell registration
1.1       dsieger  5975: 
1.184     rillig   5976: The automatic registration of shell interpreters can be disabled by the
                   5977: administrator by setting the PKG_REGISTER_SHELLS environment variable to NO.
1.1       dsieger  5978: 
1.184     rillig   5979: 20.6. Fonts
1.1       dsieger  5980: 
1.184     rillig   5981: Packages that install X11 fonts should update the database files that index the
                   5982: fonts within each fonts directory. This can easily be accomplished within the
                   5983: pkginstall framework.
1.1       dsieger  5984: 
1.184     rillig   5985: When a package installs X11 fonts, it must list the directories in which fonts
                   5986: are installed in the FONTS_DIRS.type variables, where type can be one of "ttf",
                   5987: "type1" or "x11". This will add hooks to the installation scripts to run the
                   5988: appropriate commands to update the fonts database files within each of those
                   5989: directories. For convenience, if the directory path is relative, it is taken to
                   5990: be relative to the package's installation prefix. Consider the following
                   5991: example, taken from fonts/dbz-ttf:
1.1       dsieger  5992: 
1.184     rillig   5993: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1       dsieger  5994: 
1.184     rillig   5995: 20.6.1. Disabling automatic update of the fonts databases
1.1       dsieger  5996: 
1.184     rillig   5997: The automatic update of fonts databases can be disabled by the administrator by
                   5998: setting the PKG_UPDATE_FONTS_DB environment variable to NO.
1.1       dsieger  5999: 
1.154     rillig   6000: Chapter 21. Making your package work
1.1       dsieger  6001: 
                   6002: Table of Contents
                   6003: 
1.154     rillig   6004: 21.1. General operation
1.1       dsieger  6005: 
1.154     rillig   6006:     21.1.1. How to pull in user-settable variables from mk.conf
                   6007:     21.1.2. User interaction
                   6008:     21.1.3. Handling licenses
                   6009:     21.1.4. Restricted packages
                   6010:     21.1.5. Handling dependencies
                   6011:     21.1.6. Handling conflicts with other packages
                   6012:     21.1.7. Packages that cannot or should not be built
                   6013:     21.1.8. Packages which should not be deleted, once installed
                   6014:     21.1.9. Handling packages with security problems
                   6015:     21.1.10. How to handle incrementing versions when fixing an existing
1.1       dsieger  6016:         package
1.154     rillig   6017:     21.1.11. Substituting variable text in the package files (the SUBST
1.1       dsieger  6018:         framework)
                   6019: 
1.154     rillig   6020: 21.2. The fetch phase
1.1       dsieger  6021: 
1.154     rillig   6022:     21.2.1. Packages whose distfiles aren't available for plain downloading
                   6023:     21.2.2. How to handle modified distfiles with the 'old' name
                   6024:     21.2.3. Packages hosted on github.com
                   6025: 
                   6026: 21.3. The configure phase
                   6027: 
                   6028:     21.3.1. Shared libraries - libtool
                   6029:     21.3.2. Using libtool on GNU packages that already support libtool
                   6030:     21.3.3. GNU Autoconf/Automake
                   6031: 
                   6032: 21.4. Programming languages
                   6033: 
                   6034:     21.4.1. C, C++, and Fortran
                   6035:     21.4.2. Java
                   6036:     21.4.3. Packages containing perl scripts
                   6037:     21.4.4. Packages containing shell scripts
                   6038:     21.4.5. Other programming languages
                   6039: 
                   6040: 21.5. The build phase
                   6041: 
                   6042:     21.5.1. Compiling C and C++ code conditionally
                   6043:     21.5.2. How to handle compiler bugs
1.172     rillig   6044:     21.5.3. No such file or directory
                   6045:     21.5.4. Undefined reference to "..."
                   6046:     21.5.5. Running out of memory
1.154     rillig   6047: 
                   6048: 21.6. The install phase
                   6049: 
                   6050:     21.6.1. Creating needed directories
                   6051:     21.6.2. Where to install documentation
                   6052:     21.6.3. Installing highscore files
                   6053:     21.6.4. Adding DESTDIR support to packages
                   6054:     21.6.5. Packages with hardcoded paths to other interpreters
                   6055:     21.6.6. Packages installing perl modules
                   6056:     21.6.7. Packages installing info files
                   6057:     21.6.8. Packages installing man pages
                   6058:     21.6.9. Packages installing GConf data files
                   6059:     21.6.10. Packages installing scrollkeeper/rarian data files
                   6060:     21.6.11. Packages installing X11 fonts
                   6061:     21.6.12. Packages installing GTK2 modules
                   6062:     21.6.13. Packages installing SGML or XML data
                   6063:     21.6.14. Packages installing extensions to the MIME database
                   6064:     21.6.15. Packages using intltool
                   6065:     21.6.16. Packages installing startup scripts
                   6066:     21.6.17. Packages installing TeX modules
                   6067:     21.6.18. Packages supporting running binaries in emulation
                   6068:     21.6.19. Packages installing hicolor theme icons
                   6069:     21.6.20. Packages installing desktop files
1.1       dsieger  6070: 
1.154     rillig   6071: 21.7. Marking packages as having problems
1.1       dsieger  6072: 
1.154     rillig   6073: 21.1. General operation
1.1       dsieger  6074: 
                   6075: One appealing feature of pkgsrc is that it runs on many different platforms. As
                   6076: a result, it is important to ensure, where possible, that packages in pkgsrc
                   6077: are portable. This chapter mentions some particular details you should pay
                   6078: attention to while working on pkgsrc.
                   6079: 
1.154     rillig   6080: 21.1.1. How to pull in user-settable variables from mk.conf
1.1       dsieger  6081: 
                   6082: The pkgsrc user can configure pkgsrc by overriding several variables in the
1.4       rillig   6083: file pointed to by MAKECONF, which is mk.conf by default. When you want to use
                   6084: those variables in the preprocessor directives of make(1) (for example .if or
                   6085: .for), you need to include the file ../../mk/bsd.prefs.mk before, which in turn
                   6086: loads the user preferences.
1.1       dsieger  6087: 
                   6088: But note that some variables may not be completely defined after ../../mk/
                   6089: bsd.prefs.mk has been included, as they may contain references to variables
1.108     rillig   6090: that are not yet defined. In shell commands (the lines in Makefile that are
                   6091: indented with a tab) this is no problem, since variables are only expanded when
                   6092: they are used. But in the preprocessor directives mentioned above and in
                   6093: dependency lines (of the form target: dependencies) the variables are expanded
                   6094: at load time.
1.1       dsieger  6095: 
                   6096: Note
                   6097: 
1.108     rillig   6098: To check whether a variable can be used at load time, run pkglint -Wall on your
                   6099: package.
1.1       dsieger  6100: 
1.154     rillig   6101: 21.1.2. User interaction
1.1       dsieger  6102: 
                   6103: Occasionally, packages require interaction from the user, and this can be in a
                   6104: number of ways:
                   6105: 
                   6106:   * When fetching the distfiles, some packages require user interaction such as
                   6107:     entering username/password or accepting a license on a web page.
                   6108: 
                   6109:   * When extracting the distfiles, some packages may ask for passwords.
                   6110: 
                   6111:   * help to configure the package before it is built
                   6112: 
                   6113:   * help during the build process
                   6114: 
                   6115:   * help during the installation of a package
                   6116: 
1.108     rillig   6117: A package can set the INTERACTIVE_STAGE variable to define which stages need
                   6118: interaction. This should be done in the package's Makefile, e.g.:
1.1       dsieger  6119: 
                   6120: INTERACTIVE_STAGE=      configure install
                   6121: 
                   6122: The user can then decide to skip this package by setting the BATCH variable.
1.108     rillig   6123: Packages that require interaction are also excluded from bulk builds.
1.1       dsieger  6124: 
1.154     rillig   6125: 21.1.3. Handling licenses
1.1       dsieger  6126: 
                   6127: Authors of software can choose the licence under which software can be copied.
1.111     sevan    6128: The Free Software Foundation has declared some licenses "Free", and the Open
                   6129: Source Initiative has a definition of "Open Source".
                   6130: 
                   6131: By default, pkgsrc allows packages with Free or Open Source licenses to be
                   6132: built. To allow packages with other licenses to be built as well, the pkgsrc
                   6133: user needs to add these licenses to the ACCEPTABLE_LICENSES variable in mk.conf
                   6134: . Note that this variable only affects which packages may be built, while the
                   6135: license terms often also restrict the actual use of the package and its
                   6136: redistribution.
1.1       dsieger  6137: 
                   6138: One might want to only install packages with a BSD license, or the GPL, and not
1.20      jnemeth  6139: the other. The free licenses are added to the default ACCEPTABLE_LICENSES
1.111     sevan    6140: variable. The pkgsrc user can override the default by setting the
                   6141: ACCEPTABLE_LICENSES variable with "=" instead of "+=". The licenses accepted by
                   6142: default are defined in the DEFAULT_ACCEPTABLE_LICENSES variable in the file
                   6143: pkgsrc/mk/license.mk.
1.1       dsieger  6144: 
                   6145: The license tag mechanism is intended to address copyright-related issues
                   6146: surrounding building, installing and using a package, and not to address
1.20      jnemeth  6147: redistribution issues (see RESTRICTED and NO_SRC_ON_FTP, etc.). Packages with
                   6148: redistribution restrictions should set these tags.
1.1       dsieger  6149: 
                   6150: Denoting that a package may be copied according to a particular license is done
                   6151: by placing the license in pkgsrc/licenses and setting the LICENSE variable to a
                   6152: string identifying the license, e.g. in graphics/xv:
                   6153: 
                   6154: LICENSE=        xv-license
                   6155: 
                   6156: When trying to build, the user will get a notice that the package is covered by
                   6157: a license which has not been placed in the ACCEPTABLE_LICENSES variable:
                   6158: 
                   6159: % make
                   6160: ===> xv-3.10anb9 has an unacceptable license: xv-license.
                   6161: ===>     To view the license, enter "/usr/bin/make show-license".
                   6162: ===>     To indicate acceptance, add this line to your /etc/mk.conf:
                   6163: ===>     ACCEPTABLE_LICENSES+=xv-license
                   6164: *** Error code 1
                   6165: 
                   6166: The license can be viewed with make show-license, and if the user so chooses,
1.4       rillig   6167: the line printed above can be added to mk.conf to convey to pkgsrc that it
1.1       dsieger  6168: should not in the future fail because of that license:
                   6169: 
                   6170: ACCEPTABLE_LICENSES+=xv-license
                   6171: 
1.111     sevan    6172: The use of LICENSE=shareware, LICENSE=no-commercial-use, and similar language
                   6173: is deprecated because it does not crisply refer to a particular license text.
                   6174: Another problem with such usage is that it does not enable a user to tell
                   6175: pkgsrc to proceed for a single package without also telling pkgsrc to proceed
                   6176: for all packages with that tag.
                   6177: 
1.154     rillig   6178: 21.1.3.1. Adding a package with a new license
1.1       dsieger  6179: 
1.49      rodent   6180: When adding a package with a new license, the following steps are required:
                   6181: 
1.111     sevan    6182:  1. Check whether the license qualifies as Free or Open Source by referencing
                   6183:     Various Licenses and Comments about Them and Licenses by Name | Open Source
                   6184:     Initiative. If this is the case, the filename in pkgsrc/licenses/ does not
                   6185:     need the -license suffix, and the license name should be added to:
1.49      rodent   6186: 
                   6187:       + DEFAULT_ACCEPTABLE_LICENSES in pkgsrc/mk/license.mk
                   6188: 
                   6189:       + default_acceptable_licenses in pkgsrc/pkgtools/pkg_install/files/lib/
                   6190:         license.c
                   6191: 
                   6192:  2. The license text should be added to pkgsrc/licenses for displaying. A list
                   6193:     of known licenses can be seen in this directory.
1.1       dsieger  6194: 
1.154     rillig   6195: 21.1.3.2. Change to the license
1.1       dsieger  6196: 
1.111     sevan    6197: When the license changes (in a way other than formatting), make sure that the
                   6198: new license has a different name (e.g., append the version number if it exists,
                   6199: or the date). Just because a user told pkgsrc to build programs under a
                   6200: previous version of a license does not mean that pkgsrc should build programs
                   6201: under the new licenses. The higher-level point is that pkgsrc does not evaluate
                   6202: licenses for reasonableness; the only test is a mechanistic test of whether a
                   6203: particular text has been approved by either of two bodies (FSF or OSI).
1.1       dsieger  6204: 
1.154     rillig   6205: 21.1.4. Restricted packages
1.1       dsieger  6206: 
1.111     sevan    6207: Some licenses restrict how software may be re-distributed. By declaring the
                   6208: restrictions, package tools can automatically refrain from e.g. placing binary
                   6209: packages on FTP sites.
                   6210: 
                   6211: There are four possible restrictions, which are the cross product of sources
                   6212: (distfiles) and binaries not being placed on FTP sites and CD-ROMs. Because
                   6213: this is rarely the exact language in any license, and because non-Free licenses
                   6214: tend to be different from each other, pkgsrc adopts a definition of FTP and
                   6215: CD-ROM. "FTP" means making the source or binary file available over the
                   6216: Internet at no charge. "CD-ROM" means making the source or binary available on
                   6217: some kind of media, together with other source and binary packages, which is
                   6218: sold for a distribution charge.
1.1       dsieger  6219: 
                   6220: In order to encode these restrictions, the package system defines five make
                   6221: variables that can be set to note these restrictions:
                   6222: 
                   6223:   * RESTRICTED
                   6224: 
                   6225:     This variable should be set whenever a restriction exists (regardless of
                   6226:     its kind). Set this variable to a string containing the reason for the
                   6227:     restriction. It should be understood that those wanting to understand the
                   6228:     restriction will have to read the license, and perhaps seek advice of
                   6229:     counsel.
                   6230: 
                   6231:   * NO_BIN_ON_CDROM
                   6232: 
                   6233:     Binaries may not be placed on CD-ROM containing other binary packages, for
                   6234:     which a distribution charge may be made. In this case, set this variable to
                   6235:     ${RESTRICTED}.
                   6236: 
                   6237:   * NO_BIN_ON_FTP
                   6238: 
                   6239:     Binaries may not made available on the Internet without charge. In this
                   6240:     case, set this variable to ${RESTRICTED}. If this variable is set, binary
                   6241:     packages will not be included on ftp.NetBSD.org.
                   6242: 
                   6243:   * NO_SRC_ON_CDROM
                   6244: 
                   6245:     Distfiles may not be placed on CD-ROM, together with other distfiles, for
                   6246:     which a fee may be charged. In this case, set this variable to $
                   6247:     {RESTRICTED}.
                   6248: 
                   6249:   * NO_SRC_ON_FTP
                   6250: 
                   6251:     Distfiles may not made available via FTP at no charge. In this case, set
                   6252:     this variable to ${RESTRICTED}. If this variable is set, the distfile(s)
                   6253:     will not be mirrored on ftp.NetBSD.org.
                   6254: 
1.111     sevan    6255: Please note that packages will be removed from pkgsrc when the distfiles are
1.33      wiz      6256: not distributable and cannot be obtained for a period of one full quarter
1.111     sevan    6257: branch. Packages with manual/interactive fetch must have a maintainer and it is
                   6258: his/her responsibility to ensure this.
1.33      wiz      6259: 
1.154     rillig   6260: 21.1.5. Handling dependencies
1.1       dsieger  6261: 
1.175     gutterid 6262: Your package may depend on some other package being present, and there are
                   6263: various ways of expressing this dependency. pkgsrc supports the DEPENDS,
                   6264: BUILD_DEPENDS, TOOL_DEPENDS, and TEST_DEPENDS definitions, the USE_TOOLS
                   6265: definition, as well as dependencies via buildlink3.mk, which is the preferred
                   6266: way to handle dependencies, and which uses the variables named above. See
1.184     rillig   6267: Chapter 18, Buildlink methodology for more information.
1.175     gutterid 6268: 
                   6269: The basic difference is that the DEPENDS definition registers that
                   6270: pre-requisite in the binary package so it will be pulled in when the binary
                   6271: package is later installed, whilst the BUILD_DEPENDS, TOOL_DEPENDS, and
                   6272: TEST_DEPENDS definitions do not, marking a dependency that is only needed for
1.184     rillig   6273: building or testing the resulting package. See also Chapter 14, Creating a new
1.175     gutterid 6274: pkgsrc package from scratch for more information.
                   6275: 
                   6276: This means that if you only need a package present whilst you are building or
                   6277: testing, it should be noted as a TOOL_DEPENDS, BUILD_DEPENDS, or TEST_DEPENDS.
                   6278: When cross-compiling, TOOL_DEPENDS are native packages, i.e. packages for the
                   6279: architecture where the package is built; BUILD_DEPENDS are target packages,
                   6280: i.e., packages for the architecture for which the package is built.
1.1       dsieger  6281: 
1.175     gutterid 6282: The format for a DEPENDS, BUILD_DEPENDS, TOOL_DEPENDS, and TEST_DEPENDS
                   6283: definition is:
1.1       dsieger  6284: 
                   6285: <pre-req-package-name>:../../<category>/<pre-req-package>
                   6286: 
                   6287: Please note that the "pre-req-package-name" may include any of the wildcard
                   6288: version numbers recognized by pkg_info(1).
                   6289: 
1.55      wiz      6290:  1. If your package needs another package's binaries or libraries to build and
1.1       dsieger  6291:     run, and if that package has a buildlink3.mk file available, use it:
                   6292: 
                   6293:     .include "../../graphics/jpeg/buildlink3.mk"
                   6294: 
1.55      wiz      6295:  2. If your package needs another package's binaries or libraries only for
                   6296:     building, and if that package has a buildlink3.mk file available, use it:
                   6297: 
                   6298:     .include "../../graphics/jpeg/buildlink3.mk"
                   6299: 
                   6300:     but set BUILDLINK_DEPMETHOD.jpeg?=build to make it a build dependency only.
                   6301:     This case is rather rare.
                   6302: 
                   6303:  3. If your package needs binaries from another package to build, use the
1.156     leot     6304:     TOOL_DEPENDS definition:
                   6305: 
                   6306:     TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.1       dsieger  6307: 
1.156     leot     6308:  4. If your package needs static libraries to link against, header files to
                   6309:     include, etc. from another package to build, use the BUILD_DEPENDS
                   6310:     definition.
1.1       dsieger  6311: 
1.156     leot     6312:  5. If your package needs a library with which to link and there is no
1.26      spz      6313:     buildlink3.mk file available, create one. Using DEPENDS won't be sufficient
                   6314:     because the include files and libraries will be hidden from the compiler.
1.1       dsieger  6315: 
1.156     leot     6316:  6. If your package needs some executable to be able to run correctly and if
1.26      spz      6317:     there's no buildlink3.mk file, this is specified using the DEPENDS
                   6318:     variable. The print/lyx package needs to be able to execute the latex
1.129     wiz      6319:     binary from the tex-latex-bin package when it runs, and that is specified:
1.1       dsieger  6320: 
1.129     wiz      6321:     DEPENDS+=        tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.1       dsieger  6322: 
1.175     gutterid 6323:  7. If your package includes a test suite that has extra dependencies only
                   6324:     required for this purpose (frequently this can be run as a "make test"
                   6325:     target), use the TEST_DEPENDS variable.
                   6326: 
                   6327:  8. You can use wildcards in package dependencies. Note that such wildcard
1.26      spz      6328:     dependencies are retained when creating binary packages. The dependency is
                   6329:     checked when installing the binary package and any package which matches
                   6330:     the pattern will be used. Wildcard dependencies should be used with care.
1.1       dsieger  6331: 
                   6332:     The "-[0-9]*" should be used instead of "-*" to avoid potentially ambiguous
                   6333:     matches such as "tk-postgresql" matching a "tk-*" DEPENDS.
                   6334: 
                   6335:     Wildcards can also be used to specify that a package will only build
                   6336:     against a certain minimum version of a pre-requisite:
                   6337: 
1.26      spz      6338:     DEPENDS+=       ImageMagick>=6.0:../../graphics/ImageMagick
1.1       dsieger  6339: 
1.26      spz      6340:     This means that the package will build using version 6.0 of ImageMagick or
                   6341:     newer. Such a dependency may be warranted if, for example, the command line
                   6342:     options of an executable have changed.
                   6343: 
1.183     wiz      6344:     If you need to depend on minimum versions of libraries, set
                   6345:     BUILDLINK_API_DEPENDS.pkg to the appropriate pattern before including its
                   6346:     buildlink3.mk file, e.g.
                   6347: 
                   6348:     BUILDLINK_API_DEPENDS.jpeg+=    jpeg>=9.0
                   6349:     .include "../../graphics/jpeg/buildlink3.mk"
1.1       dsieger  6350: 
                   6351:     For security fixes, please update the package vulnerabilities file. See
1.154     rillig   6352:     Section 21.1.9, "Handling packages with security problems" for more
1.1       dsieger  6353:     information.
                   6354: 
                   6355: If your package needs files from another package to build, add the relevant
                   6356: distribution files to DISTFILES, so they will be extracted automatically. See
                   6357: the print/ghostscript package for an example. (It relies on the jpeg sources
                   6358: being present in source form during the build.)
                   6359: 
1.154     rillig   6360: 21.1.6. Handling conflicts with other packages
1.1       dsieger  6361: 
                   6362: Your package may conflict with other packages a user might already have
                   6363: installed on his system, e.g. if your package installs the same set of files as
1.80      wiz      6364: another package in the pkgsrc tree or has the same PKGNAME.
1.1       dsieger  6365: 
1.142     leot     6366: For example, x11/libXaw3d and x11/Xaw-Xpm install the same shared library, thus
                   6367: you set in pkgsrc/x11/libXaw3d/Makefile:
1.1       dsieger  6368: 
1.142     leot     6369: CONFLICTS=      Xaw-Xpm-[0-9]*
1.1       dsieger  6370: 
                   6371: 
1.142     leot     6372: and in pkgsrc/x11/Xaw-Xpm/Makefile:
1.1       dsieger  6373: 
1.142     leot     6374: CONFLICTS=      libXaw3d-[0-9]*
1.1       dsieger  6375: 
1.142     leot     6376: 
                   6377: pkg_add(1) is able to detect attempts to install packages that conflict with
                   6378: existing packages and abort. However, in many situations this is too late in
                   6379: the process. Binary package managers will not know about the conflict until
                   6380: they attempt to install the package after already downloading it and all its
                   6381: dependencies. Users may also waste time building a package and its dependencies
                   6382: only to find out at the end that it conflicts with another package they have
                   6383: installed.
                   6384: 
                   6385: To avoid these issues CONFLICTS entries should be added in all cases where it
                   6386: is known that packages conflict with each other. These CONFLICTS entries are
                   6387: exported in pkg_summary(5) files and consumed by binary package managers to
                   6388: inform users that packages cannot be installed onto the target system.
1.1       dsieger  6389: 
1.154     rillig   6390: 21.1.7. Packages that cannot or should not be built
1.1       dsieger  6391: 
                   6392: There are several reasons why a package might be instructed to not build under
                   6393: certain circumstances. If the package builds and runs on most platforms, the
1.83      dholland 6394: exceptions should be noted with BROKEN_ON_PLATFORM. If the package builds and
                   6395: runs on a small handful of platforms, set BROKEN_EXCEPT_ON_PLATFORM instead.
                   6396: Both BROKEN_ON_PLATFORM and BROKEN_EXCEPT_ON_PLATFORM are OS triples
                   6397: (OS-version-platform) that can use glob-style wildcards.
                   6398: 
1.114     maya     6399: If a package is not appropriate for some platforms (as opposed to merely
1.83      dholland 6400: broken), a different set of variables should be used as this affects failure
                   6401: reporting and statistics. If the package is appropriate for most platforms, the
                   6402: exceptions should be noted with NOT_FOR_PLATFORM. If the package is appropriate
                   6403: for only a small handful of platforms (often exactly one), set
                   6404: ONLY_FOR_PLATFORM instead. Both ONLY_FOR_PLATFORM and NOT_FOR_PLATFORM are OS
                   6405: triples (OS-version-platform) that can use glob-style wildcards.
1.1       dsieger  6406: 
                   6407: Some packages are tightly bound to a specific version of an operating system,
                   6408: e.g. LKMs or sysutils/lsof. Such binary packages are not backwards compatible
                   6409: with other versions of the OS, and should be uploaded to a version specific
                   6410: directory on the FTP server. Mark these packages by setting OSVERSION_SPECIFIC
                   6411: to "yes". This variable is not currently used by any of the package system
                   6412: internals, but may be used in the future.
                   6413: 
                   6414: If the package should be skipped (for example, because it provides
                   6415: functionality already provided by the system), set PKG_SKIP_REASON to a
                   6416: descriptive message. If the package should fail because some preconditions are
                   6417: not met, set PKG_FAIL_REASON to a descriptive message.
                   6418: 
1.154     rillig   6419: 21.1.8. Packages which should not be deleted, once installed
1.1       dsieger  6420: 
                   6421: To ensure that a package may not be deleted, once it has been installed, the
                   6422: PKG_PRESERVE definition should be set in the package Makefile. This will be
1.25      wiz      6423: carried into any binary package that is made from this pkgsrc entry. A "
                   6424: preserved" package will not be deleted using pkg_delete(1) unless the "-f"
1.1       dsieger  6425: option is used.
                   6426: 
1.154     rillig   6427: 21.1.9. Handling packages with security problems
1.1       dsieger  6428: 
                   6429: When a vulnerability is found, this should be noted in localsrc/security/
1.32      wiz      6430: advisories/pkg-vulnerabilities, and after committing that file, ask
                   6431: pkgsrc-security@NetBSD.org to update the file on ftp.NetBSD.org.
1.1       dsieger  6432: 
                   6433: After fixing the vulnerability by a patch, its PKGREVISION should be increased
                   6434: (this is of course not necessary if the problem is fixed by using a newer
1.32      wiz      6435: release of the software), and the pattern in the pkg-vulnerabilities file must
                   6436: be updated.
1.1       dsieger  6437: 
                   6438: Also, if the fix should be applied to the stable pkgsrc branch, be sure to
                   6439: submit a pullup request!
                   6440: 
                   6441: Binary packages already on ftp.NetBSD.org will be handled semi-automatically by
                   6442: a weekly cron job.
                   6443: 
1.154     rillig   6444: 21.1.10. How to handle incrementing versions when fixing an existing package
1.1       dsieger  6445: 
                   6446: When making fixes to an existing package it can be useful to change the version
                   6447: number in PKGNAME. To avoid conflicting with future versions by the original
                   6448: author, a "nb1", "nb2", ... suffix can be used on package versions by setting
                   6449: PKGREVISION=1 (2, ...). The "nb" is treated like a "." by the package tools.
                   6450: e.g.
                   6451: 
                   6452: DISTNAME=       foo-17.42
                   6453: PKGREVISION=    9
                   6454: 
                   6455: will result in a PKGNAME of "foo-17.42nb9". If you want to use the original
                   6456: value of PKGNAME without the "nbX" suffix, e.g. for setting DIST_SUBDIR, use
                   6457: PKGNAME_NOREV.
                   6458: 
                   6459: When a new release of the package is released, the PKGREVISION should be
                   6460: removed, e.g. on a new minor release of the above package, things should be
                   6461: like:
                   6462: 
                   6463: DISTNAME=       foo-17.43
                   6464: 
                   6465: PKGREVISION should be incremented for any non-trivial change in the resulting
                   6466: binary package. Without a PKGREVISION bump, someone with the previous version
                   6467: installed has no way of knowing that their package is out of date. Thus,
                   6468: changes without increasing PKGREVISION are essentially labeled "this is so
                   6469: trivial that no reasonable person would want to upgrade", and this is the rough
                   6470: test for when increasing PKGREVISION is appropriate. Examples of changes that
                   6471: do not merit increasing PKGREVISION are:
                   6472: 
1.14      jmcneill 6473:   * Changing HOMEPAGE, MAINTAINER, OWNER, or comments in Makefile.
1.1       dsieger  6474: 
                   6475:   * Changing build variables if the resulting binary package is the same.
                   6476: 
                   6477:   * Changing DESCR.
                   6478: 
                   6479:   * Adding PKG_OPTIONS if the default options don't change.
                   6480: 
                   6481: Examples of changes that do merit an increase to PKGREVISION include:
                   6482: 
                   6483:   * Security fixes
                   6484: 
                   6485:   * Changes or additions to a patch file
                   6486: 
                   6487:   * Changes to the PLIST
                   6488: 
1.12      weinem   6489:   * A dependency is changed or renamed.
                   6490: 
1.1       dsieger  6491: PKGREVISION must also be incremented when dependencies have ABI changes.
                   6492: 
1.154     rillig   6493: 21.1.11. Substituting variable text in the package files (the SUBST framework)
1.1       dsieger  6494: 
1.180     rillig   6495: When you want to replace the same text in multiple files, or multiple times in
                   6496: the same file, it is cumbersome to maintain a patch file for this. This is
                   6497: where the SUBST framework steps in. It provides an easy-to-use interface for
                   6498: replacing text in files. It just needs the following information:
1.172     rillig   6499: 
1.180     rillig   6500:   * In which phase of the package build cycle should the replacement happen?
1.172     rillig   6501: 
1.180     rillig   6502:   * In which files should the replacement happen?
1.172     rillig   6503: 
                   6504:   * Which text should be replaced with what?
                   6505: 
1.180     rillig   6506: This information is encoded in a block of SUBST variables. A minimal example
                   6507: is:
                   6508: 
                   6509: SUBST_CLASSES+=         paths
                   6510: SUBST_STAGE.paths=      pre-configure
                   6511: SUBST_FILES.paths=      src/*.c
                   6512: SUBST_SED.paths=        -e 's,/usr/local,${PREFIX},g'
                   6513: 
                   6514: Translated into English, it means: In the pre-configure stage (that is, after
                   6515: applying the patches from the patches/ directory and before running the
                   6516: configure script and the portability check), replace the text /usr/local with
                   6517: the content of the variable PREFIX.
                   6518: 
                   6519: Each SUBST block starts by appending an identifier to SUBST_CLASSES (note the +
                   6520: =). This identifier can be chosen freely by the package. If there should ever
                   6521: be duplicate identifiers, the pkgsrc infrastructure will catch this and fail
                   6522: early, so don't worry about name collisions.
                   6523: 
                   6524: Except for SUBST_CLASSES, all variables in a SUBST block are parameterized
                   6525: using this identifier. In the remainder of this section, these parameterized
                   6526: variables are written as SUBST_STAGE.*.
                   6527: 
                   6528: SUBST_CLASSES+=         paths
                   6529: SUBST_STAGE.paths=      pre-configure
                   6530: SUBST_MESSAGE.paths=    Fixing absolute paths.
                   6531: SUBST_FILES.paths=      src/*.c
                   6532: SUBST_FILES.paths+=     scripts/*.sh
                   6533: SUBST_SED.paths=        -e 's,"/usr/local,"${PREFIX},g'
                   6534: SUBST_SED.paths+=       -e 's,"/var/log,"${VARBASE}/log,g'
                   6535: SUBST_VARS.paths=       LOCALBASE PREFIX PKGVERSION
                   6536: 
                   6537: To get a complete picture about the SUBST substitutions, run bmake
                   6538: show-all-subst. If something doesn't work as expected, run pkglint on the
                   6539: package, which detects several typical mistakes surrounding the SUBST blocks.
                   6540: For any questions that might remain after this, have a look at mk/subst.mk.
                   6541: 
                   6542: 21.1.11.1. Choosing the time where the substitutions happen
                   6543: 
                   6544: The SUBST_STAGE.* is one of {pre,do,post}-
                   6545: {extract,patch,configure,build,test,install}. Of these, pre-configure is used
                   6546: most often, by far. The most popular stages are, in chronological order:
                   6547: 
                   6548: post-extract
                   6549: 
                   6550:     The substitutions are applied immediately after the distfiles are
                   6551:     extracted. Running bmake extract on the package will leave no traces of the
                   6552:     original files.
                   6553: 
                   6554:     When the substitution applies to files for which there is also a patch in
                   6555:     the patches/ directory, this means that the patches will be computed based
                   6556:     on the result of the substitution. When these patches are sent to the
                   6557:     upstream maintainer later, to be fixed in the upstream package, these
                   6558:     patches may no longer match what the upstream author is used to. Because of
                   6559:     this, pre-configure is often a better choice.
                   6560: 
                   6561: pre-configure
                   6562: 
                   6563:     The substitutions are applied after the patches from the patches/
                   6564:     directory. This makes it possible to run bmake patch on the package, after
                   6565:     which the patches can be edited using the tools pkgvi and mkpatches from
                   6566:     the pkgtools/pkgdiff package.
                   6567: 
                   6568:     When updating the patches, it is helpful to explicitly separate the bmake
                   6569:     patch from the bmake configure, and to only edit the patches between these
                   6570:     commands. Otherwise the substitutions from the SUBST block will end up in
                   6571:     the patch file. When this happens in really obvious ways, pkglint will
                   6572:     complain about patches that contain a hard-coded /usr/pkg instead of the
                   6573:     correct and intended @PREFIX@, but it can only detect these really obvious
                   6574:     cases.
                   6575: 
                   6576: do-configure
                   6577: 
                   6578:     This stage should only be used if the package defines a pre-configure
                   6579:     action itself, and the substitution must happen after that. Typical
                   6580:     examples are packages that use the pre-configure stage to regenerate the
                   6581:     GNU configure script from configure.ac.
                   6582: 
                   6583: post-configure
                   6584: 
                   6585:     This stage is used to fix up any mistakes by the configure stage.
                   6586: 
                   6587: pre-build
                   6588: 
                   6589:     This stage should only be used for substitutions that are clearly related
                   6590:     to building the package, not for fixing the configuration. Substitutions
                   6591:     for pathnames (such as replacing /usr/local with ${PREFIX}) or user names
                   6592:     (such as replacing @MY_USER@ with the actual username) belong in
                   6593:     pre-configure or post-configure instead.
                   6594: 
                   6595: post-build
                   6596: 
                   6597:     Just as with pre-build, this stage should only be used for substitutions
                   6598:     that are clearly related to building the package, not for fixing the
                   6599:     configuration. Substitutions for pathnames (such as replacing /usr/local
                   6600:     with ${PREFIX}) or user names (such as replacing @MY_USER@ with the actual
                   6601:     username) belong in pre-configure or post-configure instead.
                   6602: 
                   6603:     A typical use is to update pkg-config files to include the rpath compiler
                   6604:     options.
                   6605: 
                   6606: pre-install
                   6607: 
                   6608:     In general, the install phase should be as simple as possible. As with the
                   6609:     pre-build and post-build stages, it should not be used to fix pathnames or
                   6610:     user names, these belong in pre-configure instead. There are only few
                   6611:     legitimate use cases for applying substitutions in this stage.
                   6612: 
1.181     rillig   6613: 21.1.11.2. Choosing the files where the substitutions happen
1.180     rillig   6614: 
                   6615: The SUBST_FILES.* variable contains a list of filename patterns. These patterns
                   6616: are relative to WRKSRC since that is where most substitutions happen. A typical
                   6617: example is:
                   6618: 
                   6619: SUBST_FILES.path=       Makefile */Makefile */*/Makefile *.[ch]
                   6620: 
                   6621: The above patterns, especially the last, are quite broad. The SUBST
                   6622: implementation checks that each filename pattern that is mentioned here has an
                   6623: effect. For example, if none of the */*/Makefile files contains the patterns to
                   6624: be found and substituted, that filename pattern is redundant and should be left
1.181     rillig   6625: out. By default, the SUBST framework will complain with an error message. If
                   6626: the text to be substituted occurs in some of the files from a single pattern,
                   6627: but not in all of them, that is totally ok, and the SUBST framework will only
                   6628: print an INFO message for those files.
1.180     rillig   6629: 
                   6630: If there is a good reason for having redundant filename patterns, set
1.181     rillig   6631: SUBST_NOOP_OK.* to yes.
1.180     rillig   6632: 
                   6633: Another popular way of choosing the files for the substitutions is via a shell
                   6634: command, like this:
                   6635: 
1.181     rillig   6636: C_FILES_CMD=            cd ${WRKSRC} && ${FIND} . -name '*.c'
1.180     rillig   6637: SUBST_FILES.path=       ${C_FILES_CMD:sh}
                   6638: 
                   6639: The variable name C_FILES_CMD in this example is freely chosen and independent
                   6640: of the SUBST framework.
                   6641: 
                   6642: In this variant, the SUBST_FILES.* variable lists each file individually.
                   6643: Thereby chances are higher that there are filename patterns in which no
                   6644: substitution happens. Since the SUBST framework cannot know whether the
                   6645: filename patterns in SUBST_FILES.* have been explicitly listed in the Makefile
                   6646: (where any redundant filename pattern would be suspicious) or been generated by
                   6647: a shell command (in which redundant filename patterns are more likely and to be
                   6648: expected), it will complain about these redundant filename patterns. Therefore,
                   6649: SUBST blocks that use a shell command to generate the list of filename patterns
                   6650: often need to set SUBST_NOOP_OK.* to yes.
                   6651: 
                   6652: 21.1.11.3. Choosing what to substitute
                   6653: 
                   6654: In most cases, the substitutions are given using one or more sed(1) commands,
                   6655: like this:
                   6656: 
                   6657: SUBST_SED.path=         -e 's|/usr/local|${PREFIX}|g'
                   6658: 
                   6659: Each of the sed commands needs to be preceded by the -e option and should be
                   6660: specified on a line of its own, to avoid hiding short sed commands at the end
                   6661: of a line.
                   6662: 
                   6663: Since the sed commands often contain shell metacharacters as the separator (the
                   6664: | in the above example), it is common to enclose them in single quotes.
                   6665: 
                   6666: A common substitution is to replace placeholders of the form @VARNAME@ with
                   6667: their pkgsrc counterpart variable ${VARNAME}. A typical example is:
                   6668: 
                   6669: SUBST_VARS.path=        PREFIX
                   6670: 
1.181     rillig   6671: This type of substitutions is typically done by the GNU configure scripts
                   6672: during the do-configure stage, but in some cases these need to be overridden.
                   6673: The same pattern is also used when a package defines patches that replace
                   6674: previously hard-coded paths like /usr/local with a @PREFIX@ placeholder first,
                   6675: which then gets substituted by the actual ${PREFIX} in the pre-configure stage.
                   6676: In many of these cases, it works equally well to just use the SUBST framework
                   6677: to directly replace /usr/local with ${PREFIX}, thereby omitting the
                   6678: intermediate patch file.
1.180     rillig   6679: 
                   6680: If the above is not flexible enough, it is possible to not use sed at all for
                   6681: the substitution but to specify an entirely different command, like this:
                   6682: 
                   6683: SUBST_FILTER_CMD.path=  LC_ALL=C ${TR} -d '\r'
1.1       dsieger  6684: 
1.180     rillig   6685: This is used for the few remaining packages in which the distributed files use
                   6686: Windows-style line endings that need to be converted to UNIX-style line
                   6687: endings.
1.1       dsieger  6688: 
1.180     rillig   6689: 21.1.11.4. Other SUBST variables
1.172     rillig   6690: 
1.180     rillig   6691: When a SUBST block is applied during a package build, a message is logged. The
                   6692: default message is fine for most purposes but can be overridden by setting
                   6693: SUBST_MESSAGE.* to an individual message.
1.1       dsieger  6694: 
1.154     rillig   6695: 21.2. The fetch phase
1.1       dsieger  6696: 
1.154     rillig   6697: 21.2.1. Packages whose distfiles aren't available for plain downloading
1.1       dsieger  6698: 
                   6699: If you need to download from a dynamic URL you can set DYNAMIC_MASTER_SITES and
                   6700: a make fetch will call files/getsite.sh with the name of each file to download
                   6701: as an argument, expecting it to output the URL of the directory from which to
                   6702: download it. graphics/ns-cult3d is an example of this usage.
                   6703: 
                   6704: If the download can't be automated, because the user must submit personal
                   6705: information to apply for a password, or must pay for the source, or whatever,
                   6706: you can set FETCH_MESSAGE to a list of lines that are displayed to the user
                   6707: before aborting the build. Example:
                   6708: 
                   6709: FETCH_MESSAGE=  "Please download the files"
                   6710: FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   6711: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
                   6712: 
1.154     rillig   6713: 21.2.2. How to handle modified distfiles with the 'old' name
1.1       dsieger  6714: 
                   6715: Sometimes authors of a software package make some modifications after the
                   6716: software was released, and they put up a new distfile without changing the
                   6717: package's version number. If a package is already in pkgsrc at that time, the
                   6718: checksum will no longer match. The contents of the new distfile should be
                   6719: compared against the old one before changing anything, to make sure the
                   6720: distfile was really updated on purpose, and that no trojan horse or so crept
                   6721: in. Please mention that the distfiles were compared and what was found in your
1.54      rodent   6722: commit message.
                   6723: 
                   6724: Then, the correct way to work around this is to set DIST_SUBDIR to a unique
1.109     wiz      6725: directory name, usually based on PKGNAME_NOREV (but take care with python or
                   6726: ruby packages, where PKGNAME includes a variable prefix). All DISTFILES and
                   6727: PATCHFILES for this package will be put in that subdirectory of the local
1.154     rillig   6728: distfiles directory. (See Section 21.1.10, "How to handle incrementing versions
1.109     wiz      6729: when fixing an existing package" for more details.) In case this happens more
                   6730: often, PKGNAME can be used (thus including the nbX suffix) or a date stamp can
                   6731: be appended, like ${PKGNAME_NOREV}-YYYYMMDD.
1.54      rodent   6732: 
                   6733: DIST_SUBDIR is also used when a distfile's name does not contain a version and
                   6734: the distfile is apt to change. In cases where the likelihood of this is very
                   6735: small, DIST_SUBDIR might not be required. Additionally, DIST_SUBDIR must not be
                   6736: removed unless the distfile name changes, even if a package is being moved or
                   6737: renamed.
                   6738: 
                   6739: Do not forget regenerating the distinfo file after that, since it contains the
                   6740: DIST_SUBDIR path in the filenames. Also, increase the PKGREVISION if the
                   6741: installed package is different. Furthermore, a mail to the package's authors
                   6742: seems appropriate telling them that changing distfiles after releases without
                   6743: changing the file names is not good practice.
1.1       dsieger  6744: 
1.154     rillig   6745: 21.2.3. Packages hosted on github.com
1.88      tnn      6746: 
1.90      tnn      6747: Helper methods exist for packages hosted on github.com which will often have
                   6748: distfile names that clash with other packages, for example 1.0.tar.gz. Use one
                   6749: of the three recipes from below:
1.88      tnn      6750: 
1.154     rillig   6751: 21.2.3.1. Fetch based on a tagged release
1.88      tnn      6752: 
1.189     bacon    6753: If your distfile URL looks similar to https://github.com/username/example/
                   6754: archive/v1.0.zip, then you are packaging a tagged release.
1.88      tnn      6755: 
1.189     bacon    6756: DISTNAME=       example-1.0
1.90      tnn      6757: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
1.189     bacon    6758: #GITHUB_PROJECT= example    # can be omitted if same as DISTNAME
1.90      tnn      6759: GITHUB_TAG=     v${PKGVERSION_NOREV}
1.88      tnn      6760: EXTRACT_SUFX=   .zip
                   6761: 
1.189     bacon    6762: 21.2.3.2. Fetch based on a specific commit before the first release
                   6763: 
                   6764: If your distfile looks similar to https://github.com/username/example/archive/
                   6765: 988881adc9fc3655077dc2d4d757d480b5ea0e11 and is from a commit before the first
                   6766: release, then set the package version to 0.0.0.N, where N is the number of
                   6767: commits to the repository, and set GITHUB_TAG to the commit hash. This will
                   6768: (almost) ensure that the first tagged release will have a version greater than
                   6769: this one so that package upgrades will function properly.
                   6770: 
                   6771: DISTNAME=       example-0.0.0.347
                   6772: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   6773: #GITHUB_PROJECT= example    # can be omitted if same as DISTNAME
                   6774: GITHUB_TAG=     988881adc9fc3655077dc2d4d757d480b5ea0e11
                   6775: 
                   6776: 21.2.3.3. Fetch based on a specific commit after a release
1.88      tnn      6777: 
1.189     bacon    6778: If your distfile looks similar to https://github.com/username/example/archive/
                   6779: 988881adc9fc3655077dc2d4d757d480b5ea0e11 and is from a commit after a release,
                   6780: then include the last release version and the commit count since that release
                   6781: in the package version and set GITHUB_TAG to the commit hash. The latest
                   6782: release and commit count are shown in the output of "git describe --tags":
                   6783: 
                   6784: # git clone https://github.com/username/example
                   6785: # cd example
                   6786: # git describe --tags
                   6787: 1.2.3-5-g988881a
1.88      tnn      6788: 
1.189     bacon    6789: DISTNAME=       example-1.2.3.5
                   6790: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   6791: #GITHUB_PROJECT= example    # can be omitted if same as DISTNAME
1.90      tnn      6792: GITHUB_TAG=     988881adc9fc3655077dc2d4d757d480b5ea0e11
1.88      tnn      6793: 
1.189     bacon    6794: 21.2.3.4. Fetch based on release
1.88      tnn      6795: 
1.189     bacon    6796: If your distfile URL looks similar to https://github.com/username/example/
                   6797: releases/download/rel-1.6/offensive-1.6.zip, then you are packaging a release.
1.88      tnn      6798: 
1.90      tnn      6799: DISTNAME=       offensive-1.6
1.88      tnn      6800: PKGNAME=        ${DISTNAME:S/offensive/proper/}
1.90      tnn      6801: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
1.189     bacon    6802: GITHUB_PROJECT= example
1.90      tnn      6803: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
                   6804: EXTRACT_SUFX=   .zip
1.88      tnn      6805: 
1.154     rillig   6806: 21.3. The configure phase
1.1       dsieger  6807: 
1.154     rillig   6808: 21.3.1. Shared libraries - libtool
1.1       dsieger  6809: 
                   6810: pkgsrc supports many different machines, with different object formats like
                   6811: a.out and ELF, and varying abilities to do shared library and dynamic loading
                   6812: at all. To accompany this, varying commands and options have to be passed to
                   6813: the compiler, linker, etc. to get the Right Thing, which can be pretty annoying
                   6814: especially if you don't have all the machines at your hand to test things. The
                   6815: devel/libtool pkg can help here, as it just "knows" how to build both static
                   6816: and dynamic libraries from a set of source files, thus being
                   6817: platform-independent.
                   6818: 
                   6819: Here's how to use libtool in a package in seven simple steps:
                   6820: 
                   6821:  1. Add USE_LIBTOOL=yes to the package Makefile.
                   6822: 
                   6823:  2. For library objects, use "${LIBTOOL} --mode=compile ${CC}" in place of "$
                   6824:     {CC}". You could even add it to the definition of CC, if only libraries are
                   6825:     being built in a given Makefile. This one command will build both PIC and
                   6826:     non-PIC library objects, so you need not have separate shared and
                   6827:     non-shared library rules.
                   6828: 
                   6829:  3. For the linking of the library, remove any "ar", "ranlib", and "ld
                   6830:     -Bshareable" commands, and instead use:
                   6831: 
                   6832:     ${LIBTOOL} --mode=link \
                   6833:         ${CC} -o ${.TARGET:.a=.la} \
                   6834:             ${OBJS:.o=.lo} \
                   6835:             -rpath ${PREFIX}/lib \
                   6836:             -version-info major:minor
                   6837: 
                   6838:     Note that the library is changed to have a .la extension, and the objects
                   6839:     are changed to have a .lo extension. Change OBJS as necessary. This
                   6840:     automatically creates all of the .a, .so.major.minor, and ELF symlinks (if
                   6841:     necessary) in the build directory. Be sure to include "-version-info",
                   6842:     especially when major and minor are zero, as libtool will otherwise strip
                   6843:     off the shared library version.
                   6844: 
                   6845:     From the libtool manual:
                   6846: 
                   6847:     So, libtool library versions are described by three integers:
                   6848: 
                   6849:     CURRENT
                   6850:     The most recent interface number that this library implements.
                   6851: 
                   6852:     REVISION
                   6853:     The implementation number of the CURRENT interface.
                   6854: 
                   6855:     AGE
                   6856:     The difference between the newest and oldest interfaces that
                   6857:     this library implements.  In other words, the library implements
                   6858:     all the interface numbers in the range from number `CURRENT -
                   6859:     AGE' to `CURRENT'.
                   6860: 
                   6861:     If two libraries have identical CURRENT and AGE numbers, then the
                   6862:     dynamic linker chooses the library with the greater REVISION number.
                   6863: 
                   6864:     The "-release" option will produce different results for a.out and ELF
1.25      wiz      6865:     (excluding symlinks) in only one case. An ELF library of the form "
                   6866:     libfoo-release.so.x.y" will have a symlink of "libfoo.so.x.y" on an a.out
1.1       dsieger  6867:     platform. This is handled automatically.
                   6868: 
                   6869:     The "-rpath argument" is the install directory of the library being built.
                   6870: 
                   6871:     In the PLIST, include only the .la file, the other files will be added
                   6872:     automatically.
                   6873: 
                   6874:  4. When linking shared object (.so) files, i.e. files that are loaded via
                   6875:     dlopen(3), NOT shared libraries, use "-module -avoid-version" to prevent
                   6876:     them getting version tacked on.
                   6877: 
                   6878:     The PLIST file gets the foo.so entry.
                   6879: 
                   6880:  5. When linking programs that depend on these libraries before they are
                   6881:     installed, preface the cc(1) or ld(1) line with "${LIBTOOL} --mode=link",
                   6882:     and it will find the correct libraries (static or shared), but please be
                   6883:     aware that libtool will not allow you to specify a relative path in -L
                   6884:     (such as "-L../somelib"), because it expects you to change that argument to
                   6885:     be the .la file. e.g.
                   6886: 
                   6887:     ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
                   6888: 
                   6889:     should be changed to:
                   6890: 
                   6891:     ${LIBTOOL} --mode=link ${CC} -o someprog ../somelib/somelib.la
                   6892: 
                   6893:     and it will do the right thing with the libraries.
                   6894: 
                   6895:  6. When installing libraries, preface the install(1) or cp(1) command with "$
                   6896:     {LIBTOOL} --mode=install", and change the library name to .la. e.g.
                   6897: 
1.23      jakllsch 6898:     ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.1       dsieger  6899: 
                   6900:     This will install the static .a, shared library, any needed symlinks, and
                   6901:     run ldconfig(8).
                   6902: 
                   6903:  7. In your PLIST, include only the .la file (this is a change from previous
                   6904:     behaviour).
                   6905: 
1.154     rillig   6906: 21.3.2. Using libtool on GNU packages that already support libtool
1.1       dsieger  6907: 
                   6908: Add USE_LIBTOOL=yes to the package Makefile. This will override the package's
                   6909: own libtool in most cases. For older libtool using packages, libtool is made by
                   6910: ltconfig script during the do-configure step; you can check the libtool script
                   6911: location by doing make configure; find work*/ -name libtool.
                   6912: 
                   6913: LIBTOOL_OVERRIDE specifies which libtool scripts, relative to WRKSRC, to
                   6914: override. By default, it is set to "libtool */libtool */*/libtool". If this
                   6915: does not match the location of the package's libtool script(s), set it as
                   6916: appropriate.
                   6917: 
                   6918: If you do not need *.a static libraries built and installed, then use
                   6919: SHLIBTOOL_OVERRIDE instead.
                   6920: 
                   6921: If your package makes use of the platform-independent library for loading
                   6922: dynamic shared objects, that comes with libtool (libltdl), you should include
                   6923: devel/libltdl/buildlink3.mk.
                   6924: 
                   6925: Some packages use libtool incorrectly so that the package may not work or build
                   6926: in some circumstances. Some of the more common errors are:
                   6927: 
                   6928:   * The inclusion of a shared object (-module) as a dependent library in an
                   6929:     executable or library. This in itself isn't a problem if one of two things
                   6930:     has been done:
                   6931: 
                   6932:      1. The shared object is named correctly, i.e. libfoo.la, not foo.la
                   6933: 
                   6934:      2. The -dlopen option is used when linking an executable.
                   6935: 
                   6936:   * The use of libltdl without the correct calls to initialisation routines.
                   6937:     The function lt_dlinit() should be called and the macro
                   6938:     LTDL_SET_PRELOADED_SYMBOLS included in executables.
                   6939: 
1.154     rillig   6940: 21.3.3. GNU Autoconf/Automake
1.1       dsieger  6941: 
                   6942: If a package needs GNU autoconf or automake to be executed to regenerate the
                   6943: configure script and Makefile.in makefile templates, then they should be
                   6944: executed in a pre-configure target.
                   6945: 
                   6946: For packages that need only autoconf:
                   6947: 
                   6948: AUTOCONF_REQD=  2.50            # if default version is not good enough
                   6949: USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
                   6950: ...
                   6951: 
                   6952: pre-configure:
                   6953:         cd ${WRKSRC} && autoconf
                   6954: 
                   6955: ...
                   6956: 
                   6957: and for packages that need automake and autoconf:
                   6958: 
                   6959: AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
                   6960: USE_TOOLS+=     automake        # use "automake14" for automake-1.4
                   6961: ...
                   6962: 
                   6963: pre-configure:
                   6964:         set -e; cd ${WRKSRC}; \
                   6965:         aclocal; autoheader; automake -a --foreign -i; autoconf
                   6966: 
                   6967: ...
                   6968: 
                   6969: Packages which use GNU Automake will almost certainly require GNU Make.
                   6970: 
                   6971: There are times when the configure process makes additional changes to the
                   6972: generated files, which then causes the build process to try to re-execute the
                   6973: automake sequence. This is prevented by touching various files in the configure
                   6974: stage. If this causes problems with your package you can set AUTOMAKE_OVERRIDE=
                   6975: NO in the package Makefile.
                   6976: 
1.154     rillig   6977: 21.4. Programming languages
1.1       dsieger  6978: 
1.154     rillig   6979: 21.4.1. C, C++, and Fortran
1.1       dsieger  6980: 
                   6981: Compilers for the C, C++, and Fortran languages comes with the NetBSD base
                   6982: system. By default, pkgsrc assumes that a package is written in C and will hide
1.184     rillig   6983: all other compilers (via the wrapper framework, see Chapter 18, Buildlink
1.1       dsieger  6984: methodology).
                   6985: 
                   6986: To declare which language's compiler a package needs, set the USE_LANGUAGES
                   6987: variable. Allowed values currently are "c", "c++", and "fortran" (and any
                   6988: combination). The default is "c". Packages using GNU configure scripts, even if
                   6989: written in C++, usually need a C compiler for the configure phase.
                   6990: 
1.154     rillig   6991: 21.4.2. Java
1.1       dsieger  6992: 
                   6993: If a program is written in Java, use the Java framework in pkgsrc. The package
                   6994: must include ../../mk/java-vm.mk. This Makefile fragment provides the following
                   6995: variables:
                   6996: 
                   6997:   * USE_JAVA defines if a build dependency on the JDK is added. If USE_JAVA is
                   6998:     set to "run", then there is only a runtime dependency on the JDK. The
                   6999:     default is "yes", which also adds a build dependency on the JDK.
                   7000: 
                   7001:   * Set USE_JAVA2 to declare that a package needs a Java2 implementation. The
                   7002:     supported values are "yes", "1.4", and "1.5". "yes" accepts any Java2
                   7003:     implementation, "1.4" insists on versions 1.4 or above, and "1.5" only
                   7004:     accepts versions 1.5 or above. This variable is not set by default.
                   7005: 
1.25      wiz      7006:   * PKG_JAVA_HOME is automatically set to the runtime location of the used Java
                   7007:     implementation dependency. It may be used to set JAVA_HOME to a good value
                   7008:     if the program needs this variable to be defined.
                   7009: 
1.154     rillig   7010: 21.4.3. Packages containing perl scripts
1.1       dsieger  7011: 
                   7012: If your package contains interpreted perl scripts, add "perl" to the USE_TOOLS
                   7013: variable and set REPLACE_PERL to ensure that the proper interpreter path is
                   7014: set. REPLACE_PERL should contain a list of scripts, relative to WRKSRC, that
1.74      wiz      7015: you want adjusted. Every occurrence of */bin/perl in a she-bang line will be
                   7016: replaced with the full path to the perl executable.
1.1       dsieger  7017: 
                   7018: If a particular version of perl is needed, set the PERL5_REQD variable to the
                   7019: version number. The default is "5.0".
                   7020: 
1.154     rillig   7021: See Section 21.6.6, "Packages installing perl modules" for information about
1.1       dsieger  7022: handling perl modules.
                   7023: 
1.154     rillig   7024: 21.4.4. Packages containing shell scripts
1.41      wiz      7025: 
                   7026: REPLACE_SH, REPLACE_BASH, REPLACE_CSH, and REPLACE_KSH can be used to replace
1.195     gutterid 7027: shell hash bangs in files. Please use the appropriate one, preferring
                   7028: REPLACE_SH in case this shell is sufficient. Each should contain a list of
                   7029: scripts, relative to WRKSRC, that you want adjusted. Every occurrence of the
                   7030: matching shell in a she-bang line will be replaced with the full path to the
                   7031: shell executable. When using REPLACE_BASH, don't forget to add bash to
                   7032: USE_TOOLS.
1.41      wiz      7033: 
1.154     rillig   7034: 21.4.5. Other programming languages
1.1       dsieger  7035: 
                   7036: Currently, there is no special handling for other languages in pkgsrc. If a
                   7037: compiler package provides a buildlink3.mk file, include that, otherwise just
                   7038: add a (build) dependency on the appropriate compiler package.
                   7039: 
1.154     rillig   7040: 21.5. The build phase
1.1       dsieger  7041: 
                   7042: The most common failures when building a package are that some platforms do not
                   7043: provide certain header files, functions or libraries, or they provide the
                   7044: functions in a library that the original package author didn't know. To work
                   7045: around this, you can rewrite the source code in most cases so that it does not
                   7046: use the missing functions or provides a replacement function.
                   7047: 
1.154     rillig   7048: 21.5.1. Compiling C and C++ code conditionally
1.1       dsieger  7049: 
                   7050: If a package already comes with a GNU configure script, the preferred way to
                   7051: fix the build failure is to change the configure script, not the code. In the
                   7052: other cases, you can utilize the C preprocessor, which defines certain macros
                   7053: depending on the operating system and hardware architecture it compiles for.
                   7054: These macros can be queried using for example #if defined(__i386). Almost every
                   7055: operating system, hardware architecture and compiler has its own macro. For
                   7056: example, if the macros __GNUC__, __i386__ and __NetBSD__ are all defined, you
                   7057: know that you are using NetBSD on an i386 compatible CPU, and your compiler is
                   7058: GCC.
                   7059: 
                   7060: The list of the following macros for hardware and operating system depends on
                   7061: the compiler that is used. For example, if you want to conditionally compile
                   7062: code on Solaris, don't use __sun__, as the SunPro compiler does not define it.
                   7063: Use __sun instead.
                   7064: 
1.154     rillig   7065: 21.5.1.1. C preprocessor macros to identify the operating system
1.1       dsieger  7066: 
                   7067: To distinguish between 4.4 BSD-derived systems and the rest of the world, you
                   7068: should use the following code.
                   7069: 
                   7070: #include <sys/param.h>
                   7071: #if (defined(BSD) && BSD >= 199306)
                   7072: /* BSD-specific code goes here */
                   7073: #else
                   7074: /* non-BSD-specific code goes here */
                   7075: #endif
                   7076: 
                   7077: If this distinction is not fine enough, you can also test for the following
                   7078: macros.
                   7079: 
1.46      obache   7080: Cygwin      __CYGWIN__
                   7081: DragonFly   __DragonFly__
1.1       dsieger  7082: FreeBSD     __FreeBSD__
1.46      obache   7083: Haiku       __HAIKU__
1.1       dsieger  7084: Interix     __INTERIX
                   7085: IRIX        __sgi (TODO: get a definite source for this)
                   7086: Linux       linux, __linux, __linux__
1.83      dholland 7087: Mac OS X    __APPLE__
1.46      obache   7088: MirBSD      __MirBSD__ (__OpenBSD__ is also defined)
                   7089: Minix3      __minix
1.1       dsieger  7090: NetBSD      __NetBSD__
                   7091: OpenBSD     __OpenBSD__
                   7092: Solaris     sun, __sun
                   7093: 
1.154     rillig   7094: 21.5.1.2. C preprocessor macros to identify the hardware architecture
1.1       dsieger  7095: 
                   7096: i386        i386, __i386, __i386__
                   7097: MIPS        __mips
                   7098: SPARC       sparc, __sparc
                   7099: 
1.154     rillig   7100: 21.5.1.3. C preprocessor macros to identify the compiler
1.1       dsieger  7101: 
                   7102: GCC         __GNUC__ (major version), __GNUC_MINOR__
                   7103: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
                   7104: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
                   7105: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
                   7106: 
1.154     rillig   7107: 21.5.2. How to handle compiler bugs
1.1       dsieger  7108: 
                   7109: Some source files trigger bugs in the compiler, based on combinations of
                   7110: compiler version and architecture and almost always relation to optimisation
                   7111: being enabled. Common symptoms are gcc internal errors or never finishing
                   7112: compiling a file.
                   7113: 
                   7114: Typically, a workaround involves testing the MACHINE_ARCH and compiler version,
1.87      tnn      7115: disabling optimisation for that combination of file, MACHINE_ARCH and compiler.
                   7116: 
                   7117: This used to be a big problem in the past, but is rarely needed now as compiler
                   7118: technology has matured. If you still need to add a compiler specific
                   7119: workaround, please do so in the file hacks.mk and describe the symptom and
                   7120: compiler version as detailed as possible.
1.1       dsieger  7121: 
1.172     rillig   7122: 21.5.3. No such file or directory
                   7123: 
                   7124: Compilation sometimes fails with an error message like this:
                   7125: 
                   7126: .../x11/gtk3/work/gtk+-3.24.12/gdk/gdktypes.h:35:10:
                   7127:     fatal error: pango/pango.h: No such file or directory
                   7128: 
                   7129: The proper way to fix this problem depends on the type of the header, which is
                   7130: described in the following sections.
                   7131: 
                   7132: 21.5.3.1. Headers from other packages
                   7133: 
                   7134: If the header name looks like it comes from a different package, that other
                   7135: package should be included via the buildlink3 framework.
                   7136: 
                   7137: First, look whether the header is somewhere in the buildlink3 directory below
                   7138: WRKDIR. In the above case of the missing Pango header:
                   7139: 
                   7140: $ find work/.buildlink/ -print | grep -F pango/pango.h
                   7141: 
                   7142: In the case of Pango, the output is:
                   7143: 
                   7144: work/.buildlink/include/pango-1.0/pango/pango.h
                   7145: 
                   7146: If the pango/pango.h file were placed directly in the .buildlink directory, it
                   7147: would have been found automatically. There is an extra pango-1.0 path component
                   7148: though, which means that the compiler command line must contain an option of
                   7149: the form -I${BUILDLINK3_PREFIX.pango}/include/pango-1.0. In most cases this
                   7150: option is generated by the configure script, which can be examined using:
                   7151: 
                   7152: $ $ grep -o '[-]I[^[:space:]]*/pango[^[:space:]]*' work/*/Makefile
                   7153: -I/usr/pkg/include/pango-1.0
                   7154: -I/usr/pkg/include/pango-1.0
                   7155: -I/usr/pkg/include/pango-1.0
                   7156: -I/usr/pkg/include/pango-1.0
                   7157: -I/usr/pkg/include/pango-1.0
                   7158: 
                   7159: This looks good. These options are transformed by the buildlink wrapper to
                   7160: refer to the correct path inside work/.buildlink.
                   7161: 
                   7162: Since the compilation fails though, examine the compiler command lines in work
                   7163: /.work.log to see whether the -I option is included in the particular command
                   7164: line.
                   7165: 
                   7166: To further analyze the situation, run bmake build-env, which sets up an
                   7167: interactive, realistic environment including all the pkgsrc wrapper commands
                   7168: and environment variables. From there, try to compile some simple example
                   7169: programs that use the header.
                   7170: 
                   7171: 21.5.3.2. Headers generated during the build
                   7172: 
                   7173: If the name of the header seems to come from the package itself, and if the
                   7174: build is run with parallel jobs, the package may have some undeclared
                   7175: dependencies between the .c and the .h files, and a C file is compiled before
                   7176: its required header is generated.
                   7177: 
                   7178: To see whether the build runs with parallel jobs, run bmake show-all-build |
                   7179: grep JOBS. Its output looks like this:
                   7180: 
                   7181:   usr   MAKE_JOBS=              7
                   7182:   pkg   MAKE_JOBS_SAFE          # undefined
                   7183:   def   _MAKE_JOBS_N=           7
                   7184: 
                   7185: In this case the pkgsrc user has asked pkgsrc to build packages with 7 jobs in
                   7186: parallel (MAKE_JOBS). The package could have disabled parallel builds by
                   7187: setting MAKE_JOBS_SAFE to no, but in this case it hasn't.
                   7188: 
                   7189: To see whether the build failure is caused by parallel builds, first save the
                   7190: exact error message and a bit of context, maybe you need it later for reporting
                   7191: a bug. Next, run:
                   7192: 
                   7193: MAKE_JOBS_SAFE=no bmake clean build
                   7194: 
                   7195: If that succeeds, file a bug report against the pkgsrc package, including the
                   7196: exact error message and the contents of your mk.conf file.
                   7197: 
1.173     rillig   7198: 21.5.3.3. Symlinks
                   7199: 
                   7200: Pkgsrc does not work reliably if any of LOCALBASE, VARBASE or WRKDIR contains a
                   7201: symlink. Since 2019Q2, the pkgsrc bootstrap program prevents installing pkgsrc
                   7202: in symlink-based directories. Existing pkgsrc installations are not checked for
                   7203: symlinks though.
                   7204: 
                   7205: The "No such file or directory" error messages are a typical symptom of
                   7206: symlinks, and it's quite difficult to find out that this is the actual cause.
                   7207: 
                   7208: 21.5.3.4. Stale working directories
                   7209: 
                   7210: When building a hierarchy of packages, it may happen that one package is built
                   7211: and then pkgsrc is updated. This situation can provoke various hard to diagnose
                   7212: build errors. To clean up the situation:
                   7213: 
                   7214: $ (cd ../../ && test -f mk/bsd.pkg.mk && rm -rf */*/work)
                   7215: 
                   7216: (The test for bsd.pkg.mk just prevents running this command in the wrong
                   7217: directory.)
                   7218: 
                   7219: If you have set WRKOBJDIR in mk.conf, remove that directory as well.
                   7220: 
                   7221: 21.5.3.5. Other possible reasons
                   7222: 
                   7223: On platforms other than BSD, third-party packages are installed in /usr/
                   7224: include, together with the base system. This means that pkgsrc cannot
                   7225: distinguish between headers provided by the base system (which it needs) and
                   7226: headers from third-party packages (which are often included in pkgsrc as well).
                   7227: This can lead to subtle version mismatches.
                   7228: 
                   7229: In pkgsrc installations that have been active for several years, it may happen
                   7230: that some files are manually deleted. To exclude this unlikely reason, run 
                   7231: pkg_admin check.
                   7232: 
                   7233: It may help to run pkg_admin rebuild-tree to check/fix dependencies.
                   7234: 
                   7235: If all of the above doesn't help, see Chapter 2, Getting help for contact
                   7236: information. Be prepared to describe what you have tried so far and what any
                   7237: error messages were.
                   7238: 
1.172     rillig   7239: 21.5.4. Undefined reference to "..."
1.1       dsieger  7240: 
                   7241: This error message often means that a package did not link to a shared library
                   7242: it needs. The following functions are known to cause this error message over
                   7243: and over.
                   7244: 
                   7245: +-----------------------------------------------------+
                   7246: |        Function         |Library |Affected platforms|
                   7247: |-------------------------+--------+------------------|
                   7248: |accept, bind, connect    |-lsocket|Solaris           |
                   7249: |-------------------------+--------+------------------|
                   7250: |crypt                    |-lcrypt |DragonFly, NetBSD |
                   7251: |-------------------------+--------+------------------|
                   7252: |dlopen, dlsym            |-ldl    |Linux             |
                   7253: |-------------------------+--------+------------------|
                   7254: |gethost*                 |-lnsl   |Solaris           |
                   7255: |-------------------------+--------+------------------|
                   7256: |inet_aton                |-lresolv|Solaris           |
                   7257: |-------------------------+--------+------------------|
                   7258: |nanosleep, sem_*, timer_*|-lrt    |Solaris           |
                   7259: |-------------------------+--------+------------------|
                   7260: |openpty                  |-lutil  |Linux             |
                   7261: +-----------------------------------------------------+
                   7262: 
                   7263: To fix these linker errors, it is often sufficient to say LIBS.OperatingSystem+
                   7264: = -lfoo to the package Makefile and then say bmake clean; bmake.
                   7265: 
1.172     rillig   7266: 21.5.4.1. Special issue: The SunPro compiler
1.1       dsieger  7267: 
                   7268: When you are using the SunPro compiler, there is another possibility. That
                   7269: compiler cannot handle the following code:
                   7270: 
                   7271: extern int extern_func(int);
                   7272: 
                   7273: static inline int
                   7274: inline_func(int x)
                   7275: {
                   7276:         return extern_func(x);
                   7277: }
                   7278: 
                   7279: int main(void)
                   7280: {
                   7281:         return 0;
                   7282: }
                   7283: 
                   7284: It generates the code for inline_func even if that function is never used. This
                   7285: code then refers to extern_func, which can usually not be resolved. To solve
                   7286: this problem you can try to tell the package to disable inlining of functions.
                   7287: 
1.172     rillig   7288: 21.5.5. Running out of memory
1.1       dsieger  7289: 
                   7290: Sometimes packages fail to build because the compiler runs into an operating
                   7291: system specific soft limit. With the UNLIMIT_RESOURCES variable pkgsrc can be
1.94      wiz      7292: told to unlimit the resources. Currently, the allowed values are any
                   7293: combination of "cputime", "datasize", "memorysize", and "stacksize". Setting
                   7294: this variable is similar to running the shell builtin ulimit command to raise
                   7295: the maximum data segment size or maximum stack size of a process, respectively,
                   7296: to their hard limits.
1.1       dsieger  7297: 
1.154     rillig   7298: 21.6. The install phase
1.1       dsieger  7299: 
1.154     rillig   7300: 21.6.1. Creating needed directories
1.1       dsieger  7301: 
                   7302: The BSD-compatible install supplied with some operating systems cannot create
                   7303: more than one directory at a time. As such, you should call ${INSTALL_*_DIR}
                   7304: like this:
                   7305: 
                   7306: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   7307: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
                   7308: 
                   7309: You can also just append "dir1 dir2" to the INSTALLATION_DIRS variable, which
                   7310: will automatically do the right thing.
                   7311: 
1.154     rillig   7312: 21.6.2. Where to install documentation
1.1       dsieger  7313: 
                   7314: In general, documentation should be installed into ${PREFIX}/share/doc/$
                   7315: {PKGBASE} or ${PREFIX}/share/doc/${PKGNAME} (the latter includes the version
                   7316: number of the package).
                   7317: 
                   7318: Many modern packages using GNU autoconf allow to set the directory where HTML
                   7319: documentation is installed with the "--with-html-dir" option. Sometimes using
                   7320: this flag is needed because otherwise the documentation ends up in ${PREFIX}/
                   7321: share/doc/html or other places.
                   7322: 
                   7323: An exception to the above is that library API documentation generated with the
                   7324: textproc/gtk-doc tools, for use by special browsers (devhelp) should be left at
                   7325: their default location, which is ${PREFIX}/share/gtk-doc. Such documentation
                   7326: can be recognized from files ending in .devhelp or .devhelp2. (It is also
                   7327: acceptable to install such files in ${PREFIX}/share/doc/${PKGBASE} or ${PREFIX}
                   7328: /share/doc/${PKGNAME}; the .devhelp* file must be directly in that directory
                   7329: then, no additional subdirectory level is allowed in this case. This is usually
                   7330: achieved by using "--with-html-dir=${PREFIX}/share/doc". ${PREFIX}/share/
                   7331: gtk-doc is preferred though.)
                   7332: 
1.154     rillig   7333: 21.6.3. Installing highscore files
1.1       dsieger  7334: 
                   7335: Certain packages, most of them in the games category, install a score file that
                   7336: allows all users on the system to record their highscores. In order for this to
                   7337: work, the binaries need to be installed setgid and the score files owned by the
1.36      wiz      7338: appropriate group and/or owner (traditionally the "games" user/group). Set
                   7339: USE_GAMESGROUP to yes to support this. The following variables, documented in
                   7340: more detail in mk/defaults/mk.conf, control this behaviour: GAMEDATAMODE,
1.100     leot     7341: GAMEDIRMODE, GAMES_GROUP, GAMEMODE, GAME_USER. Other useful variables are:
                   7342: GAMEDIR_PERMS, GAMEDATA_PERMS and SETGID_GAMES_PERMS.
                   7343: 
                   7344: An example that illustrates some of the variables described above is games/
                   7345: moon-buggy. OWN_DIRS_PERMS is used to properly set directory permissions of the
                   7346: directory where the scorefile is saved, REQD_FILES_PERMS is used to create a
                   7347: dummy scorefile (mbscore) with the proper permissions and SPECIAL_PERMS is used
                   7348: to install setgid the game binary:
                   7349: 
                   7350: USE_GAMESGROUP=         yes
                   7351: 
                   7352: BUILD_DEFS+=            VARBASE
                   7353: 
                   7354: OWN_DIRS_PERMS+=        ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
                   7355: REQD_FILES_PERMS+=      /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
                   7356: SPECIAL_PERMS+=         ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
                   7357: 
                   7358: Various INSTALL_* variables are also available: INSTALL_GAME to install setgid
                   7359: game binaries, INSTALL_GAME_DIR to install game directories that are needed to
                   7360: be accessed by setgid games and INSTALL_GAME_DATA to install scorefiles.
1.1       dsieger  7361: 
1.14      jmcneill 7362: A package should therefore never hard code file ownership or access permissions
1.100     leot     7363: but rely on *_PERMS as described above or alternatively on INSTALL_GAME,
                   7364: INSTALL_GAME_DATA and INSTALL_GAME_DIR to set these correctly.
1.1       dsieger  7365: 
1.154     rillig   7366: 21.6.4. Adding DESTDIR support to packages
1.4       rillig   7367: 
1.14      jmcneill 7368: DESTDIR support means that a package installs into a staging directory, not the
                   7369: final location of the files. Then a binary package is created which can be used
                   7370: for installation as usual. There are two ways: Either the package must install
1.25      wiz      7371: as root ("destdir") or the package can install as non-root user ("user-destdir"
                   7372: ).
1.14      jmcneill 7373: 
1.113     leot     7374:   * PKG_DESTDIR_SUPPORT has to be set to "destdir" or "user-destdir". By
                   7375:     default PKG_DESTDIR_SUPPORT is set to "user-destdir" to help catching more
                   7376:     potential packaging problems. If bsd.prefs.mk is included in the Makefile,
                   7377:     PKG_DESTDIR_SUPPORT needs to be set before the inclusion.
1.14      jmcneill 7378: 
1.4       rillig   7379:   * All installation operations have to be prefixed with ${DESTDIR}.
                   7380: 
                   7381:   * automake gets this DESTDIR mostly right automatically. Many manual rules
                   7382:     and pre/post-install often are incorrect; fix them.
                   7383: 
1.17      imil     7384:   * If files are installed with special owner/group use SPECIAL_PERMS.
1.4       rillig   7385: 
                   7386:   * In general, packages should support UNPRIVILEGED to be able to use DESTDIR.
                   7387: 
1.154     rillig   7388: 21.6.5. Packages with hardcoded paths to other interpreters
1.1       dsieger  7389: 
                   7390: Your package may also contain scripts with hardcoded paths to other
                   7391: interpreters besides (or as well as) perl. To correct the full pathname to the
                   7392: script interpreter, you need to set the following definitions in your Makefile
                   7393: (we shall use tclsh in this example):
                   7394: 
                   7395: REPLACE_INTERPRETER+=   tcl
                   7396: REPLACE.tcl.old=        .*/bin/tclsh
                   7397: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   7398: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   7399: # relative to ${WRKSRC}, just as in REPLACE_PERL
                   7400: 
                   7401: Note
                   7402: 
                   7403: Before March 2006, these variables were called _REPLACE.* and _REPLACE_FILES.*.
                   7404: 
1.154     rillig   7405: 21.6.6. Packages installing perl modules
1.1       dsieger  7406: 
                   7407: Makefiles of packages providing perl5 modules should include the Makefile
                   7408: fragment ../../lang/perl5/module.mk. It provides a do-configure target for the
                   7409: standard perl configuration for such modules as well as various hooks to tune
                   7410: this configuration. See comments in this file for details.
                   7411: 
                   7412: Perl5 modules will install into different places depending on the version of
                   7413: perl used during the build process. To address this, pkgsrc will append lines
                   7414: to the PLIST corresponding to the files listed in the installed .packlist file
                   7415: generated by most perl5 modules. This is invoked by defining PERL5_PACKLIST to
1.48      wiz      7416: a space-separated list of packlist files relative to PERL5_PACKLIST_DIR
                   7417: (PERL5_INSTALLVENDORARCH by default), e.g.:
1.1       dsieger  7418: 
1.48      wiz      7419: PERL5_PACKLIST= auto/Pg/.packlist
1.1       dsieger  7420: 
1.48      wiz      7421: The perl5 config variables installarchlib, installscript, installvendorbin,
                   7422: installvendorscript, installvendorarch, installvendorlib, installvendorman1dir,
                   7423: and installvendorman3dir represent those locations in which components of perl5
                   7424: modules may be installed, provided as variable with uppercase and prefixed with
                   7425: PERL5_, e.g. PERL5_INSTALLARCHLIB and may be used by perl5 packages that don't
                   7426: have a packlist. These variables are also substituted for in the PLIST as
                   7427: uppercase prefixed with PERL5_SUB_.
1.1       dsieger  7428: 
1.154     rillig   7429: 21.6.7. Packages installing info files
1.1       dsieger  7430: 
                   7431: Some packages install info files or use the "makeinfo" or "install-info"
                   7432: commands. INFO_FILES should be defined in the package Makefile so that INSTALL
                   7433: and DEINSTALL scripts will be generated to handle registration of the info
                   7434: files in the Info directory file. The "install-info" command used for the info
                   7435: files registration is either provided by the system, or by a special purpose
                   7436: package automatically added as dependency if needed.
                   7437: 
                   7438: PKGINFODIR is the directory under ${PREFIX} where info files are primarily
                   7439: located. PKGINFODIR defaults to "info" and can be overridden by the user.
                   7440: 
                   7441: The info files for the package should be listed in the package PLIST; however
                   7442: any split info files need not be listed.
                   7443: 
                   7444: A package which needs the "makeinfo" command at build time must add "makeinfo"
                   7445: to USE_TOOLS in its Makefile. If a minimum version of the "makeinfo" command is
                   7446: needed it should be noted with the TEXINFO_REQD variable in the package
                   7447: Makefile. By default, a minimum version of 3.12 is required. If the system does
                   7448: not provide a makeinfo command or if it does not match the required minimum, a
                   7449: build dependency on the devel/gtexinfo package will be added automatically.
                   7450: 
                   7451: The build and installation process of the software provided by the package
                   7452: should not use the install-info command as the registration of info files is
1.25      wiz      7453: the task of the package INSTALL script, and it must use the appropriate 
1.1       dsieger  7454: makeinfo command.
                   7455: 
                   7456: To achieve this goal, the pkgsrc infrastructure creates overriding scripts for
                   7457: the install-info and makeinfo commands in a directory listed early in PATH.
                   7458: 
                   7459: The script overriding install-info has no effect except the logging of a
                   7460: message. The script overriding makeinfo logs a message and according to the
                   7461: value of TEXINFO_REQD either runs the appropriate makeinfo command or exit on
                   7462: error.
                   7463: 
1.154     rillig   7464: 21.6.8. Packages installing man pages
1.1       dsieger  7465: 
                   7466: All packages that install manual pages should install them into the same
                   7467: directory, so that there is one common place to look for them. In pkgsrc, this
                   7468: place is ${PREFIX}/${PKGMANDIR}, and this expression should be used in
1.25      wiz      7469: packages. The default for PKGMANDIR is "man". Another often-used value is "
                   7470: share/man".
1.1       dsieger  7471: 
                   7472: Note
                   7473: 
                   7474: The support for a custom PKGMANDIR is far from complete.
                   7475: 
                   7476: The PLIST files can just use man/ as the top level directory for the man page
                   7477: file entries, and the pkgsrc framework will convert as needed. In all other
                   7478: places, the correct PKGMANDIR must be used.
                   7479: 
                   7480: Packages that are configured with GNU_CONFIGURE set as "yes", by default will
                   7481: use the ./configure --mandir switch to set where the man pages should be
                   7482: installed. The path is GNU_CONFIGURE_MANDIR which defaults to ${PREFIX}/$
                   7483: {PKGMANDIR}.
                   7484: 
                   7485: Packages that use GNU_CONFIGURE but do not use --mandir, can set
                   7486: CONFIGURE_HAS_MANDIR to "no". Or if the ./configure script uses a non-standard
                   7487: use of --mandir, you can set GNU_CONFIGURE_MANDIR as needed.
                   7488: 
1.184     rillig   7489: See Section 19.5, "Man page compression" for information on installation of
1.1       dsieger  7490: compressed manual pages.
                   7491: 
1.154     rillig   7492: 21.6.9. Packages installing GConf data files
1.1       dsieger  7493: 
1.7       rillig   7494: If a package installs .schemas or .entries files, used by GConf, you need to
1.1       dsieger  7495: take some extra steps to make sure they get registered in the database:
                   7496: 
1.7       rillig   7497:  1. Include ../../devel/GConf/schemas.mk instead of its buildlink3.mk file.
                   7498:     This takes care of rebuilding the GConf database at installation and
                   7499:     deinstallation time, and tells the package where to install GConf data
1.1       dsieger  7500:     files using some standard configure arguments. It also disallows any access
                   7501:     to the database directly from the package.
                   7502: 
                   7503:  2. Ensure that the package installs its .schemas files under ${PREFIX}/share/
                   7504:     gconf/schemas. If they get installed under ${PREFIX}/etc, you will need to
                   7505:     manually patch the package.
                   7506: 
                   7507:  3. Check the PLIST and remove any entries under the etc/gconf directory, as
1.154     rillig   7508:     they will be handled automatically. See Section 10.13, "How do I change the
1.1       dsieger  7509:     location of configuration files?" for more information.
                   7510: 
1.7       rillig   7511:  4. Define the GCONF_SCHEMAS variable in your Makefile with a list of all
1.1       dsieger  7512:     .schemas files installed by the package, if any. Names must not contain any
                   7513:     directories in them.
                   7514: 
1.7       rillig   7515:  5. Define the GCONF_ENTRIES variable in your Makefile with a list of all
1.1       dsieger  7516:     .entries files installed by the package, if any. Names must not contain any
                   7517:     directories in them.
                   7518: 
1.154     rillig   7519: 21.6.10. Packages installing scrollkeeper/rarian data files
1.1       dsieger  7520: 
1.18      mishka   7521: If a package installs .omf files, used by scrollkeeper/rarian, you need to take
                   7522: some extra steps to make sure they get registered in the database:
1.1       dsieger  7523: 
1.18      mishka   7524:  1. Include ../../mk/omf-scrollkeeper.mk instead of rarian's buildlink3.mk
                   7525:     file. This takes care of rebuilding the scrollkeeper database at
                   7526:     installation and deinstallation time, and disallows any access to it
                   7527:     directly from the package.
1.1       dsieger  7528: 
                   7529:  2. Check the PLIST and remove any entries under the libdata/scrollkeeper
                   7530:     directory, as they will be handled automatically.
                   7531: 
                   7532:  3. Remove the share/omf directory from the PLIST. It will be handled by
1.18      mishka   7533:     rarian. (make print-PLIST does this automatically.)
1.1       dsieger  7534: 
1.154     rillig   7535: 21.6.11. Packages installing X11 fonts
1.1       dsieger  7536: 
                   7537: If a package installs font files, you will need to rebuild the fonts database
                   7538: in the directory where they get installed at installation and deinstallation
                   7539: time. This can be automatically done by using the pkginstall framework.
                   7540: 
                   7541: You can list the directories where fonts are installed in the FONTS_DIRS.type
                   7542: variables, where type can be one of "ttf", "type1" or "x11". Also make sure
                   7543: that the database file fonts.dir is not listed in the PLIST.
                   7544: 
                   7545: Note that you should not create new directories for fonts; instead use the
                   7546: standard ones to avoid that the user needs to manually configure his X server
                   7547: to find them.
                   7548: 
1.154     rillig   7549: 21.6.12. Packages installing GTK2 modules
1.1       dsieger  7550: 
                   7551: If a package installs GTK2 immodules or loaders, you need to take some extra
                   7552: steps to get them registered in the GTK2 database properly:
                   7553: 
                   7554:  1. Include ../../x11/gtk2/modules.mk instead of its buildlink3.mk file. This
                   7555:     takes care of rebuilding the database at installation and deinstallation
                   7556:     time.
                   7557: 
                   7558:  2. Set GTK2_IMMODULES=YES if your package installs GTK2 immodules.
                   7559: 
                   7560:  3. Set GTK2_LOADERS=YES if your package installs GTK2 loaders.
                   7561: 
                   7562:  4. Patch the package to not touch any of the GTK2 databases directly. These
                   7563:     are:
                   7564: 
1.42      asau     7565:       + libdata/gtk-2.0/gdk-pixbuf.loaders
1.1       dsieger  7566: 
1.42      asau     7567:       + libdata/gtk-2.0/gtk.immodules
1.1       dsieger  7568: 
                   7569:  5. Check the PLIST and remove any entries under the libdata/gtk-2.0 directory,
                   7570:     as they will be handled automatically.
                   7571: 
1.154     rillig   7572: 21.6.13. Packages installing SGML or XML data
1.1       dsieger  7573: 
                   7574: If a package installs SGML or XML data files that need to be registered in
                   7575: system-wide catalogs (like DTDs, sub-catalogs, etc.), you need to take some
                   7576: extra steps:
                   7577: 
                   7578:  1. Include ../../textproc/xmlcatmgr/catalogs.mk in your Makefile, which takes
                   7579:     care of registering those files in system-wide catalogs at installation and
                   7580:     deinstallation time.
                   7581: 
                   7582:  2. Set SGML_CATALOGS to the full path of any SGML catalogs installed by the
                   7583:     package.
                   7584: 
                   7585:  3. Set XML_CATALOGS to the full path of any XML catalogs installed by the
                   7586:     package.
                   7587: 
                   7588:  4. Set SGML_ENTRIES to individual entries to be added to the SGML catalog.
                   7589:     These come in groups of three strings; see xmlcatmgr(1) for more
                   7590:     information (specifically, arguments recognized by the 'add' action). Note
                   7591:     that you will normally not use this variable.
                   7592: 
                   7593:  5. Set XML_ENTRIES to individual entries to be added to the XML catalog. These
                   7594:     come in groups of three strings; see xmlcatmgr(1) for more information
                   7595:     (specifically, arguments recognized by the 'add' action). Note that you
                   7596:     will normally not use this variable.
                   7597: 
1.154     rillig   7598: 21.6.14. Packages installing extensions to the MIME database
1.1       dsieger  7599: 
                   7600: If a package provides extensions to the MIME database by installing .xml files
                   7601: inside ${PREFIX}/share/mime/packages, you need to take some extra steps to
                   7602: ensure that the database is kept consistent with respect to these new files:
                   7603: 
                   7604:  1. Include ../../databases/shared-mime-info/mimedb.mk (avoid using the
                   7605:     buildlink3.mk file from this same directory, which is reserved for
                   7606:     inclusion from other buildlink3.mk files). It takes care of rebuilding the
                   7607:     MIME database at installation and deinstallation time, and disallows any
                   7608:     access to it directly from the package.
                   7609: 
1.25      wiz      7610:  2. Check the PLIST and remove any entries under the share/mime directory, 
1.1       dsieger  7611:     except for files saved under share/mime/packages. The former are handled
                   7612:     automatically by the update-mime-database program, but the latter are
                   7613:     package-dependent and must be removed by the package that installed them in
                   7614:     the first place.
                   7615: 
                   7616:  3. Remove any share/mime/* directories from the PLIST. They will be handled by
                   7617:     the shared-mime-info package.
                   7618: 
1.154     rillig   7619: 21.6.15. Packages using intltool
1.1       dsieger  7620: 
                   7621: If a package uses intltool during its build, add intltool to the USE_TOOLS,
                   7622: which forces it to use the intltool package provided by pkgsrc, instead of the
                   7623: one bundled with the distribution file.
                   7624: 
                   7625: This tracks intltool's build-time dependencies and uses the latest available
                   7626: version; this way, the package benefits of any bug fixes that may have appeared
                   7627: since it was released.
                   7628: 
1.154     rillig   7629: 21.6.16. Packages installing startup scripts
1.1       dsieger  7630: 
                   7631: If a package contains a rc.d script, it won't be copied into the startup
                   7632: directory by default, but you can enable it, by adding the option
1.4       rillig   7633: PKG_RCD_SCRIPTS=YES in mk.conf. This option will copy the scripts into /etc/
                   7634: rc.d when a package is installed, and it will automatically remove the scripts
                   7635: when the package is deinstalled.
1.1       dsieger  7636: 
1.154     rillig   7637: 21.6.17. Packages installing TeX modules
1.1       dsieger  7638: 
                   7639: If a package installs TeX packages into the texmf tree, the ls-R database of
                   7640: the tree needs to be updated.
                   7641: 
                   7642: Note
                   7643: 
1.23      jakllsch 7644: Except the main TeX packages such as kpathsea, packages should install files
                   7645: into ${PREFIX}/share/texmf-dist, not ${PREFIX}/share/texmf.
1.1       dsieger  7646: 
1.23      jakllsch 7647:  1. Include ../../print/kpathsea/texmf.mk. This takes care of rebuilding the
                   7648:     ls-R database at installation and deinstallation time.
1.1       dsieger  7649: 
1.23      jakllsch 7650:  2. If your package installs files into a texmf tree other than the one at $
                   7651:     {PREFIX}/share/texmf-dist, set TEX_TEXMF_DIRS to the list of all texmf
                   7652:     trees that need database update.
1.1       dsieger  7653: 
                   7654:     If your package also installs font map files that need to be registered
1.30      dholland 7655:     using updmap, include ../../print/tex-tetex/map.mk and set TEX_MAP_FILES
                   7656:     and/or TEX_MIXEDMAP_FILES to the list of all such font map files. Then 
                   7657:     updmap will be run automatically at installation/deinstallation to enable/
                   7658:     disable font map files for TeX output drivers.
1.1       dsieger  7659: 
                   7660:  3. Make sure that none of ls-R databases are included in PLIST, as they will
1.30      dholland 7661:     be removed only by the kpathsea package.
1.1       dsieger  7662: 
1.154     rillig   7663: 21.6.18. Packages supporting running binaries in emulation
1.1       dsieger  7664: 
                   7665: There are some packages that provide libraries and executables for running
                   7666: binaries from a one operating system on a different one (if the latter supports
                   7667: it). One example is running Linux binaries on NetBSD.
                   7668: 
                   7669: The pkgtools/rpm2pkg helps in extracting and packaging Linux rpm packages.
                   7670: 
                   7671: The CHECK_SHLIBS can be set to no to avoid the check-shlibs target, which tests
                   7672: if all libraries for each installed executable can be found by the dynamic
                   7673: linker. Since the standard dynamic linker is run, this fails for emulation
                   7674: packages, because the libraries used by the emulation are not in the standard
                   7675: directories.
                   7676: 
1.154     rillig   7677: 21.6.19. Packages installing hicolor theme icons
1.1       dsieger  7678: 
                   7679: If a package installs images under the share/icons/hicolor and/or updates the
                   7680: share/icons/hicolor/icon-theme.cache database, you need to take some extra
                   7681: steps to make sure that the shared theme directory is handled appropriately and
                   7682: that the cache database is rebuilt:
                   7683: 
                   7684:  1. Include ../../graphics/hicolor-icon-theme/buildlink3.mk.
                   7685: 
                   7686:  2. Check the PLIST and remove the entry that refers to the theme cache.
                   7687: 
                   7688:  3. Ensure that the PLIST does not remove the shared icon directories from the
                   7689:     share/icons/hicolor hierarchy because they will be handled automatically.
                   7690: 
                   7691: The best way to verify that the PLIST is correct with respect to the last two
                   7692: points is to regenerate it using make print-PLIST.
                   7693: 
1.154     rillig   7694: 21.6.20. Packages installing desktop files
1.1       dsieger  7695: 
                   7696: If a package installs .desktop files under share/applications and these include
1.54      rodent   7697: MIME information (MimeType key), you need to take extra steps to ensure that
                   7698: they are registered into the MIME database:
1.1       dsieger  7699: 
                   7700:  1. Include ../../sysutils/desktop-file-utils/desktopdb.mk.
                   7701: 
                   7702:  2. Check the PLIST and remove the entry that refers to the share/applications/
                   7703:     mimeinfo.cache file. It will be handled automatically.
                   7704: 
                   7705: The best way to verify that the PLIST is correct with respect to the last point
                   7706: is to regenerate it using make print-PLIST.
                   7707: 
1.154     rillig   7708: 21.7. Marking packages as having problems
1.1       dsieger  7709: 
1.23      jakllsch 7710: In some cases one does not have the time to solve a problem immediately. In
                   7711: this case, one can plainly mark a package as broken. For this, one just sets
                   7712: the variable BROKEN to the reason why the package is broken (similar to the
1.162     rillig   7713: PKG_FAIL_REASON variable). A user trying to build the package will immediately
                   7714: be shown this message, and the build will not be even tried.
1.1       dsieger  7715: 
1.23      jakllsch 7716: BROKEN packages are removed from pkgsrc in irregular intervals.
1.1       dsieger  7717: 
1.184     rillig   7718: Chapter 22. GNOME packaging and porting
                   7719: 
                   7720: Table of Contents
                   7721: 
                   7722: 22.1. Meta packages
                   7723: 22.2. Packaging a GNOME application
                   7724: 22.3. Updating GNOME to a newer version
                   7725: 22.4. Patching guidelines
                   7726: 
                   7727: Quoting GNOME's web site:
                   7728: 
                   7729:     The GNOME project provides two things: The GNOME desktop environment, an
                   7730:     intuitive and attractive desktop for users, and the GNOME development
                   7731:     platform, an extensive framework for building applications that integrate
                   7732:     into the rest of the desktop.
                   7733: 
                   7734: pkgsrc provides a seamless way to automatically build and install a complete
                   7735: GNOME environment under many different platforms. We can say with confidence
                   7736: that pkgsrc is one of the most advanced build and packaging systems for GNOME
                   7737: due to its included technologies buildlink3, the wrappers and tools framework
                   7738: and automatic configuration file management. Lots of efforts are put into
                   7739: achieving a completely clean deinstallation of installed software components.
                   7740: 
                   7741: Given that pkgsrc is NetBSD's official packaging system, the above also means
                   7742: that great efforts are put into making GNOME work under this operating system.
                   7743: 
                   7744: This chapter is aimed at pkgsrc developers and other people interested in
                   7745: helping our GNOME porting and packaging efforts. It provides instructions on
                   7746: how to manage the existing packages and some important information regarding
                   7747: their internals.
                   7748: 
                   7749: We need your help!
                   7750: 
                   7751: Should you have some spare cycles to devote to NetBSD, pkgsrc and GNOME and are
                   7752: willing to learn new exciting stuff, please jump straight to the pending work
                   7753: list! There is still a long way to go to get a fully-functional GNOME desktop
                   7754: under NetBSD and we need your help to achieve it!
                   7755: 
                   7756: 22.1. Meta packages
                   7757: 
                   7758: pkgsrc includes three GNOME-related meta packages:
                   7759: 
                   7760:   * meta-pkgs/gnome-base: Provides the core GNOME desktop environment. It only
                   7761:     includes the necessary bits to get it to boot correctly, although it may
                   7762:     lack important functionality for daily operation. The idea behind this
                   7763:     package is to let end users build their own configurations on top of this
                   7764:     one, first installing this meta package to achieve a functional setup and
                   7765:     then adding individual applications.
                   7766: 
                   7767:   * meta-pkgs/gnome: Provides a complete installation of the GNOME platform and
                   7768:     desktop as defined by the GNOME project; this is based on the components
                   7769:     distributed in the platform/x.y/x.y.z/sources and desktop/x.y/x.y.z/sources
                   7770:     directories of the official FTP server. Developer-only tools found in those
                   7771:     directories are not installed unless required by some other component to
                   7772:     work properly. Similarly, packages from the bindings set (bindings/x.y/
                   7773:     x.y.z/sources) are not pulled in unless required as a dependency for an
                   7774:     end-user component. This package "extends" meta-pkgs/gnome-base.
                   7775: 
                   7776:   * meta-pkgs/gnome-devel: Installs all the tools required to build a GNOME
                   7777:     component when fetched from the CVS repository. These are required to let
                   7778:     the autogen.sh scripts work appropriately.
                   7779: 
                   7780: In all these packages, the DEPENDS lines are sorted in a way that eases
                   7781: updates: a package may depend on other packages listed before it but not on any
                   7782: listed after it. It is very important to keep this order to ease updates so... 
                   7783: do not change it to alphabetical sorting!
                   7784: 
                   7785: 22.2. Packaging a GNOME application
                   7786: 
                   7787: Almost all GNOME applications are written in C and use a common set of tools as
                   7788: their build system. Things get different with the new bindings to other
                   7789: languages (such as Python), but the following will give you a general idea on
                   7790: the minimum required tools:
                   7791: 
                   7792:   * Almost all GNOME applications use the GNU Autotools as their build system.
                   7793:     As a general rule you will need to tell this to your package:
                   7794: 
                   7795:     GNU_CONFIGURE=yes
                   7796:     USE_LIBTOOL=yes
                   7797:     USE_TOOLS+=gmake
                   7798: 
                   7799:   * If the package uses pkg-config to detect dependencies, add this tool to the
                   7800:     list of required utilities:
                   7801: 
                   7802:     USE_TOOLS+=pkg-config
                   7803: 
                   7804:     Also use pkgtools/verifypc at the end of the build process to ensure that
                   7805:     you did not miss to specify any dependency in your package and that the
                   7806:     version requirements are all correct.
                   7807: 
                   7808:   * If the package uses intltool, be sure to add intltool to the USE_TOOLS to
                   7809:     handle dependencies and to force the package to use the latest available
                   7810:     version.
                   7811: 
                   7812:   * If the package uses gtk-doc (a documentation generation utility), do not
                   7813:     add a dependency on it. The tool is rather big and the distfile should come
                   7814:     with pregenerated documentation anyway; if it does not, it is a bug that
                   7815:     you ought to report. For such packages you should disable gtk-doc (unless
                   7816:     it is the default):
                   7817: 
                   7818:     CONFIGURE_ARGS+=--disable-gtk-doc
                   7819: 
                   7820:     The default location of installed HTML files (share/gtk-doc/<package-name>)
                   7821:     is correct and should not be changed unless the package insists on
                   7822:     installing them somewhere else. Otherwise programs as devhelp will not be
                   7823:     able to open them. You can do that with an entry similar to:
1.1       dsieger  7824: 
1.184     rillig   7825:     CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
1.1       dsieger  7826: 
1.184     rillig   7827: GNOME uses multiple shared directories and files under the installation prefix
                   7828: to maintain databases. In this context, shared means that those exact same
                   7829: directories and files are used among several different packages, leading to
                   7830: conflicts in the PLIST. pkgsrc currently includes functionality to handle the
                   7831: most common cases, so you have to forget about using @unexec ${RMDIR} lines in
                   7832: your file lists and omitting shared files from them. If you find yourself doing
                   7833: those, your package is most likely incorrect.
1.1       dsieger  7834: 
1.184     rillig   7835: The following table lists the common situations that result in using shared
                   7836: directories or files. For each of them, the appropriate solution is given.
                   7837: After applying the solution be sure to regenerate the package's file list with 
                   7838: make print-PLIST and ensure it is correct.
1.1       dsieger  7839: 
1.184     rillig   7840: Table 22.1. PLIST handling for GNOME packages
1.1       dsieger  7841: 
1.184     rillig   7842: +-----------------------------------------------------------------------------+
                   7843: |             If the package...             |             Then...             |
                   7844: |-------------------------------------------+---------------------------------|
                   7845: |                                           |See Section 21.6.10, "Packages   |
                   7846: |Installs OMF files under share/omf.        |installing scrollkeeper/rarian   |
                   7847: |                                           |data files".                     |
                   7848: |-------------------------------------------+---------------------------------|
                   7849: |Installs icons under the share/icons/      |See Section 21.6.19, "Packages   |
                   7850: |hicolor hierarchy or updates share/icons/  |installing hicolor theme icons". |
                   7851: |hicolor/icon-theme.cache.                  |                                 |
                   7852: |-------------------------------------------+---------------------------------|
                   7853: |                                           |See Section 21.6.14, "Packages   |
                   7854: |Installs files under share/mime/packages.  |installing extensions to the MIME|
                   7855: |                                           |database".                       |
                   7856: |-------------------------------------------+---------------------------------|
                   7857: |Installs .desktop files under share/       |See Section 21.6.20, "Packages   |
                   7858: |applications and these include MIME        |installing desktop files".       |
                   7859: |information.                               |                                 |
                   7860: +-----------------------------------------------------------------------------+
1.1       dsieger  7861: 
                   7862: 
1.184     rillig   7863: 22.3. Updating GNOME to a newer version
1.1       dsieger  7864: 
1.184     rillig   7865: When seeing GNOME as a whole, there are two kinds of updates:
1.1       dsieger  7866: 
1.184     rillig   7867: Major update
1.1       dsieger  7868: 
1.184     rillig   7869:     Given that there is still a very long way for GNOME 3 (if it ever appears),
                   7870:     we consider a major update one that goes from a 2.X version to a 2.Y one,
                   7871:     where Y is even and greater than X. These are hard to achieve because they
                   7872:     introduce lots of changes in the components' code and almost all GNOME
                   7873:     distfiles are updated to newer versions. Some of them can even break API
                   7874:     and ABI compatibility with the previous major version series. As a result,
                   7875:     the update needs to be done all at once to minimize breakage.
1.1       dsieger  7876: 
1.184     rillig   7877:     A major update typically consists of around 80 package updates and the
                   7878:     addition of some new ones.
1.1       dsieger  7879: 
1.184     rillig   7880: Minor update
1.1       dsieger  7881: 
1.184     rillig   7882:     We consider a minor update one that goes from a 2.A.X version to a 2.A.Y
                   7883:     one where Y is greater than X. These are easy to achieve because they do
                   7884:     not update all GNOME components, can be done in an incremental way and do
                   7885:     not break API nor ABI compatibility.
1.1       dsieger  7886: 
1.184     rillig   7887:     A minor update typically consists of around 50 package updates, although
                   7888:     the numbers here may vary a lot.
1.1       dsieger  7889: 
1.184     rillig   7890: In order to update the GNOME components in pkgsrc to a new stable release
                   7891: (either major or minor), the following steps should be followed:
1.1       dsieger  7892: 
1.184     rillig   7893:  1. Get a list of all the tarballs that form the new release by using the
                   7894:     following commands. These will leave the full list of the components'
                   7895:     distfiles into the list.txt file:
1.1       dsieger  7896: 
1.184     rillig   7897:     % echo ls "*.tar.bz2" | \
                   7898:         ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   7899:         awk '{ print $9 }' >list.txt
                   7900:     % echo ls "*.tar.bz2" | \
                   7901:         ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   7902:         awk '{ print $9 }' >>list.txt
1.1       dsieger  7903: 
1.184     rillig   7904:  2. Open each meta package's Makefile and bump their version to the release you
                   7905:     are updating them to. The three meta packages should be always consistent
                   7906:     with versioning. Obviously remove any PKGREVISIONs that might be in them.
1.1       dsieger  7907: 
1.184     rillig   7908:  3. For each meta package, update all its DEPENDS lines to match the latest
                   7909:     versions as shown by the above commands. Do not list any newer version
                   7910:     (even if found in the FTP) because the meta packages are supposed to list
                   7911:     the exact versions that form a specific GNOME release. Exceptions are
                   7912:     permitted here if a newer version solves a serious issue in the overall
                   7913:     desktop experience; these typically come in the form of a revision bump in
                   7914:     pkgsrc, not in newer versions from the developers.
1.1       dsieger  7915: 
1.184     rillig   7916:     Packages not listed in the list.txt file should be updated to the latest
                   7917:     version available (if found in pkgsrc). This is the case, for example, of
                   7918:     the dependencies on the GNU Autotools in the meta-pkgs/gnome-devel meta
                   7919:     package.
1.1       dsieger  7920: 
1.184     rillig   7921:  4. Generate a patch from the modified meta packages and extract the list of
                   7922:     "new" lines. This will provide you an outline on what packages need to be
                   7923:     updated in pkgsrc and in what order:
1.1       dsieger  7924: 
1.184     rillig   7925:     % cvs diff -u gnome-devel gnome-base gnome | grep '^+D' >todo.txt
1.1       dsieger  7926: 
1.184     rillig   7927:  5. For major desktop updates it is recommended to zap all your installed
                   7928:     packages and start over from scratch at this point.
1.1       dsieger  7929: 
1.184     rillig   7930:  6. Now comes the longest step by far: iterate over the contents of todo.txt
                   7931:     and update the packages listed in it in order. For major desktop updates
                   7932:     none of these should be committed until the entire set is completed because
                   7933:     there are chances of breaking not-yet-updated packages.
1.1       dsieger  7934: 
1.184     rillig   7935:  7. Once the packages are up to date and working, commit them to the tree one
                   7936:     by one with appropriate log messages. At the end, commit the three meta
                   7937:     package updates and all the corresponding changes to the doc/CHANGES-<YEAR>
                   7938:     and pkgsrc/doc/TODO files.
1.1       dsieger  7939: 
1.184     rillig   7940: 22.4. Patching guidelines
1.1       dsieger  7941: 
1.184     rillig   7942: GNOME is a very big component in pkgsrc which approaches 100 packages. Please,
                   7943: it is very important that you always, always, always feed back any portability
                   7944: fixes you do to a GNOME package to the mainstream developers (see
                   7945: Section 12.3.5, "Feedback to the author"). This is the only way to get their
                   7946: attention on portability issues and to ensure that future versions can be built
                   7947: out-of-the box on NetBSD. The less custom patches in pkgsrc, the easier further
                   7948: updates are. Those developers in charge of issuing major GNOME updates will be
                   7949: grateful if you do that.
1.1       dsieger  7950: 
1.200     cirnatda 7951: The most common places to report bugs are the GNOME's GitLab and the
                   7952: freedesktop.org's GitLab. Not all components use these to track bugs, but most
                   7953: of them do. Do not be short on your reports: always provide detailed
1.184     rillig   7954: explanations of the current failure, how it can be improved to achieve maximum
1.200     cirnatda 7955: portability and, if at all possible, provide a patch against the main Git
                   7956: branch. The more verbose you are, the higher chances of your patch being
                   7957: accepted.
1.1       dsieger  7958: 
1.184     rillig   7959: Also, please avoid using preprocessor magic to fix portability issues. While
                   7960: the FreeBSD GNOME people are doing a great job in porting GNOME to their
                   7961: operating system, the official GNOME sources are now plagued by conditionals
                   7962: that check for __FreeBSD__ and similar macros. This hurts portability. Please
                   7963: see our patching guidelines (Section 12.3.4, "Patching guidelines") for more
                   7964: details.
1.1       dsieger  7965: 
1.154     rillig   7966: Chapter 23. Submitting and Committing
1.1       dsieger  7967: 
                   7968: Table of Contents
                   7969: 
1.154     rillig   7970: 23.1. Submitting binary packages
                   7971: 23.2. Submitting source packages (for non-NetBSD-developers)
                   7972: 23.3. General notes when adding, updating, or removing packages
                   7973: 23.4. Commit Messages
                   7974: 23.5. Committing: Adding a package to CVS
                   7975: 23.6. Updating a package to a newer version
                   7976: 23.7. Renaming a package in pkgsrc
                   7977: 23.8. Moving a package in pkgsrc
1.1       dsieger  7978: 
1.154     rillig   7979: 23.1. Submitting binary packages
1.1       dsieger  7980: 
                   7981: Our policy is that we accept binaries only from pkgsrc developers to guarantee
                   7982: that the packages don't contain any trojan horses etc. This is not to annoy
                   7983: anyone but rather to protect our users! You're still free to put up your
                   7984: home-made binary packages and tell the world where to get them. NetBSD
1.154     rillig   7985: developers doing bulk builds and wanting to upload them please see Chapter 8, 
1.66      asau     7986: Creating binary packages for everything in pkgsrc (bulk builds).
1.1       dsieger  7987: 
1.154     rillig   7988: 23.2. Submitting source packages (for non-NetBSD-developers)
1.1       dsieger  7989: 
                   7990: First, check that your package is complete, compiles and runs well; see
1.184     rillig   7991: Chapter 14, Creating a new pkgsrc package from scratch and the rest of this
                   7992: document. Next, generate an uuencoded gzipped tar(1) archive that contains all
                   7993: files that make up the package. Finally, send this package to the pkgsrc bug
                   7994: tracking system, either with the send-pr(1) command, or if you don't have that,
                   7995: go to the web page https://www.NetBSD.org/support/send-pr.html, which contains
                   7996: some instructions and a link to a form where you can submit packages. The
                   7997: sysutils/gtk-send-pr package is also available as a substitute for either of
                   7998: the above two tools.
1.1       dsieger  7999: 
                   8000: In the form of the problem report, the category should be "pkg", the synopsis
                   8001: should include the package name and version number, and the description field
                   8002: should contain a short description of your package (contents of the COMMENT
1.25      wiz      8003: variable or DESCR file are OK). The uuencoded package data should go into the "
                   8004: fix" field.
1.1       dsieger  8005: 
                   8006: If you want to submit several packages, please send a separate PR for each one,
                   8007: it's easier for us to track things that way.
                   8008: 
                   8009: Alternatively, you can also import new packages into pkgsrc-wip ("pkgsrc
1.174     leot     8010: work-in-progress"); see the homepage at https://pkgsrc.org/wip/ for details.
1.1       dsieger  8011: 
1.154     rillig   8012: 23.3. General notes when adding, updating, or removing packages
1.1       dsieger  8013: 
                   8014: Please note all package additions, updates, moves, and removals in pkgsrc/doc/
                   8015: CHANGES-YYYY. It's very important to keep this file up to date and conforming
                   8016: to the existing format, because it will be used by scripts to automatically
                   8017: update pages on www.NetBSD.org and other sites. Additionally, check the pkgsrc/
                   8018: doc/TODO file and remove the entry for the package you updated or removed, in
                   8019: case it was mentioned there.
                   8020: 
                   8021: When the PKGREVISION of a package is bumped, the change should appear in pkgsrc
                   8022: /doc/CHANGES-YYYY if it is security related or otherwise relevant. Mass bumps
                   8023: that result from a dependency being updated should not be mentioned. In all
                   8024: other cases it's the developer's decision.
                   8025: 
                   8026: There is a make target that helps in creating proper CHANGES-YYYY entries: make
                   8027: changes-entry. It uses the optional CTYPE and NETBSD_LOGIN_NAME variables. The
                   8028: general usage is to first make sure that your CHANGES-YYYY file is up-to-date
                   8029: (to avoid having to resolve conflicts later-on) and then to cd to the package
                   8030: directory. For package updates, make changes-entry is enough. For new packages,
                   8031: or package moves or removals, set the CTYPE variable on the command line to
1.4       rillig   8032: "Added", "Moved", or "Removed". You can set NETBSD_LOGIN_NAME in mk.conf if
1.23      jakllsch 8033: your local login name is not the same as your NetBSD login name. The target
                   8034: also automatically removes possibly existing entries for the package in the
                   8035: TODO file. Don't forget to commit the changes, e.g. by using make
1.66      asau     8036: commit-changes-entry! If you are not using a checkout directly from
1.23      jakllsch 8037: cvs.NetBSD.org, but e.g. a local copy of the repository, you can set
                   8038: USE_NETBSD_REPO=yes. This makes the cvs commands use the main repository.
1.1       dsieger  8039: 
1.154     rillig   8040: 23.4. Commit Messages
1.130     wiz      8041: 
                   8042: For several years, there have been mirrors of pkgsrc in fossil, git, and hg.
                   8043: Standard practise when using these tools is to make the first line of a commit
                   8044: message function as a summary that can be read without the rest, such as is
                   8045: commonly done with "git log --oneline". For this reason, we have the following
                   8046: guidelines for pkgsrc commit messages:
                   8047: 
1.131     wiz      8048:   * Start the commit message with a line that explains the big picture in 65
1.130     wiz      8049:     characters or less. When a commit is for one package, include the name of
                   8050:     the package. For updates, include the version to which it is updated.
                   8051: 
                   8052:   * Leave the next line empty.
                   8053: 
                   8054:   * Then come the details for the commit (changes in that package, reason for a
                   8055:     change) and any relevant PRs. Wrap this section.
                   8056: 
                   8057: Here is an example:
                   8058: 
                   8059:   libxslt: update to 1.0.30
                   8060: 
                   8061:   Changes since 1.0.29:
                   8062:   ...
                   8063: 
                   8064: 
                   8065: Here is another example:
                   8066: 
                   8067:   mk/bsd.pkg.mk: enable SSP by default on NetBSD
                   8068: 
                   8069:   (rationale)
                   8070: 
                   8071: 
                   8072: Commit messages are final: no "cvs admin" is allowed on the pkgsrc repository
                   8073: to change commit messages.
                   8074: 
1.154     rillig   8075: 23.5. Committing: Adding a package to CVS
1.1       dsieger  8076: 
                   8077: This section is only of interest for pkgsrc developers with write access to the
1.34      wiz      8078: pkgsrc repository.
                   8079: 
                   8080: When the package is finished, "cvs add" the files. Start by adding the
                   8081: directory and then files in the directory. Don't forget to add the new package
                   8082: to the category's Makefile. Make sure you don't forget any files; you can check
                   8083: by running "cvs status". An example:
                   8084: 
                   8085: $ cd .../pkgsrc/category
                   8086: $ cvs add pkgname
                   8087: $ cd pkgname
                   8088: $ cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
                   8089: $ cvs add patches/p*
                   8090: $ cvs status | less
1.35      wiz      8091: $ cvs commit
1.34      wiz      8092: $ cd ..
                   8093: $ vi Makefile # add SUBDIRS+=pkgname line
1.35      wiz      8094: $ cvs commit Makefile
1.66      asau     8095: $ cd pkgname
1.73      jnemeth  8096: $ make CTYPE=Added commit-changes-entry
1.1       dsieger  8097: 
                   8098: The commit message of the initial import should include part of the DESCR file,
                   8099: so people reading the mailing lists know what the package is/does.
                   8100: 
1.34      wiz      8101: Also mention the new package in pkgsrc/doc/CHANGES-20xx.
                   8102: 
                   8103: Previously, "cvs import" was suggested, but it was much easier to get wrong
                   8104: than "cvs add".
1.1       dsieger  8105: 
1.154     rillig   8106: 23.6. Updating a package to a newer version
1.1       dsieger  8107: 
                   8108: Please always put a concise, appropriate and relevant summary of the changes
                   8109: between old and new versions into the commit log when updating a package. There
                   8110: are various reasons for this:
                   8111: 
                   8112:   * A URL is volatile, and can change over time. It may go away completely or
                   8113:     its information may be overwritten by newer information.
                   8114: 
                   8115:   * Having the change information between old and new versions in our CVS
                   8116:     repository is very useful for people who use either cvs or anoncvs.
                   8117: 
                   8118:   * Having the change information between old and new versions in our CVS
                   8119:     repository is very useful for people who read the pkgsrc-changes mailing
                   8120:     list, so that they can make tactical decisions about when to upgrade the
                   8121:     package.
                   8122: 
                   8123: Please also recognize that, just because a new version of a package has been
                   8124: released, it should not automatically be upgraded in the CVS repository. We
                   8125: prefer to be conservative in the packages that are included in pkgsrc -
                   8126: development or beta packages are not really the best thing for most places in
                   8127: which pkgsrc is used. Please use your judgement about what should go into
                   8128: pkgsrc, and bear in mind that stability is to be preferred above new and
                   8129: possibly untested features.
                   8130: 
1.154     rillig   8131: 23.7. Renaming a package in pkgsrc
1.21      snj      8132: 
                   8133: Renaming packages is not recommended.
                   8134: 
1.175     gutterid 8135: When renaming packages, be sure to fix any references to the old name in other
1.21      snj      8136: Makefiles, options, buildlink files, etc.
                   8137: 
1.175     gutterid 8138: Also, when renaming a package, please add the package name and version pattern
1.167     leot     8139: (s) of the previous package to SUPERSEDES. This may be repeated for multiple
                   8140: renames. The new package would be an exact replacement. Example:
                   8141: 
                   8142: SUPERSEDES+=    p5-IO-Compress-Zlib<2.017
                   8143: SUPERSEDES+=    optcomp-[0-9]*
1.21      snj      8144: 
                   8145: Note that "successor" in the CHANGES-YYYY file doesn't necessarily mean that it
                   8146: supersedes, as that successor may not be an exact replacement but is a
                   8147: suggestion for the replaced functionality.
                   8148: 
1.154     rillig   8149: 23.8. Moving a package in pkgsrc
1.21      snj      8150: 
                   8151: It is preferred that packages are not renamed or moved, but if needed please
                   8152: follow these steps.
1.1       dsieger  8153: 
                   8154:  1. Make a copy of the directory somewhere else.
                   8155: 
                   8156:  2. Remove all CVS dirs.
                   8157: 
                   8158:     Alternatively to the first two steps you can also do:
                   8159: 
                   8160:     % cvs -d user@cvs.NetBSD.org:/cvsroot export -D today pkgsrc/category/package
                   8161: 
                   8162:     and use that for further work.
                   8163: 
1.25      wiz      8164:  3. Fix CATEGORIES and any DEPENDS paths that just did "../package" instead of 
1.1       dsieger  8165:     "../../category/package".
                   8166: 
1.21      snj      8167:  4. In the modified package's Makefile, consider setting PREV_PKGPATH to the
                   8168:     previous category/package pathname. The PREV_PKGPATH can be used by tools
                   8169:     for doing an update using pkgsrc building; for example, it can search the
                   8170:     pkg_summary(5) database for PREV_PKGPATH (if no SUPERSEDES) and then use
                   8171:     the corresponding new PKGPATH for that moved package. Note that it may have
                   8172:     multiple matches, so the tool should also check on the PKGBASE too. The
                   8173:     PREV_PKGPATH probably has no value unless SUPERSEDES is not set, i.e.
                   8174:     PKGBASE stays the same.
                   8175: 
                   8176:  5. cvs import the modified package in the new place.
1.1       dsieger  8177: 
1.21      snj      8178:  6. Check if any package depends on it:
1.1       dsieger  8179: 
                   8180:     % cd /usr/pkgsrc
                   8181:     % grep /package */*/Makefile* */*/buildlink*
                   8182: 
1.21      snj      8183:  7. Fix paths in packages from step 5 to point to new location.
1.1       dsieger  8184: 
1.21      snj      8185:  8. cvs rm (-f) the package at the old location.
1.1       dsieger  8186: 
1.21      snj      8187:  9. Remove from oldcategory/Makefile.
1.1       dsieger  8188: 
1.21      snj      8189: 10. Add to newcategory/Makefile.
1.1       dsieger  8190: 
1.21      snj      8191: 11. Commit the changed and removed files:
1.1       dsieger  8192: 
                   8193:     % cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile
                   8194: 
                   8195:     (and any packages from step 5, of course).
                   8196: 
1.154     rillig   8197: Chapter 24. Frequently Asked Questions
1.1       dsieger  8198: 
                   8199: This section contains the answers to questions that may arise when you are
                   8200: writing a package. If you don't find your question answered here, first have a
                   8201: look in the other chapters, and if you still don't have the answer, ask on the
                   8202: pkgsrc-users mailing list.
                   8203: 
1.154     rillig   8204: 24.1. What is the difference between MAKEFLAGS, .MAKEFLAGS and MAKE_FLAGS?
                   8205: 24.2. What is the difference between MAKE, GMAKE and MAKE_PROGRAM?
                   8206: 24.3. What is the difference between CC, PKG_CC and PKGSRC_COMPILER?
                   8207: 24.4. What is the difference between BUILDLINK_LDFLAGS, BUILDLINK_LDADD and
1.1       dsieger  8208:     BUILDLINK_LIBS?
1.154     rillig   8209: 24.5. Why does make show-var VARNAME=BUILDLINK_PREFIX.foo say it's empty?
                   8210: 24.6. What does ${MASTER_SITE_SOURCEFORGE:=package/} mean? I don't understand
1.1       dsieger  8211:     the := inside it.
1.154     rillig   8212: 24.7. Which mailing lists are there for package developers?
                   8213: 24.8. Where is the pkgsrc documentation?
                   8214: 24.9. I have a little time to kill. What shall I do?
1.1       dsieger  8215: 
1.154     rillig   8216: 24.1. What is the difference between MAKEFLAGS, .MAKEFLAGS and MAKE_FLAGS?
1.1       dsieger  8217: 
                   8218:       MAKEFLAGS are the flags passed to the pkgsrc-internal invocations of make
                   8219:       (1), while MAKE_FLAGS are the flags that are passed to the MAKE_PROGRAM
                   8220:       when building the package. [FIXME: What is .MAKEFLAGS for?]
                   8221: 
1.154     rillig   8222: 24.2. What is the difference between MAKE, GMAKE and MAKE_PROGRAM?
1.1       dsieger  8223: 
                   8224:       MAKE is the path to the make(1) program that is used in the pkgsrc
                   8225:       infrastructure. GMAKE is the path to GNU Make, but you need to say
                   8226:       USE_TOOLS+=gmake to use that. MAKE_PROGRAM is the path to the Make
                   8227:       program that is used for building the package.
                   8228: 
1.154     rillig   8229: 24.3. What is the difference between CC, PKG_CC and PKGSRC_COMPILER?
1.1       dsieger  8230: 
                   8231:       CC is the path to the real C compiler, which can be configured by the
                   8232:       pkgsrc user. PKG_CC is the path to the compiler wrapper. PKGSRC_COMPILER
                   8233:       is not a path to a compiler, but the type of compiler that should be
                   8234:       used. See mk/compiler.mk for more information about the latter variable.
                   8235: 
1.154     rillig   8236: 24.4. What is the difference between BUILDLINK_LDFLAGS, BUILDLINK_LDADD and
1.1       dsieger  8237:       BUILDLINK_LIBS?
                   8238: 
                   8239:       [FIXME]
                   8240: 
1.154     rillig   8241: 24.5. Why does make show-var VARNAME=BUILDLINK_PREFIX.foo say it's empty?
1.1       dsieger  8242: 
1.25      wiz      8243:       For optimization reasons, some variables are only available in the "
                   8244:       wrapper" phase and later. To "simulate" the wrapper phase, append 
1.1       dsieger  8245:       PKG_PHASE=wrapper to the above command.
                   8246: 
1.154     rillig   8247: 24.6. What does ${MASTER_SITE_SOURCEFORGE:=package/} mean? I don't understand
1.1       dsieger  8248:       the := inside it.
                   8249: 
1.108     rillig   8250:       The := is not really an assignment operator, although it looks like it.
                   8251:       Instead, it is a degenerate form of ${LIST:old_string=new_string}, which
                   8252:       is documented in the make(1) man page and which is commonly used in the
                   8253:       form ${SRCS:.c=.o}. In the case of MASTER_SITE_*, old_string is the empty
                   8254:       string and new_string is package/. That's where the : and the = fall
                   8255:       together.
1.1       dsieger  8256: 
1.154     rillig   8257: 24.7. Which mailing lists are there for package developers?
1.1       dsieger  8258: 
                   8259:       tech-pkg
                   8260: 
                   8261:           This is a list for technical discussions related to pkgsrc
                   8262:           development, e.g. soliciting feedback for changes to pkgsrc
                   8263:           infrastructure, proposed new features, questions related to porting
                   8264:           pkgsrc to a new platform, advice for maintaining a package, patches
                   8265:           that affect many packages, help requests moved from pkgsrc-users when
                   8266:           an infrastructure bug is found, etc.
                   8267: 
                   8268:       pkgsrc-bugs
                   8269: 
                   8270:           All bug reports in category "pkg" sent with send-pr(1) appear here.
                   8271:           Please do not report your bugs here directly; use one of the other
                   8272:           mailing lists.
                   8273: 
1.154     rillig   8274: 24.8. Where is the pkgsrc documentation?
1.1       dsieger  8275: 
                   8276:       There are many places where you can find documentation about pkgsrc:
                   8277: 
                   8278:         * The pkgsrc guide (this document) is a collection of chapters that
                   8279:           explain large parts of pkgsrc, but some chapters tend to be outdated.
                   8280:           Which ones they are is hard to say.
                   8281: 
1.174     leot     8282:         * On the mailing list archives (see https://mail-index.NetBSD.org/),
                   8283:           you can find discussions about certain features, announcements of new
1.1       dsieger  8284:           parts of the pkgsrc infrastructure and sometimes even announcements
                   8285:           that a certain feature has been marked as obsolete. The benefit here
                   8286:           is that each message has a date appended to it.
                   8287: 
                   8288:         * Many of the files in the mk/ directory start with a comment that
                   8289:           describes the purpose of the file and how it can be used by the
                   8290:           pkgsrc user and package authors. An easy way to find this
                   8291:           documentation is to run bmake help.
                   8292: 
                   8293:         * The CVS log messages are a rich source of information, but they tend
                   8294:           to be highly abbreviated, especially for actions that occur often.
                   8295:           Some contain a detailed description of what has changed, but they are
                   8296:           geared towards the other pkgsrc developers, not towards an average
                   8297:           pkgsrc user. They also only document changes, so if you don't know
                   8298:           what has been before, these messages may not be worth too much to
                   8299:           you.
                   8300: 
                   8301:         * Some parts of pkgsrc are only "implicitly documented", that is the
                   8302:           documentation exists only in the mind of the developer who wrote the
                   8303:           code. To get this information, use the cvs annotate command to see
                   8304:           who has written it and ask on the tech-pkg mailing list, so that
                   8305:           others can find your questions later (see above). To be sure that the
                   8306:           developer in charge reads the mail, you may CC him or her.
                   8307: 
1.154     rillig   8308: 24.9. I have a little time to kill. What shall I do?
1.1       dsieger  8309: 
                   8310:       This is not really an FAQ yet, but here's the answer anyway.
                   8311: 
                   8312:         * Run pkg_chk -N (from the pkgtools/pkg_chk package). It will tell you
                   8313:           about newer versions of installed packages that are available, but
                   8314:           not yet updated in pkgsrc.
                   8315: 
1.198     leot     8316:         * Browse pkgsrc/doc/TODO -- it contains a list of suggested new
                   8317:           packages and a list of cleanups and enhancements for pkgsrc that
                   8318:           would be nice to have.
1.1       dsieger  8319: 
1.71      wiz      8320:         * Review packages for which review was requested on the tech-pkg
                   8321:           mailing list.
1.1       dsieger  8322: 
                   8323: Part III. The pkgsrc infrastructure internals
                   8324: 
                   8325: This part of the guide deals with everything from the infrastructure that is
                   8326: behind the interfaces described in the developer's guide. A casual package
                   8327: maintainer should not need anything from this part.
                   8328: 
                   8329: Table of Contents
                   8330: 
1.184     rillig   8331: 25. Design of the pkgsrc infrastructure
1.1       dsieger  8332: 
1.184     rillig   8333:     25.1. The meaning of variable definitions
                   8334:     25.2. Avoiding problems before they arise
                   8335:     25.3. Variable evaluation
1.1       dsieger  8336: 
1.184     rillig   8337:         25.3.1. At load time
                   8338:         25.3.2. At runtime
1.1       dsieger  8339: 
1.184     rillig   8340:     25.4. How can variables be specified?
                   8341:     25.5. Designing interfaces for Makefile fragments
1.1       dsieger  8342: 
1.184     rillig   8343:         25.5.1. Procedures with parameters
                   8344:         25.5.2. Actions taken on behalf of parameters
1.1       dsieger  8345: 
1.184     rillig   8346:     25.6. The order in which files are loaded
1.1       dsieger  8347: 
1.184     rillig   8348:         25.6.1. The order in bsd.prefs.mk
                   8349:         25.6.2. The order in bsd.pkg.mk
1.1       dsieger  8350: 
1.184     rillig   8351: 26. Regression tests
1.1       dsieger  8352: 
1.184     rillig   8353:     26.1. Running the regression tests
                   8354:     26.2. Adding a new regression test
1.1       dsieger  8355: 
1.184     rillig   8356:         26.2.1. Overridable functions
                   8357:         26.2.2. Helper functions
1.1       dsieger  8358: 
1.184     rillig   8359: 27. Porting pkgsrc
1.1       dsieger  8360: 
1.184     rillig   8361:     27.1. Porting pkgsrc to a new operating system
1.1       dsieger  8362: 
1.184     rillig   8363: Chapter 25. Design of the pkgsrc infrastructure
1.1       dsieger  8364: 
                   8365: Table of Contents
                   8366: 
1.184     rillig   8367: 25.1. The meaning of variable definitions
                   8368: 25.2. Avoiding problems before they arise
                   8369: 25.3. Variable evaluation
1.1       dsieger  8370: 
1.184     rillig   8371:     25.3.1. At load time
                   8372:     25.3.2. At runtime
1.1       dsieger  8373: 
1.184     rillig   8374: 25.4. How can variables be specified?
                   8375: 25.5. Designing interfaces for Makefile fragments
1.1       dsieger  8376: 
1.184     rillig   8377:     25.5.1. Procedures with parameters
                   8378:     25.5.2. Actions taken on behalf of parameters
1.1       dsieger  8379: 
1.184     rillig   8380: 25.6. The order in which files are loaded
1.1       dsieger  8381: 
1.184     rillig   8382:     25.6.1. The order in bsd.prefs.mk
                   8383:     25.6.2. The order in bsd.pkg.mk
1.1       dsieger  8384: 
                   8385: The pkgsrc infrastructure consists of many small Makefile fragments. Each such
                   8386: fragment needs a properly specified interface. This chapter explains how such
                   8387: an interface looks like.
                   8388: 
1.184     rillig   8389: 25.1. The meaning of variable definitions
1.1       dsieger  8390: 
                   8391: Whenever a variable is defined in the pkgsrc infrastructure, the location and
                   8392: the way of definition provide much information about the intended use of that
                   8393: variable. Additionally, more documentation may be found in a header comment or
                   8394: in this pkgsrc guide.
                   8395: 
                   8396: A special file is mk/defaults/mk.conf, which lists all variables that are
                   8397: intended to be user-defined. They are either defined using the ?= operator or
                   8398: they are left undefined because defining them to anything would effectively
                   8399: mean "yes". All these variables may be overridden by the pkgsrc user in the
                   8400: MAKECONF file.
                   8401: 
                   8402: Outside this file, the following conventions apply: Variables that are defined
                   8403: using the ?= operator may be overridden by a package.
                   8404: 
                   8405: Variables that are defined using the = operator may be used read-only at
                   8406: run-time.
                   8407: 
                   8408: Variables whose name starts with an underscore must not be accessed outside the
                   8409: pkgsrc infrastructure at all. They may change without further notice.
                   8410: 
                   8411: Note
                   8412: 
                   8413: These conventions are currently not applied consistently to the complete pkgsrc
                   8414: infrastructure.
                   8415: 
1.184     rillig   8416: 25.2. Avoiding problems before they arise
1.1       dsieger  8417: 
                   8418: All variables that contain lists of things should default to being empty. Two
                   8419: examples that do not follow this rule are USE_LANGUAGES and DISTFILES. These
                   8420: variables cannot simply be modified using the += operator in package Makefiles
                   8421: (or other files included by them), since there is no guarantee whether the
                   8422: variable is already set or not, and what its value is. In the case of
                   8423: DISTFILES, the packages "know" the default value and just define it as in the
                   8424: following example.
                   8425: 
                   8426: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
                   8427: 
                   8428: Because of the selection of this default value, the same value appears in many
                   8429: package Makefiles. Similarly for USE_LANGUAGES, but in this case the default
                   8430: value ("c") is so short that it doesn't stand out. Nevertheless it is mentioned
                   8431: in many files.
                   8432: 
1.184     rillig   8433: 25.3. Variable evaluation
1.1       dsieger  8434: 
1.184     rillig   8435: 25.3.1. At load time
1.1       dsieger  8436: 
                   8437: Variable evaluation takes place either at load time or at runtime, depending on
                   8438: the context in which they occur. The contexts where variables are evaluated at
                   8439: load time are:
                   8440: 
                   8441:   * The right hand side of the := and != operators,
                   8442: 
                   8443:   * Make directives like .if or .for,
                   8444: 
                   8445:   * Dependency lines.
                   8446: 
                   8447: A special exception are references to the iteration variables of .for loops,
                   8448: which are expanded inline, no matter in which context they appear.
                   8449: 
                   8450: As the values of variables may change during load time, care must be taken not
                   8451: to evaluate them by accident. Typical examples for variables that should not be
                   8452: evaluated at load time are DEPENDS and CONFIGURE_ARGS. To make the effect more
                   8453: clear, here is an example:
                   8454: 
                   8455: CONFIGURE_ARGS=         # none
                   8456: CFLAGS=                 -O
                   8457: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
                   8458: 
                   8459: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
                   8460: 
                   8461: CFLAGS+=                -Wall
                   8462: 
                   8463: This code shows how the use of the := operator can quickly lead to unexpected
                   8464: results. The first paragraph is fairly common code. The second paragraph
                   8465: evaluates the CONFIGURE_ARGS variable, which results in CFLAGS=-O. In the third
                   8466: paragraph, the -Wall is appended to the CFLAGS, but this addition will not
                   8467: appear in CONFIGURE_ARGS. In actual code, the three paragraphs from above
                   8468: typically occur in completely unrelated files.
                   8469: 
1.184     rillig   8470: 25.3.2. At runtime
1.1       dsieger  8471: 
                   8472: After all the files have been loaded, the values of the variables cannot be
                   8473: changed anymore. Variables that are used in the shell commands are expanded at
                   8474: this point.
                   8475: 
1.184     rillig   8476: 25.4. How can variables be specified?
1.1       dsieger  8477: 
                   8478: There are many ways in which the definition and use of a variable can be
                   8479: restricted in order to detect bugs and violations of the (mostly unwritten)
1.108     rillig   8480: policies. A package can be checked with pkglint -Wall to see whether it meets
                   8481: these rules.
1.1       dsieger  8482: 
1.184     rillig   8483: 25.5. Designing interfaces for Makefile fragments
1.1       dsieger  8484: 
                   8485: Most of the .mk files fall into one of the following classes. Cases where a
                   8486: file falls into more than one class should be avoided as it often leads to
                   8487: subtle bugs.
                   8488: 
1.184     rillig   8489: 25.5.1. Procedures with parameters
1.1       dsieger  8490: 
                   8491: In a traditional imperative programming language some of the .mk files could be
1.198     leot     8492: described as procedures. They take some input parameters and--after
                   8493: inclusion--provide a result in output parameters. Since all variables in
1.23      jakllsch 8494: Makefiles have global scope care must be taken not to use parameter names that
                   8495: have already another meaning. For example, PKGNAME is a bad choice for a
                   8496: parameter name.
1.1       dsieger  8497: 
                   8498: Procedures are completely evaluated at preprocessing time. That is, when
                   8499: calling a procedure all input parameters must be completely resolvable. For
                   8500: example, CONFIGURE_ARGS should never be an input parameter since it is very
                   8501: likely that further text will be added after calling the procedure, which would
                   8502: effectively apply the procedure to only a part of the variable. Also,
1.108     rillig   8503: references to other variables will be modified after calling the procedure.
1.1       dsieger  8504: 
                   8505: A procedure can declare its output parameters either as suitable for use in
                   8506: preprocessing directives or as only available at runtime. The latter
                   8507: alternative is for variables that contain references to other runtime
                   8508: variables.
                   8509: 
                   8510: Procedures shall be written such that it is possible to call the procedure more
                   8511: than once. That is, the file must not contain multiple-inclusion guards.
                   8512: 
                   8513: Examples for procedures are mk/bsd.options.mk and mk/buildlink3/bsd.builtin.mk.
                   8514: To express that the parameters are evaluated at load time, they should be
                   8515: assigned using the := operator, which should be used only for this purpose.
                   8516: 
1.184     rillig   8517: 25.5.2. Actions taken on behalf of parameters
1.1       dsieger  8518: 
                   8519: Action files take some input parameters and may define runtime variables. They
                   8520: shall not define loadtime variables. There are action files that are included
                   8521: implicitly by the pkgsrc infrastructure, while other must be included
                   8522: explicitly.
                   8523: 
                   8524: An example for action files is mk/subst.mk.
                   8525: 
1.184     rillig   8526: 25.6. The order in which files are loaded
1.1       dsieger  8527: 
                   8528: Package Makefiles usually consist of a set of variable definitions, and include
                   8529: the file ../../mk/bsd.pkg.mk in the very last line. Before that, they may also
                   8530: include various other *.mk files if they need to query the availability of
                   8531: certain features like the type of compiler or the X11 implementation. Due to
                   8532: the heavy use of preprocessor directives like .if and .for, the order in which
                   8533: the files are loaded matters.
                   8534: 
                   8535: This section describes at which point the various files are loaded and gives
                   8536: reasons for that order.
                   8537: 
1.184     rillig   8538: 25.6.1. The order in bsd.prefs.mk
1.1       dsieger  8539: 
                   8540: The very first action in bsd.prefs.mk is to define some essential variables
                   8541: like OPSYS, OS_VERSION and MACHINE_ARCH.
                   8542: 
1.4       rillig   8543: Then, the user settings are loaded from the file specified in MAKECONF, which
                   8544: is usually mk.conf. After that, those variables that have not been overridden
                   8545: by the user are loaded from mk/defaults/mk.conf.
1.1       dsieger  8546: 
                   8547: After the user settings, the system settings and platform settings are loaded,
                   8548: which may override the user settings.
                   8549: 
                   8550: Then, the tool definitions are loaded. The tool wrappers are not yet in effect.
                   8551: This only happens when building a package, so the proper variables must be used
                   8552: instead of the direct tool names.
                   8553: 
                   8554: As the last steps, some essential variables from the wrapper and the package
                   8555: system flavor are loaded, as well as the variables that have been cached in
                   8556: earlier phases of a package build.
                   8557: 
1.184     rillig   8558: 25.6.2. The order in bsd.pkg.mk
1.1       dsieger  8559: 
                   8560: First, bsd.prefs.mk is loaded.
                   8561: 
                   8562: Then, the various *-vars.mk files are loaded, which fill default values for
                   8563: those variables that have not been defined by the package. These variables may
                   8564: later be used even in unrelated files.
                   8565: 
                   8566: Then, the file bsd.pkg.error.mk provides the target error-check that is added
                   8567: as a special dependency to all other targets that use DELAYED_ERROR_MSG or
                   8568: DELAYED_WARNING_MSG.
                   8569: 
                   8570: Then, the package-specific hacks from hacks.mk are included.
                   8571: 
                   8572: Then, various other files follow. Most of them don't have any dependencies on
                   8573: what they need to have included before or after them, though some do.
                   8574: 
                   8575: The code to check PKG_FAIL_REASON and PKG_SKIP_REASON is then executed, which
                   8576: restricts the use of these variables to all the files that have been included
                   8577: before. Appearances in later files will be silently ignored.
                   8578: 
                   8579: Then, the files for the main targets are included, in the order of later
                   8580: execution, though the actual order should not matter.
                   8581: 
                   8582: At last, some more files are included that don't set any interesting variables
                   8583: but rather just define make targets to be executed.
                   8584: 
1.184     rillig   8585: Chapter 26. Regression tests
1.1       dsieger  8586: 
                   8587: Table of Contents
                   8588: 
1.184     rillig   8589: 26.1. Running the regression tests
                   8590: 26.2. Adding a new regression test
1.1       dsieger  8591: 
1.184     rillig   8592:     26.2.1. Overridable functions
                   8593:     26.2.2. Helper functions
1.1       dsieger  8594: 
                   8595: The pkgsrc infrastructure consists of a large codebase, and there are many
                   8596: corners where every little bit of a file is well thought out, making pkgsrc
                   8597: likely to fail as soon as anything is changed near those parts. To prevent most
                   8598: changes from breaking anything, a suite of regression tests should go along
                   8599: with every important part of the pkgsrc infrastructure. This chapter describes
                   8600: how regression tests work in pkgsrc and how you can add new tests.
                   8601: 
1.184     rillig   8602: 26.1. Running the regression tests
1.1       dsieger  8603: 
1.25      wiz      8604: You first need to install the pkgtools/pkg_regress package, which provides the 
1.1       dsieger  8605: pkg_regress command. Then you can simply run that command, which will run all
1.168     rillig   8606: tests in the regress/ directory.
1.1       dsieger  8607: 
1.184     rillig   8608: 26.2. Adding a new regression test
1.1       dsieger  8609: 
1.168     rillig   8610: Every directory in the regress/ directory that contains a file called spec is
1.1       dsieger  8611: considered a regression test. This file is a shell program that is included by
                   8612: the pkg_regress command. The following functions can be overridden to suit your
                   8613: needs.
                   8614: 
1.184     rillig   8615: 26.2.1. Overridable functions
1.1       dsieger  8616: 
1.108     rillig   8617: These functions do not take any parameters. Although they are called in "set -e
1.168     rillig   8618: " mode, they don't stop at the first failing command. See this Stack Overflow
1.108     rillig   8619: question for details.
1.1       dsieger  8620: 
1.108     rillig   8621: do_setup
1.1       dsieger  8622: 
                   8623:     This function prepares the environment for the test. By default it does
                   8624:     nothing.
                   8625: 
1.108     rillig   8626: do_test
1.1       dsieger  8627: 
                   8628:     This function runs the actual test. By default, it calls TEST_MAKE with the
                   8629:     arguments MAKEARGS_TEST and writes its output including error messages into
                   8630:     the file TEST_OUTFILE.
                   8631: 
1.108     rillig   8632:     When defining this function, make sure that all output that needs to be
                   8633:     checked is written to the correct output file. Example:
                   8634: 
                   8635:     do_test() {
                   8636:             echo "Example output"
                   8637:     } 1>$TEST_OUTFILE 2>&1
                   8638: 
                   8639: check_result
1.1       dsieger  8640: 
                   8641:     This function is run after the test and is typically used to compare the
                   8642:     actual output from the one that is expected. It can make use of the various
1.108     rillig   8643:     helper functions from the next section. Example:
                   8644: 
                   8645:     check_result() {
                   8646:             exit_status 0
                   8647:             output_require "Example"
                   8648:             output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
                   8649:             output_prohibit "no such file or directory"
1.169     rillig   8650:             regress_fail "expected $expected but got $actual for input $input"
1.108     rillig   8651:     }
1.1       dsieger  8652: 
1.108     rillig   8653: do_cleanup
1.1       dsieger  8654: 
                   8655:     This function cleans everything up after the test has been run. By default
                   8656:     it does nothing.
                   8657: 
1.184     rillig   8658: 26.2.2. Helper functions
1.1       dsieger  8659: 
1.168     rillig   8660: regress_fail message...
                   8661: 
                   8662:     This function makes the test fail with the given error message.
                   8663: 
1.108     rillig   8664: exit_status expected
1.1       dsieger  8665: 
1.108     rillig   8666:     This function compares the exitcode of the do_test function with its first
                   8667:     parameter. If they differ, the test will fail.
1.1       dsieger  8668: 
1.108     rillig   8669: output_require regex...
1.1       dsieger  8670: 
                   8671:     This function checks for each of its parameters if the output from do_test
1.108     rillig   8672:     matches the extended regular expression. If it does not, the test will
                   8673:     fail. Example:
                   8674: 
                   8675:     output_require "looks fine"
                   8676:     output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
1.1       dsieger  8677: 
1.177     leot     8678: output_prohibit regex...
1.1       dsieger  8679: 
                   8680:     This function checks for each of its parameters if the output from do_test
                   8681:     () does not match the extended regular expression. If any of the regular
                   8682:     expressions matches, the test will fail.
                   8683: 
1.184     rillig   8684: Chapter 27. Porting pkgsrc
1.1       dsieger  8685: 
                   8686: Table of Contents
                   8687: 
1.184     rillig   8688: 27.1. Porting pkgsrc to a new operating system
1.1       dsieger  8689: 
                   8690: The pkgsrc system has already been ported to many operating systems, hardware
                   8691: architectures and compilers. This chapter explains the necessary steps to make
                   8692: pkgsrc even more portable.
                   8693: 
1.184     rillig   8694: 27.1. Porting pkgsrc to a new operating system
1.1       dsieger  8695: 
                   8696: To port pkgsrc to a new operating system (called MyOS in this example), you
                   8697: need to touch the following files:
                   8698: 
                   8699: pkgtools/bootstrap-mk-files/files/mods/MyOS.sys.mk
                   8700: 
                   8701:     This file contains some basic definitions, for example the name of the C
                   8702:     compiler.
                   8703: 
                   8704: mk/bsd.prefs.mk
                   8705: 
                   8706:     Insert code that defines the variables OPSYS, OS_VERSION, LOWER_OS_VERSION,
                   8707:     LOWER_VENDOR, MACHINE_ARCH, OBJECT_FMT, APPEND_ELF, and the other variables
                   8708:     that appear in this file.
                   8709: 
                   8710: mk/platform/MyOS.mk
                   8711: 
                   8712:     This file contains the platform-specific definitions that are used by
                   8713:     pkgsrc. Start by copying one of the other files and edit it to your needs.
                   8714: 
                   8715: mk/tools/tools.MyOS.mk
                   8716: 
                   8717:     This file defines the paths to all the tools that are needed by one or the
                   8718:     other package in pkgsrc, as well as by pkgsrc itself. Find out where these
                   8719:     tools are on your platform and add them.
                   8720: 
                   8721: Now, you should be able to build some basic packages, like lang/perl5, shells/
                   8722: bash.
                   8723: 
                   8724: Appendix A. A simple example package: bison
                   8725: 
                   8726: Table of Contents
                   8727: 
                   8728: A.1. files
                   8729: 
                   8730:     A.1.1. Makefile
                   8731:     A.1.2. DESCR
                   8732:     A.1.3. PLIST
                   8733:     A.1.4. Checking a package with pkglint
                   8734: 
                   8735: A.2. Steps for building, installing, packaging
                   8736: 
                   8737: We checked to find a piece of software that wasn't in the packages collection,
1.25      wiz      8738: and picked GNU bison. Quite why someone would want to have bison when Berkeley 
1.1       dsieger  8739: yacc is already present in the tree is beyond us, but it's useful for the
                   8740: purposes of this exercise.
                   8741: 
                   8742: A.1. files
                   8743: 
                   8744: A.1.1. Makefile
                   8745: 
1.2       rillig   8746: # $NetBSD$
1.1       dsieger  8747: #
                   8748: 
                   8749: DISTNAME=       bison-1.25
                   8750: CATEGORIES=     devel
1.171     rillig   8751: MASTER_SITES=   ${MASTER_SITE_GNU:=bison/}
1.1       dsieger  8752: 
1.30      dholland 8753: MAINTAINER=     pkgsrc-users@NetBSD.org
1.174     leot     8754: HOMEPAGE=       https://www.gnu.org/software/bison/bison.html
1.1       dsieger  8755: COMMENT=        GNU yacc clone
                   8756: 
                   8757: GNU_CONFIGURE=  yes
1.47      wiz      8758: INFO_FILES=     yes
1.1       dsieger  8759: 
                   8760: .include "../../mk/bsd.pkg.mk"
                   8761: 
                   8762: A.1.2. DESCR
                   8763: 
                   8764: GNU version of yacc.  Can make re-entrant parsers, and numerous other
                   8765: improvements.  Why you would want this when Berkeley yacc(1) is part
                   8766: of the NetBSD source tree is beyond me.
                   8767: 
                   8768: A.1.3. PLIST
                   8769: 
1.2       rillig   8770: @comment $NetBSD$
1.1       dsieger  8771: bin/bison
                   8772: man/man1/bison.1.gz
                   8773: share/bison.simple
                   8774: share/bison.hairy
                   8775: 
                   8776: A.1.4. Checking a package with pkglint
                   8777: 
                   8778: The NetBSD package system comes with pkgtools/pkglint which helps to check the
                   8779: contents of these files. After installation it is quite easy to use, just
1.171     rillig   8780: change to the directory of the package you wish to examine and run pkglint:
1.1       dsieger  8781: 
                   8782: $ pkglint
1.171     rillig   8783: ERROR: Makefile: Each package must define its LICENSE.
                   8784: WARN: Makefile:9: HOMEPAGE should migrate from http to https.
                   8785: NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
                   8786: WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
                   8787: 1 error, 2 warnings and 1 note found.
                   8788: (Run "pkglint -e" to show explanations.)
                   8789: (Run "pkglint -fs" to show what can be fixed automatically.)
1.172     rillig   8790: (Run "pkglint -F" to automatically fix some issues.)
1.1       dsieger  8791: 
                   8792: Depending on the supplied command line arguments (see pkglint(1)), more checks
1.170     rillig   8793: will be performed. Use e.g. pkglint -Wall for a very thorough check.
1.1       dsieger  8794: 
                   8795: A.2. Steps for building, installing, packaging
                   8796: 
                   8797: Create the directory where the package lives, plus any auxiliary directories:
                   8798: 
                   8799: # cd /usr/pkgsrc/lang
                   8800: # mkdir bison
                   8801: # cd bison
                   8802: # mkdir patches
                   8803: 
1.184     rillig   8804: Create Makefile, DESCR and PLIST (see Chapter 12, Package components - files,
1.1       dsieger  8805: directories and contents) then continue with fetching the distfile:
                   8806: 
                   8807: # make fetch
                   8808: >> bison-1.25.tar.gz doesn't seem to exist on this system.
                   8809: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   8810: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   8811: ftp: Error retrieving file: 500 Internal error
                   8812: 
                   8813: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   8814: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   8815: ftp: Error retrieving file: 500 Internal error
                   8816: 
                   8817: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   8818: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   8819: Successfully retrieved file.
                   8820: 
                   8821: Generate the checksum of the distfile into distinfo:
                   8822: 
                   8823: # make makedistinfo
                   8824: 
                   8825: Now compile:
                   8826: 
                   8827: # make
                   8828: >> Checksum OK for bison-1.25.tar.gz.
                   8829: ===>  Extracting for bison-1.25
                   8830: ===>  Patching for bison-1.25
                   8831: ===>   Ignoring empty patch directory
                   8832: ===>  Configuring for bison-1.25
                   8833: creating cache ./config.cache
                   8834: checking for gcc... cc
                   8835: checking whether we are using GNU C... yes
                   8836: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   8837: checking how to run the C preprocessor... cc -E
                   8838: checking for minix/config.h... no
                   8839: checking for POSIXized ISC... no
                   8840: checking whether cross-compiling... no
                   8841: checking for ANSI C header files... yes
                   8842: checking for string.h... yes
                   8843: checking for stdlib.h... yes
                   8844: checking for memory.h... yes
                   8845: checking for working const... yes
                   8846: checking for working alloca.h... no
                   8847: checking for alloca... yes
                   8848: checking for strerror... yes
                   8849: updating cache ./config.cache
                   8850: creating ./config.status
                   8851: creating Makefile
                   8852: ===>  Building for bison-1.25
                   8853: 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
                   8854: 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
                   8855: 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
                   8856: 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
                   8857: 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
                   8858: 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
                   8859: 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
                   8860: 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
                   8861: 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
                   8862: 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
                   8863: 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
                   8864: 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
                   8865: 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
                   8866: 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
                   8867: 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
                   8868: 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
                   8869: 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
                   8870: 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
                   8871: 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
                   8872: 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
                   8873: 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
                   8874: 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
                   8875: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   8876: rm -f bison.s1
                   8877: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1
                   8878: 
                   8879: Everything seems OK, so install the files:
                   8880: 
                   8881: # make install
                   8882: >> Checksum OK for bison-1.25.tar.gz.
                   8883: ===>  Installing for bison-1.25
                   8884: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   8885: rm -f /usr/pkg/bin/bison
                   8886: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   8887: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   8888: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   8889: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   8890: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   8891: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   8892: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
                   8893: ===>  Registering installation for bison-1.25
                   8894: 
                   8895: You can now use bison, and also - if you decide so - remove it with pkg_delete
                   8896: bison. Should you decide that you want a binary package, do this now:
                   8897: 
                   8898: # make package
                   8899: >> Checksum OK for bison-1.25.tar.gz.
                   8900: ===>  Building package for bison-1.25
                   8901: Creating package bison-1.25.tgz
                   8902: Registering depends:.
                   8903: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'
                   8904: 
                   8905: Now that you don't need the source and object files any more, clean up:
                   8906: 
                   8907: # make clean
                   8908: ===>  Cleaning for bison-1.25
                   8909: 
                   8910: Appendix B. Build logs
                   8911: 
                   8912: Table of Contents
                   8913: 
                   8914: B.1. Building figlet
                   8915: B.2. Packaging figlet
                   8916: 
                   8917: B.1. Building figlet
                   8918: 
                   8919: # make
                   8920: ===> Checking for vulnerabilities in figlet-2.2.1nb2
                   8921: => figlet221.tar.gz doesn't seem to exist on this system.
                   8922: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   8923: => [172219 bytes]
                   8924: Connected to ftp.plig.net.
                   8925: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   8926: 331 Guest login ok, send your complete e-mail address as password.
                   8927: 230-You are user #5 of 500 simultaneous users allowed.
                   8928: 230-
                   8929: 230-  ___ _             _ _
                   8930: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
                   8931: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   8932: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   8933: 230-         |_|   |_|     |___|         |___|
                   8934: 230-
                   8935: 230-** Welcome to ftp.plig.org **
                   8936: 230-
                   8937: 230-Please note that all transfers from this FTP site are logged. If you
                   8938: 230-do not like this, please disconnect now.
                   8939: 230-
1.19      snj      8940: 230-This archive is available via
1.1       dsieger  8941: 230-
                   8942: 230-HTTP:  http://ftp.plig.org/
                   8943: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   8944: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   8945: 230-
                   8946: 230-Please email comments, bug reports and requests for packages to be
                   8947: 230-mirrored to ftp-admin@plig.org.
                   8948: 230-
                   8949: 230-
                   8950: 230 Logged in anonymously.
                   8951: Remote system type is UNIX.
                   8952: Using binary mode to transfer files.
                   8953: 200 Type okay.
                   8954: 250 "/pub" is new cwd.
                   8955: 250-"/pub/figlet" is new cwd.
                   8956: 250-
                   8957: 250-Welcome to the figlet archive at ftp.figlet.org
                   8958: 250-
                   8959: 250-    ftp://ftp.figlet.org/pub/figlet/
                   8960: 250-
                   8961: 250-The official FIGlet web page is:
                   8962: 250-    http://www.figlet.org/
                   8963: 250-
                   8964: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   8965: 250-contribute a font or something else, you can email us.
                   8966: 250
                   8967: 250 "/pub/figlet/program" is new cwd.
                   8968: 250 "/pub/figlet/program/unix" is new cwd.
                   8969: local: figlet221.tar.gz remote: figlet221.tar.gz
                   8970: 502 Unimplemented command.
                   8971: 227 Entering Passive Mode (195,40,6,41,246,104)
                   8972: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   8973: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   8974: 226 Transfer completed.
                   8975: 172219 bytes received in 00:02 (75.99 KB/s)
                   8976: 221 Goodbye.
                   8977: => Checksum OK for figlet221.tar.gz.
                   8978: ===> Extracting for figlet-2.2.1nb2
                   8979: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   8980: ===> Patching for figlet-2.2.1nb2
                   8981: ===> Applying pkgsrc patches for figlet-2.2.1nb2
                   8982: ===> Overriding tools for figlet-2.2.1nb2
                   8983: ===> Creating toolchain wrappers for figlet-2.2.1nb2
                   8984: ===> Configuring for figlet-2.2.1nb2
                   8985: ===> Building for figlet-2.2.1nb2
                   8986: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   8987: chmod a+x figlet
                   8988: gcc -O2 -o chkfont chkfont.c
                   8989: => Unwrapping files-to-be-installed.
                   8990: #
                   8991: # make install
                   8992: ===> Checking for vulnerabilities in figlet-2.2.1nb2
                   8993: ===> Installing for figlet-2.2.1nb2
                   8994: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   8995: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   8996: mkdir -p /usr/pkg/share/figlet
                   8997: cp figlet /usr/pkg/bin
                   8998: cp chkfont /usr/pkg/bin
                   8999: chmod 555 figlist showfigfonts
                   9000: cp figlist /usr/pkg/bin
                   9001: cp showfigfonts /usr/pkg/bin
                   9002: cp fonts/*.flf /usr/pkg/share/figlet
                   9003: cp fonts/*.flc /usr/pkg/share/figlet
                   9004: cp figlet.6 /usr/pkg/man/man6
                   9005: ===> Registering installation for figlet-2.2.1nb2
                   9006: #
                   9007: 
                   9008: B.2. Packaging figlet
                   9009: 
                   9010: # make package
                   9011: ===> Checking for vulnerabilities in figlet-2.2.1nb2
                   9012: ===> Packaging figlet-2.2.1nb2
                   9013: ===> Building binary package for figlet-2.2.1nb2
                   9014: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   9015: Using SrcDir value of /usr/pkg
                   9016: Registering depends:.
                   9017: #
                   9018: 
                   9019: Appendix C. Directory layout of the pkgsrc FTP server
                   9020: 
                   9021: Table of Contents
                   9022: 
1.23      jakllsch 9023: C.1. distfiles: The distributed source files
                   9024: C.2. misc: Miscellaneous things
                   9025: C.3. packages: Binary packages
                   9026: C.4. reports: Bulk build reports
1.148     leot     9027: C.5. current, stable, pkgsrc-20xxQy: source packages
1.1       dsieger  9028: 
                   9029: As in other big projects, the directory layout of pkgsrc is quite complex for
                   9030: newbies. This chapter explains where you find things on the FTP server. The
                   9031: base directory on ftp.NetBSD.org is /pub/pkgsrc/. On other servers it may be
                   9032: different, but inside this directory, everything should look the same, no
                   9033: matter on which server you are. This directory contains some subdirectories,
                   9034: which are explained below.
                   9035: 
1.23      jakllsch 9036: C.1. distfiles: The distributed source files
1.1       dsieger  9037: 
                   9038: The directory distfiles contains lots of archive files from all pkgsrc
                   9039: packages, which are mirrored here. The subdirectories are called after their
                   9040: package names and are used when the distributed files have names that don't
                   9041: explicitly contain a version number or are otherwise too generic (for example
                   9042: release.tar.gz).
                   9043: 
1.23      jakllsch 9044: C.2. misc: Miscellaneous things
1.1       dsieger  9045: 
                   9046: This directory contains things that individual pkgsrc developers find worth
                   9047: publishing.
                   9048: 
1.23      jakllsch 9049: C.3. packages: Binary packages
1.1       dsieger  9050: 
1.3       rillig   9051: This directory contains binary packages for the various platforms that are
                   9052: supported by pkgsrc. Each subdirectory is of the form OPSYS/ARCH/OSVERSION_TAG.
                   9053: The meaning of these variables is:
                   9054: 
                   9055:   * OPSYS is the name of the operating system for which the packages have been
1.9       rillig   9056:     built. The name is taken from the output of the uname command, so it may
                   9057:     differ from the one you are used to hear.
1.3       rillig   9058: 
1.8       rillig   9059:   * ARCH is the hardware architecture of the platform for which the packages
1.10      hubertf  9060:     have been built. It also includes the ABI (Application Binary Interface)
                   9061:     for platforms that have several of them.
1.3       rillig   9062: 
1.8       rillig   9063:   * OSVERSION is the version of the operating system. For version numbers that
                   9064:     change often (for example NetBSD-current), the often-changing part should
                   9065:     be replaced with an x, for example 4.99.x.
1.3       rillig   9066: 
1.23      jakllsch 9067:   * TAG is either 20xxQy for a stable branch, or head for packages built from
1.8       rillig   9068:     the HEAD branch. The latter should only be used when the packages are
                   9069:     updated on a regular basis. Otherwise the date from checking out pkgsrc
                   9070:     should be appended, for example head_20071015.
1.3       rillig   9071: 
                   9072: The rationale for exactly this scheme is that the pkgsrc users looking for
                   9073: binary packages can quickly click through the directories on the server and
                   9074: find the best binary packages for their machines. Since they usually know the
                   9075: operating system and the hardware architecture, OPSYS and ARCH are placed
                   9076: first. After these choices, they can select the best combination of OSVERSION
                   9077: and TAG together, since it is usually the case that packages stay compatible
                   9078: between different version of the operating system.
                   9079: 
                   9080: In each of these directories, there is a whole binary packages collection for a
                   9081: specific platform. It has a directory called All which contains all binary
                   9082: packages. Besides that, there are various category directories that contain
                   9083: symbolic links to the real binary packages.
1.1       dsieger  9084: 
1.23      jakllsch 9085: C.4. reports: Bulk build reports
1.8       rillig   9086: 
                   9087: Here are the reports from bulk builds, for those who want to fix packages that
                   9088: didn't build on some of the platforms. The structure of subdirectories should
1.23      jakllsch 9089: look like the one in Section C.3, "packages: Binary packages".
1.8       rillig   9090: 
1.148     leot     9091: C.5. current, stable, pkgsrc-20xxQy: source packages
1.1       dsieger  9092: 
                   9093: These directories contain the "real" pkgsrc, that is the files that define how
                   9094: to create binary packages from source archives.
                   9095: 
1.149     leot     9096: Each of the current, stable and pkgsrc-20xxQy directories share the same
                   9097: structure. They each contain a pkgsrc directory and pkgsrc.tar.{bz,gz,xz} file.
                   9098: 
1.1       dsieger  9099: The directory pkgsrc contains a snapshot of the CVS repository, which is
1.149     leot     9100: updated regularly. The file pkgsrc.tar.{bz,gz,xz} contains the same as the
                   9101: directory, ready to be downloaded as a whole.
1.1       dsieger  9102: 
1.149     leot     9103: The current directory contains files related to the HEAD branch of the CVS
                   9104: repository. In this directory there is an additional file called
                   9105: pkgsrc-readmes.tar.{bz,gz,xz} that contains all pkgsrc READMEs with information
                   9106: about categories and packages.
                   9107: 
                   9108: The stable directory is a symlink to the latest pkgsrc-20xxQy.
                   9109: 
                   9110: The pkgsrc-20xxQy. directories contain files related to the -20xxQy stable
                   9111: branch of the CVS repository. In these directories there is an additional file
                   9112: called pkgsrc-20xxQy.tar.{bz,gz,xz}, which contains the state of pkgsrc when it
                   9113: was branched.
1.148     leot     9114: 
1.154     rillig   9115: Appendix D. Help topics
                   9116: 
                   9117: The following list contains all help topics that are available when running 
                   9118: bmake help topic=:index.
                   9119: 
1.201   ! cirnatda 9120: #!                                   -lintl
        !          9121: 64bit                                ABI
        !          9122: ACCEPTABLE_LICENSES                  ACROREAD_FONTPATH
        !          9123: ADDITIONAL                           AFAIK
        !          9124: AIX                                  ALLOW_VULNERABLE_PACKAGES
        !          9125: ALL_ENV                              ALTERNATIVES_SRC
        !          9126: AMANDA_TMP                           AMANDA_USER
        !          9127: AMANDA_VAR                           APACHE_GROUP
        !          9128: APACHE_MODULE_NAME                   APACHE_MODULE_SRC
        !          9129: APACHE_MODULE_SRCDIR                 APACHE_PKG_PREFIX
        !          9130: APACHE_SUEXEC_CONFIGURE_ARGS         APACHE_SUEXEC_DOCROOT
        !          9131: APACHE_USER                          APPEND_ABI
        !          9132: APPEND_ELF                           ARLA_CACHE
        !          9133: AUDIT_PACKAGES_FLAGS                 AUTOCONF_REQD
        !          9134: AUTOMAKE_OVERRIDE                    AUTOMAKE_REQD
        !          9135: AUTO_MKDIRS                          BDB185_DEFAULT
        !          9136: BDBBASE                              BDB_ACCEPTED
        !          9137: BDB_DEFAULT                          BDB_LIBS
        !          9138: BDB_TYPE                             BINCIMAP_GROUP
        !          9139: BINCIMAP_USER                        BIND_DIR
        !          9140: BIND_GROUP                           BIND_USER
        !          9141: BINOWN                               BINPKG_SITES
        !          9142: BIN_INSTALL_FLAGS                    BISON_PKGDATADIR
        !          9143: BLAS_ACCEPTED                        BLAS_LIBS
        !          9144: BLAS_TYPE                            BOOTSTRAP_DEPENDS
        !          9145: BOOTSTRAP_SETUPTOOLS                 BROKEN
        !          9146: BROKEN_EXCEPT_ON_PLATFORM            BROKEN_ON_PLATFORM
        !          9147: BSDSRCDIR                            BSDXSRCDIR
        !          9148: BSD_MAKE_ENV                         BUILDLINK_AUTO_DIRS
        !          9149: BUILDLINK_AUTO_VARS                  BUILDLINK_CFLAGS
        !          9150: BUILDLINK_CONTENTS_FILTER            BUILDLINK_CPPFLAGS
        !          9151: BUILDLINK_FILES                      BUILDLINK_FILES_CMD
        !          9152: BUILDLINK_FNAME_TRANSFORM            BUILDLINK_LDFLAGS
        !          9153: BUILDLINK_LIBS                       BUILDLINK_OPSYS_SUPPORT_PTHREAD
        !          9154: BUILDLINK_PKGNAME                    BUILDLINK_PREFIX
        !          9155: BUILDLINK_RPATHDIRS                  BUILDLINK_TREE
        !          9156: BUILD_DEFS                           BUILD_DEFS_EFFECTS
        !          9157: BUILD_DEPENDS                        BUILD_DIRS
        !          9158: BUILD_ENV_SHELL                      BUILD_MAKE_CMD
        !          9159: BUILD_MAKE_FLAGS                     BUILD_TARGET
        !          9160: BUILTIN_FIND_FILES                   BUILTIN_FIND_FILES_VAR
        !          9161: BUILTIN_FIND_GREP                    BUILTIN_FIND_HEADERS
        !          9162: BUILTIN_FIND_HEADERS_VAR             BUILTIN_FIND_PKGCONFIG
        !          9163: BUILTIN_FIND_PKGCONFIG_VAR           BUILTIN_PKG
        !          9164: BUILTIN_TEST_CURSES_DEFINES          BUILTIN_TEST_CURSES_FUNCS
        !          9165: BUILTIN_VERSION_SCRIPT               BUILTIN_X11_TYPE
        !          9166: BUILTIN_X11_VERSION                  CACTI_GROUP
        !          9167: CACTI_USER                           CANNA_GROUP
        !          9168: CANNA_USER                           CAT
        !          9169: CCACHE_BASE                          CCACHE_DIR
        !          9170: CCACHE_LOGFILE                       CC_VERSION
        !          9171: CC_VERSION_STRING                    CDRECORD_CONF
        !          9172: CDROM_PKG_URL_DIR                    CDROM_PKG_URL_HOST
        !          9173: CHECK_COMPILER                       CHECK_FAKEHOME
        !          9174: CHECK_FILES                          CHECK_FILES_SKIP
        !          9175: CHECK_FILES_STRICT                   CHECK_HEADERS
        !          9176: CHECK_HEADERS_SKIP                   CHECK_INTERPRETER
        !          9177: CHECK_INTERPRETER_SKIP               CHECK_PERMS
        !          9178: CHECK_PERMS_AUTOFIX                  CHECK_PERMS_SKIP
        !          9179: CHECK_PORTABILITY                    CHECK_PORTABILITY_EXPERIMENTAL
        !          9180: CHECK_PORTABILITY_SKIP               CHECK_RELRO
        !          9181: CHECK_RELRO_SKIP                     CHECK_RELRO_SUPPORTED
        !          9182: CHECK_SHLIBS                         CHECK_SHLIBS_BLACKLIST
        !          9183: CHECK_SHLIBS_SKIP                    CHECK_SHLIBS_SUPPORTED
        !          9184: CHECK_SSP                            CHECK_SSP_SKIP
        !          9185: CHECK_SSP_SUPPORTED                  CHECK_STRIPPED
        !          9186: CHECK_STRIPPED_SKIP                  CHECK_WRKREF
        !          9187: CHECK_WRKREF_EXTRA_DIRS              CHECK_WRKREF_SKIP
        !          9188: CLAMAV_DBDIR                         CLAMAV_GROUP
        !          9189: CLAMAV_USER                          CLANGBASE
        !          9190: CLEANDEPENDS                         CMAKE_DEPENDENCIES_REWRITE
        !          9191: CMAKE_INSTALL_NAME_DIR               CMAKE_INSTALL_PREFIX
        !          9192: CMAKE_MODULE_PATH_OVERRIDE           CMAKE_PKGSRC_BUILD_FLAGS
        !          9193: CMAKE_PREFIX_PATH                    CMAKE_USE_GNU_INSTALL_DIRS
        !          9194: COMPILER_RPATH_FLAG                  COMPILER_USE_SYMLINKS
        !          9195: CONFIGURE_ARGS                       CONFIGURE_DIRS
        !          9196: CONFIGURE_ENV                        CONFIGURE_ENV_SHELL
        !          9197: CONFIGURE_HAS_INFODIR                CONFIGURE_HAS_MANDIR
        !          9198: CONFIGURE_SCRIPT                     CONFIG_SHELL
        !          9199: CONFIG_SHELL_FLAGS                   CONF_FILES
        !          9200: CONF_FILES_MODE                      CONF_FILES_PERMS
        !          9201: CONSERVER_DEFAULTHOST                CONSERVER_DEFAULTPORT
        !          9202: CP                                   CPP
        !          9203: CPP_PRECOMP_FLAGS                    CREATE_WRKDIR_SYMLINK
        !          9204: CROSSBASE                            CTFCONVERT
        !          9205: CTF_FILES_SKIP                       CTF_SUPPORTED
        !          9206: CTYPE                                CUPS_GROUP
        !          9207: CUPS_SYSTEM_GROUPS                   CUPS_USER
        !          9208: CURSES_DEFAULT                       CURSES_TYPE
        !          9209: CXX                                  CYRUS_GROUP
        !          9210: CYRUS_IDLE                           CYRUS_USER
        !          9211: DAEMONTOOLS_GROUP                    DAEMONTOOLS_LOG_USER
        !          9212: DARWIN_NO_SYSTEM_LIBS                DARWIN_REQUIRES_FILTER
        !          9213: DBUS_GROUP                           DBUS_USER
        !          9214: DEFANG_GROUP                         DEFANG_USER
        !          9215: DEFAULT_ACCEPTABLE_LICENSES          DEFAULT_DISTFILES
        !          9216: DEFAULT_IRC_SERVER                   DEFAULT_SERIAL_DEVICE
        !          9217: DEF_UMASK                            DEINSTALLDEPENDS
        !          9218: DEINSTALL_SRC                        DEINSTALL_TEMPLATES
        !          9219: DELAYED_ERROR_MSG                    DELAYED_WARNING_MSG
        !          9220: DEPENDS                              DEPENDS_TARGET
        !          9221: DEPENDS_TYPE                         DESTDIR
        !          9222: DESTDIR_VARNAME                      DIALER_GROUP
        !          9223: DIGEST_REQD                          DISTDIR
        !          9224: DISTFILES                            DISTINFO_FILE
        !          9225: DISTNAME                             DIST_PATH
        !          9226: DIST_SUBDIR                          DJBDNS_AXFR_USER
        !          9227: DJBDNS_CACHE_USER                    DJBDNS_DJBDNS_GROUP
        !          9228: DJBDNS_LOG_USER                      DJBDNS_RBL_USER
        !          9229: DJBDNS_TINY_USER                     DLOPEN_REQUIRE_PTHREADS
        !          9230: DL_AUTO_VARS                         DL_CFLAGS
        !          9231: DL_LDFLAGS                           DL_LIBS
        !          9232: DNS                                  DOCOWN
        !          9233: DOWNLOADED_DISTFILE                  DT_LAYOUT
        !          9234: DYNAMIC_SITES_CMD                    DYNAMIC_SITES_SCRIPT
        !          9235: ECHO                                 ECHO_N
        !          9236: ELK_GUI                              EMACS_TYPE
        !          9237: EMULDIR                              EMULSUBDIR
        !          9238: EMULSUBDIRSLASH                      EMUL_ARCH
        !          9239: EMUL_DISTRO                          EMUL_EXEC_FMT
        !          9240: EMUL_IS_NATIVE                       EMUL_MODULES
        !          9241: EMUL_OPSYS                           EMUL_PKG_FMT
        !          9242: EMUL_PLATFORM                        EMUL_PLATFORMS
        !          9243: EMUL_PREFER                          EMUL_REQD
        !          9244: EMUL_TYPE                            ERROR_MSG
        !          9245: EXIM_GROUP                           EXIM_USER
        !          9246: EXPORT_SYMBOLS_LDFLAGS               EXTRACTOR
        !          9247: EXTRACT_CMD                          EXTRACT_CMD_DEFAULT
        !          9248: EXTRACT_DIR                          EXTRACT_ELEMENTS
        !          9249: EXTRACT_ENV                          EXTRACT_ONLY
        !          9250: EXTRACT_OPTS                         EXTRACT_SUFX
        !          9251: EXTRACT_USING                        FAIL
        !          9252: FAILOVER_FETCH                       FAIL_MSG
        !          9253: FAKE_NCURSES                         FAM
        !          9254: FAM_ACCEPTED                         FAM_DEFAULT
        !          9255: FAM_SERVER                           FCPATH
        !          9256: FEATURE_CPPFLAGS                     FEATURE_LDFLAGS
        !          9257: FEATURE_LIBS                         FETCH_AFTER_ARGS
        !          9258: FETCH_BEFORE_ARGS                    FETCH_CMD
        !          9259: FETCH_OUTPUT_ARGS                    FETCH_PROXY
        !          9260: FETCH_RESUME_ARGS                    FETCH_TIMEOUT
        !          9261: FETCH_USE_IPV4_ONLY                  FETCH_USING
        !          9262: FILES_SUBST                          FILES_SUBST_SED
        !          9263: FIX_SYSTEM_HEADERS                   FLUXBOX_USE_GNOME
        !          9264: FLUXBOX_USE_KDE                      FLUXBOX_USE_XFT
        !          9265: FLUXBOX_USE_XINERAMA                 FONTS_DIRS
        !          9266: FONTS_VERBOSE                        FOO_HACKS_MK
        !          9267: FOX_USE_XUNICODE                     FREEWNN_GROUP
        !          9268: FREEWNN_USER                         FTP_PKG_URL_DIR
        !          9269: FTP_PKG_URL_HOST                     GAMEDATAMODE
        !          9270: GAMEDATA_PERMS                       GAMEDIRMODE
        !          9271: GAMEDIR_PERMS                        GAMEGRP
        !          9272: GAMEMODE                             GAMEOWN
        !          9273: GAMES_GROUP                          GAMES_USER
        !          9274: GCC                                  GCCBASE
        !          9275: GCC_REQD                             GCC_VERSION_SUFFIX
        !          9276: GEM_BUILD                            GEM_CLEANBUILD
        !          9277: GEM_CLEANBUILD_EXTENSIONS            GEM_DOCDIR
        !          9278: GEM_EXTSDIR                          GEM_HOME
        !          9279: GEM_KEEPBUILD                        GEM_LIBDIR
        !          9280: GEM_NAME                             GEM_PATH
        !          9281: GEM_PLUGINSDIR                       GEM_SPECFILE
        !          9282: GENERATE_PLIST                       GHC
        !          9283: GHOSTSCRIPT_REQD                     GITHUB_PROJECT
        !          9284: GITHUB_RELEASE                       GITHUB_SUBMODULES
        !          9285: GITHUB_TAG                           GITHUB_TYPE
        !          9286: GNU                                  GNU_CONFIGURE
        !          9287: GNU_CONFIGURE_INFODIR                GNU_CONFIGURE_MANDIR
        !          9288: GNU_CONFIGURE_QUIET                  GNU_CONFIGURE_STRICT
        !          9289: GODEP_REDIRECTS                      GO_BUILD_PATTERN
        !          9290: GO_DEPS                              GO_DIST_BASE
        !          9291: GO_MODULE_FILES                      GO_SRCPATH
        !          9292: GO_VERSION_DEFAULT                   GROUP_SPECIFIC_PKGS
        !          9293: GRUB_NETWORK_CARDS                   GRUB_PRESET_COMMAND
        !          9294: GRUB_SCAN_ARGS                       GZIP
        !          9295: HASKELL_ENABLE_HADDOCK_DOCUMENTATION HASKELL_ENABLE_LIBRARY_PROFILING
        !          9296: HASKELL_ENABLE_SHARED_LIBRARY        HASKELL_OPTIMIZATION_LEVEL
        !          9297: HAS_CONFIGURE                        HEADER_TEMPLATES
        !          9298: HOMEPAGE                             HOST_PKGTOOLS_ARGS
        !          9299: HOST_SPECIFIC_PKGS                   HOWL_GROUP
        !          9300: HOWL_USER                            ICCBASE
        !          9301: ICECAST_CHROOTDIR                    ICON_THEMES
        !          9302: IDOBASE                              IGNORE_CCACHE
        !          9303: IGNORE_INFO_DIRS                     IGNORE_INTERACTIVE_FETCH
        !          9304: IMAKE                                IMAKEOPTS
        !          9305: IMAKE_MAKE                           IMAKE_MANINSTALL
        !          9306: IMAP_UW_CCLIENT_MBOX_FMT             IMDICTDIR
        !          9307: INCOMPAT_CURSES                      INFO_DIR
        !          9308: INFO_FILES                           INFO_FILES_VERBOSE
        !          9309: INFO_MSG                             INIT_SYSTEM
        !          9310: INN_DATA_DIR                         INN_GROUP
        !          9311: INN_USER                             INSTALLATION_DIRS
        !          9312: INSTALLATION_DIRS_FROM_PLIST         INSTALL_ENV
        !          9313: INSTALL_SH_OVERRIDE                  INSTALL_SRC
        !          9314: INSTALL_TEMPLATES                    INSTALL_UNSTRIPPED
        !          9315: IRCD_HYBRID_IRC_GROUP                IRCD_HYBRID_IRC_USER
        !          9316: IRCD_HYBRID_MAXCONN                  IRCD_HYBRID_NICLEN
        !          9317: IRCD_HYBRID_SYSLOG_EVENTS            IRCD_HYBRID_SYSLOG_FACILITY
        !          9318: IRCD_HYBRID_TOPICLEN                 IRIX
        !          9319: IRRD_USE_PGP                         JABBERD_GROUP
        !          9320: JABBERD_LOGDIR                       JABBERD_PIDDIR
        !          9321: JABBERD_SPOOLDIR                     JABBERD_USER
        !          9322: JAKARTA_HOME                         JAVA_BINPREFIX
        !          9323: JAVA_CLASSPATH                       JAVA_HOME
        !          9324: JAVA_LD_LIBRARY_PATH                 JAVA_NAME
        !          9325: JAVA_UNLIMIT                         JAVA_WRAPPERS
        !          9326: JPEG_ACCEPTED                        JPEG_DEFAULT
        !          9327: KERBEROS                             KERMIT_SUID_UUCP
        !          9328: KJS_USE_PCRE                         KNEWS_DOMAIN_FILE
        !          9329: KNEWS_DOMAIN_NAME                    KRB5_ACCEPTED
        !          9330: KRB5_DEFAULT                         LANGUAGES
        !          9331: LAPACK_LIBS                          LATEX2HTML_ICONPATH
        !          9332: LDCONFIG_ADD_CMD                     LDCONFIG_REMOVE_CMD
        !          9333: LEAFNODE_DATA_DIR                    LEAFNODE_GROUP
        !          9334: LEAFNODE_USER                        LIBDVDCSS_HOMEPAGE
        !          9335: LIBDVDCSS_MASTER_SITES               LIBRSVG_TYPE
        !          9336: LIBTOOL                              LIBTOOLIZE_PLIST
        !          9337: LIBTOOL_M4_OVERRIDE                  LIBUSB_TYPE
        !          9338: LICENSE                              LINKER_RPATH_FLAG
        !          9339: LINK_RPATH_FLAG                      LINUX_LOCALES
        !          9340: LOCALBASE                            LOCALBASE_LOCKTYPE
        !          9341: LOCALPATCHES                         LOVE_DATA
        !          9342: LOVE_GAME                            LOVE_VERSION
        !          9343: LP64PLATFORMS                        MACHINE_PLATFORM
        !          9344: MAILAGENT_DOMAIN                     MAILAGENT_EMAIL
        !          9345: MAILAGENT_FQDN                       MAILAGENT_ORGANIZATION
        !          9346: MAJORDOMO_HOMEDIR                    MAKEINFO_ARGS
        !          9347: MAKE_DIRS                            MAKE_DIRS_PERMS
        !          9348: MAKE_ENV                             MAKE_FILE
        !          9349: MAKE_FLAGS                           MAKE_JOBS
        !          9350: MAKE_JOBS_SAFE                       MAKE_PROGRAM
        !          9351: MANCOMPRESSED_IF_MANZ                MANINSTALL
        !          9352: MANZ                                 MASTER_SITES
        !          9353: MASTER_SITE_BACKUP                   MASTER_SITE_LOCAL
        !          9354: MASTER_SITE_MOZILLA                  MASTER_SITE_OVERRIDE
        !          9355: MASTER_SITE_PERL_CPAN                MASTER_SORT
        !          9356: MASTER_SORT_RANDOM                   MASTER_SORT_REGEX
        !          9357: MECAB_CHARSET                        MEDIATOMB_GROUP
        !          9358: MEDIATOMB_USER                       MIPSPROBASE
        !          9359: MIREDO_GROUP                         MIREDO_USER
        !          9360: MISSING_FEATURES                     MKDIR
        !          9361: MLDONKEY_GROUP                       MLDONKEY_HOME
        !          9362: MLDONKEY_USER                        MONOTONE_GROUP
        !          9363: MONOTONE_USER                        MOTIFBASE
        !          9364: MOTIF_TYPE                           MOTIF_TYPE_DEFAULT
        !          9365: MPI_TYPE                             MSGFMT_STRIP_MSGCTXT
        !          9366: MSGFMT_STRIP_MSGID_PLURAL            MTOOLS_ENABLE_FLOPPYD
        !          9367: MV                                   MYSQL_CHARSET
        !          9368: MYSQL_DATADIR                        MYSQL_EXTRA_CHARSET
        !          9369: MYSQL_GROUP                          MYSQL_USER
        !          9370: MYSQL_VERSION                        MYSQL_VERSIONS_ACCEPTED
        !          9371: MYSQL_VERSIONS_ALL                   MYSQL_VERSION_DEFAULT
        !          9372: NAGIOSCMD_GROUP                      NAGIOSDIR
        !          9373: NAGIOS_GROUP                         NAGIOS_USER
        !          9374: NATIVE_APPEND_ABI                    NATIVE_APPEND_ELF
        !          9375: NATIVE_EXEC_FMT                      NATIVE_MACHINE_PLATFORM
        !          9376: NATIVE_OBJECT_FMT                    NBPAX_PROGRAM_PREFIX
        !          9377: NETBSD_LOGIN_NAME                    NMH_EDITOR
        !          9378: NMH_MTA                              NMH_PAGER
        !          9379: NOLOGIN                              NOTE
        !          9380: NOT_FOR_PLATFORM                     NOT_PAX_ASLR_SAFE
        !          9381: NOT_PAX_MPROTECT_SAFE                NO_BUILD
        !          9382: NO_CHECKSUM                          NO_CONFIGURE
        !          9383: NO_SKIP                              NS_PREFERRED
        !          9384: NULLMAILER_GROUP                     NULLMAILER_USER
        !          9385: OASIS                                OASIS_BUILD_ARGS
        !          9386: OBJHOSTNAME                          OBJMACHINE
        !          9387: OCAML_FINDLIB_DIRS                   OCAML_FINDLIB_REGISTER
        !          9388: OCAML_FINDLIB_REGISTER_VERBOSE       OCAML_SITELIBDIR
        !          9389: OCAML_TOPKG_DOCDIR                   OCAML_USE_DUNE
        !          9390: OCAML_USE_FINDLIB                    OCAML_USE_JBUILDER
        !          9391: OCAML_USE_OASIS                      OCAML_USE_OASIS_DYNRUN
        !          9392: OCAML_USE_OPAM                       OCAML_USE_OPT_COMPILER
        !          9393: OCAML_USE_TOPKG                      OMF
        !          9394: ONLY_FOR_COMPILER                    ONLY_FOR_PLATFORM
        !          9395: OPENSSH_CHROOT                       OPENSSH_GROUP
        !          9396: OPENSSH_USER                         OPSYS
        !          9397: OPSYS_EMULDIR                        OS
        !          9398: OSS_TYPE                             OSX
        !          9399: OSX_TOLERATE_SDK_SKEW                OS_VARIANT
        !          9400: OS_VERSION                           OTF_FONTS_DIR
        !          9401: OVERRIDE_DIRDEPTH                    OVERRIDE_GEMSPEC
        !          9402: OVERRIDE_GNU_CONFIG_SCRIPTS          OWN_DIRS
        !          9403: OWN_DIRS_PERMS                       P4GROUP
        !          9404: P4PORT                               P4ROOT
        !          9405: P4USER                               PACKAGES
        !          9406: PALMOS_DEFAULT_SDK                   PAMBASE
        !          9407: PAM_DEFAULT                          PAPERSIZE
        !          9408: PASSIVE_FETCH                        PATCHDIR
        !          9409: PATCHFILES                           PATCH_ARGS
        !          9410: PATCH_DEBUG                          PATCH_DIST_ARGS
        !          9411: PATCH_DIST_CAT                       PATCH_DIST_STRIP
        !          9412: PATCH_FUZZ_FACTOR                    PATCH_STRIP
        !          9413: PATH                                 PCCBASE
        !          9414: PEAR_CMD                             PEAR_LIB
        !          9415: PEAR_PACKAGE_XML                     PERL5
        !          9416: PERL5_CONFIGURE                      PERL5_CONFIGURE_DIRS
        !          9417: PERL5_LDFLAGS                        PERL5_LICENSE
        !          9418: PERL5_MODULE_TYPE                    PERL5_PACKLIST
        !          9419: PERL5_PACKLIST_DIR                   PERL5_PERLBASE
        !          9420: PERL5_SITEBASE                       PERL5_USE_PACKLIST
        !          9421: PERL5_VENDORBASE                     PFCTL
        !          9422: PFVAR_H                              PF_VERSION
        !          9423: PGGROUP                              PGHOME
        !          9424: PGPKGSRCDIR                          PGSQL_TYPE
        !          9425: PGSQL_VERSION                        PGSQL_VERSIONS_ACCEPTED
        !          9426: PGSQL_VERSION_DEFAULT                PGUSER
        !          9427: PG_LIB_EXT                           PHP
        !          9428: PHPCOMMON_MK                         PHPPKGSRCDIR
        !          9429: PHP_BASE_VERS                        PHP_CHECK_INSTALLED
        !          9430: PHP_EXTENSION_DIR                    PHP_INITIAL_TEENY
        !          9431: PHP_PKG_PREFIX                       PHP_VERSION
        !          9432: PHP_VERSIONS_ACCEPTED                PHP_VERSIONS_INCOMPATIBLE
        !          9433: PHP_VERSION_DEFAULT                  PHP_VERSION_REQD
        !          9434: PILRC_USE_GTK                        PKGCONFIG_BASE
        !          9435: PKGCONFIG_FILE                       PKGCONFIG_OVERRIDE
        !          9436: PKGCONFIG_OVERRIDE_STAGE             PKGDIR
        !          9437: PKGGNUDIR                            PKGINFODIR
        !          9438: PKGLOCALEDIR                         PKGMANDIR
        !          9439: PKGNAME                              PKGNAME_REQD
        !          9440: PKGPATH                              PKGREVISION
        !          9441: PKGSRC_BLAS_TYPES                    PKGSRC_CHANGES
        !          9442: PKGSRC_COMPILER                      PKGSRC_KEEP_BIN_PKGS
        !          9443: PKGSRC_LOCKTYPE                      PKGSRC_MAKE_ENV
        !          9444: PKGSRC_MESSAGE_RECIPIENTS            PKGSRC_MKPIE
        !          9445: PKGSRC_MKREPRO                       PKGSRC_RUN_TEST
        !          9446: PKGSRC_SETENV                        PKGSRC_SLEEPSECS
        !          9447: PKGSRC_TODO                          PKGSRC_USE_CTF
        !          9448: PKGSRC_USE_FORTIFY                   PKGSRC_USE_RELRO
        !          9449: PKGSRC_USE_SSP                       PKGSRC_USE_STACK_CHECK
        !          9450: PKGTASKS_DATAFILE                    PKGTOOLS_ARGS
        !          9451: PKGTOOLS_ENV                         PKG_ALTERNATIVES
        !          9452: PKG_APACHE                           PKG_APACHE_ACCEPTED
        !          9453: PKG_APACHE_DEFAULT                   PKG_BEST_EXISTS
        !          9454: PKG_BUILD_OPTIONS                    PKG_COMPRESSION
        !          9455: PKG_CONFIG                           PKG_CONFIG_PERMS
        !          9456: PKG_CREATE_USERGROUP                 PKG_DB_TMPDIR
        !          9457: PKG_DEBUG_LEVEL                      PKG_DEFAULT_OPTIONS
        !          9458: PKG_DESTDIR_SUPPORT                  PKG_DEVELOPER
        !          9459: PKG_DISABLED_OPTIONS                 PKG_FATAL_ERRORS
        !          9460: PKG_FC                               PKG_FILELIST_CMD
        !          9461: PKG_GECOS                            PKG_GID
        !          9462: PKG_GROUPS                           PKG_GROUPS_VARS
        !          9463: PKG_HOME                             PKG_INIT_SCRIPTS
        !          9464: PKG_JAVA_HOME                        PKG_JVM
        !          9465: PKG_JVMS_ACCEPTED                    PKG_JVM_DEFAULT
        !          9466: PKG_LEGACY_OPTIONS                   PKG_LIBTOOL
        !          9467: PKG_OPTIONS                          PKG_OPTIONS_DEPRECATED_WARNINGS
        !          9468: PKG_OPTIONS_LEGACY_OPTS              PKG_OPTIONS_LEGACY_VARS
        !          9469: PKG_OPTIONS_NONEMPTY_SETS            PKG_OPTIONS_OPTIONAL_GROUPS
        !          9470: PKG_OPTIONS_REQUIRED_GROUPS          PKG_OPTIONS_VAR
        !          9471: PKG_PHP                              PKG_PHP_MAJOR_VERS
        !          9472: PKG_PHP_VERSION                      PKG_RCD_SCRIPTS
        !          9473: PKG_REFCOUNT_DBDIR                   PKG_REGISTER_SHELLS
        !          9474: PKG_RESUME_TRANSFERS                 PKG_SHELL
        !          9475: PKG_SUGGESTED_OPTIONS                PKG_SUPPORTED_OPTIONS
        !          9476: PKG_SYSCONFBASE                      PKG_SYSCONFBASEDIR
        !          9477: PKG_SYSCONFDIR                       PKG_SYSCONFDIR_PERMS
        !          9478: PKG_SYSCONFSUBDIR                    PKG_SYSCONFVAR
        !          9479: PKG_TOOLS_BIN                        PKG_UID
        !          9480: PKG_UPDATE_FONTS_DB                  PKG_USERS
        !          9481: PKG_USERS_VARS                       PKG_VERBOSE
        !          9482: PLEASE                               PLIST
        !          9483: PLIST_AWK                            PLIST_AWK_ENV
        !          9484: PLIST_SRC                            PLIST_SUBST
        !          9485: PLIST_TYPE                           PLIST_VARS
        !          9486: POPTOP_USE_MPPE                      POSSIBLE_GFORTRAN_VERSION
        !          9487: POST_FETCH_HOOK                      PREFER
        !          9488: PREFER_NATIVE                        PREFER_NATIVE_PTHREADS
        !          9489: PREFER_PKGSRC                        PREFIX
        !          9490: PREPEND_PATH                         PRE_ROOT_CMD
        !          9491: PRIVILEGED_STAGES                    PS
        !          9492: PTHREAD_AUTO_VARS                    PTHREAD_CFLAGS
        !          9493: PTHREAD_LDFLAGS                      PTHREAD_LIBS
        !          9494: PTHREAD_OPTS                         PTHREAD_TYPE
        !          9495: PVM_SSH                              PYPKGPREFIX
        !          9496: PYTHON_FOR_BUILD_ONLY                PYTHON_SELF_CONFLICT
        !          9497: PYTHON_VERSIONED_DEPENDENCIES        PYTHON_VERSIONS_ACCEPTED
        !          9498: PYTHON_VERSIONS_INCOMPATIBLE         PYTHON_VERSION_DEFAULT
        !          9499: PYTHON_VERSION_REQD                  PYVERSSUFFIX
        !          9500: PY_NO_EGG                            QMAILDIR
        !          9501: QMAIL_ALIAS_USER                     QMAIL_DAEMON_USER
        !          9502: QMAIL_LOG_USER                       QMAIL_NOFILES_GROUP
        !          9503: QMAIL_PASSWD_USER                    QMAIL_QMAIL_GROUP
        !          9504: QMAIL_QUEUE_DIR                      QMAIL_QUEUE_EXTRA
        !          9505: QMAIL_QUEUE_USER                     QMAIL_REMOTE_USER
        !          9506: QMAIL_ROOT_USER                      QMAIL_SEND_USER
        !          9507: QPOPPER_FAC                          QPOPPER_SPOOL_DIR
        !          9508: QPOPPER_USER                         RAKE_NAME
        !          9509: RASMOL_DEPTH                         RCD_SCRIPTS
        !          9510: RCD_SCRIPTS_DIR                      RCD_SCRIPTS_EXAMPLEDIR
        !          9511: RCD_SCRIPTS_MODE                     RCD_SCRIPTS_SHELL
        !          9512: RCD_SCRIPT_SRC                       RDOC
        !          9513: READLINE_DEFAULT                     READLINE_TYPE
        !          9514: REAL_ROOT_GROUP                      REAL_ROOT_USER
        !          9515: RECURSIVE_MAKE                       RELAY_CTRL_DIR
        !          9516: RELRO_SUPPORTED                      REPLACE_AWK
        !          9517: REPLACE_BASH                         REPLACE_CSH
        !          9518: REPLACE_KSH                          REPLACE_PERL
        !          9519: REPLACE_PERL6                        REPLACE_PHP
        !          9520: REPLACE_PYTHON                       REPLACE_RUBY
        !          9521: REPLACE_RUBY_DIRS                    REPLACE_RUBY_PAT
        !          9522: REPLACE_SH                           REPLACE_TEXLUA
        !          9523: REQD_DIRS                            REQD_DIRS_PERMS
        !          9524: REQD_FILES                           REQD_FILES_MODE
        !          9525: REQD_FILES_PERMS                     RESOLV_AUTO_VARS
        !          9526: RESOLV_LDFLAGS                       RESOLV_LIBS
        !          9527: RM                                   ROOT_CMD
        !          9528: ROOT_GROUP                           ROOT_USER
        !          9529: RPCGEN                               RPM
        !          9530: RPM2PKG_PLIST                        RPM2PKG_PREFIX
        !          9531: RPM2PKG_STAGE                        RPM2PKG_STRIP
        !          9532: RPM2PKG_SUBPREFIX                    RPMFILES
        !          9533: RPMIGNOREPATH                        RPM_DB_PREFIX
        !          9534: RSSH_CVS_PATH                        RSSH_RDIST_PATH
        !          9535: RSSH_RSYNC_PATH                      RSSH_SCP_PATH
        !          9536: RSSH_SFTP_SERVER_PATH                RUBY
        !          9537: RUBYGEM                              RUBYGEM_NAME
        !          9538: RUBYGEM_OPTIONS                      RUBYGEM_VERBOSE
        !          9539: RUBY_ABI_VERSION                     RUBY_ARCH
        !          9540: RUBY_ARCHINC                         RUBY_ARCHLIB
        !          9541: RUBY_BASE                            RUBY_BASERIDIR
        !          9542: RUBY_BUILD_DOCUMENT                  RUBY_DLEXT
        !          9543: RUBY_DOC                             RUBY_DYNAMIC_DIRS
        !          9544: RUBY_EG                              RUBY_ENCODING_ARG
        !          9545: RUBY_EXTCONF                         RUBY_EXTCONF_CHECK
        !          9546: RUBY_EXTCONF_DEBUG                   RUBY_EXTCONF_MAKEFILE
        !          9547: RUBY_GEM_BASE                        RUBY_INC
        !          9548: RUBY_LIB                             RUBY_LIB_BASE
        !          9549: RUBY_NAME                            RUBY_NOVERSION
        !          9550: RUBY_PKGPREFIX                       RUBY_RAILS
        !          9551: RUBY_RAILS52_VERSION                 RUBY_RAILS60_VERSION
        !          9552: RUBY_RAILS61_VERSION                 RUBY_RAILS_ACCEPTED
        !          9553: RUBY_RAILS_DEFAULT                   RUBY_RAILS_REQD
        !          9554: RUBY_RAILS_STRICT_DEP                RUBY_RIDIR
        !          9555: RUBY_SETUP                           RUBY_SHLIB
        !          9556: RUBY_SHLIBALIAS                      RUBY_SHLIBVER
        !          9557: RUBY_SIMPLE_INSTALL                  RUBY_SITEARCHLIB
        !          9558: RUBY_SITELIB                         RUBY_SITELIB_BASE
        !          9559: RUBY_SITERIDIR                       RUBY_SLEXT
        !          9560: RUBY_SRCDIR                          RUBY_STATICLIB
        !          9561: RUBY_SUFFIX                          RUBY_SYSRIDIR
        !          9562: RUBY_USE_PTHREAD                     RUBY_VENDORARCHLIB
        !          9563: RUBY_VENDORLIB                       RUBY_VENDORLIB_BASE
        !          9564: RUBY_VER                             RUBY_VERSION
        !          9565: RUBY_VERSIONS_ACCEPTED               RUBY_VERSIONS_INCOMPATIBLE
        !          9566: RUBY_VERSION_DEFAULT                 RUBY_VERSION_REQD
        !          9567: RUBY_VER_DIR                         RUN
        !          9568: RUN_LDCONFIG                         SAWFISH_THEMES
        !          9569: SCO                                  SCREWS_GROUP
        !          9570: SCREWS_USER                          SCRIPTS_ENV
        !          9571: SCROLLKEEPER_DATADIR                 SCROLLKEEPER_REBUILDDB
        !          9572: SCROLLKEEPER_UPDATEDB                SDIST_PAWD
        !          9573: SERIAL_DEVICES                       SETGIDGAME
        !          9574: SETGID_GAMES_PERMS                   SETUID_ROOT_PERMS
        !          9575: SH                                   SHLIB
        !          9576: SIGN_PACKAGES                        SILC_CLIENT_WITH_PERL
        !          9577: SITE_SPECIFIC_PKGS                   SKIP_DEPENDS
        !          9578: SMF_INSTANCES                        SMF_MANIFEST
        !          9579: SMF_METHODS                          SMF_METHOD_SHELL
        !          9580: SMF_METHOD_SRC                       SMF_NAME
        !          9581: SMF_PREFIX                           SMF_SRCDIR
        !          9582: SNIPROXY_GROUP                       SNIPROXY_USER
        !          9583: SOURCE_BUFFSIZE                      SPECIAL_PERMS
        !          9584: SPECIFIC_PKGS                        SSH_SUID
        !          9585: SSP_SUPPORTED                        SSYNC_PAWD
        !          9586: STEP_MSG                             STRIP
        !          9587: STRIP_DBG                            STRIP_DEBUG
        !          9588: STRIP_DEBUG_SUPPORTED                STRIP_FILES_SKIP
        !          9589: SU                                   SUBDIR
        !          9590: SUBST                                SUBST_CLASSES
        !          9591: SUBST_FILES                          SUBST_FILTER_CMD
        !          9592: SUBST_MESSAGE                        SUBST_NOOP_OK
        !          9593: SUBST_SED                            SUBST_SHOW_DIFF
        !          9594: SUBST_SKIP_TEXT_CHECK                SUBST_STAGE
        !          9595: SUBST_VARS                           SUNWSPROBASE
        !          9596: SUSE_PREFER                          SU_CMD
        !          9597: SYSCONFBASE                          TBL
        !          9598: TERMCAP_TYPE                         TERMINFO_DEFAULT
        !          9599: TERMINFO_TYPE                        TEST
        !          9600: TEST_DEPENDS                         TEST_DIRS
        !          9601: TEST_ENV                             TEST_ENV_SHELL
        !          9602: TEST_MAKE_CMD                        TEST_MAKE_FLAGS
        !          9603: TEST_TARGET                          TEXLIVE_IGNORE_PATTERNS
        !          9604: TEXLIVE_REV                          TEXLIVE_UNVERSIONED
        !          9605: TEXMFSITE                            TEX_FORMATS
        !          9606: TEX_HYPHEN_DAT                       TEX_HYPHEN_DEF
        !          9607: TEX_TEXMF_DIRS                       THTTPD_LOG_FACILITY
        !          9608: TINYDYN_USER                         TO
        !          9609: TOOLS_ALIASES                        TOOLS_ALWAYS_WRAP
        !          9610: TOOLS_ARGS                           TOOLS_BROKEN
        !          9611: TOOLS_CMD                            TOOLS_CMDLINE_SED
        !          9612: TOOLS_CREATE                         TOOLS_DIR
        !          9613: TOOLS_FAIL                           TOOLS_GNU_MISSING
        !          9614: TOOLS_LDCONFIG                       TOOLS_NOOP
        !          9615: TOOLS_PATH                           TOOLS_SCRIPT
        !          9616: TOOL_DEPENDS                         TTF_FONTS_DIR
        !          9617: TYPE                                 UAC_REQD_EXECS
        !          9618: UCSPI_SSL_GROUP                      UCSPI_SSL_USER
        !          9619: UNLIMIT_RESOURCES                    UNPRIVILEGED
        !          9620: UNPRIVILEGED_GROUP                   UNPRIVILEGED_GROUPS
        !          9621: UNPRIVILEGED_USER                    UNWRAP_FILES
        !          9622: UNWRAP_PATTERNS                      UPDATE_GEMSPEC
        !          9623: UPDATE_TARGET                        URI
        !          9624: USERGROUP_PHASE                      USERPPP_GROUP
        !          9625: USER_SPECIFIC_PKGS                   USE_ABI_DEPENDS
        !          9626: USE_APR                              USE_BSD_MAKEFILE
        !          9627: USE_BUILTIN                          USE_CROSS_COMPILE
        !          9628: USE_CURSES                           USE_CWRAPPERS
        !          9629: USE_DB185                            USE_FEATURES
        !          9630: USE_GAMESGROUP                       USE_GCC_RUNTIME
        !          9631: USE_IMAKE                            USE_JAVA
        !          9632: USE_JAVA2                            USE_LANGUAGES
        !          9633: USE_LIBTOOL                          USE_NATIVE_GCC
        !          9634: USE_NETBSD_REPO                      USE_PKGSRC_GCC
        !          9635: USE_PKGSRC_GCC_RUNTIME               USE_PKGTASKS
        !          9636: USE_PKG_ADMIN_DIGEST                 USE_RUBY_EXTCONF
        !          9637: USE_RUBY_INSTALL                     USE_RUBY_SETUP
        !          9638: USE_RUBY_SETUP_PKG                   USE_TOOLS
        !          9639: UUCP_GROUP                           UUCP_USER
        !          9640: VARBASE                              VARNAME
        !          9641: VIM_EXTRA_OPTS                       WARNING_MSG
        !          9642: WCALC_CGIDIR                         WCALC_CGIPATH
        !          9643: WCALC_HTMLDIR                        WCALC_HTMLPATH
        !          9644: WDM_MANAGERS                         WRAPPER_CC
        !          9645: WRAPPER_REORDER_CMDS                 WRKDIR
        !          9646: WRKDIR_BASENAME                      WRKDIR_LOCKTYPE
        !          9647: WRKLOG                               WRKOBJDIR
        !          9648: WRKSRC                               X10_PORT
        !          9649: X11                                  X11BASE
        !          9650: X11_PKGSRCDIR                        X11_TYPE
        !          9651: X509_CERTIFICATE                     X509_KEY
        !          9652: XAW_TYPE                             XLOCK_DEFAULT_MODE
        !          9653: XMKMF                                XMKMF_FLAGS
        !          9654: XXX                                  YES
        !          9655: ZSH_STATIC                           __stdc__
        !          9656: _vargroups                           accept
        !          9657: acquire-localbase-lock               acquire-lock
        !          9658: add                                  administrator
        !          9659: alloca                               alternatives
        !          9660: aslr                                 asprintf
        !          9661: atlas                                autoconf
        !          9662: automake                             autoreconf
        !          9663: awk                                  bash
        !          9664: big-endian                           bin-install
        !          9665: bind                                 binpkg-list
        !          9666: blas                                 bootstrap-depends
        !          9667: broken                               broken_on_platform
        !          9668: bsd                                  bsd.prog.mk
        !          9669: build                                build-env
        !          9670: buildlink-directories                buildlink-oss-soundcard-h
        !          9671: c                                    c++
        !          9672: ccache                               cce
        !          9673: cdefs                                ceil
        !          9674: changes                              changes-entry
        !          9675: changes-entry-noupdate               check
        !          9676: check-clean                          check-files
        !          9677: check-files-clean                    check-vulnerable
        !          9678: checksum                             checksum-phase
        !          9679: clean                                clean-depends
        !          9680: cleandir                             commit
        !          9681: commit-changes-entry                 compact
        !          9682: compiler                             conf
        !          9683: config.guess                         config.sub
        !          9684: configuration                        configure
        !          9685: configure-env                        configure-help
        !          9686: configure_args                       connect
        !          9687: cos                                  cputime
        !          9688: create-usergroup                     csh
        !          9689: ctf                                  debug
        !          9690: declaration                          declare
        !          9691: defined                              depend
        !          9692: dependencies                         depends
        !          9693: depends-checksum                     depends-fetch
        !          9694: deps                                 describe
        !          9695: destdir                              disable
        !          9696: distclean                            distinfo
        !          9697: dl                                   dlopen
        !          9698: do-build                             do-buildlink
        !          9699: do-clean                             do-configure
        !          9700: do-configure-post-hook               do-extract
        !          9701: do-fetch                             emul
        !          9702: emul-distinfo                        emul-fetch
        !          9703: emulation                            emulator
        !          9704: enable                               endian
        !          9705: enomem                               err
        !          9706: errx                                 etc
        !          9707: exp                                  extract-rpm
        !          9708: fabs                                 feature
        !          9709: features                             fetch
        !          9710: fetch-list                           follows
        !          9711: forbids                              form
        !          9712: format                               fortify
        !          9713: fortify_source                       friend
        !          9714: fts                                  fts_close
        !          9715: fts_open                             fts_read
        !          9716: fts_set                              gcc
        !          9717: gethostbyaddr                        gethostbyname
        !          9718: gethostbyname2                       getopt_long
        !          9719: getprogname                          getservbyname
        !          9720: getservbyport                        getservent
        !          9721: gettext                              github
        !          9722: glob                                 gnu
        !          9723: gnu_configure_strict                 go
        !          9724: go-deps                              golang
        !          9725: guess-license                        hashbang
        !          9726: heimdal                              help
        !          9727: imake                                increment
        !          9728: inet_aton                            interp
        !          9729: interpreter                          intl
        !          9730: ip4                                  ip6
        !          9731: ipv4                                 ipv6
        !          9732: iso                                  kerberos
        !          9733: krb                                  krb5
        !          9734: ksh                                  lapack
        !          9735: latex                                libintl_bindtextdomain
        !          9736: libintl_gettext                      libintl_textdomain
        !          9737: libnbcompat                          libs
        !          9738: libtool                              licence
        !          9739: license                              lintl
        !          9740: little-endian                        lock
        !          9741: locking                              lvalue
        !          9742: make                                 makesum
        !          9743: memory                               meta
        !          9744: meta-package                         meta_package
        !          9745: mit-krb5                             mk.conf
        !          9746: mkl                                  mount
        !          9747: mprotect                             mremap
        !          9748: nb                                   nbcompat
        !          9749: obstack                              obstack_ptr_grow
        !          9750: occurs                               only
        !          9751: openblas                             options
        !          9752: options.mk                           order
        !          9753: override                             override-intltool
        !          9754: override-message-intltool            package
        !          9755: parallel                             path
        !          9756: pax                                  paxctl
        !          9757: pbulk-index                          pc
        !          9758: perl                                 perl5
        !          9759: perms                                php
        !          9760: pkg-build-options                    pkg-config
        !          9761: pkg_build_options                    platform
        !          9762: plist                                post-extract
        !          9763: post-fetch                           post-wrapper
        !          9764: pre-build-checks-hook                pre-configure
        !          9765: pre-configure-checks-hook            pre-extract
        !          9766: pre-fetch                            print-go-deps
        !          9767: print-plist                          print-summary-data
        !          9768: privileged-install-hook              pypi
        !          9769: python                               readme-all
        !          9770: recv                                 recvfrom
        !          9771: regcomp                              release-localbase-lock
        !          9772: release-lock                         relro
        !          9773: rename                               reorder
        !          9774: replace                              replace_interpreter
        !          9775: reproducible                         resolv
        !          9776: root                                 ruby
        !          9777: send                                 sendfile
        !          9778: sendto                               setenv
        !          9779: setgid                               setprogname
        !          9780: setuid                               sh
        !          9781: shebang                              show
        !          9782: show-all                             show-build-defs
        !          9783: show-depends                         show-deps
        !          9784: show-distfiles                       show-downlevel
        !          9785: show-subdir-var                      show-tools
        !          9786: show-var                             show-vars
        !          9787: snprintf                             socket
        !          9788: ssp                                  st_mode
        !          9789: stage-install                        strcasestr
        !          9790: strict                               strip
        !          9791: strndup                              strnlen
        !          9792: strsep                               subst
        !          9793: substitutions                        sun
        !          9794: sunpro                               sunwspro
        !          9795: symlink                              test
        !          9796: test-env                             tex
        !          9797: texlive                              tmp
        !          9798: tool                                 tools
        !          9799: tools-libtool-m4-override            type
        !          9800: ulimit                               undefined
        !          9801: undo-replace                         unlimit
        !          9802: unprivileged                         unprivileged-install-hook
        !          9803: unstripped                           update
        !          9804: upload                               upload-distfiles
        !          9805: use_tools                            user
        !          9806: utimes                               vasprintf
        !          9807: verbose                              vsnprintf
        !          9808: warn                                 warning
        !          9809: warnings                             warnx
        !          9810: wattr_off                            wattr_on
        !          9811: work                                 wrapper
        !          9812: wrkdir                                
1.154     rillig   9813: 
                   9814: Appendix E. Editing guidelines for the pkgsrc guide
1.1       dsieger  9815: 
                   9816: Table of Contents
                   9817: 
1.154     rillig   9818: E.1. Make targets
                   9819: E.2. Procedure
1.1       dsieger  9820: 
                   9821: This section contains information on editing the pkgsrc guide itself.
                   9822: 
1.154     rillig   9823: E.1. Make targets
1.1       dsieger  9824: 
                   9825: The pkgsrc guide's source code is stored in pkgsrc/doc/guide/files, and several
                   9826: files are created from it:
                   9827: 
                   9828:   * pkgsrc/doc/pkgsrc.txt
                   9829: 
                   9830:   * pkgsrc/doc/pkgsrc.html
                   9831: 
1.174     leot     9832:   * https://www.NetBSD.org/docs/pkgsrc/
1.1       dsieger  9833: 
1.174     leot     9834:   * https://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf: The PDF version of the
                   9835:     pkgsrc guide.
1.1       dsieger  9836: 
1.174     leot     9837:   * https://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps: PostScript version of the
1.2       rillig   9838:     pkgsrc guide.
1.1       dsieger  9839: 
1.154     rillig   9840: E.2. Procedure
1.1       dsieger  9841: 
                   9842: The procedure to edit the pkgsrc guide is:
                   9843: 
1.190     bacon    9844:  1. Make sure you have checked out the htdocs repository into a sibling
                   9845:     directory of your pkgsrc directory. You will need the ability to commit
                   9846:     from both pkgsrc and htdocs.
                   9847: 
                   9848:  2. Make sure you have the packages needed to regenerate the pkgsrc guide (and
1.46      obache   9849:     other XML-based NetBSD documentation) installed. These are automatically
                   9850:     installed when you install the meta-pkgs/pkgsrc-guide-tools package.
1.1       dsieger  9851: 
1.190     bacon    9852:  3. Run cd doc/guide to get to the right directory. All further steps will take
1.1       dsieger  9853:     place here.
                   9854: 
1.190     bacon    9855:  4. Edit the XML file(s) in files/.
1.1       dsieger  9856: 
1.190     bacon    9857:  5. Run bmake to check the pkgsrc guide for valid XML and to build the final
1.1       dsieger  9858:     output files. If you get any errors at this stage, you can just edit the
                   9859:     files, as there are only symbolic links in the working directory, pointing
                   9860:     to the files in files/.
                   9861: 
1.190     bacon    9862:  6. (cd files && cvs commit)
1.1       dsieger  9863: 
1.190     bacon    9864:  7. Run bmake clean && bmake to regenerate the output files with the proper RCS
1.1       dsieger  9865:     Ids.
                   9866: 
1.190     bacon    9867:  8. Run bmake regen to install and commit the files in both pkgsrc/doc and
1.1       dsieger  9868:     htdocs.
                   9869: 
                   9870:     Note
                   9871: 
                   9872:     If you have added, removed or renamed some chapters, you need to
                   9873:     synchronize them using cvs add or cvs delete in the htdocs directory.
                   9874: 

CVSweb <webmaster@jp.NetBSD.org>