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

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

CVSweb <webmaster@jp.NetBSD.org>