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

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

CVSweb <webmaster@jp.NetBSD.org>