diff options
author | rillig <rillig@pkgsrc.org> | 2019-04-28 15:22:38 +0000 |
---|---|---|
committer | rillig <rillig@pkgsrc.org> | 2019-04-28 15:22:38 +0000 |
commit | 11ecc803873687b05d13707f9d8d06cf0a2484f7 (patch) | |
tree | 857831e2549b44d2d8d5d81743ccb11892a924c8 /doc/pkgsrc.txt | |
parent | d0afa28db92eada10921f615622feb25373c1cf0 (diff) | |
download | pkgsrc-11ecc803873687b05d13707f9d8d06cf0a2484f7.tar.gz |
doc/pkgsrc.*: regen
Diffstat (limited to 'doc/pkgsrc.txt')
-rw-r--r-- | doc/pkgsrc.txt | 5008 |
1 files changed, 3871 insertions, 1137 deletions
diff --git a/doc/pkgsrc.txt b/doc/pkgsrc.txt index 0dc7765deb8..6bb909bb8ea 100644 --- a/doc/pkgsrc.txt +++ b/doc/pkgsrc.txt @@ -14,7 +14,7 @@ The pkgsrc Developers Copyright 1994-2019 The NetBSD Foundation, Inc -$NetBSD: pkgsrc.xml,v 1.33 2019/01/01 02:50:23 jnemeth Exp $ +$NetBSD: pkgsrc.xml,v 1.34 2019/04/28 13:41:18 rillig Exp $ Abstract @@ -43,363 +43,365 @@ Table of Contents I. The pkgsrc user's guide - 2. Where to get pkgsrc and how to keep it up-to-date + 2. Getting help + 3. Where to get pkgsrc and how to keep it up-to-date - 2.1. Getting pkgsrc for the first time + 3.1. Getting pkgsrc for the first time - 2.1.1. As tar archive - 2.1.2. Via anonymous CVS + 3.1.1. As tar archive + 3.1.2. Via anonymous CVS - 2.2. Keeping pkgsrc up-to-date + 3.2. Keeping pkgsrc up-to-date - 2.2.1. Via tar files - 2.2.2. Via CVS + 3.2.1. Via tar files + 3.2.2. Via CVS - 3. Using pkgsrc on systems other than NetBSD + 4. Using pkgsrc on systems other than NetBSD - 3.1. Binary distribution - 3.2. Bootstrapping pkgsrc + 4.1. Binary distribution + 4.2. Bootstrapping pkgsrc - 4. Using pkgsrc + 5. Using pkgsrc - 4.1. Using binary packages + 5.1. Using binary packages - 4.1.1. Finding binary packages - 4.1.2. Installing binary packages - 4.1.3. Deinstalling packages - 4.1.4. Getting information about installed packages - 4.1.5. Checking for security vulnerabilities in installed packages - 4.1.6. Finding if newer versions of your installed packages are in + 5.1.1. Finding binary packages + 5.1.2. Installing binary packages + 5.1.3. Deinstalling packages + 5.1.4. Getting information about installed packages + 5.1.5. Checking for security vulnerabilities in installed packages + 5.1.6. Finding if newer versions of your installed packages are in pkgsrc - 4.1.7. Other administrative functions + 5.1.7. Other administrative functions - 4.2. Building packages from source + 5.2. Building packages from source - 4.2.1. Requirements - 4.2.2. Fetching distfiles - 4.2.3. How to build and install + 5.2.1. Requirements + 5.2.2. Fetching distfiles + 5.2.3. How to build and install - 5. Configuring pkgsrc + 6. Configuring pkgsrc - 5.1. General configuration - 5.2. Variables affecting the build process - 5.3. Variables affecting the installation process - 5.4. Selecting and configuring the compiler + 6.1. General configuration + 6.2. Variables affecting the build process + 6.3. Variables affecting the installation process + 6.4. Selecting and configuring the compiler - 5.4.1. Selecting the compiler - 5.4.2. Additional flags to the compiler (CFLAGS) - 5.4.3. Additional flags to the linker (LDFLAGS) + 6.4.1. Selecting the compiler + 6.4.2. Additional flags to the compiler (CFLAGS) + 6.4.3. Additional flags to the linker (LDFLAGS) - 5.5. Developer/advanced settings - 5.6. Selecting Build Options + 6.5. Developer/advanced settings + 6.6. Selecting Build Options - 6. Creating binary packages + 7. Creating binary packages - 6.1. Building a single binary package - 6.2. Settings for creation of binary packages + 7.1. Building a single binary package + 7.2. Settings for creation of binary packages - 7. Creating binary packages for everything in pkgsrc (bulk builds) + 8. Creating binary packages for everything in pkgsrc (bulk builds) - 7.1. Preparations - 7.2. Running a pbulk-style bulk build + 8.1. Preparations + 8.2. Running a pbulk-style bulk build - 7.2.1. Configuration + 8.2.1. Configuration - 7.3. Requirements of a full bulk build - 7.4. Creating a multiple CD-ROM packages collection + 8.3. Requirements of a full bulk build + 8.4. Creating a multiple CD-ROM packages collection - 7.4.1. Example of cdpack + 8.4.1. Example of cdpack - 8. Directory layout of the installed files + 9. Directory layout of the installed files - 8.1. File system layout in ${LOCALBASE} - 8.2. File system layout in ${VARBASE} + 9.1. File system layout in ${LOCALBASE} + 9.2. File system layout in ${VARBASE} - 9. Frequently Asked Questions + 10. Frequently Asked Questions - 9.1. Are there any mailing lists for pkg-related discussion? - 9.2. Utilities for package management (pkgtools) - 9.3. How to use pkgsrc as non-root - 9.4. How to resume transfers when fetching distfiles? - 9.5. How can I install/use modular X.org from pkgsrc? - 9.6. How to fetch files from behind a firewall - 9.7. How to fetch files from HTTPS sites - 9.8. How do I tell make fetch to do passive FTP? - 9.9. How to fetch all distfiles at once - 9.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" + 10.1. Are there any mailing lists for pkg-related discussion? + 10.2. Utilities for package management (pkgtools) + 10.3. How to use pkgsrc as non-root + 10.4. How to resume transfers when fetching distfiles? + 10.5. How can I install/use modular X.org from pkgsrc? + 10.6. How to fetch files from behind a firewall + 10.7. How to fetch files from HTTPS sites + 10.8. How do I tell make fetch to do passive FTP? + 10.9. How to fetch all distfiles at once + 10.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean? - 9.11. What does "Could not find bsd.own.mk" mean? - 9.12. Using 'sudo' with pkgsrc - 9.13. How do I change the location of configuration files? - 9.14. Automated security checks - 9.15. Why do some packages ignore my CFLAGS? - 9.16. A package does not build. What shall I do? - 9.17. What does "Makefile appears to contain unresolved cvs/rcs/??? + 10.11. What does "Could not find bsd.own.mk" mean? + 10.12. Using 'sudo' with pkgsrc + 10.13. How do I change the location of configuration files? + 10.14. Automated security checks + 10.15. Why do some packages ignore my CFLAGS? + 10.16. A package does not build. What shall I do? + 10.17. What does "Makefile appears to contain unresolved cvs/rcs/??? merge conflicts" mean? II. The pkgsrc developer's guide - 10. Creating a new pkgsrc package from scratch + 11. Getting help + 12. Creating a new pkgsrc package from scratch - 10.1. Common types of packages + 12.1. Common types of packages - 10.1.1. Perl modules - 10.1.2. Python modules and programs + 12.1.1. Perl modules + 12.1.2. Python modules and programs - 10.2. Examples + 12.2. Examples - 10.2.1. How the www/nvu package came into pkgsrc + 12.2.1. How the www/nvu package came into pkgsrc - 11. Package components - files, directories and contents + 13. Package components - files, directories and contents - 11.1. Makefile - 11.2. distinfo - 11.3. patches/* + 13.1. Makefile + 13.2. distinfo + 13.3. patches/* - 11.3.1. Structure of a single patch file - 11.3.2. Creating patch files - 11.3.3. Sources where the patch files come from - 11.3.4. Patching guidelines - 11.3.5. Feedback to the author + 13.3.1. Structure of a single patch file + 13.3.2. Creating patch files + 13.3.3. Sources where the patch files come from + 13.3.4. Patching guidelines + 13.3.5. Feedback to the author - 11.4. Other mandatory files - 11.5. Optional files + 13.4. Other mandatory files + 13.5. Optional files - 11.5.1. Files affecting the binary package - 11.5.2. Files affecting the build process - 11.5.3. Files affecting nothing at all + 13.5.1. Files affecting the binary package + 13.5.2. Files affecting the build process + 13.5.3. Files affecting nothing at all - 11.6. work* - 11.7. files/* + 13.6. work* + 13.7. files/* - 12. Programming in Makefiles + 14. Programming in Makefiles - 12.1. Caveats - 12.2. Makefile variables + 14.1. Caveats + 14.2. Makefile variables - 12.2.1. Naming conventions + 14.2.1. Naming conventions - 12.3. Code snippets + 14.3. Code snippets - 12.3.1. Adding things to a list - 12.3.2. Echoing a string exactly as-is - 12.3.3. Passing CFLAGS to GNU configure scripts - 12.3.4. Handling possibly empty variables + 14.3.1. Adding things to a list + 14.3.2. Echoing a string exactly as-is + 14.3.3. Passing CFLAGS to GNU configure scripts + 14.3.4. Handling possibly empty variables - 13. PLIST issues + 15. PLIST issues - 13.1. RCS ID - 13.2. Semi-automatic PLIST generation - 13.3. Tweaking output of make print-PLIST - 13.4. Variable substitution in PLIST - 13.5. Man page compression - 13.6. Changing PLIST source with PLIST_SRC - 13.7. Platform-specific and differing PLISTs - 13.8. Build-specific PLISTs - 13.9. Sharing directories between packages + 15.1. RCS ID + 15.2. Semi-automatic PLIST generation + 15.3. Tweaking output of make print-PLIST + 15.4. Variable substitution in PLIST + 15.5. Man page compression + 15.6. Changing PLIST source with PLIST_SRC + 15.7. Platform-specific and differing PLISTs + 15.8. Build-specific PLISTs + 15.9. Sharing directories between packages - 14. Buildlink methodology + 16. Buildlink methodology - 14.1. Converting packages to use buildlink3 - 14.2. Writing buildlink3.mk files + 16.1. Converting packages to use buildlink3 + 16.2. Writing buildlink3.mk files - 14.2.1. Anatomy of a buildlink3.mk file - 14.2.2. Updating BUILDLINK_API_DEPENDS.pkg and + 16.2.1. Anatomy of a buildlink3.mk file + 16.2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS.pkg in buildlink3.mk files - 14.3. Writing builtin.mk files + 16.3. Writing builtin.mk files - 14.3.1. Anatomy of a builtin.mk file - 14.3.2. Global preferences for native or pkgsrc software + 16.3.1. Anatomy of a builtin.mk file + 16.3.2. Global preferences for native or pkgsrc software - 15. The pkginstall framework + 17. The pkginstall framework - 15.1. Files and directories outside the installation prefix + 17.1. Files and directories outside the installation prefix - 15.1.1. Directory manipulation - 15.1.2. File manipulation + 17.1.1. Directory manipulation + 17.1.2. File manipulation - 15.2. Configuration files + 17.2. Configuration files - 15.2.1. How PKG_SYSCONFDIR is set - 15.2.2. Telling the software where configuration files are - 15.2.3. Patching installations - 15.2.4. Disabling handling of configuration files + 17.2.1. How PKG_SYSCONFDIR is set + 17.2.2. Telling the software where configuration files are + 17.2.3. Patching installations + 17.2.4. Disabling handling of configuration files - 15.3. System startup scripts + 17.3. System startup scripts - 15.3.1. Disabling handling of system startup scripts + 17.3.1. Disabling handling of system startup scripts - 15.4. System users and groups - 15.5. System shells + 17.4. System users and groups + 17.5. System shells - 15.5.1. Disabling shell registration + 17.5.1. Disabling shell registration - 15.6. Fonts + 17.6. Fonts - 15.6.1. Disabling automatic update of the fonts databases + 17.6.1. Disabling automatic update of the fonts databases - 16. Options handling + 18. Options handling - 16.1. Global default options - 16.2. Converting packages to use bsd.options.mk - 16.3. Option Names - 16.4. Determining the options of dependencies + 18.1. Global default options + 18.2. Converting packages to use bsd.options.mk + 18.3. Option Names + 18.4. Determining the options of dependencies - 17. The build process + 19. The build process - 17.1. Introduction - 17.2. Program location - 17.3. Directories used during the build process - 17.4. Running a phase - 17.5. The fetch phase + 19.1. Introduction + 19.2. Program location + 19.3. Directories used during the build process + 19.4. Running a phase + 19.5. The fetch phase - 17.5.1. What to fetch and where to get it from - 17.5.2. How are the files fetched? + 19.5.1. What to fetch and where to get it from + 19.5.2. How are the files fetched? - 17.6. The checksum phase - 17.7. The extract phase - 17.8. The patch phase - 17.9. The tools phase - 17.10. The wrapper phase - 17.11. The configure phase - 17.12. The build phase - 17.13. The test phase - 17.14. The install phase - 17.15. The package phase - 17.16. Cleaning up - 17.17. Other helpful targets + 19.6. The checksum phase + 19.7. The extract phase + 19.8. The patch phase + 19.9. The tools phase + 19.10. The wrapper phase + 19.11. The configure phase + 19.12. The build phase + 19.13. The test phase + 19.14. The install phase + 19.15. The package phase + 19.16. Cleaning up + 19.17. Other helpful targets - 18. Tools needed for building or running + 20. Tools needed for building or running - 18.1. Tools for pkgsrc builds - 18.2. Tools needed by packages - 18.3. Tools provided by platforms + 20.1. Tools for pkgsrc builds + 20.2. Tools needed by packages + 20.3. Tools provided by platforms - 19. Making your package work + 21. Making your package work - 19.1. General operation + 21.1. General operation - 19.1.1. How to pull in user-settable variables from mk.conf - 19.1.2. User interaction - 19.1.3. Handling licenses - 19.1.4. Restricted packages - 19.1.5. Handling dependencies - 19.1.6. Handling conflicts with other packages - 19.1.7. Packages that cannot or should not be built - 19.1.8. Packages which should not be deleted, once installed - 19.1.9. Handling packages with security problems - 19.1.10. How to handle incrementing versions when fixing an + 21.1.1. How to pull in user-settable variables from mk.conf + 21.1.2. User interaction + 21.1.3. Handling licenses + 21.1.4. Restricted packages + 21.1.5. Handling dependencies + 21.1.6. Handling conflicts with other packages + 21.1.7. Packages that cannot or should not be built + 21.1.8. Packages which should not be deleted, once installed + 21.1.9. Handling packages with security problems + 21.1.10. How to handle incrementing versions when fixing an existing package - 19.1.11. Substituting variable text in the package files (the SUBST + 21.1.11. Substituting variable text in the package files (the SUBST framework) - 19.2. The fetch phase + 21.2. The fetch phase - 19.2.1. Packages whose distfiles aren't available for plain + 21.2.1. Packages whose distfiles aren't available for plain downloading - 19.2.2. How to handle modified distfiles with the 'old' name - 19.2.3. Packages hosted on github.com - - 19.3. The configure phase - - 19.3.1. Shared libraries - libtool - 19.3.2. Using libtool on GNU packages that already support libtool - 19.3.3. GNU Autoconf/Automake - - 19.4. Programming languages - - 19.4.1. C, C++, and Fortran - 19.4.2. Java - 19.4.3. Packages containing perl scripts - 19.4.4. Packages containing shell scripts - 19.4.5. Other programming languages - - 19.5. The build phase - - 19.5.1. Compiling C and C++ code conditionally - 19.5.2. How to handle compiler bugs - 19.5.3. Undefined reference to "..." - 19.5.4. Running out of memory - - 19.6. The install phase - - 19.6.1. Creating needed directories - 19.6.2. Where to install documentation - 19.6.3. Installing highscore files - 19.6.4. Adding DESTDIR support to packages - 19.6.5. Packages with hardcoded paths to other interpreters - 19.6.6. Packages installing perl modules - 19.6.7. Packages installing info files - 19.6.8. Packages installing man pages - 19.6.9. Packages installing GConf data files - 19.6.10. Packages installing scrollkeeper/rarian data files - 19.6.11. Packages installing X11 fonts - 19.6.12. Packages installing GTK2 modules - 19.6.13. Packages installing SGML or XML data - 19.6.14. Packages installing extensions to the MIME database - 19.6.15. Packages using intltool - 19.6.16. Packages installing startup scripts - 19.6.17. Packages installing TeX modules - 19.6.18. Packages supporting running binaries in emulation - 19.6.19. Packages installing hicolor theme icons - 19.6.20. Packages installing desktop files - - 19.7. Marking packages as having problems - - 20. Debugging - 21. Submitting and Committing - - 21.1. Submitting binary packages - 21.2. Submitting source packages (for non-NetBSD-developers) - 21.3. General notes when adding, updating, or removing packages - 21.4. Commit Messages - 21.5. Committing: Adding a package to CVS - 21.6. Updating a package to a newer version - 21.7. Renaming a package in pkgsrc - 21.8. Moving a package in pkgsrc - - 22. Frequently Asked Questions - 23. GNOME packaging and porting - - 23.1. Meta packages - 23.2. Packaging a GNOME application - 23.3. Updating GNOME to a newer version - 23.4. Patching guidelines + 21.2.2. How to handle modified distfiles with the 'old' name + 21.2.3. Packages hosted on github.com + + 21.3. The configure phase + + 21.3.1. Shared libraries - libtool + 21.3.2. Using libtool on GNU packages that already support libtool + 21.3.3. GNU Autoconf/Automake + + 21.4. Programming languages + + 21.4.1. C, C++, and Fortran + 21.4.2. Java + 21.4.3. Packages containing perl scripts + 21.4.4. Packages containing shell scripts + 21.4.5. Other programming languages + + 21.5. The build phase + + 21.5.1. Compiling C and C++ code conditionally + 21.5.2. How to handle compiler bugs + 21.5.3. Undefined reference to "..." + 21.5.4. Running out of memory + + 21.6. The install phase + + 21.6.1. Creating needed directories + 21.6.2. Where to install documentation + 21.6.3. Installing highscore files + 21.6.4. Adding DESTDIR support to packages + 21.6.5. Packages with hardcoded paths to other interpreters + 21.6.6. Packages installing perl modules + 21.6.7. Packages installing info files + 21.6.8. Packages installing man pages + 21.6.9. Packages installing GConf data files + 21.6.10. Packages installing scrollkeeper/rarian data files + 21.6.11. Packages installing X11 fonts + 21.6.12. Packages installing GTK2 modules + 21.6.13. Packages installing SGML or XML data + 21.6.14. Packages installing extensions to the MIME database + 21.6.15. Packages using intltool + 21.6.16. Packages installing startup scripts + 21.6.17. Packages installing TeX modules + 21.6.18. Packages supporting running binaries in emulation + 21.6.19. Packages installing hicolor theme icons + 21.6.20. Packages installing desktop files + + 21.7. Marking packages as having problems + + 22. Debugging + 23. Submitting and Committing + + 23.1. Submitting binary packages + 23.2. Submitting source packages (for non-NetBSD-developers) + 23.3. General notes when adding, updating, or removing packages + 23.4. Commit Messages + 23.5. Committing: Adding a package to CVS + 23.6. Updating a package to a newer version + 23.7. Renaming a package in pkgsrc + 23.8. Moving a package in pkgsrc + + 24. Frequently Asked Questions + 25. GNOME packaging and porting + + 25.1. Meta packages + 25.2. Packaging a GNOME application + 25.3. Updating GNOME to a newer version + 25.4. Patching guidelines III. The pkgsrc infrastructure internals - 24. Design of the pkgsrc infrastructure + 26. Design of the pkgsrc infrastructure - 24.1. The meaning of variable definitions - 24.2. Avoiding problems before they arise - 24.3. Variable evaluation + 26.1. The meaning of variable definitions + 26.2. Avoiding problems before they arise + 26.3. Variable evaluation - 24.3.1. At load time - 24.3.2. At runtime + 26.3.1. At load time + 26.3.2. At runtime - 24.4. How can variables be specified? - 24.5. Designing interfaces for Makefile fragments + 26.4. How can variables be specified? + 26.5. Designing interfaces for Makefile fragments - 24.5.1. Procedures with parameters - 24.5.2. Actions taken on behalf of parameters + 26.5.1. Procedures with parameters + 26.5.2. Actions taken on behalf of parameters - 24.6. The order in which files are loaded + 26.6. The order in which files are loaded - 24.6.1. The order in bsd.prefs.mk - 24.6.2. The order in bsd.pkg.mk + 26.6.1. The order in bsd.prefs.mk + 26.6.2. The order in bsd.pkg.mk - 25. Regression tests + 27. Regression tests - 25.1. Running the regression tests - 25.2. Adding a new regression test + 27.1. Running the regression tests + 27.2. Adding a new regression test - 25.2.1. Overridable functions - 25.2.2. Helper functions + 27.2.1. Overridable functions + 27.2.2. Helper functions - 26. Porting pkgsrc + 28. Porting pkgsrc - 26.1. Porting pkgsrc to a new operating system + 28.1. Porting pkgsrc to a new operating system A. A simple example package: bison @@ -425,16 +427,17 @@ C. Directory layout of the pkgsrc FTP server C.4. reports: Bulk build reports C.5. current, stable, pkgsrc-20xxQy: source packages -D. Editing guidelines for the pkgsrc guide +D. Help topics +E. Editing guidelines for the pkgsrc guide - D.1. Make targets - D.2. Procedure + E.1. Make targets + E.2. Procedure List of Tables 1.1. Platforms supported by pkgsrc -11.1. Patching examples -23.1. PLIST handling for GNOME packages +13.1. Patching examples +25.1. PLIST handling for GNOME packages Chapter 1. What is pkgsrc? @@ -678,112 +681,132 @@ Part I. The pkgsrc user's guide Table of Contents -2. Where to get pkgsrc and how to keep it up-to-date +2. Getting help +3. Where to get pkgsrc and how to keep it up-to-date - 2.1. Getting pkgsrc for the first time + 3.1. Getting pkgsrc for the first time - 2.1.1. As tar archive - 2.1.2. Via anonymous CVS + 3.1.1. As tar archive + 3.1.2. Via anonymous CVS - 2.2. Keeping pkgsrc up-to-date + 3.2. Keeping pkgsrc up-to-date - 2.2.1. Via tar files - 2.2.2. Via CVS + 3.2.1. Via tar files + 3.2.2. Via CVS -3. Using pkgsrc on systems other than NetBSD +4. Using pkgsrc on systems other than NetBSD - 3.1. Binary distribution - 3.2. Bootstrapping pkgsrc + 4.1. Binary distribution + 4.2. Bootstrapping pkgsrc -4. Using pkgsrc +5. Using pkgsrc - 4.1. Using binary packages + 5.1. Using binary packages - 4.1.1. Finding binary packages - 4.1.2. Installing binary packages - 4.1.3. Deinstalling packages - 4.1.4. Getting information about installed packages - 4.1.5. Checking for security vulnerabilities in installed packages - 4.1.6. Finding if newer versions of your installed packages are in + 5.1.1. Finding binary packages + 5.1.2. Installing binary packages + 5.1.3. Deinstalling packages + 5.1.4. Getting information about installed packages + 5.1.5. Checking for security vulnerabilities in installed packages + 5.1.6. Finding if newer versions of your installed packages are in pkgsrc - 4.1.7. Other administrative functions + 5.1.7. Other administrative functions - 4.2. Building packages from source + 5.2. Building packages from source - 4.2.1. Requirements - 4.2.2. Fetching distfiles - 4.2.3. How to build and install + 5.2.1. Requirements + 5.2.2. Fetching distfiles + 5.2.3. How to build and install -5. Configuring pkgsrc +6. Configuring pkgsrc - 5.1. General configuration - 5.2. Variables affecting the build process - 5.3. Variables affecting the installation process - 5.4. Selecting and configuring the compiler + 6.1. General configuration + 6.2. Variables affecting the build process + 6.3. Variables affecting the installation process + 6.4. Selecting and configuring the compiler - 5.4.1. Selecting the compiler - 5.4.2. Additional flags to the compiler (CFLAGS) - 5.4.3. Additional flags to the linker (LDFLAGS) + 6.4.1. Selecting the compiler + 6.4.2. Additional flags to the compiler (CFLAGS) + 6.4.3. Additional flags to the linker (LDFLAGS) - 5.5. Developer/advanced settings - 5.6. Selecting Build Options + 6.5. Developer/advanced settings + 6.6. Selecting Build Options -6. Creating binary packages +7. Creating binary packages - 6.1. Building a single binary package - 6.2. Settings for creation of binary packages + 7.1. Building a single binary package + 7.2. Settings for creation of binary packages -7. Creating binary packages for everything in pkgsrc (bulk builds) +8. Creating binary packages for everything in pkgsrc (bulk builds) - 7.1. Preparations - 7.2. Running a pbulk-style bulk build + 8.1. Preparations + 8.2. Running a pbulk-style bulk build - 7.2.1. Configuration + 8.2.1. Configuration - 7.3. Requirements of a full bulk build - 7.4. Creating a multiple CD-ROM packages collection + 8.3. Requirements of a full bulk build + 8.4. Creating a multiple CD-ROM packages collection - 7.4.1. Example of cdpack + 8.4.1. Example of cdpack -8. Directory layout of the installed files +9. Directory layout of the installed files - 8.1. File system layout in ${LOCALBASE} - 8.2. File system layout in ${VARBASE} + 9.1. File system layout in ${LOCALBASE} + 9.2. File system layout in ${VARBASE} -9. Frequently Asked Questions +10. Frequently Asked Questions - 9.1. Are there any mailing lists for pkg-related discussion? - 9.2. Utilities for package management (pkgtools) - 9.3. How to use pkgsrc as non-root - 9.4. How to resume transfers when fetching distfiles? - 9.5. How can I install/use modular X.org from pkgsrc? - 9.6. How to fetch files from behind a firewall - 9.7. How to fetch files from HTTPS sites - 9.8. How do I tell make fetch to do passive FTP? - 9.9. How to fetch all distfiles at once - 9.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean? - 9.11. What does "Could not find bsd.own.mk" mean? - 9.12. Using 'sudo' with pkgsrc - 9.13. How do I change the location of configuration files? - 9.14. Automated security checks - 9.15. Why do some packages ignore my CFLAGS? - 9.16. A package does not build. What shall I do? - 9.17. What does "Makefile appears to contain unresolved cvs/rcs/??? merge + 10.1. Are there any mailing lists for pkg-related discussion? + 10.2. Utilities for package management (pkgtools) + 10.3. How to use pkgsrc as non-root + 10.4. How to resume transfers when fetching distfiles? + 10.5. How can I install/use modular X.org from pkgsrc? + 10.6. How to fetch files from behind a firewall + 10.7. How to fetch files from HTTPS sites + 10.8. How do I tell make fetch to do passive FTP? + 10.9. How to fetch all distfiles at once + 10.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean? + 10.11. What does "Could not find bsd.own.mk" mean? + 10.12. Using 'sudo' with pkgsrc + 10.13. How do I change the location of configuration files? + 10.14. Automated security checks + 10.15. Why do some packages ignore my CFLAGS? + 10.16. A package does not build. What shall I do? + 10.17. What does "Makefile appears to contain unresolved cvs/rcs/??? merge conflicts" mean? -Chapter 2. Where to get pkgsrc and how to keep it up-to-date +Chapter 2. Getting help + +To get help when using pkgsrc, the definitive source is this document, the +pkgsrc guide. If you don't find anything here, there are alternatives: + + * The built-in pkgsrc help, which is available after bootstrapping pkgsrc. + Run bmake help topic=? to get help for any topic, such as a variable name + like BUILD_DEFS, a make target like do-build, a missing C or C++ function + like strcasecmp or any other topic. + + The available help topics are listed in Appendix D, Help topics. + + * The pkgsrc-users mailing list, to which you can subscribe and then ask your + questions. + + * The #pkgsrc IRC channel, which is accessible via a web browser or by using + a specialized chat program such as XChat. Pick any user name and join the + channel #pkgsrc. + +Chapter 3. Where to get pkgsrc and how to keep it up-to-date Table of Contents -2.1. Getting pkgsrc for the first time +3.1. Getting pkgsrc for the first time - 2.1.1. As tar archive - 2.1.2. Via anonymous CVS + 3.1.1. As tar archive + 3.1.2. Via anonymous CVS -2.2. Keeping pkgsrc up-to-date +3.2. Keeping pkgsrc up-to-date - 2.2.1. Via tar files - 2.2.2. Via CVS + 3.2.1. Via tar files + 3.2.2. Via CVS Before you download and extract the files, you need to decide where you want to extract them. When using pkgsrc as root user, pkgsrc is usually installed in / @@ -793,7 +816,7 @@ contain white-space or other characters that are interpreted specially by the shell and some other programs. A safe bet is to use only letters, digits, underscores and dashes. -2.1. Getting pkgsrc for the first time +3.1. Getting pkgsrc for the first time Before you download any pkgsrc files, you should decide whether you want the current branch or the stable branch. The latter is forked on a quarterly basis @@ -807,7 +830,7 @@ a tar file or via CVS. Both ways are described here. Note that tar archive contains CVS working copy. Thus you can switch to using CVS at any later time. -2.1.1. As tar archive +3.1.1. As tar archive The primary download location for all pkgsrc files is https://cdn.NetBSD.org/ pub/pkgsrc/ or ftp://ftp.NetBSD.org/pub/pkgsrc/ (it points to the same @@ -843,7 +866,7 @@ To download pkgsrc-current, run: $ ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz -2.1.2. Via anonymous CVS +3.1.2. Via anonymous CVS To fetch a specific pkgsrc stable branch, run: @@ -885,13 +908,13 @@ diff -upN rdiff -u release -d -2.2. Keeping pkgsrc up-to-date +3.2. Keeping pkgsrc up-to-date The preferred way to keep pkgsrc up-to-date is via CVS (which also works if you have first installed it via a tar file). It saves bandwidth and hard disk activity, compared to downloading the tar file again. -2.2.1. Via tar files +3.2.1. Via tar files Warning @@ -905,14 +928,14 @@ strongly recommended. Note that by default the distfiles and the binary packages are saved in the pkgsrc tree, so don't forget to rescue them before updating. You can also configure pkgsrc to store distfiles and packages in directories outside the -pkgsrc tree by setting the DISTDIR and PACKAGES variables. See Chapter 5, +pkgsrc tree by setting the DISTDIR and PACKAGES variables. See Chapter 6, Configuring pkgsrc for the details. To update pkgsrc from a tar file, download the tar file as explained above. Then, make sure that you have not made any changes to the files in the pkgsrc directory. Remove the pkgsrc directory and extract the new tar file. Done. -2.2.2. Via CVS +3.2.2. Via CVS To update pkgsrc via CVS, change to the pkgsrc directory and run cvs: @@ -923,7 +946,7 @@ described above. E.g.: $ cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP -2.2.2.1. Switching between different pkgsrc branches +3.2.2.1. Switching between different pkgsrc branches When updating pkgsrc, the CVS program keeps track of the branch you selected. But if you, for whatever reason, want to switch from the stable branch to the @@ -931,7 +954,7 @@ current one, you can do it by adding the option "-A" after the "update" keyword. To switch from the current branch back to the stable branch, add the " -rpkgsrc-2019Q1" option. -2.2.2.2. What happens to my changes when updating? +3.2.2.2. What happens to my changes when updating? When you update pkgsrc, the CVS program will only touch those files that are registered in the CVS repository. That means that any packages that you created @@ -939,18 +962,18 @@ on your own will stay unmodified. If you change files that are managed by CVS, later updates will try to merge your changes with those that have been done by others. See the CVS manual, chapter "update" for details. -Chapter 3. Using pkgsrc on systems other than NetBSD +Chapter 4. Using pkgsrc on systems other than NetBSD Table of Contents -3.1. Binary distribution -3.2. Bootstrapping pkgsrc +4.1. Binary distribution +4.2. Bootstrapping pkgsrc -3.1. Binary distribution +4.1. Binary distribution -See Section 4.1, "Using binary packages". +See Section 5.1, "Using binary packages". -3.2. Bootstrapping pkgsrc +4.2. Bootstrapping pkgsrc pkgsrc can be bootstrapped for use in two different modes: privileged and unprivileged one. In unprivileged mode in contrast to privileged one all @@ -987,25 +1010,25 @@ It is possible to bootstrap multiple instances of pkgsrc using non-intersecting directories. Use bmake corresponding to the installation you're working with to build and install packages. -Chapter 4. Using pkgsrc +Chapter 5. Using pkgsrc Table of Contents -4.1. Using binary packages +5.1. Using binary packages - 4.1.1. Finding binary packages - 4.1.2. Installing binary packages - 4.1.3. Deinstalling packages - 4.1.4. Getting information about installed packages - 4.1.5. Checking for security vulnerabilities in installed packages - 4.1.6. Finding if newer versions of your installed packages are in pkgsrc - 4.1.7. Other administrative functions + 5.1.1. Finding binary packages + 5.1.2. Installing binary packages + 5.1.3. Deinstalling packages + 5.1.4. Getting information about installed packages + 5.1.5. Checking for security vulnerabilities in installed packages + 5.1.6. Finding if newer versions of your installed packages are in pkgsrc + 5.1.7. Other administrative functions -4.2. Building packages from source +5.2. Building packages from source - 4.2.1. Requirements - 4.2.2. Fetching distfiles - 4.2.3. How to build and install + 5.2.1. Requirements + 5.2.2. Fetching distfiles + 5.2.3. How to build and install Basically, there are two ways of using pkgsrc. The first is to only install the package tools and to use binary packages that someone else has prepared. This @@ -1013,7 +1036,7 @@ is the "pkg" in pkgsrc. The second way is to install the "src" of pkgsrc, too. Then you are able to build your own packages, and you can still use binary packages from someone else. -4.1. Using binary packages +5.1. Using binary packages On the cdn.NetBSD.org site and mirrors, there are collections of binary packages, ready to be installed. These binary packages have been built using @@ -1028,9 +1051,9 @@ the default settings for the directories, that is: If you cannot use these directories for whatever reasons (maybe because you're not root), you cannot use these binary packages, but have to build the packages -yourself, which is explained in Section 3.2, "Bootstrapping pkgsrc". +yourself, which is explained in Section 4.2, "Bootstrapping pkgsrc". -4.1.1. Finding binary packages +5.1.1. Finding binary packages To install binary packages, you first need to know from where to get them. The first place where you should look is on the main pkgsrc FTP server in the @@ -1048,7 +1071,7 @@ operating system already provides those tools. Download the file and extract it in the / directory. It will create the directories /usr/pkg (containing the tools for managing binary packages and the database of installed packages). -4.1.2. Installing binary packages +5.1.2. Installing binary packages In the directory from the last section, there is a subdirectory called All/, which contains all the binary packages that are available for the platform, @@ -1082,7 +1105,7 @@ that the vulnerabilities are acceptable for your configuration. After you've installed packages, be sure to have /usr/pkg/bin and /usr/pkg/sbin in your PATH so you can actually start the just installed program. -4.1.3. Deinstalling packages +5.1.3. Deinstalling packages To deinstall a package, it does not matter whether it was installed from source code or from a binary package. The pkg_delete command does not know it anyway. @@ -1100,12 +1123,12 @@ package in question and then removes the package itself. For example: will remove jpeg and all the packages that used it; this allows upgrading the jpeg package. -4.1.4. Getting information about installed packages +5.1.4. Getting information about installed packages The pkg_info shows information about installed packages or binary package files. -4.1.5. Checking for security vulnerabilities in installed packages +5.1.5. Checking for security vulnerabilities in installed packages The NetBSD Security-Officer and Packages Groups maintain a list of known security vulnerabilities to packages which are (or have been) included in @@ -1152,7 +1175,7 @@ check_pkg_vulnerabilities=YES see daily.conf(5) and security.conf(5) for more details. -4.1.6. Finding if newer versions of your installed packages are in pkgsrc +5.1.6. Finding if newer versions of your installed packages are in pkgsrc Install pkgtools/lintpkgsrc and run lintpkgsrc with the "-i" argument to check if your packages are up-to-date, e.g. @@ -1165,11 +1188,11 @@ Version mismatch: 'tcsh' 6.09.00 vs 6.10.00 You can then use make update to update the package on your system and rebuild any dependencies. -4.1.7. Other administrative functions +5.1.7. Other administrative functions The pkg_admin executes various administrative functions on the package system. -4.2. Building packages from source +5.2. Building packages from source After obtaining pkgsrc, the pkgsrc directory now contains a set of packages, organized into categories. You can browse the online index of packages, or run @@ -1185,14 +1208,14 @@ The rest of this chapter assumes that the package is already in pkgsrc. If it is not, see Part II, "The pkgsrc developer's guide" for instructions how to create your own packages. -4.2.1. Requirements +5.2.1. Requirements To build packages from source, you need a working C compiler. On NetBSD, you need to install the "comp" and the "text" distribution sets. If you want to build X11-related packages, the "xbase" and "xcomp" distribution sets are required, too. -4.2.2. Fetching distfiles +5.2.2. Fetching distfiles The first step for building a package is downloading the distfiles (i.e. the unmodified source). If they have not yet been downloaded, pkgsrc will fetch @@ -1235,7 +1258,7 @@ which will output and run a set of shell commands to fetch the necessary files into the distfiles directory. You can also choose to download the files manually. -4.2.3. How to build and install +5.2.3. How to build and install Once the software has downloaded, any patches will be applied, then it will be compiled for you. This may take some time depending on your computer, and how @@ -1338,21 +1361,21 @@ miserably. Note also that precompiled binary packages are usually built with the default LOCALBASE of /usr/pkg, and that you should not install any if you use a non-standard LOCALBASE. -Chapter 5. Configuring pkgsrc +Chapter 6. Configuring pkgsrc Table of Contents -5.1. General configuration -5.2. Variables affecting the build process -5.3. Variables affecting the installation process -5.4. Selecting and configuring the compiler +6.1. General configuration +6.2. Variables affecting the build process +6.3. Variables affecting the installation process +6.4. Selecting and configuring the compiler - 5.4.1. Selecting the compiler - 5.4.2. Additional flags to the compiler (CFLAGS) - 5.4.3. Additional flags to the linker (LDFLAGS) + 6.4.1. Selecting the compiler + 6.4.2. Additional flags to the compiler (CFLAGS) + 6.4.3. Additional flags to the linker (LDFLAGS) -5.5. Developer/advanced settings -5.6. Selecting Build Options +6.5. Developer/advanced settings +6.6. Selecting Build Options The whole pkgsrc system is configured in a single file, usually called mk.conf. In which directory pkgsrc looks for that file depends on the installation. On @@ -1365,7 +1388,7 @@ The whole pkgsrc configuration is done by setting variables in this file. Note that you can define all kinds of variables, and no special error checking (for example for spelling mistakes) takes place. -5.1. General configuration +6.1. General configuration The following variables apply to all pkgsrc packages. A complete list of the variables that can be configured by the user is available in mk/defaults/ @@ -1403,7 +1426,7 @@ mk.conf, together with some comments that describe each variable's intent. simple enough, the error message will include specific instructions on how to change this variable. -5.2. Variables affecting the build process +6.2. Variables affecting the build process * PACKAGES: The top level directory for the binary packages. The default is $ {PKGSRCDIR}/packages. @@ -1417,13 +1440,13 @@ mk.conf, together with some comments that describe each variable's intent. tree. It is possible to have many pkgsrc tree instances.) * LOCALPATCHES: Directory for local patches that aren't part of pkgsrc. See - Section 11.3, "patches/*" for more information. + Section 13.3, "patches/*" for more information. * PKGMAKECONF: Location of the mk.conf file used by a package's BSD-style Makefile. If this is not set, MAKECONF is set to /dev/null to avoid picking up settings used by builds in /usr/src. -5.3. Variables affecting the installation process +6.3. Variables affecting the installation process * PKGSRC_KEEP_BIN_PKGSRC: By default, binary packages of built packages are preserved in ${PACKAGES}/All. Setting this variable to "no" prevents this. @@ -1464,9 +1487,9 @@ Then, as a simple user $ make clean -5.4. Selecting and configuring the compiler +6.4. Selecting and configuring the compiler -5.4.1. Selecting the compiler +6.4.1. Selecting the compiler By default, pkgsrc will use GCC to build packages. This may be overridden by setting the following variables in /etc/mk.conf: @@ -1528,7 +1551,7 @@ GFORTRAN_VERSION: If PKGSRC_FORTRAN= gfortran is used, this option specifies which version to use. -5.4.2. Additional flags to the compiler (CFLAGS) +6.4.2. Additional flags to the compiler (CFLAGS) If you wish to set the CFLAGS variable, please make sure to use the += operator instead of the = operator: @@ -1539,7 +1562,7 @@ Using CFLAGS= (i.e. without the "+") may lead to problems with packages that need to add their own flags. You may want to take a look at the devel/cpuflags package if you're interested in optimization specifically for the current CPU. -5.4.3. Additional flags to the linker (LDFLAGS) +6.4.3. Additional flags to the linker (LDFLAGS) If you want to pass flags to the linker, both in the configure step and the build step, you can do this in two ways. Either set LDFLAGS or LIBS. The @@ -1551,7 +1574,7 @@ settings, use the += operator: LDFLAGS+= -your -linkerflags -5.5. Developer/advanced settings +6.5. Developer/advanced settings * PKG_DEVELOPER: Run some sanity checks that package developers want: @@ -1566,7 +1589,7 @@ LDFLAGS+= -your -linkerflags invocation, and the value 2 will display both the shell commands before their invocation, as well as their actual execution progress with set -x. -5.6. Selecting Build Options +6.6. Selecting Build Options Some packages have build time options, usually to select between different dependencies, enable optional support for big dependencies or enable @@ -1629,14 +1652,14 @@ automatically. A warning is issued to prompt the user to update mk.conf to use the options framework directly. Support for the legacy variables will be removed eventually. -Chapter 6. Creating binary packages +Chapter 7. Creating binary packages Table of Contents -6.1. Building a single binary package -6.2. Settings for creation of binary packages +7.1. Building a single binary package +7.2. Settings for creation of binary packages -6.1. Building a single binary package +7.1. Building a single binary package Once you have built and installed a package, you can create a binary package which can be installed on another system with pkg_add(1). This saves having to @@ -1656,26 +1679,26 @@ manipulate it. Binary packages are created by default in /usr/pkgsrc/packages, in the form of a gzipped tar file. See Section B.2, "Packaging figlet" for a continuation of the above misc/figlet example. -See Chapter 21, Submitting and Committing for information on how to submit such +See Chapter 23, Submitting and Committing for information on how to submit such a binary package. -6.2. Settings for creation of binary packages +7.2. Settings for creation of binary packages -See Section 17.17, "Other helpful targets". +See Section 19.17, "Other helpful targets". -Chapter 7. Creating binary packages for everything in pkgsrc (bulk builds) +Chapter 8. Creating binary packages for everything in pkgsrc (bulk builds) Table of Contents -7.1. Preparations -7.2. Running a pbulk-style bulk build +8.1. Preparations +8.2. Running a pbulk-style bulk build - 7.2.1. Configuration + 8.2.1. Configuration -7.3. Requirements of a full bulk build -7.4. Creating a multiple CD-ROM packages collection +8.3. Requirements of a full bulk build +8.4. Creating a multiple CD-ROM packages collection - 7.4.1. Example of cdpack + 8.4.1. Example of cdpack For a number of reasons you may want to build binary packages for a large selected set of packages in pkgsrc or even for all pkgsrc packages. For @@ -1686,7 +1709,7 @@ onto production system. There is a way of getting a set of binary packages: The bulk build system, or pbulk ("p" stands for "parallel"). This chapter describes how to set it up. -7.1. Preparations +8.1. Preparations First of all, you have to decide whether you build all packages or a limited set of them. Full bulk builds usually consume a lot more resources, both space @@ -1705,7 +1728,7 @@ effect this makes sure that bulk builds cannot break anything in your system. There have been numerous cases where certain packages tried to install files outside the LOCALBASE or wanted to edit some files in /etc. -7.2. Running a pbulk-style bulk build +8.2. Running a pbulk-style bulk build Running a pbulk-style bulk build works roughly as follows: @@ -1714,7 +1737,7 @@ Running a pbulk-style bulk build works roughly as follows: * Then, build each of the packages from a clean installation directory using the infrastructure. -7.2.1. Configuration +8.2.1. Configuration To simplify configuration, we provide the helper script mk/pbulk/pbulk.sh. @@ -1774,7 +1797,7 @@ Note The pbulk.sh script supports running unprivileged bulk build and helps configuring distributed bulk builds. -7.3. Requirements of a full bulk build +8.3. Requirements of a full bulk build A complete bulk build requires lots of disk space. Some of the disk space can be read-only, some other must be writable. Some can be on remote filesystems @@ -1793,7 +1816,7 @@ others must survive a sudden reboot. * 5 GB for temporary files (read-write, local, temporary) -7.4. Creating a multiple CD-ROM packages collection +8.4. Creating a multiple CD-ROM packages collection After your pkgsrc bulk-build has completed, you may wish to create a CD-ROM set of the resulting binary packages to assist in installing packages on other @@ -1801,7 +1824,7 @@ machines. The pkgtools/cdpack package provides a simple tool for creating the ISO 9660 images. cdpack arranges the packages on the CD-ROMs in a way that keeps all the dependencies for a given package on the same CD as that package. -7.4.1. Example of cdpack +8.4.1. Example of cdpack Complete documentation for cdpack is found in the cdpack(1) man page. The following short example assumes that the binary packages are left in /usr/ @@ -1833,12 +1856,12 @@ Now create the images: Each image will contain README, COPYING, and bin/myscript in their root directories. -Chapter 8. Directory layout of the installed files +Chapter 9. Directory layout of the installed files Table of Contents -8.1. File system layout in ${LOCALBASE} -8.2. File system layout in ${VARBASE} +9.1. File system layout in ${LOCALBASE} +9.2. File system layout in ${VARBASE} The files that are installed by pkgsrc are organized in a way that is similar to what you find in the /usr directory of the base system. But some details are @@ -1877,7 +1900,7 @@ below. * PKG_SYSCONFDIR corresponds to /etc in the base system. It contains configuration files of the packages, as well as pkgsrc's mk.conf itself. -8.1. File system layout in ${LOCALBASE} +9.1. File system layout in ${LOCALBASE} The following directories exist in a typical pkgsrc installation in $ {LOCALBASE}. @@ -1954,7 +1977,7 @@ var (the usual location of ${VARBASE}) Contains files that may be modified after installation. -8.2. File system layout in ${VARBASE} +9.2. File system layout in ${VARBASE} db/pkg (the usual location of ${PKG_DBDIR}) @@ -1972,34 +1995,34 @@ run Contains informational files about daemons that are currently running. -Chapter 9. Frequently Asked Questions +Chapter 10. Frequently Asked Questions Table of Contents -9.1. Are there any mailing lists for pkg-related discussion? -9.2. Utilities for package management (pkgtools) -9.3. How to use pkgsrc as non-root -9.4. How to resume transfers when fetching distfiles? -9.5. How can I install/use modular X.org from pkgsrc? -9.6. How to fetch files from behind a firewall -9.7. How to fetch files from HTTPS sites -9.8. How do I tell make fetch to do passive FTP? -9.9. How to fetch all distfiles at once -9.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean? -9.11. What does "Could not find bsd.own.mk" mean? -9.12. Using 'sudo' with pkgsrc -9.13. How do I change the location of configuration files? -9.14. Automated security checks -9.15. Why do some packages ignore my CFLAGS? -9.16. A package does not build. What shall I do? -9.17. What does "Makefile appears to contain unresolved cvs/rcs/??? merge +10.1. Are there any mailing lists for pkg-related discussion? +10.2. Utilities for package management (pkgtools) +10.3. How to use pkgsrc as non-root +10.4. How to resume transfers when fetching distfiles? +10.5. How can I install/use modular X.org from pkgsrc? +10.6. How to fetch files from behind a firewall +10.7. How to fetch files from HTTPS sites +10.8. How do I tell make fetch to do passive FTP? +10.9. How to fetch all distfiles at once +10.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean? +10.11. What does "Could not find bsd.own.mk" mean? +10.12. Using 'sudo' with pkgsrc +10.13. How do I change the location of configuration files? +10.14. Automated security checks +10.15. Why do some packages ignore my CFLAGS? +10.16. A package does not build. What shall I do? +10.17. What does "Makefile appears to contain unresolved cvs/rcs/??? merge conflicts" mean? This section contains hints, tips & tricks on special things in pkgsrc that we didn't find a better place for in the previous chapters, and it contains items for both pkgsrc users and developers. -9.1. Are there any mailing lists for pkg-related discussion? +10.1. Are there any mailing lists for pkg-related discussion? The following mailing lists may be of interest to pkgsrc users: @@ -2026,7 +2049,7 @@ To subscribe, do: Archives for all these mailing lists are available from http:// mail-index.NetBSD.org/. -9.2. Utilities for package management (pkgtools) +10.2. Utilities for package management (pkgtools) The directory pkgsrc/pkgtools contains a number of useful utilities for both users and developers of pkgsrc. This section attempts only to make the reader @@ -2094,10 +2117,10 @@ Utilities for people maintaining pkgsrc (or: more obscure pkg utilities) * pkgtools/libkver: Spoof kernel version for chrooted cross builds. -9.3. How to use pkgsrc as non-root +10.3. How to use pkgsrc as non-root To install packages from source as a non-root user, download pkgsrc as -described in Chapter 2, Where to get pkgsrc and how to keep it up-to-date, cd +described in Chapter 3, Where to get pkgsrc and how to keep it up-to-date, cd into that directory and run the command ./bootstrap/bootstrap --unprivileged. This will install the binary part of pkgsrc to ~/pkg and put the pkgsrc @@ -2105,7 +2128,7 @@ configuration mk.conf into ~/pkg/etc. For more details, see mk/unprivileged.mk. -9.4. How to resume transfers when fetching distfiles? +10.4. How to resume transfers when fetching distfiles? By default, resuming transfers in pkgsrc is disabled, but you can enable this feature by adding the option PKG_RESUME_TRANSFERS=YES into mk.conf. If, during @@ -2123,7 +2146,7 @@ like: FETCH_USING= wget -9.5. How can I install/use modular X.org from pkgsrc? +10.5. How can I install/use modular X.org from pkgsrc? If you want to use modular X.org from pkgsrc instead of your system's own X11 (/usr/X11R6, /usr/openwin, ...) you will have to add the following line into @@ -2131,7 +2154,7 @@ mk.conf: X11_TYPE=modular -9.6. How to fetch files from behind a firewall +10.6. How to fetch files from behind a firewall If you are sitting behind a firewall which does not allow direct connections to Internet hosts (i.e. non-NAT), you may specify the relevant proxy hosts. This @@ -2142,7 +2165,7 @@ the proxy port number. So the proxy environment variables are: ftp_proxy=ftp://orpheus.amdahl.com:80/ http_proxy=http://orpheus.amdahl.com:80/ -9.7. How to fetch files from HTTPS sites +10.7. How to fetch files from HTTPS sites Some fetch tools are not prepared to support HTTPS by default (for example, the one in NetBSD 6.0), or the one installed by the pkgsrc bootstrap (to avoid an @@ -2154,7 +2177,7 @@ pkgsrc-current. In that case, set FETCH_USING in your mk.conf file to "curl" or "wget", which are both compiled with HTTPS support by default. Of course, these tools need to be installed before you can use them this way. -9.8. How do I tell make fetch to do passive FTP? +10.8. How do I tell make fetch to do passive FTP? This depends on which utility is used to retrieve distfiles. From bsd.pkg.mk, FETCH_CMD is assigned the first available command from the following list: @@ -2171,7 +2194,7 @@ following to your mk.conf file: PASSIVE_FETCH=1. Having that option present will prevent /usr/bin/ftp from falling back to active transfers. -9.9. How to fetch all distfiles at once +10.9. How to fetch all distfiles at once You would like to download all the distfiles in a single batch from work or university, where you can't run a make fetch. There is an archive of distfiles @@ -2206,7 +2229,7 @@ everything by running: % make fetch NO_SKIP=yes -9.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean? +10.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean? When compiling the pkgtools/pkg_install package, you get the error from make that it doesn't know how to make /usr/share/tmac/tmac.andoc? This indicates @@ -2216,7 +2239,7 @@ distribution on your machine. It is recommended to do that to format man pages. In the case of the pkgtools/pkg_install package, you can get away with setting NOMAN=YES either in the environment or in mk.conf. -9.11. What does "Could not find bsd.own.mk" mean? +10.11. What does "Could not find bsd.own.mk" mean? You didn't install the compiler set, comp.tgz, when you installed your NetBSD machine. Please get and install it, by extracting it in /: @@ -2227,7 +2250,7 @@ machine. Please get and install it, by extracting it in /: comp.tgz is part of every NetBSD release. Get the one that corresponds to your release (determine via uname -r). -9.12. Using 'sudo' with pkgsrc +10.12. Using 'sudo' with pkgsrc When installing packages as non-root user and using the just-in-time su(1) feature of pkgsrc, it can become annoying to type in the root password for each @@ -2240,7 +2263,7 @@ mk.conf, somewhere after the definition of the LOCALBASE variable: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c .endif -9.13. How do I change the location of configuration files? +10.13. How do I change the location of configuration files? As the system administrator, you can choose where configuration files are installed. The default settings make all these files go into ${PREFIX}/etc or @@ -2260,7 +2283,7 @@ of PKGBASE. Note that after changing these settings, you must rebuild and reinstall any affected packages. -9.14. Automated security checks +10.14. Automated security checks Please be aware that there can often be bugs in third-party software, and some of these bugs can leave a machine vulnerable to exploitation by attackers. In @@ -2281,14 +2304,14 @@ following two tools (installed as part of the pkgtools/pkg_install package): by output to stdout, including a description of the type of vulnerability, and a URL containing more information. -Use of these tools is strongly recommended! See Section 4.1.5, "Checking for +Use of these tools is strongly recommended! See Section 5.1.5, "Checking for security vulnerabilities in installed packages" for instructions on how to automate checking and reporting. If this database is installed, pkgsrc builds will use it to perform a security check before building any package. -9.15. Why do some packages ignore my CFLAGS? +10.15. Why do some packages ignore my CFLAGS? When you add your own preferences to the CFLAGS variable in your mk.conf, these flags are passed in environment variables to the ./configure scripts and to @@ -2302,7 +2325,7 @@ Usually you can remove these lines. But be aware that some "smart" programmers write so bad code that it only works for the specific combination of CFLAGS they have chosen. -9.16. A package does not build. What shall I do? +10.16. A package does not build. What shall I do? 1. Make sure that your copy of pkgsrc is consistent. A case that occurs often is that people only update pkgsrc in parts, because of performance reasons. @@ -2317,11 +2340,11 @@ they have chosen. make clean clean-depends to verify this. 4. If you are a package developer who wants to invest some work, have a look - at Chapter 19, Making your package work. + at Chapter 21, Making your package work. 5. If the problem still exists, write a mail to the pkgsrc-users mailing list. -9.17. What does "Makefile appears to contain unresolved cvs/rcs/??? merge +10.17. What does "Makefile appears to contain unresolved cvs/rcs/??? merge conflicts" mean? You have modified a file from pkgsrc, and someone else has modified that same @@ -2342,245 +2365,265 @@ more like a reference manual for pkgsrc. Table of Contents -10. Creating a new pkgsrc package from scratch +11. Getting help +12. Creating a new pkgsrc package from scratch - 10.1. Common types of packages + 12.1. Common types of packages - 10.1.1. Perl modules - 10.1.2. Python modules and programs + 12.1.1. Perl modules + 12.1.2. Python modules and programs - 10.2. Examples + 12.2. Examples - 10.2.1. How the www/nvu package came into pkgsrc + 12.2.1. How the www/nvu package came into pkgsrc -11. Package components - files, directories and contents +13. Package components - files, directories and contents - 11.1. Makefile - 11.2. distinfo - 11.3. patches/* + 13.1. Makefile + 13.2. distinfo + 13.3. patches/* - 11.3.1. Structure of a single patch file - 11.3.2. Creating patch files - 11.3.3. Sources where the patch files come from - 11.3.4. Patching guidelines - 11.3.5. Feedback to the author + 13.3.1. Structure of a single patch file + 13.3.2. Creating patch files + 13.3.3. Sources where the patch files come from + 13.3.4. Patching guidelines + 13.3.5. Feedback to the author - 11.4. Other mandatory files - 11.5. Optional files + 13.4. Other mandatory files + 13.5. Optional files - 11.5.1. Files affecting the binary package - 11.5.2. Files affecting the build process - 11.5.3. Files affecting nothing at all + 13.5.1. Files affecting the binary package + 13.5.2. Files affecting the build process + 13.5.3. Files affecting nothing at all - 11.6. work* - 11.7. files/* + 13.6. work* + 13.7. files/* -12. Programming in Makefiles +14. Programming in Makefiles - 12.1. Caveats - 12.2. Makefile variables + 14.1. Caveats + 14.2. Makefile variables - 12.2.1. Naming conventions + 14.2.1. Naming conventions - 12.3. Code snippets + 14.3. Code snippets - 12.3.1. Adding things to a list - 12.3.2. Echoing a string exactly as-is - 12.3.3. Passing CFLAGS to GNU configure scripts - 12.3.4. Handling possibly empty variables + 14.3.1. Adding things to a list + 14.3.2. Echoing a string exactly as-is + 14.3.3. Passing CFLAGS to GNU configure scripts + 14.3.4. Handling possibly empty variables -13. PLIST issues +15. PLIST issues - 13.1. RCS ID - 13.2. Semi-automatic PLIST generation - 13.3. Tweaking output of make print-PLIST - 13.4. Variable substitution in PLIST - 13.5. Man page compression - 13.6. Changing PLIST source with PLIST_SRC - 13.7. Platform-specific and differing PLISTs - 13.8. Build-specific PLISTs - 13.9. Sharing directories between packages + 15.1. RCS ID + 15.2. Semi-automatic PLIST generation + 15.3. Tweaking output of make print-PLIST + 15.4. Variable substitution in PLIST + 15.5. Man page compression + 15.6. Changing PLIST source with PLIST_SRC + 15.7. Platform-specific and differing PLISTs + 15.8. Build-specific PLISTs + 15.9. Sharing directories between packages -14. Buildlink methodology +16. Buildlink methodology - 14.1. Converting packages to use buildlink3 - 14.2. Writing buildlink3.mk files + 16.1. Converting packages to use buildlink3 + 16.2. Writing buildlink3.mk files - 14.2.1. Anatomy of a buildlink3.mk file - 14.2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS. + 16.2.1. Anatomy of a buildlink3.mk file + 16.2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS. pkg in buildlink3.mk files - 14.3. Writing builtin.mk files + 16.3. Writing builtin.mk files - 14.3.1. Anatomy of a builtin.mk file - 14.3.2. Global preferences for native or pkgsrc software + 16.3.1. Anatomy of a builtin.mk file + 16.3.2. Global preferences for native or pkgsrc software -15. The pkginstall framework +17. The pkginstall framework - 15.1. Files and directories outside the installation prefix + 17.1. Files and directories outside the installation prefix - 15.1.1. Directory manipulation - 15.1.2. File manipulation + 17.1.1. Directory manipulation + 17.1.2. File manipulation - 15.2. Configuration files + 17.2. Configuration files - 15.2.1. How PKG_SYSCONFDIR is set - 15.2.2. Telling the software where configuration files are - 15.2.3. Patching installations - 15.2.4. Disabling handling of configuration files + 17.2.1. How PKG_SYSCONFDIR is set + 17.2.2. Telling the software where configuration files are + 17.2.3. Patching installations + 17.2.4. Disabling handling of configuration files - 15.3. System startup scripts + 17.3. System startup scripts - 15.3.1. Disabling handling of system startup scripts + 17.3.1. Disabling handling of system startup scripts - 15.4. System users and groups - 15.5. System shells + 17.4. System users and groups + 17.5. System shells - 15.5.1. Disabling shell registration + 17.5.1. Disabling shell registration - 15.6. Fonts + 17.6. Fonts - 15.6.1. Disabling automatic update of the fonts databases + 17.6.1. Disabling automatic update of the fonts databases -16. Options handling +18. Options handling - 16.1. Global default options - 16.2. Converting packages to use bsd.options.mk - 16.3. Option Names - 16.4. Determining the options of dependencies + 18.1. Global default options + 18.2. Converting packages to use bsd.options.mk + 18.3. Option Names + 18.4. Determining the options of dependencies -17. The build process +19. The build process - 17.1. Introduction - 17.2. Program location - 17.3. Directories used during the build process - 17.4. Running a phase - 17.5. The fetch phase + 19.1. Introduction + 19.2. Program location + 19.3. Directories used during the build process + 19.4. Running a phase + 19.5. The fetch phase - 17.5.1. What to fetch and where to get it from - 17.5.2. How are the files fetched? + 19.5.1. What to fetch and where to get it from + 19.5.2. How are the files fetched? - 17.6. The checksum phase - 17.7. The extract phase - 17.8. The patch phase - 17.9. The tools phase - 17.10. The wrapper phase - 17.11. The configure phase - 17.12. The build phase - 17.13. The test phase - 17.14. The install phase - 17.15. The package phase - 17.16. Cleaning up - 17.17. Other helpful targets + 19.6. The checksum phase + 19.7. The extract phase + 19.8. The patch phase + 19.9. The tools phase + 19.10. The wrapper phase + 19.11. The configure phase + 19.12. The build phase + 19.13. The test phase + 19.14. The install phase + 19.15. The package phase + 19.16. Cleaning up + 19.17. Other helpful targets -18. Tools needed for building or running +20. Tools needed for building or running - 18.1. Tools for pkgsrc builds - 18.2. Tools needed by packages - 18.3. Tools provided by platforms + 20.1. Tools for pkgsrc builds + 20.2. Tools needed by packages + 20.3. Tools provided by platforms -19. Making your package work +21. Making your package work - 19.1. General operation + 21.1. General operation - 19.1.1. How to pull in user-settable variables from mk.conf - 19.1.2. User interaction - 19.1.3. Handling licenses - 19.1.4. Restricted packages - 19.1.5. Handling dependencies - 19.1.6. Handling conflicts with other packages - 19.1.7. Packages that cannot or should not be built - 19.1.8. Packages which should not be deleted, once installed - 19.1.9. Handling packages with security problems - 19.1.10. How to handle incrementing versions when fixing an existing + 21.1.1. How to pull in user-settable variables from mk.conf + 21.1.2. User interaction + 21.1.3. Handling licenses + 21.1.4. Restricted packages + 21.1.5. Handling dependencies + 21.1.6. Handling conflicts with other packages + 21.1.7. Packages that cannot or should not be built + 21.1.8. Packages which should not be deleted, once installed + 21.1.9. Handling packages with security problems + 21.1.10. How to handle incrementing versions when fixing an existing package - 19.1.11. Substituting variable text in the package files (the SUBST + 21.1.11. Substituting variable text in the package files (the SUBST framework) - 19.2. The fetch phase - - 19.2.1. Packages whose distfiles aren't available for plain downloading - 19.2.2. How to handle modified distfiles with the 'old' name - 19.2.3. Packages hosted on github.com - - 19.3. The configure phase - - 19.3.1. Shared libraries - libtool - 19.3.2. Using libtool on GNU packages that already support libtool - 19.3.3. GNU Autoconf/Automake - - 19.4. Programming languages - - 19.4.1. C, C++, and Fortran - 19.4.2. Java - 19.4.3. Packages containing perl scripts - 19.4.4. Packages containing shell scripts - 19.4.5. Other programming languages - - 19.5. The build phase - - 19.5.1. Compiling C and C++ code conditionally - 19.5.2. How to handle compiler bugs - 19.5.3. Undefined reference to "..." - 19.5.4. Running out of memory - - 19.6. The install phase - - 19.6.1. Creating needed directories - 19.6.2. Where to install documentation - 19.6.3. Installing highscore files - 19.6.4. Adding DESTDIR support to packages - 19.6.5. Packages with hardcoded paths to other interpreters - 19.6.6. Packages installing perl modules - 19.6.7. Packages installing info files - 19.6.8. Packages installing man pages - 19.6.9. Packages installing GConf data files - 19.6.10. Packages installing scrollkeeper/rarian data files - 19.6.11. Packages installing X11 fonts - 19.6.12. Packages installing GTK2 modules - 19.6.13. Packages installing SGML or XML data - 19.6.14. Packages installing extensions to the MIME database - 19.6.15. Packages using intltool - 19.6.16. Packages installing startup scripts - 19.6.17. Packages installing TeX modules - 19.6.18. Packages supporting running binaries in emulation - 19.6.19. Packages installing hicolor theme icons - 19.6.20. Packages installing desktop files - - 19.7. Marking packages as having problems - -20. Debugging -21. Submitting and Committing - - 21.1. Submitting binary packages - 21.2. Submitting source packages (for non-NetBSD-developers) - 21.3. General notes when adding, updating, or removing packages - 21.4. Commit Messages - 21.5. Committing: Adding a package to CVS - 21.6. Updating a package to a newer version - 21.7. Renaming a package in pkgsrc - 21.8. Moving a package in pkgsrc - -22. Frequently Asked Questions -23. GNOME packaging and porting - - 23.1. Meta packages - 23.2. Packaging a GNOME application - 23.3. Updating GNOME to a newer version - 23.4. Patching guidelines - -Chapter 10. Creating a new pkgsrc package from scratch + 21.2. The fetch phase + + 21.2.1. Packages whose distfiles aren't available for plain downloading + 21.2.2. How to handle modified distfiles with the 'old' name + 21.2.3. Packages hosted on github.com + + 21.3. The configure phase + + 21.3.1. Shared libraries - libtool + 21.3.2. Using libtool on GNU packages that already support libtool + 21.3.3. GNU Autoconf/Automake + + 21.4. Programming languages + + 21.4.1. C, C++, and Fortran + 21.4.2. Java + 21.4.3. Packages containing perl scripts + 21.4.4. Packages containing shell scripts + 21.4.5. Other programming languages + + 21.5. The build phase + + 21.5.1. Compiling C and C++ code conditionally + 21.5.2. How to handle compiler bugs + 21.5.3. Undefined reference to "..." + 21.5.4. Running out of memory + + 21.6. The install phase + + 21.6.1. Creating needed directories + 21.6.2. Where to install documentation + 21.6.3. Installing highscore files + 21.6.4. Adding DESTDIR support to packages + 21.6.5. Packages with hardcoded paths to other interpreters + 21.6.6. Packages installing perl modules + 21.6.7. Packages installing info files + 21.6.8. Packages installing man pages + 21.6.9. Packages installing GConf data files + 21.6.10. Packages installing scrollkeeper/rarian data files + 21.6.11. Packages installing X11 fonts + 21.6.12. Packages installing GTK2 modules + 21.6.13. Packages installing SGML or XML data + 21.6.14. Packages installing extensions to the MIME database + 21.6.15. Packages using intltool + 21.6.16. Packages installing startup scripts + 21.6.17. Packages installing TeX modules + 21.6.18. Packages supporting running binaries in emulation + 21.6.19. Packages installing hicolor theme icons + 21.6.20. Packages installing desktop files + + 21.7. Marking packages as having problems + +22. Debugging +23. Submitting and Committing + + 23.1. Submitting binary packages + 23.2. Submitting source packages (for non-NetBSD-developers) + 23.3. General notes when adding, updating, or removing packages + 23.4. Commit Messages + 23.5. Committing: Adding a package to CVS + 23.6. Updating a package to a newer version + 23.7. Renaming a package in pkgsrc + 23.8. Moving a package in pkgsrc + +24. Frequently Asked Questions +25. GNOME packaging and porting + + 25.1. Meta packages + 25.2. Packaging a GNOME application + 25.3. Updating GNOME to a newer version + 25.4. Patching guidelines + +Chapter 11. Getting help + +To get help when developing pkgsrc, the definitive source is this document, the +pkgsrc guide. If you don't find anything here, there are alternatives: + + * The built-in pkgsrc help, which is available after bootstrapping pkgsrc. + Run bmake help topic=? to get help for any topic, such as a variable name + like BUILD_DEFS, a make target like do-build, a missing C or C++ function + like strcasecmp or any other topic. + + The available help topics are listed in Appendix D, Help topics. + + * The tech-pkg mailing list, to which you can subscribe and then ask your + questions. + + * The #pkgsrc IRC channel, which is accessible via a web browser or by using + a specialized chat program such as XChat. Pick any user name and join the + channel #pkgsrc. + +Chapter 12. Creating a new pkgsrc package from scratch Table of Contents -10.1. Common types of packages +12.1. Common types of packages - 10.1.1. Perl modules - 10.1.2. Python modules and programs + 12.1.1. Perl modules + 12.1.2. Python modules and programs -10.2. Examples +12.2. Examples - 10.2.1. How the www/nvu package came into pkgsrc + 12.2.1. How the www/nvu package came into pkgsrc When you find a package that is not yet in pkgsrc, you most likely have a URL from where you can download the source code. Starting with this URL, creating a @@ -2631,7 +2674,7 @@ package involves only a few steps. pkglint --explain or pkglint -e, which outputs additional explanations. 6. In many cases the package is not yet ready to build. You can find - instructions for the most common cases in the next section, Section 10.1, + instructions for the most common cases in the next section, Section 12.1, "Common types of packages". After you have followed the instructions over there, you can hopefully continue here. @@ -2641,7 +2684,7 @@ package involves only a few steps. edited the Makefile. 8. Now, run bmake to build the package. For the various things that can go - wrong in this phase, consult Chapter 19, Making your package work. + wrong in this phase, consult Chapter 21, Making your package work. 9. When the package builds fine, the next step is to install the package. Run bmake install and hope that everything works. @@ -2661,14 +2704,14 @@ package involves only a few steps. 13. Run bmake package to create a binary package from the set of installed files. -10.1. Common types of packages +12.1. Common types of packages -10.1.1. Perl modules +12.1.1. Perl modules Simple Perl modules are handled automatically by url2pkg, including dependencies. -10.1.2. Python modules and programs +12.1.2. Python modules and programs Python modules and programs packages are easily created using a set of predefined variables. @@ -2712,11 +2755,11 @@ PYTHON_VERSIONED_DEPENDENCIES=dialog Look inside versioned_dependencies.mk for a list of supported packages. -10.2. Examples +12.2. Examples -10.2.1. How the www/nvu package came into pkgsrc +12.2.1. How the www/nvu package came into pkgsrc -10.2.1.1. The initial package +12.2.1.1. The initial package Looking at the file pkgsrc/doc/TODO, I saw that the "nvu" package has not yet been imported into pkgsrc. As the description says it has to do with the web, @@ -2777,7 +2820,7 @@ Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done! Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-) -10.2.1.2. Fixing all kinds of problems to make the package work +12.2.1.2. Fixing all kinds of problems to make the package work Now that the package has been extracted, let's see what's inside it. The package has a README.txt, but that only says something about mozilla, so it's @@ -2900,7 +2943,7 @@ looked up in www/seamonkey which patch files were relevant for this issue and copied them to the patches directory. Then I retried, fixed the patches so that they applied cleanly and retried again. This time, everything worked. -10.2.1.3. Installing the package +12.2.1.3. Installing the package $ bmake CHECK_FILES=no install [...] @@ -2908,34 +2951,34 @@ $ bmake print-PLIST >PLIST $ bmake deinstall $ bmake install -Chapter 11. Package components - files, directories and contents +Chapter 13. Package components - files, directories and contents Table of Contents -11.1. Makefile -11.2. distinfo -11.3. patches/* +13.1. Makefile +13.2. distinfo +13.3. patches/* - 11.3.1. Structure of a single patch file - 11.3.2. Creating patch files - 11.3.3. Sources where the patch files come from - 11.3.4. Patching guidelines - 11.3.5. Feedback to the author + 13.3.1. Structure of a single patch file + 13.3.2. Creating patch files + 13.3.3. Sources where the patch files come from + 13.3.4. Patching guidelines + 13.3.5. Feedback to the author -11.4. Other mandatory files -11.5. Optional files +13.4. Other mandatory files +13.5. Optional files - 11.5.1. Files affecting the binary package - 11.5.2. Files affecting the build process - 11.5.3. Files affecting nothing at all + 13.5.1. Files affecting the binary package + 13.5.2. Files affecting the build process + 13.5.3. Files affecting nothing at all -11.6. work* -11.7. files/* +13.6. work* +13.7. files/* Whenever you're preparing a package, there are a number of files involved which are described in the following sections. -11.1. Makefile +13.1. Makefile Building, installation and creation of a binary package are all controlled by the package's Makefile. The Makefile describes various things about a package, @@ -2974,7 +3017,7 @@ mostly historical and has no further meaning. converters games mbone print x11 * MASTER_SITES, DYNAMIC_MASTER_SITES, DIST_SUBDIR, EXTRACT_SUFX and DISTFILES - are discussed in detail in Section 17.5, "The fetch phase". + are discussed in detail in Section 19.5, "The fetch phase". The second section contains information about separately downloaded patches, if any. @@ -3010,7 +3053,7 @@ The third section contains the following variables. package name). * LICENSE indicates the license(s) applicable for the package. See - Section 19.1.3, "Handling licenses" for further details. + Section 21.1.3, "Handling licenses" for further details. Other variables that affect the build: @@ -3044,10 +3087,10 @@ Please pay attention to the following gotchas: * Replace /usr/local with "${PREFIX}" in all files (see patches, below). - * If the package installs any info files, see Section 19.6.7, "Packages + * If the package installs any info files, see Section 21.6.7, "Packages installing info files". -11.2. distinfo +13.2. distinfo The distinfo file contains the message digest, or checksum, of each distfile needed for the package. This ensures that the distfiles retrieved from the @@ -3057,7 +3100,7 @@ protected using three different message digest algorithms (SHA1, RMD160, SHA512), as well as the file size. The distinfo file also contains the checksums for all the patches found in the -patches directory (see Section 11.3, "patches/*"). These checksums ensure that +patches directory (see Section 13.3, "patches/*"). These checksums ensure that patches are only applied intentionally and that they don't accidentally change, e.g. when merging different changes together. They also make sure that new patches are actually added to CVS and old ones are removed. Too see whether the @@ -3070,7 +3113,7 @@ example lang/openjdk7. These are kept in the same distinfo file and care should be taken when upgrading such a package to ensure distfile information is not lost. -11.3. patches/* +13.3. patches/* Some packages don't work out-of-the box on the various platforms that are supported by pkgsrc. These packages need to be patched to make them work. The @@ -3079,7 +3122,7 @@ patch files can be found in the patches/ directory. In the patch phase, these patches are applied to the files in WRKSRC directory after extracting them, in alphabetic order. -11.3.1. Structure of a single patch file +13.3.1. Structure of a single patch file The patch-* files should be in diff -bu format, and apply without a fuzz to avoid problems. (To force patches to apply with fuzz you can set @@ -3103,7 +3146,7 @@ application can make some use of the patch. Special care should be taken for the upstream developers, since we generally want that they accept our patches, so we have less work in the future. -11.3.2. Creating patch files +13.3.2. Creating patch files One important thing to mention is to pay attention that no RCS IDs get stored in the patch files, as these will cause problems when later checked into the @@ -3119,7 +3162,7 @@ patchdiff. The files in patches are replaced by new files, so carefully check if you want to take all the changes. When you have finished a package, remember to generate the checksums for the -patch files by using the make makepatchsum command, see Section 11.2, +patch files by using the make makepatchsum command, see Section 13.2, "distinfo". When adding a patch that corrects a problem in the distfile (rather than e.g. @@ -3133,7 +3176,7 @@ convention patch-[a-z][a-z], but new patches should be of the form containing the filename. mkpatches included in pkgtools/pkgdiff takes care of the name automatically. -11.3.3. Sources where the patch files come from +13.3.3. Sources where the patch files come from If you want to share patches between multiple packages in pkgsrc, e.g. because they use the same distfiles, set PATCHDIR to the path where the patch files can @@ -3153,7 +3196,7 @@ for pkgsrc/graphics/png, keep it in $LOCALPATCHES/graphics/png/mypatch. All files in the named directory are expected to be patch files, and they are applied after pkgsrc patches are applied. -11.3.4. Patching guidelines +13.3.4. Patching guidelines When fixing a portability issue in the code do not use preprocessor magic to check for the current operating system nor platform. Doing so hurts portability @@ -3177,7 +3220,7 @@ doesn't work unless it is right! Some typical examples: -Table 11.1. Patching examples +Table 13.1. Patching examples +-------------------------------------------------------------------------------------------+ | Where | Incorrect | Correct | @@ -3204,7 +3247,7 @@ Table 11.1. Patching examples +-------------------------------------------------------------------------------------------+ -11.3.5. Feedback to the author +13.3.5. Feedback to the author Always, always, always feed back any portability fixes or improvements you do to a package to the mainstream developers. This is the only way to get their @@ -3224,7 +3267,7 @@ patch comment. Support the idea of free software! -11.4. Other mandatory files +13.4. Other mandatory files DESCR @@ -3238,12 +3281,12 @@ PLIST This file governs the files that are installed on your system: all the binaries, manual pages, etc. There are other directives which may be entered in this file, to control the creation and deletion of directories, - and the location of inserted files. See Chapter 13, PLIST issues for more + and the location of inserted files. See Chapter 15, PLIST issues for more information. -11.5. Optional files +13.5. Optional files -11.5.1. Files affecting the binary package +13.5.1. Files affecting the binary package INSTALL @@ -3251,7 +3294,7 @@ INSTALL extraction and before files are moved in place, the second time after the files to install are moved in place. This can be used to do any custom procedures not possible with @exec commands in PLIST. See pkg_add(1) and - pkg_create(1) for more information. See also Section 15.1, "Files and + pkg_create(1) for more information. See also Section 17.1, "Files and directories outside the installation prefix". Please note that you can modify variables in it easily by using FILES_SUBST in the package's Makefile: @@ -3298,7 +3341,7 @@ ALTERNATIVES Each line of the file contains two filenames, first the wrapper and then the alternative provided by the package. Both paths are relative to PREFIX. -11.5.2. Files affecting the build process +13.5.2. Files affecting the build process Makefile.common @@ -3311,7 +3354,7 @@ Makefile.common buildlink3.mk This file contains the dependency information for the buildlink3 framework - (see Chapter 14, Buildlink methodology). + (see Chapter 16, Buildlink methodology). hacks.mk @@ -3322,11 +3365,11 @@ hacks.mk options.mk This file contains the code for the package-specific options (see - Chapter 16, Options handling) that can be selected by the user. If a + Chapter 18, Options handling) that can be selected by the user. If a package has only one or two options, it is equally acceptable to put the code directly into the Makefile. -11.5.3. Files affecting nothing at all +13.5.3. Files affecting nothing at all README* @@ -3338,7 +3381,7 @@ TODO This file contains things that need to be done to make the package even better. -11.6. work* +13.6. work* When you type make, the distribution files are unpacked into the directory denoted by WRKDIR. It can be removed by running make clean. Besides the @@ -3346,7 +3389,7 @@ sources, this directory is also used to keep various timestamp files. The directory gets removed completely on clean. The default is ${.CURDIR}/work or $ {.CURDIR}/work.${MACHINE_ARCH} if OBJMACHINE is set. -11.7. files/* +13.7. files/* If you have any files that you wish to be placed in the package prior to configuration or building, you could place these files here and use a ${CP} @@ -3359,37 +3402,36 @@ variable to point to the other package's files directory, e.g.: FILESDIR=${.CURDIR}/../xemacs/files -Chapter 12. Programming in Makefiles +Chapter 14. Programming in Makefiles Table of Contents -12.1. Caveats -12.2. Makefile variables +14.1. Caveats +14.2. Makefile variables - 12.2.1. Naming conventions + 14.2.1. Naming conventions -12.3. Code snippets +14.3. Code snippets - 12.3.1. Adding things to a list - 12.3.2. Echoing a string exactly as-is - 12.3.3. Passing CFLAGS to GNU configure scripts - 12.3.4. Handling possibly empty variables + 14.3.1. Adding things to a list + 14.3.2. Echoing a string exactly as-is + 14.3.3. Passing CFLAGS to GNU configure scripts + 14.3.4. Handling possibly empty variables Pkgsrc consists of many Makefile fragments, each of which forms a well-defined part of the pkgsrc system. Using the make(1) system as a programming language for a big system like pkgsrc requires some discipline to keep the code correct and understandable. -The basic ingredients for Makefile programming are variables (which are -actually macros) and shell commands. Among these shell commands may even be -more complex ones like awk(1) programs. To make sure that every shell command -runs as intended it is necessary to quote all variables correctly when they are -used. +The basic ingredients for Makefile programming are variables and shell +commands. Among these shell commands may even be more complex ones like awk(1) +programs. To make sure that every shell command runs as intended it is +necessary to quote all variables correctly when they are used. -This chapter describes some patterns, that appear quite often in Makefiles, +This chapter describes some patterns that appear quite often in Makefiles, including the pitfalls that come along with them. -12.1. Caveats +14.1. Caveats * When you are creating a file as a target of a rule, always write the data to a temporary file first and finally rename that file. Otherwise there @@ -3414,65 +3456,46 @@ including the pitfalls that come along with them. You might remember that make(1) sometimes removes ${.TARGET} in case of error, but this only happens when it is interrupted, for example by - pressing ^C. This does not happen when one of the commands fails (like + pressing Ctrl+C. This does not happen when one of the commands fails (like false(1) above). -12.2. Makefile variables +14.2. Makefile variables Makefile variables contain strings that can be processed using the five -operators ``='', ``+='', ``?='', ``:='', and ``!='', which are described in the -make(1) man page. - -When a variable's value is parsed from a Makefile, the hash character ``#'' and -the backslash character ``\'' are handled specially. If a backslash is followed -by a newline, any whitespace immediately in front of the backslash, the -backslash, the newline, and any whitespace immediately behind the newline are -replaced with a single space. A backslash character and an immediately -following hash character are replaced with a single hash character. Otherwise, -the backslash is passed as is. In a variable assignment, any hash character -that is not preceded by a backslash starts a comment that continues up to the -end of the logical line. +operators =, +=, ?=, := and !=, which are described in the make(1) man page. + +When a variable's value is parsed from a Makefile, the hash character # and the +backslash character \ are handled specially. If a backslash is the last +character in a line, that backslash is removed from the line and the line +continues with the next line of the file. + +The # character starts a comment that reaches until the end of the line. To get +an actual # character, such as in a URL, write \# instead. The evaluation of variables either happens immediately or lazy. It happens -immediately when the variable occurs on the right-hand side of the ``:='' or -the ``!='' operator, in a .if condition or a .for loop. In the other cases, it -is evaluated lazily. +immediately when the variable occurs on the right-hand side of the := or the != +operator, in a .if condition or a .for loop. In the other cases, it is +evaluated lazily. Some of the modifiers split the string into words and then operate on the words, others operate on the string as a whole. When a string is split into -words, it is split like in sh(1). - -There are several types of variables that should be handled differently. -Strings and two types of lists. - - * Strings can contain arbitrary characters. Nevertheless, you should restrict - yourself to only using printable characters. Examples are PREFIX and - COMMENT. - - * Internal lists are lists that are never exported to any shell command. - Their elements are separated by whitespace. Therefore, the elements - themselves cannot have embedded whitespace. Any other characters are - allowed. Internal lists can be used in .for loops. Examples are DEPENDS and - BUILD_DEPENDS. - - * External lists are lists that may be exported to a shell command. Their - elements can contain any characters, including whitespace. That's why they - cannot be used in .for loops. Examples are DISTFILES and MASTER_SITES. +words, double quotes and single quotes are interpreted as delimiters, just like +in sh(1). -12.2.1. Naming conventions +14.2.1. Naming conventions * All variable names starting with an underscore are reserved for use by the - pkgsrc infrastructure. They shall not be used by package Makefiles. + pkgsrc infrastructure. They shall not be used by packages. * In .for loops you should use lowercase variable names for the iteration variables. - * All list variables should have a ``plural'' name, e.g. PKG_OPTIONS or + * All list variables should have a plural name, such as PKG_OPTIONS or DISTFILES. -12.3. Code snippets +14.3. Code snippets -12.3.1. Adding things to a list +14.3.1. Adding things to a list When adding a string that possibly contains whitespace or quotes to a list (example 1), it must be quoted using the :Q modifier. @@ -3487,7 +3510,7 @@ ANOTHER_LIST= a=b c=d LIST+= ${STRING:Q} # 1 LIST+= ${ANOTHER_LIST} # 2 -12.3.2. Echoing a string exactly as-is +14.3.2. Echoing a string exactly as-is Echoing a string containing special characters needs special work. @@ -3516,7 +3539,7 @@ doesn't make a difference, but other programs may care. In example 4, the EXAMPLE_ENV does not need to be quoted because the quoting has already been done when adding elements to the list. -12.3.3. Passing CFLAGS to GNU configure scripts +14.3.3. Passing CFLAGS to GNU configure scripts When passing CFLAGS or similar variables to a GNU-style configure script (especially those that call other configure scripts), it must not have leading @@ -3537,7 +3560,7 @@ all: In this example, CPPFLAGS has both leading and trailing whitespace because the += operator always adds a space. -12.3.4. Handling possibly empty variables +14.3.4. Handling possibly empty variables When a possibly empty variable is used in a shell program, it may lead to a syntax error. @@ -3571,25 +3594,25 @@ install-examples: echo "Installing ${egfile}" .endfor -This variant only works when EGFILES does not contain filenames with spaces, -since the .for loop splits on simple whitespace. +If one of the filenames contains special characters, it should be enclosed in +single or double quotes. To have a shell command test whether a make variable is empty, use the following code: ${TEST} -z ${POSSIBLY_EMPTY:Q}"". -Chapter 13. PLIST issues +Chapter 15. PLIST issues Table of Contents -13.1. RCS ID -13.2. Semi-automatic PLIST generation -13.3. Tweaking output of make print-PLIST -13.4. Variable substitution in PLIST -13.5. Man page compression -13.6. Changing PLIST source with PLIST_SRC -13.7. Platform-specific and differing PLISTs -13.8. Build-specific PLISTs -13.9. Sharing directories between packages +15.1. RCS ID +15.2. Semi-automatic PLIST generation +15.3. Tweaking output of make print-PLIST +15.4. Variable substitution in PLIST +15.5. Man page compression +15.6. Changing PLIST source with PLIST_SRC +15.7. Platform-specific and differing PLISTs +15.8. Build-specific PLISTs +15.9. Sharing directories between packages The PLIST file contains a package's "packing list", i.e. a list of files that belong to the package (relative to the ${PREFIX} directory it's been installed @@ -3597,7 +3620,7 @@ in) plus some additional statements - see the pkg_create(1) man page for a full list. This chapter addresses some issues that need attention when dealing with the PLIST file (or files, see below!). -13.1. RCS ID +15.1. RCS ID Be sure to add a RCS ID line as the first thing in any PLIST file you write: @@ -3607,13 +3630,13 @@ An artificial space has been added between NetBSD and $, this is a workaround here to prevent CVS expanding to the filename of the guide. When adding the RCS ID the space should be omitted. -13.2. Semi-automatic PLIST generation +15.2. Semi-automatic PLIST generation You can use the make print-PLIST command to output a PLIST that matches any new -files since the package was extracted. See Section 17.17, "Other helpful +files since the package was extracted. See Section 19.17, "Other helpful targets" for more information on this target. -13.3. Tweaking output of make print-PLIST +15.3. Tweaking output of make print-PLIST The PRINT_PLIST_AWK variable takes a set of AWK patterns and actions that are used to filter the output of print-PLIST. You can append any chunk of AWK @@ -3624,7 +3647,7 @@ resulting PLIST: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; } -13.4. Variable substitution in PLIST +15.4. Variable substitution in PLIST A number of variables are substituted automatically in PLISTs when a package is installed on a system. This includes the following variables: @@ -3661,7 +3684,7 @@ PLIST_SUBST should help. If you want to change other variables not listed above, you can add variables and their expansions to this variable in the following way, similar to -MESSAGE_SUBST (see Section 11.5, "Optional files"): +MESSAGE_SUBST (see Section 13.5, "Optional files"): PLIST_SUBST+= SOMEVAR="somevalue" @@ -3691,7 +3714,7 @@ An artificial space has been added between NetBSD and $, this is a workaround here to prevent CVS expanding to the filename of the guide. When adding the RCS ID the space should be ommited. -13.5. Man page compression +15.5. Man page compression Man pages should be installed in compressed form if MANZ is set (in bsd.own.mk), and uncompressed otherwise. To handle this in the PLIST file, the @@ -3699,14 +3722,14 @@ suffix ".gz" is appended/removed automatically for man pages according to MANZ and MANCOMPRESSED being set or not, see above for details. This modification of the PLIST file is done on a copy of it, not PLIST itself. -13.6. Changing PLIST source with PLIST_SRC +15.6. Changing PLIST source with PLIST_SRC To use one or more files as source for the PLIST used in generating the binary package, set the variable PLIST_SRC to the names of that file(s). The files are later concatenated using cat(1), and the order of things is important. The default for PLIST_SRC is ${PKGDIR}/PLIST. -13.7. Platform-specific and differing PLISTs +15.7. Platform-specific and differing PLISTs Some packages decide to install a different set of files based on the operating system being used. These differences can be automatically handled by using the @@ -3722,7 +3745,7 @@ following files: * PLIST.common_end -13.8. Build-specific PLISTs +15.8. Build-specific PLISTs Some packages decide to generate hard-to-guess file names during installation that are hard to wire down. @@ -3737,7 +3760,7 @@ GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ; which will append something like bin/xemacs-21.4.23-54e8ea71.dmp to the PLIST. -13.9. Sharing directories between packages +15.9. Sharing directories between packages A "shared directory" is a directory where multiple (and unrelated) packages install files. These directories were problematic because you had to add @@ -3755,21 +3778,21 @@ installation as usual, and also add an entry to the PLIST: or take a look at MAKE_DIRS and OWN_DIRS. -Chapter 14. Buildlink methodology +Chapter 16. Buildlink methodology Table of Contents -14.1. Converting packages to use buildlink3 -14.2. Writing buildlink3.mk files +16.1. Converting packages to use buildlink3 +16.2. Writing buildlink3.mk files - 14.2.1. Anatomy of a buildlink3.mk file - 14.2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS.pkg in + 16.2.1. Anatomy of a buildlink3.mk file + 16.2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS.pkg in buildlink3.mk files -14.3. Writing builtin.mk files +16.3. Writing builtin.mk files - 14.3.1. Anatomy of a builtin.mk file - 14.3.2. Global preferences for native or pkgsrc software + 16.3.1. Anatomy of a builtin.mk file + 16.3.2. Global preferences for native or pkgsrc software Buildlink is a framework in pkgsrc that controls what headers and libraries are seen by a package's configure and build processes. This is implemented in a two @@ -3790,7 +3813,7 @@ note that the normal system header and library paths, e.g. /usr/include, /usr/ lib, etc., are always searched -- buildlink3 is designed to insulate the package build from non-system-supplied software. -14.1. Converting packages to use buildlink3 +16.1. Converting packages to use buildlink3 The process of converting packages to use the buildlink3 framework ("bl3ifying" ) is fairly straightforward. The things to keep in mind are: @@ -3863,7 +3886,7 @@ issues: The comments in those buildlink3.mk files provide a more complete description of how to use them properly. -14.2. Writing buildlink3.mk files +16.2. Writing buildlink3.mk files A package's buildlink3.mk file is included by Makefiles to indicate the need to compile and link against header files and libraries provided by the package. A @@ -3879,7 +3902,7 @@ following command will generate a good starting point for buildlink3.mk files: % createbuildlink >buildlink3.mk -14.2.1. Anatomy of a buildlink3.mk file +16.2.1. Anatomy of a buildlink3.mk file The following real-life example buildlink3.mk is taken from pkgsrc/graphics/ tiff: @@ -3979,7 +4002,7 @@ included: pulls in the X libraries, so they will show up in the ldd output, while on others (like OS X) it won't. ldd output can thus only be used as a hint. -14.2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS.pkg in +16.2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS.pkg in buildlink3.mk files These two variables differ in that one describes source compatibility (API) and @@ -3999,7 +4022,7 @@ buildlink3.mk files, their BUILDLINK_ABI_DEPENDS.pkg adjusted, too. This is needed so pkgsrc will require the correct package dependency and not settle for an older one when building the source. -See Section 19.1.5, "Handling dependencies" for more information about +See Section 21.1.5, "Handling dependencies" for more information about dependencies on other packages, including the BUILDLINK_ABI_DEPENDS and ABI_DEPENDS definitions. @@ -4011,7 +4034,7 @@ dependencies. Also it is not needed to set BUILDLINK_ABI_DEPENDS.pkg when it is identical to BUILDLINK_API_DEPENDS.pkg. -14.3. Writing builtin.mk files +16.3. Writing builtin.mk files Some packages in pkgsrc install headers and libraries that coincide with headers and libraries present in the base system. Aside from a buildlink3.mk @@ -4029,7 +4052,7 @@ The only requirements of a builtin.mk file for pkg are: 3. It should be written to allow multiple inclusion. This is very important and takes careful attention to Makefile coding. -14.3.1. Anatomy of a builtin.mk file +16.3.1. Anatomy of a builtin.mk file The following is the recommended template for builtin.mk files: @@ -4094,7 +4117,7 @@ the value of USE_BUILTIN.pkg set in the previous section. This typically includes, e.g., adding additional dependency restrictions and listing additional files to symlink into ${BUILDLINK_DIR} (via BUILDLINK_FILES.pkg). -14.3.2. Global preferences for native or pkgsrc software +16.3.2. Global preferences for native or pkgsrc software When building packages, it's possible to choose whether to set a global preference for using either the built-in (native) version or the pkgsrc version @@ -4122,34 +4145,34 @@ other. # ./bootstrap --prefer-pkgsrc yes -Chapter 15. The pkginstall framework +Chapter 17. The pkginstall framework Table of Contents -15.1. Files and directories outside the installation prefix +17.1. Files and directories outside the installation prefix - 15.1.1. Directory manipulation - 15.1.2. File manipulation + 17.1.1. Directory manipulation + 17.1.2. File manipulation -15.2. Configuration files +17.2. Configuration files - 15.2.1. How PKG_SYSCONFDIR is set - 15.2.2. Telling the software where configuration files are - 15.2.3. Patching installations - 15.2.4. Disabling handling of configuration files + 17.2.1. How PKG_SYSCONFDIR is set + 17.2.2. Telling the software where configuration files are + 17.2.3. Patching installations + 17.2.4. Disabling handling of configuration files -15.3. System startup scripts +17.3. System startup scripts - 15.3.1. Disabling handling of system startup scripts + 17.3.1. Disabling handling of system startup scripts -15.4. System users and groups -15.5. System shells +17.4. System users and groups +17.5. System shells - 15.5.1. Disabling shell registration + 17.5.1. Disabling shell registration -15.6. Fonts +17.6. Fonts - 15.6.1. Disabling automatic update of the fonts databases + 17.6.1. Disabling automatic update of the fonts databases This chapter describes the framework known as pkginstall, whose key features are: @@ -4178,7 +4201,7 @@ itself could be unavailable). Therefore, the only way to achieve any of the items described above is by means of the installation scripts, which are automatically generated by pkginstall. -15.1. Files and directories outside the installation prefix +17.1. Files and directories outside the installation prefix As you already know, the PLIST file holds a list of files and directories that belong to a package. The names used in it are relative to the installation @@ -4207,7 +4230,7 @@ scripts to abstract the manipulation of such files and directories based on variables set in the package's Makefile. The rest of this section describes these variables. -15.1.1. Directory manipulation +17.1.1. Directory manipulation The following variables can be set to request the creation of directories anywhere in the file system: @@ -4232,7 +4255,7 @@ anywhere in the file system: The difference between the two is exactly the same as their non-PERMS counterparts. -15.1.2. File manipulation +17.1.2. File manipulation Creating non-empty files outside the installation prefix is tricky because the PLIST forces all files to be inside it. To overcome this problem, the only @@ -4263,7 +4286,7 @@ handle files outside the installation prefix: The difference between the two is exactly the same as their non-PERMS counterparts. -15.2. Configuration files +17.2. Configuration files Configuration files are special in the sense that they are installed in their own specific directory, PKG_SYSCONFDIR, and need special treatment during @@ -4274,7 +4297,7 @@ if and only if they didn't exist before. Similarly, they will not be removed if they have local modifications. This ensures that administrators never lose any custom changes they may have made. -15.2.1. How PKG_SYSCONFDIR is set +17.2.1. How PKG_SYSCONFDIR is set As said before, the PKG_SYSCONFDIR variable specifies where configuration files shall be installed. Its contents are set based upon the following variables: @@ -4314,11 +4337,11 @@ basically the following: 3. Otherwise, it is set to ${PKG_SYSCONFBASE}. It is worth mentioning that ${PKG_SYSCONFDIR} is automatically added to -OWN_DIRS. See Section 15.1.1, "Directory manipulation" what this means. This +OWN_DIRS. See Section 17.1.1, "Directory manipulation" what this means. This does not apply to subdirectories of ${PKG_SYSCONFDIR}, they still have to be created with OWN_DIRS or MAKE_DIRS. -15.2.2. Telling the software where configuration files are +17.2.2. Telling the software where configuration files are Given that pkgsrc (and users!) expect configuration files to be in a known place, you need to teach each package where it shall install its files. In some @@ -4332,7 +4355,7 @@ Note that this specifies where the package has to look for its configuration files, not where they will be originally installed (although the difference is never explicit, unfortunately). -15.2.3. Patching installations +17.2.3. Patching installations As said before, pkginstall automatically handles configuration files. This means that the packages themselves must not touch the contents of $ @@ -4349,7 +4372,7 @@ Once the required configuration files are in place (i.e., under the examples hierarchy), the pkginstall framework can use them as master copies during the package installation to update what is in ${PKG_SYSCONFDIR}. To achieve this, the variables CONF_FILES and CONF_FILES_PERMS are used. Check out -Section 15.1.2, "File manipulation" for information about their syntax and +Section 17.1.2, "File manipulation" for information about their syntax and their purpose. Here is an example, taken from the mail/mutt package: EGDIR= ${PREFIX}/share/doc/mutt/samples @@ -4358,16 +4381,16 @@ CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc Note that the EGDIR variable is specific to that package and has no meaning outside it. -15.2.4. Disabling handling of configuration files +17.2.4. Disabling handling of configuration files The automatic copying of config files can be toggled by setting the environment variable PKG_CONFIG prior to package installation. -15.3. System startup scripts +17.3. System startup scripts System startup scripts are special files because they must be installed in a place known by the underlying OS, usually outside the installation prefix. -Therefore, the same rules described in Section 15.1, "Files and directories +Therefore, the same rules described in Section 17.1, "Files and directories outside the installation prefix" apply, and the same solutions can be used. However, pkginstall provides a special mechanism to handle these files. @@ -4395,14 +4418,14 @@ automated fashion: 3. Add code to the installation scripts to copy the startup script from the examples hierarchy into the system-wide startup scripts directory. -15.3.1. Disabling handling of system startup scripts +17.3.1. Disabling handling of system startup scripts The automatic copying of config files can be toggled by setting the environment variable PKG_RCD_SCRIPTS prior to package installation. Note that the scripts will be always copied inside the examples hierarchy, ${PREFIX}/share/examples/ rc.d/, no matter what the value of this variable is. -15.4. System users and groups +17.4. System users and groups If a package needs to create special users and/or groups during installation, it can do so by using the pkginstall framework. @@ -4431,7 +4454,7 @@ the phase before which the users and groups are created. In this case, the numeric UIDs and GIDs of the created users and groups are automatically hardcoded into the final installation scripts. -15.5. System shells +17.5. System shells Packages that install system shells should register them in the shell database, /etc/shells, to make things easier to the administrator. This must be done from @@ -4445,12 +4468,12 @@ shells/zsh: PKG_SHELL= ${PREFIX}/bin/zsh -15.5.1. Disabling shell registration +17.5.1. Disabling shell registration The automatic registration of shell interpreters can be disabled by the administrator by setting the PKG_REGISTER_SHELLS environment variable to NO. -15.6. Fonts +17.6. Fonts Packages that install X11 fonts should update the database files that index the fonts within each fonts directory. This can easily be accomplished within the @@ -4466,19 +4489,19 @@ example, taken from fonts/dbz-ttf: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF -15.6.1. Disabling automatic update of the fonts databases +17.6.1. Disabling automatic update of the fonts databases The automatic update of fonts databases can be disabled by the administrator by setting the PKG_UPDATE_FONTS_DB environment variable to NO. -Chapter 16. Options handling +Chapter 18. Options handling Table of Contents -16.1. Global default options -16.2. Converting packages to use bsd.options.mk -16.3. Option Names -16.4. Determining the options of dependencies +18.1. Global default options +18.2. Converting packages to use bsd.options.mk +18.3. Option Names +18.4. Determining the options of dependencies Many packages have the ability to be built to support different sets of features. bsd.options.mk is a framework in pkgsrc that provides generic @@ -4515,13 +4538,13 @@ A further consideration is licensing. Non-free parts, or parts that depend on non-free dependencies (especially plugins) should almost always be split if feasible. -16.1. Global default options +18.1. Global default options Global default options are listed in PKG_DEFAULT_OPTIONS, which is a list of the options that should be built into every package if that option is supported. This variable should be set in mk.conf. -16.2. Converting packages to use bsd.options.mk +18.2. Converting packages to use bsd.options.mk The following example shows how bsd.options.mk should be used by the hypothetical ``wibble'' package, either in the package Makefile, or in a file, @@ -4639,7 +4662,7 @@ PKG_OPTIONS: .if !empty(PKG_OPTIONS:Moption) -16.3. Option Names +18.3. Option Names Options that enable similar features in different packages (like optional support for a library) should use a common name in all packages that support it @@ -4660,7 +4683,7 @@ description. The description should be a whole sentence (starting with an uppercase letter and ending with a period) that describes what enabling the option does. E. g. "Enable ispell support." The file is sorted by option names. -16.4. Determining the options of dependencies +18.4. Determining the options of dependencies When writing buildlink3.mk files, it is often necessary to list different dependencies based on the options with which the package was built. For @@ -4679,33 +4702,33 @@ PKG_BUILD_OPTIONS.libpurple to the build options of the libpurple package, which can then be queried like PKG_OPTIONS in the options.mk file. See the file pkg-build-options.mk for more details. -Chapter 17. The build process +Chapter 19. The build process Table of Contents -17.1. Introduction -17.2. Program location -17.3. Directories used during the build process -17.4. Running a phase -17.5. The fetch phase - - 17.5.1. What to fetch and where to get it from - 17.5.2. How are the files fetched? - -17.6. The checksum phase -17.7. The extract phase -17.8. The patch phase -17.9. The tools phase -17.10. The wrapper phase -17.11. The configure phase -17.12. The build phase -17.13. The test phase -17.14. The install phase -17.15. The package phase -17.16. Cleaning up -17.17. Other helpful targets - -17.1. Introduction +19.1. Introduction +19.2. Program location +19.3. Directories used during the build process +19.4. Running a phase +19.5. The fetch phase + + 19.5.1. What to fetch and where to get it from + 19.5.2. How are the files fetched? + +19.6. The checksum phase +19.7. The extract phase +19.8. The patch phase +19.9. The tools phase +19.10. The wrapper phase +19.11. The configure phase +19.12. The build phase +19.13. The test phase +19.14. The install phase +19.15. The package phase +19.16. Cleaning up +19.17. Other helpful targets + +19.1. Introduction This chapter gives a detailed description on how a package is built. Building a package is separated into different phases (for example fetch, build, install), @@ -4727,7 +4750,7 @@ To get more details about what is happening at each step, you can set the PKG_VERBOSE variable, or the PATCH_DEBUG variable if you are just interested in more details about the patch step. -17.2. Program location +19.2. Program location Before outlining the process performed by the NetBSD package system in the next section, here's a brief discussion on where programs are installed, and which @@ -4737,7 +4760,7 @@ The automatic variable PREFIX indicates where all files of the final program shall be installed. It is usually set to LOCALBASE (/usr/pkg), or CROSSBASE for pkgs in the cross category. The value of PREFIX needs to be put into the various places in the program's source where paths to these files are encoded. -See Section 11.3, "patches/*" and Section 19.3.1, "Shared libraries - libtool" +See Section 13.3, "patches/*" and Section 21.3.1, "Shared libraries - libtool" for more details. When choosing which of these variables to use, follow the following rules: @@ -4764,7 +4787,7 @@ When choosing which of these variables to use, follow the following rules: the exception that manual pages go into ${PREFIX}/man, not ${PREFIX}/share/ man. -17.3. Directories used during the build process +19.3. Directories used during the build process When building a package, various directories are used to store source files, temporary files, pkgsrc-internal files, and so on. These directories are @@ -4809,7 +4832,7 @@ created in the pkgsrc entry's directory. If users would like to have their pkgsrc trees behave in a read-only manner, then the value of CREATE_WRKDIR_SYMLINK should be set to no. -17.4. Running a phase +19.4. Running a phase You can run a particular phase by typing make phase, where phase is the name of the phase. This will automatically run all phases that are required for this @@ -4817,13 +4840,13 @@ phase. The default phase is build, that is, when you run make without parameters in a package directory, the package will be built, but not installed. -17.5. The fetch phase +19.5. The fetch phase The first step in building a package is to fetch the distribution files (distfiles) from the sites that are providing them. This is the task of the fetch phase. -17.5.1. What to fetch and where to get it from +19.5.1. What to fetch and where to get it from In simple cases, MASTER_SITES defines all URLs from where the distfile, whose name is derived from the DISTNAME variable, is fetched. The more complicated @@ -4920,7 +4943,7 @@ MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/} Note the trailing slash after the subdirectory name. -17.5.2. How are the files fetched? +19.5.2. How are the files fetched? The fetch phase makes sure that all the distfiles exist in a local directory (DISTDIR, which can be set by the pkgsrc user). If the files do not exist, they @@ -4943,7 +4966,7 @@ target to mirror the distfiles, if they are freely distributable. Packages setting NO_SRC_ON_FTP (usually to "${RESTRICTED}") will not have their distfiles mirrored. -17.6. The checksum phase +19.6. The checksum phase After the distfile(s) are fetched, their checksum is generated and compared with the checksums stored in the distinfo file. If the checksums don't match, @@ -4951,7 +4974,7 @@ the build is aborted. This is to ensure the same distfile is used for building, and that the distfile wasn't changed, e.g. by some malign force, deliberately changed distfiles on the master distribution site or network lossage. -17.7. The extract phase +19.7. The extract phase When the distfiles are present on the local system, they need to be extracted, as they usually come in the form of some compressed archive format. @@ -4985,25 +5008,25 @@ file that is going to be extracted. And if that still does not suffice, you can override the do-extract target in the package Makefile. -17.8. The patch phase +19.8. The patch phase After extraction, all the patches named by the PATCHFILES, those present in the patches subdirectory of the package as well as in $LOCALPATCHES/$PKGPATH (e.g. /usr/local/patches/graphics/png) are applied. Patchfiles ending in .Z or .gz are uncompressed before they are applied, files ending in .orig or .rej are ignored. Any special options to patch(1) can be handed in PATCH_DIST_ARGS. See -Section 11.3, "patches/*" for more details. +Section 13.3, "patches/*" for more details. By default patch(1) is given special args to make it fail if the patches apply with some lines of fuzz. Please fix (regen) the patches so that they apply cleanly. The rationale behind this is that patches that don't apply cleanly may end up being applied in the wrong place, and cause severe harm there. -17.9. The tools phase +19.9. The tools phase -This is covered in Chapter 18, Tools needed for building or running. +This is covered in Chapter 20, Tools needed for building or running. -17.10. The wrapper phase +19.10. The wrapper phase This phase creates wrapper programs for the compilers and linkers. The following variables can be used to tweak the wrappers. @@ -5033,7 +5056,7 @@ WRAPPER_TRANSFORM_CMDS A list of transformation commands. [TODO: investigate further] -17.11. The configure phase +19.11. The configure phase Most pieces of software need information on the header files, system calls, and library routines which are available on the platform they run on. The process @@ -5077,7 +5100,7 @@ CONFIGURE_DIRS) If there is no configure step at all, set NO_CONFIGURE to "yes". -17.12. The build phase +19.12. The build phase For building a package, a rough equivalent of the following code is executed. @@ -5101,11 +5124,11 @@ defaults to "all". If there is no build step at all, set NO_BUILD to "yes". -17.13. The test phase +19.13. The test phase [TODO] -17.14. The install phase +19.14. The install phase Once the build stage has completed, the final step is to install the software in public directories, so users can access the programs and files. @@ -5202,7 +5225,7 @@ INSTALLATION_DIRS In the rare cases that a package shouldn't install anything, set NO_INSTALL to "yes". This is mostly relevant for packages in the regress category. -17.15. The package phase +19.15. The package phase Once the install stage has completed, a binary package of the installed files can be built. These binary packages can be used for quick installation without @@ -5212,13 +5235,13 @@ By default, the binary packages are created in ${PACKAGES}/All and symlinks are created in ${PACKAGES}/category, one for each category in the CATEGORIES variable. PACKAGES defaults to pkgsrc/packages. -17.16. Cleaning up +19.16. Cleaning up Once you're finished with a package, you can clean the work directory by running make clean. If you want to clean the work directories of all dependencies too, use make clean-depends. -17.17. Other helpful targets +19.17. Other helpful targets pre/post-* @@ -5488,14 +5511,14 @@ print-PLIST file access times, be sure to add these files manually to your PLIST, as the "find -newer" command used by this target won't catch them! - See Section 13.3, "Tweaking output of make print-PLIST" for more + See Section 15.3, "Tweaking output of make print-PLIST" for more information on this target. bulk-package Used to do bulk builds. If an appropriate binary package already exists, no action is taken. If not, this target will compile, install and package it - (and its depends, if PKG_DEPENDS is set properly. See Chapter 7, Creating + (and its depends, if PKG_DEPENDS is set properly. See Chapter 8, Creating binary packages for everything in pkgsrc (bulk builds)). After creating the binary package, the sources, the just-installed package and its required packages are removed, preserving free disk space. @@ -5520,13 +5543,13 @@ bulk-install Beware that this target may deinstall all packages installed on a system! -Chapter 18. Tools needed for building or running +Chapter 20. Tools needed for building or running Table of Contents -18.1. Tools for pkgsrc builds -18.2. Tools needed by packages -18.3. Tools provided by platforms +20.1. Tools for pkgsrc builds +20.2. Tools needed by packages +20.3. Tools provided by platforms The USE_TOOLS definition is used both internally by pkgsrc and also for individual packages to define what commands are needed for building a package @@ -5547,7 +5570,7 @@ package may need GNU awk, bison (instead of yacc) or a better sed. The tools used by a package can be listed by running make show-tools. -18.1. Tools for pkgsrc builds +20.1. Tools for pkgsrc builds The default set of tools used by pkgsrc is defined in bsd.pkg.mk. This includes standard Unix tools, such as: cat, awk, chmod, test, and so on. These can be @@ -5556,7 +5579,7 @@ seen by running: make show-var VARNAME=USE_TOOLS. If a package needs a specific program to build then the USE_TOOLS variable can be used to define the tools needed. -18.2. Tools needed by packages +20.2. Tools needed by packages In the following examples, the :run means that it is needed at run-time (and becomes a DEPENDS). The default is a build dependency which can be set with @@ -5572,7 +5595,7 @@ could be "/bin/bash" on Linux systems. If you always need a pkgsrc version of the tool at run-time, then just use DEPENDS instead. -18.3. Tools provided by platforms +20.3. Tools provided by platforms When improving or porting pkgsrc to a new platform, have a look at (or create) the corresponding platform specific make file fragment under pkgsrc/mk/tools/ @@ -5586,86 +5609,86 @@ TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd TOOLS_PLATFORM.true?= true # shell builtin -Chapter 19. Making your package work +Chapter 21. Making your package work Table of Contents -19.1. General operation - - 19.1.1. How to pull in user-settable variables from mk.conf - 19.1.2. User interaction - 19.1.3. Handling licenses - 19.1.4. Restricted packages - 19.1.5. Handling dependencies - 19.1.6. Handling conflicts with other packages - 19.1.7. Packages that cannot or should not be built - 19.1.8. Packages which should not be deleted, once installed - 19.1.9. Handling packages with security problems - 19.1.10. How to handle incrementing versions when fixing an existing +21.1. General operation + + 21.1.1. How to pull in user-settable variables from mk.conf + 21.1.2. User interaction + 21.1.3. Handling licenses + 21.1.4. Restricted packages + 21.1.5. Handling dependencies + 21.1.6. Handling conflicts with other packages + 21.1.7. Packages that cannot or should not be built + 21.1.8. Packages which should not be deleted, once installed + 21.1.9. Handling packages with security problems + 21.1.10. How to handle incrementing versions when fixing an existing package - 19.1.11. Substituting variable text in the package files (the SUBST + 21.1.11. Substituting variable text in the package files (the SUBST framework) -19.2. The fetch phase +21.2. The fetch phase - 19.2.1. Packages whose distfiles aren't available for plain downloading - 19.2.2. How to handle modified distfiles with the 'old' name - 19.2.3. Packages hosted on github.com + 21.2.1. Packages whose distfiles aren't available for plain downloading + 21.2.2. How to handle modified distfiles with the 'old' name + 21.2.3. Packages hosted on github.com -19.3. The configure phase +21.3. The configure phase - 19.3.1. Shared libraries - libtool - 19.3.2. Using libtool on GNU packages that already support libtool - 19.3.3. GNU Autoconf/Automake + 21.3.1. Shared libraries - libtool + 21.3.2. Using libtool on GNU packages that already support libtool + 21.3.3. GNU Autoconf/Automake -19.4. Programming languages +21.4. Programming languages - 19.4.1. C, C++, and Fortran - 19.4.2. Java - 19.4.3. Packages containing perl scripts - 19.4.4. Packages containing shell scripts - 19.4.5. Other programming languages + 21.4.1. C, C++, and Fortran + 21.4.2. Java + 21.4.3. Packages containing perl scripts + 21.4.4. Packages containing shell scripts + 21.4.5. Other programming languages -19.5. The build phase +21.5. The build phase - 19.5.1. Compiling C and C++ code conditionally - 19.5.2. How to handle compiler bugs - 19.5.3. Undefined reference to "..." - 19.5.4. Running out of memory + 21.5.1. Compiling C and C++ code conditionally + 21.5.2. How to handle compiler bugs + 21.5.3. Undefined reference to "..." + 21.5.4. Running out of memory -19.6. The install phase +21.6. The install phase - 19.6.1. Creating needed directories - 19.6.2. Where to install documentation - 19.6.3. Installing highscore files - 19.6.4. Adding DESTDIR support to packages - 19.6.5. Packages with hardcoded paths to other interpreters - 19.6.6. Packages installing perl modules - 19.6.7. Packages installing info files - 19.6.8. Packages installing man pages - 19.6.9. Packages installing GConf data files - 19.6.10. Packages installing scrollkeeper/rarian data files - 19.6.11. Packages installing X11 fonts - 19.6.12. Packages installing GTK2 modules - 19.6.13. Packages installing SGML or XML data - 19.6.14. Packages installing extensions to the MIME database - 19.6.15. Packages using intltool - 19.6.16. Packages installing startup scripts - 19.6.17. Packages installing TeX modules - 19.6.18. Packages supporting running binaries in emulation - 19.6.19. Packages installing hicolor theme icons - 19.6.20. Packages installing desktop files + 21.6.1. Creating needed directories + 21.6.2. Where to install documentation + 21.6.3. Installing highscore files + 21.6.4. Adding DESTDIR support to packages + 21.6.5. Packages with hardcoded paths to other interpreters + 21.6.6. Packages installing perl modules + 21.6.7. Packages installing info files + 21.6.8. Packages installing man pages + 21.6.9. Packages installing GConf data files + 21.6.10. Packages installing scrollkeeper/rarian data files + 21.6.11. Packages installing X11 fonts + 21.6.12. Packages installing GTK2 modules + 21.6.13. Packages installing SGML or XML data + 21.6.14. Packages installing extensions to the MIME database + 21.6.15. Packages using intltool + 21.6.16. Packages installing startup scripts + 21.6.17. Packages installing TeX modules + 21.6.18. Packages supporting running binaries in emulation + 21.6.19. Packages installing hicolor theme icons + 21.6.20. Packages installing desktop files -19.7. Marking packages as having problems +21.7. Marking packages as having problems -19.1. General operation +21.1. General operation One appealing feature of pkgsrc is that it runs on many different platforms. As a result, it is important to ensure, where possible, that packages in pkgsrc are portable. This chapter mentions some particular details you should pay attention to while working on pkgsrc. -19.1.1. How to pull in user-settable variables from mk.conf +21.1.1. How to pull in user-settable variables from mk.conf The pkgsrc user can configure pkgsrc by overriding several variables in the file pointed to by MAKECONF, which is mk.conf by default. When you want to use @@ -5686,7 +5709,7 @@ Note To check whether a variable can be used at load time, run pkglint -Wall on your package. -19.1.2. User interaction +21.1.2. User interaction Occasionally, packages require interaction from the user, and this can be in a number of ways: @@ -5710,7 +5733,7 @@ INTERACTIVE_STAGE= configure install The user can then decide to skip this package by setting the BATCH variable. Packages that require interaction are also excluded from bulk builds. -19.1.3. Handling licenses +21.1.3. Handling licenses Authors of software can choose the licence under which software can be copied. The Free Software Foundation has declared some licenses "Free", and the Open @@ -5763,7 +5786,7 @@ Another problem with such usage is that it does not enable a user to tell pkgsrc to proceed for a single package without also telling pkgsrc to proceed for all packages with that tag. -19.1.3.1. Adding a package with a new license +21.1.3.1. Adding a package with a new license When adding a package with a new license, the following steps are required: @@ -5780,7 +5803,7 @@ When adding a package with a new license, the following steps are required: 2. The license text should be added to pkgsrc/licenses for displaying. A list of known licenses can be seen in this directory. -19.1.3.2. Change to the license +21.1.3.2. Change to the license When the license changes (in a way other than formatting), make sure that the new license has a different name (e.g., append the version number if it exists, @@ -5790,7 +5813,7 @@ under the new licenses. The higher-level point is that pkgsrc does not evaluate licenses for reasonableness; the only test is a mechanistic test of whether a particular text has been approved by either of two bodies (FSF or OSI). -19.1.4. Restricted packages +21.1.4. Restricted packages Some licenses restrict how software may be re-distributed. By declaring the restrictions, package tools can automatically refrain from e.g. placing binary @@ -5845,13 +5868,13 @@ not distributable and cannot be obtained for a period of one full quarter branch. Packages with manual/interactive fetch must have a maintainer and it is his/her responsibility to ensure this. -19.1.5. Handling dependencies +21.1.5. Handling dependencies Your package may depend on some other package being present - and there are various ways of expressing this dependency. pkgsrc supports the BUILD_DEPENDS and DEPENDS definitions, the USE_TOOLS definition, as well as dependencies via buildlink3.mk, which is the preferred way to handle dependencies, and which -uses the variables named above. See Chapter 14, Buildlink methodology for more +uses the variables named above. See Chapter 16, Buildlink methodology for more information. The basic difference between the two variables is as follows: The DEPENDS @@ -5920,7 +5943,7 @@ version numbers recognized by pkg_info(1). section of the pkgsrc guide. For security fixes, please update the package vulnerabilities file. See - Section 19.1.9, "Handling packages with security problems" for more + Section 21.1.9, "Handling packages with security problems" for more information. If your package needs files from another package to build, add the relevant @@ -5928,7 +5951,7 @@ distribution files to DISTFILES, so they will be extracted automatically. See the print/ghostscript package for an example. (It relies on the jpeg sources being present in source form during the build.) -19.1.6. Handling conflicts with other packages +21.1.6. Handling conflicts with other packages Your package may conflict with other packages a user might already have installed on his system, e.g. if your package installs the same set of files as @@ -5958,7 +5981,7 @@ is known that packages conflict with each other. These CONFLICTS entries are exported in pkg_summary(5) files and consumed by binary package managers to inform users that packages cannot be installed onto the target system. -19.1.7. Packages that cannot or should not be built +21.1.7. Packages that cannot or should not be built There are several reasons why a package might be instructed to not build under certain circumstances. If the package builds and runs on most platforms, the @@ -5987,7 +6010,7 @@ functionality already provided by the system), set PKG_SKIP_REASON to a descriptive message. If the package should fail because some preconditions are not met, set PKG_FAIL_REASON to a descriptive message. -19.1.8. Packages which should not be deleted, once installed +21.1.8. Packages which should not be deleted, once installed To ensure that a package may not be deleted, once it has been installed, the PKG_PRESERVE definition should be set in the package Makefile. This will be @@ -5995,7 +6018,7 @@ carried into any binary package that is made from this pkgsrc entry. A " preserved" package will not be deleted using pkg_delete(1) unless the "-f" option is used. -19.1.9. Handling packages with security problems +21.1.9. Handling packages with security problems When a vulnerability is found, this should be noted in localsrc/security/ advisories/pkg-vulnerabilities, and after committing that file, ask @@ -6012,7 +6035,7 @@ submit a pullup request! Binary packages already on ftp.NetBSD.org will be handled semi-automatically by a weekly cron job. -19.1.10. How to handle incrementing versions when fixing an existing package +21.1.10. How to handle incrementing versions when fixing an existing package When making fixes to an existing package it can be useful to change the version number in PKGNAME. To avoid conflicting with future versions by the original @@ -6061,7 +6084,7 @@ Examples of changes that do merit an increase to PKGREVISION include: PKGREVISION must also be incremented when dependencies have ABI changes. -19.1.11. Substituting variable text in the package files (the SUBST framework) +21.1.11. Substituting variable text in the package files (the SUBST framework) When you want to replace the same text in multiple files or when the replacement text varies, patches alone cannot help. This is where the SUBST @@ -6111,9 +6134,9 @@ blocks look uniform. There are some more variables, but they are so seldomly used that they are only documented in the mk/subst.mk file. -19.2. The fetch phase +21.2. The fetch phase -19.2.1. Packages whose distfiles aren't available for plain downloading +21.2.1. Packages whose distfiles aren't available for plain downloading If you need to download from a dynamic URL you can set DYNAMIC_MASTER_SITES and a make fetch will call files/getsite.sh with the name of each file to download @@ -6129,7 +6152,7 @@ FETCH_MESSAGE= "Please download the files" FETCH_MESSAGE+= " "${DISTFILES:Q} FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"." -19.2.2. How to handle modified distfiles with the 'old' name +21.2.2. How to handle modified distfiles with the 'old' name Sometimes authors of a software package make some modifications after the software was released, and they put up a new distfile without changing the @@ -6144,7 +6167,7 @@ Then, the correct way to work around this is to set DIST_SUBDIR to a unique directory name, usually based on PKGNAME_NOREV (but take care with python or ruby packages, where PKGNAME includes a variable prefix). All DISTFILES and PATCHFILES for this package will be put in that subdirectory of the local -distfiles directory. (See Section 19.1.10, "How to handle incrementing versions +distfiles directory. (See Section 21.1.10, "How to handle incrementing versions when fixing an existing package" for more details.) In case this happens more often, PKGNAME can be used (thus including the nbX suffix) or a date stamp can be appended, like ${PKGNAME_NOREV}-YYYYMMDD. @@ -6161,13 +6184,13 @@ installed package is different. Furthermore, a mail to the package's authors seems appropriate telling them that changing distfiles after releases without changing the file names is not good practice. -19.2.3. Packages hosted on github.com +21.2.3. Packages hosted on github.com Helper methods exist for packages hosted on github.com which will often have distfile names that clash with other packages, for example 1.0.tar.gz. Use one of the three recipes from below: -19.2.3.1. Fetch based on a tagged release +21.2.3.1. Fetch based on a tagged release If your distfile URL looks similar to http://github.com/username/exampleproject /archive/v1.0.zip, then you are packaging a tagged release. @@ -6178,7 +6201,7 @@ MASTER_SITES= ${MASTER_SITE_GITHUB:=username/} GITHUB_TAG= v${PKGVERSION_NOREV} EXTRACT_SUFX= .zip -19.2.3.2. Fetch based on a specific commit +21.2.3.2. Fetch based on a specific commit If your distfile URL looks similar to http://github.com/example/example/archive /988881adc9fc3655077dc2d4d757d480b5ea0e11.tar.gz, then you are packaging a @@ -6189,7 +6212,7 @@ MASTER_SITES= ${MASTER_SITE_GITHUB:=example/} #GITHUB_PROJECT= # can be omitted if same as DISTNAME GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11 -19.2.3.3. Fetch based on release +21.2.3.3. Fetch based on release If your distfile URL looks similar to http://github.com/username/exampleproject /releases/download/rel-1.6/offensive-1.6.zip, then you are packaging a release. @@ -6201,9 +6224,9 @@ GITHUB_PROJECT= exampleproject GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME} EXTRACT_SUFX= .zip -19.3. The configure phase +21.3. The configure phase -19.3.1. Shared libraries - libtool +21.3.1. Shared libraries - libtool pkgsrc supports many different machines, with different object formats like a.out and ELF, and varying abilities to do shared library and dynamic loading @@ -6301,7 +6324,7 @@ Here's how to use libtool in a package in seven simple steps: 7. In your PLIST, include only the .la file (this is a change from previous behaviour). -19.3.2. Using libtool on GNU packages that already support libtool +21.3.2. Using libtool on GNU packages that already support libtool Add USE_LIBTOOL=yes to the package Makefile. This will override the package's own libtool in most cases. For older libtool using packages, libtool is made by @@ -6335,7 +6358,7 @@ in some circumstances. Some of the more common errors are: The function lt_dlinit() should be called and the macro LTDL_SET_PRELOADED_SYMBOLS included in executables. -19.3.3. GNU Autoconf/Automake +21.3.3. GNU Autoconf/Automake If a package needs GNU autoconf or automake to be executed to regenerate the configure script and Makefile.in makefile templates, then they should be @@ -6372,13 +6395,13 @@ automake sequence. This is prevented by touching various files in the configure stage. If this causes problems with your package you can set AUTOMAKE_OVERRIDE= NO in the package Makefile. -19.4. Programming languages +21.4. Programming languages -19.4.1. C, C++, and Fortran +21.4.1. C, C++, and Fortran Compilers for the C, C++, and Fortran languages comes with the NetBSD base system. By default, pkgsrc assumes that a package is written in C and will hide -all other compilers (via the wrapper framework, see Chapter 14, Buildlink +all other compilers (via the wrapper framework, see Chapter 16, Buildlink methodology). To declare which language's compiler a package needs, set the USE_LANGUAGES @@ -6386,7 +6409,7 @@ variable. Allowed values currently are "c", "c++", and "fortran" (and any combination). The default is "c". Packages using GNU configure scripts, even if written in C++, usually need a C compiler for the configure phase. -19.4.2. Java +21.4.2. Java If a program is written in Java, use the Java framework in pkgsrc. The package must include ../../mk/java-vm.mk. This Makefile fragment provides the following @@ -6405,7 +6428,7 @@ variables: implementation dependency. It may be used to set JAVA_HOME to a good value if the program needs this variable to be defined. -19.4.3. Packages containing perl scripts +21.4.3. Packages containing perl scripts If your package contains interpreted perl scripts, add "perl" to the USE_TOOLS variable and set REPLACE_PERL to ensure that the proper interpreter path is @@ -6416,10 +6439,10 @@ replaced with the full path to the perl executable. If a particular version of perl is needed, set the PERL5_REQD variable to the version number. The default is "5.0". -See Section 19.6.6, "Packages installing perl modules" for information about +See Section 21.6.6, "Packages installing perl modules" for information about handling perl modules. -19.4.4. Packages containing shell scripts +21.4.4. Packages containing shell scripts REPLACE_SH, REPLACE_BASH, REPLACE_CSH, and REPLACE_KSH can be used to replace shell hash bangs in files. Please use the appropriate one, prefering REPLACE_SH @@ -6428,13 +6451,13 @@ relative to WRKSRC, that you want adjusted. Every occurrence of the matching shell in a she-bang line will be replaced with the full path to the shell executable. When using REPLACE_BASH, don't forget to add bash to USE_TOOLS. -19.4.5. Other programming languages +21.4.5. Other programming languages Currently, there is no special handling for other languages in pkgsrc. If a compiler package provides a buildlink3.mk file, include that, otherwise just add a (build) dependency on the appropriate compiler package. -19.5. The build phase +21.5. The build phase The most common failures when building a package are that some platforms do not provide certain header files, functions or libraries, or they provide the @@ -6442,7 +6465,7 @@ functions in a library that the original package author didn't know. To work around this, you can rewrite the source code in most cases so that it does not use the missing functions or provides a replacement function. -19.5.1. Compiling C and C++ code conditionally +21.5.1. Compiling C and C++ code conditionally If a package already comes with a GNU configure script, the preferred way to fix the build failure is to change the configure script, not the code. In the @@ -6459,7 +6482,7 @@ the compiler that is used. For example, if you want to conditionally compile code on Solaris, don't use __sun__, as the SunPro compiler does not define it. Use __sun instead. -19.5.1.1. C preprocessor macros to identify the operating system +21.5.1.1. C preprocessor macros to identify the operating system To distinguish between 4.4 BSD-derived systems and the rest of the world, you should use the following code. @@ -6488,20 +6511,20 @@ NetBSD __NetBSD__ OpenBSD __OpenBSD__ Solaris sun, __sun -19.5.1.2. C preprocessor macros to identify the hardware architecture +21.5.1.2. C preprocessor macros to identify the hardware architecture i386 i386, __i386, __i386__ MIPS __mips SPARC sparc, __sparc -19.5.1.3. C preprocessor macros to identify the compiler +21.5.1.3. C preprocessor macros to identify the compiler GCC __GNUC__ (major version), __GNUC_MINOR__ MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41) SunPro __SUNPRO_C (0x570 for Sun C 5.7) SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8) -19.5.2. How to handle compiler bugs +21.5.2. How to handle compiler bugs Some source files trigger bugs in the compiler, based on combinations of compiler version and architecture and almost always relation to optimisation @@ -6516,7 +6539,7 @@ technology has matured. If you still need to add a compiler specific workaround, please do so in the file hacks.mk and describe the symptom and compiler version as detailed as possible. -19.5.3. Undefined reference to "..." +21.5.3. Undefined reference to "..." This error message often means that a package did not link to a shared library it needs. The following functions are known to cause this error message over @@ -6543,7 +6566,7 @@ and over. To fix these linker errors, it is often sufficient to say LIBS.OperatingSystem+ = -lfoo to the package Makefile and then say bmake clean; bmake. -19.5.3.1. Special issue: The SunPro compiler +21.5.3.1. Special issue: The SunPro compiler When you are using the SunPro compiler, there is another possibility. That compiler cannot handle the following code: @@ -6565,7 +6588,7 @@ It generates the code for inline_func even if that function is never used. This code then refers to extern_func, which can usually not be resolved. To solve this problem you can try to tell the package to disable inlining of functions. -19.5.4. Running out of memory +21.5.4. Running out of memory Sometimes packages fail to build because the compiler runs into an operating system specific soft limit. With the UNLIMIT_RESOURCES variable pkgsrc can be @@ -6575,9 +6598,9 @@ this variable is similar to running the shell builtin ulimit command to raise the maximum data segment size or maximum stack size of a process, respectively, to their hard limits. -19.6. The install phase +21.6. The install phase -19.6.1. Creating needed directories +21.6.1. Creating needed directories The BSD-compatible install supplied with some operating systems cannot create more than one directory at a time. As such, you should call ${INSTALL_*_DIR} @@ -6589,7 +6612,7 @@ ${INSTALL_DATA_DIR} ${PREFIX}/dir2 You can also just append "dir1 dir2" to the INSTALLATION_DIRS variable, which will automatically do the right thing. -19.6.2. Where to install documentation +21.6.2. Where to install documentation In general, documentation should be installed into ${PREFIX}/share/doc/$ {PKGBASE} or ${PREFIX}/share/doc/${PKGNAME} (the latter includes the version @@ -6610,7 +6633,7 @@ then, no additional subdirectory level is allowed in this case. This is usually achieved by using "--with-html-dir=${PREFIX}/share/doc". ${PREFIX}/share/ gtk-doc is preferred though.) -19.6.3. Installing highscore files +21.6.3. Installing highscore files Certain packages, most of them in the games category, install a score file that allows all users on the system to record their highscores. In order for this to @@ -6643,7 +6666,7 @@ A package should therefore never hard code file ownership or access permissions but rely on *_PERMS as described above or alternatively on INSTALL_GAME, INSTALL_GAME_DATA and INSTALL_GAME_DIR to set these correctly. -19.6.4. Adding DESTDIR support to packages +21.6.4. Adding DESTDIR support to packages DESTDIR support means that a package installs into a staging directory, not the final location of the files. Then a binary package is created which can be used @@ -6665,7 +6688,7 @@ as root ("destdir") or the package can install as non-root user ("user-destdir" * In general, packages should support UNPRIVILEGED to be able to use DESTDIR. -19.6.5. Packages with hardcoded paths to other interpreters +21.6.5. Packages with hardcoded paths to other interpreters Your package may also contain scripts with hardcoded paths to other interpreters besides (or as well as) perl. To correct the full pathname to the @@ -6682,7 +6705,7 @@ Note Before March 2006, these variables were called _REPLACE.* and _REPLACE_FILES.*. -19.6.6. Packages installing perl modules +21.6.6. Packages installing perl modules Makefiles of packages providing perl5 modules should include the Makefile fragment ../../lang/perl5/module.mk. It provides a do-configure target for the @@ -6706,7 +6729,7 @@ PERL5_, e.g. PERL5_INSTALLARCHLIB and may be used by perl5 packages that don't have a packlist. These variables are also substituted for in the PLIST as uppercase prefixed with PERL5_SUB_. -19.6.7. Packages installing info files +21.6.7. Packages installing info files Some packages install info files or use the "makeinfo" or "install-info" commands. INFO_FILES should be defined in the package Makefile so that INSTALL @@ -6741,7 +6764,7 @@ message. The script overriding makeinfo logs a message and according to the value of TEXINFO_REQD either runs the appropriate makeinfo command or exit on error. -19.6.8. Packages installing man pages +21.6.8. Packages installing man pages All packages that install manual pages should install them into the same directory, so that there is one common place to look for them. In pkgsrc, this @@ -6766,10 +6789,10 @@ Packages that use GNU_CONFIGURE but do not use --mandir, can set CONFIGURE_HAS_MANDIR to "no". Or if the ./configure script uses a non-standard use of --mandir, you can set GNU_CONFIGURE_MANDIR as needed. -See Section 13.5, "Man page compression" for information on installation of +See Section 15.5, "Man page compression" for information on installation of compressed manual pages. -19.6.9. Packages installing GConf data files +21.6.9. Packages installing GConf data files If a package installs .schemas or .entries files, used by GConf, you need to take some extra steps to make sure they get registered in the database: @@ -6785,7 +6808,7 @@ take some extra steps to make sure they get registered in the database: manually patch the package. 3. Check the PLIST and remove any entries under the etc/gconf directory, as - they will be handled automatically. See Section 9.13, "How do I change the + they will be handled automatically. See Section 10.13, "How do I change the location of configuration files?" for more information. 4. Define the GCONF_SCHEMAS variable in your Makefile with a list of all @@ -6796,7 +6819,7 @@ take some extra steps to make sure they get registered in the database: .entries files installed by the package, if any. Names must not contain any directories in them. -19.6.10. Packages installing scrollkeeper/rarian data files +21.6.10. Packages installing scrollkeeper/rarian data files If a package installs .omf files, used by scrollkeeper/rarian, you need to take some extra steps to make sure they get registered in the database: @@ -6812,7 +6835,7 @@ some extra steps to make sure they get registered in the database: 3. Remove the share/omf directory from the PLIST. It will be handled by rarian. (make print-PLIST does this automatically.) -19.6.11. Packages installing X11 fonts +21.6.11. Packages installing X11 fonts If a package installs font files, you will need to rebuild the fonts database in the directory where they get installed at installation and deinstallation @@ -6826,7 +6849,7 @@ Note that you should not create new directories for fonts; instead use the standard ones to avoid that the user needs to manually configure his X server to find them. -19.6.12. Packages installing GTK2 modules +21.6.12. Packages installing GTK2 modules If a package installs GTK2 immodules or loaders, you need to take some extra steps to get them registered in the GTK2 database properly: @@ -6849,7 +6872,7 @@ steps to get them registered in the GTK2 database properly: 5. Check the PLIST and remove any entries under the libdata/gtk-2.0 directory, as they will be handled automatically. -19.6.13. Packages installing SGML or XML data +21.6.13. Packages installing SGML or XML data If a package installs SGML or XML data files that need to be registered in system-wide catalogs (like DTDs, sub-catalogs, etc.), you need to take some @@ -6875,7 +6898,7 @@ extra steps: (specifically, arguments recognized by the 'add' action). Note that you will normally not use this variable. -19.6.14. Packages installing extensions to the MIME database +21.6.14. Packages installing extensions to the MIME database If a package provides extensions to the MIME database by installing .xml files inside ${PREFIX}/share/mime/packages, you need to take some extra steps to @@ -6896,7 +6919,7 @@ ensure that the database is kept consistent with respect to these new files: 3. Remove any share/mime/* directories from the PLIST. They will be handled by the shared-mime-info package. -19.6.15. Packages using intltool +21.6.15. Packages using intltool If a package uses intltool during its build, add intltool to the USE_TOOLS, which forces it to use the intltool package provided by pkgsrc, instead of the @@ -6906,7 +6929,7 @@ This tracks intltool's build-time dependencies and uses the latest available version; this way, the package benefits of any bug fixes that may have appeared since it was released. -19.6.16. Packages installing startup scripts +21.6.16. Packages installing startup scripts If a package contains a rc.d script, it won't be copied into the startup directory by default, but you can enable it, by adding the option @@ -6914,7 +6937,7 @@ PKG_RCD_SCRIPTS=YES in mk.conf. This option will copy the scripts into /etc/ rc.d when a package is installed, and it will automatically remove the scripts when the package is deinstalled. -19.6.17. Packages installing TeX modules +21.6.17. Packages installing TeX modules If a package installs TeX packages into the texmf tree, the ls-R database of the tree needs to be updated. @@ -6940,7 +6963,7 @@ into ${PREFIX}/share/texmf-dist, not ${PREFIX}/share/texmf. 3. Make sure that none of ls-R databases are included in PLIST, as they will be removed only by the kpathsea package. -19.6.18. Packages supporting running binaries in emulation +21.6.18. Packages supporting running binaries in emulation There are some packages that provide libraries and executables for running binaries from a one operating system on a different one (if the latter supports @@ -6954,7 +6977,7 @@ linker. Since the standard dynamic linker is run, this fails for emulation packages, because the libraries used by the emulation are not in the standard directories. -19.6.19. Packages installing hicolor theme icons +21.6.19. Packages installing hicolor theme icons If a package installs images under the share/icons/hicolor and/or updates the share/icons/hicolor/icon-theme.cache database, you need to take some extra @@ -6971,7 +6994,7 @@ that the cache database is rebuilt: The best way to verify that the PLIST is correct with respect to the last two points is to regenerate it using make print-PLIST. -19.6.20. Packages installing desktop files +21.6.20. Packages installing desktop files If a package installs .desktop files under share/applications and these include MIME information (MimeType key), you need to take extra steps to ensure that @@ -6985,7 +7008,7 @@ they are registered into the MIME database: The best way to verify that the PLIST is correct with respect to the last point is to regenerate it using make print-PLIST. -19.7. Marking packages as having problems +21.7. Marking packages as having problems In some cases one does not have the time to solve a problem immediately. In this case, one can plainly mark a package as broken. For this, one just sets @@ -6995,7 +7018,7 @@ shown this message, and the build will not be even tried. BROKEN packages are removed from pkgsrc in irregular intervals. -Chapter 20. Debugging +Chapter 22. Debugging To check out all the gotchas when building a package, here are the steps that I do in order to get a package working. Please note this is basically the same as @@ -7033,7 +7056,7 @@ what was explained in the previous sections, only with some debugging aids. that shouldn't be, especially during the build phase. mkpatches, patchdiff and pkgvi are from the pkgtools/pkgdiff package. - * Look at the Makefile, fix if necessary; see Section 11.1, "Makefile". + * Look at the Makefile, fix if necessary; see Section 13.1, "Makefile". * Generate a PLIST: @@ -7074,35 +7097,35 @@ what was explained in the previous sections, only with some debugging aids. # pkglint - * Submit (or commit, if you have cvs access); see Chapter 21, Submitting and + * Submit (or commit, if you have cvs access); see Chapter 23, Submitting and Committing. -Chapter 21. Submitting and Committing +Chapter 23. Submitting and Committing Table of Contents -21.1. Submitting binary packages -21.2. Submitting source packages (for non-NetBSD-developers) -21.3. General notes when adding, updating, or removing packages -21.4. Commit Messages -21.5. Committing: Adding a package to CVS -21.6. Updating a package to a newer version -21.7. Renaming a package in pkgsrc -21.8. Moving a package in pkgsrc +23.1. Submitting binary packages +23.2. Submitting source packages (for non-NetBSD-developers) +23.3. General notes when adding, updating, or removing packages +23.4. Commit Messages +23.5. Committing: Adding a package to CVS +23.6. Updating a package to a newer version +23.7. Renaming a package in pkgsrc +23.8. Moving a package in pkgsrc -21.1. Submitting binary packages +23.1. Submitting binary packages Our policy is that we accept binaries only from pkgsrc developers to guarantee that the packages don't contain any trojan horses etc. This is not to annoy anyone but rather to protect our users! You're still free to put up your home-made binary packages and tell the world where to get them. NetBSD -developers doing bulk builds and wanting to upload them please see Chapter 7, +developers doing bulk builds and wanting to upload them please see Chapter 8, Creating binary packages for everything in pkgsrc (bulk builds). -21.2. Submitting source packages (for non-NetBSD-developers) +23.2. Submitting source packages (for non-NetBSD-developers) First, check that your package is complete, compiles and runs well; see -Chapter 20, Debugging and the rest of this document. Next, generate an +Chapter 22, Debugging and the rest of this document. Next, generate an uuencoded gzipped tar(1) archive that contains all files that make up the package. Finally, send this package to the pkgsrc bug tracking system, either with the send-pr(1) command, or if you don't have that, go to the web page @@ -7122,7 +7145,7 @@ it's easier for us to track things that way. Alternatively, you can also import new packages into pkgsrc-wip ("pkgsrc work-in-progress"); see the homepage at http://pkgsrc.org/wip/ for details. -21.3. General notes when adding, updating, or removing packages +23.3. General notes when adding, updating, or removing packages Please note all package additions, updates, moves, and removals in pkgsrc/doc/ CHANGES-YYYY. It's very important to keep this file up to date and conforming @@ -7150,7 +7173,7 @@ commit-changes-entry! If you are not using a checkout directly from cvs.NetBSD.org, but e.g. a local copy of the repository, you can set USE_NETBSD_REPO=yes. This makes the cvs commands use the main repository. -21.4. Commit Messages +23.4. Commit Messages For several years, there have been mirrors of pkgsrc in fossil, git, and hg. Standard practise when using these tools is to make the first line of a commit @@ -7185,7 +7208,7 @@ Here is another example: Commit messages are final: no "cvs admin" is allowed on the pkgsrc repository to change commit messages. -21.5. Committing: Adding a package to CVS +23.5. Committing: Adding a package to CVS This section is only of interest for pkgsrc developers with write access to the pkgsrc repository. @@ -7216,7 +7239,7 @@ Also mention the new package in pkgsrc/doc/CHANGES-20xx. Previously, "cvs import" was suggested, but it was much easier to get wrong than "cvs add". -21.6. Updating a package to a newer version +23.6. Updating a package to a newer version Please always put a concise, appropriate and relevant summary of the changes between old and new versions into the commit log when updating a package. There @@ -7241,7 +7264,7 @@ which pkgsrc is used. Please use your judgement about what should go into pkgsrc, and bear in mind that stability is to be preferred above new and possibly untested features. -21.7. Renaming a package in pkgsrc +23.7. Renaming a package in pkgsrc Renaming packages is not recommended. @@ -7256,7 +7279,7 @@ Note that "successor" in the CHANGES-YYYY file doesn't necessarily mean that it supersedes, as that successor may not be an exact replacement but is a suggestion for the replaced functionality. -21.8. Moving a package in pkgsrc +23.8. Moving a package in pkgsrc It is preferred that packages are not renamed or moved, but if needed please follow these steps. @@ -7304,57 +7327,57 @@ follow these steps. (and any packages from step 5, of course). -Chapter 22. Frequently Asked Questions +Chapter 24. Frequently Asked Questions This section contains the answers to questions that may arise when you are writing a package. If you don't find your question answered here, first have a look in the other chapters, and if you still don't have the answer, ask on the pkgsrc-users mailing list. -22.1. What is the difference between MAKEFLAGS, .MAKEFLAGS and MAKE_FLAGS? -22.2. What is the difference between MAKE, GMAKE and MAKE_PROGRAM? -22.3. What is the difference between CC, PKG_CC and PKGSRC_COMPILER? -22.4. What is the difference between BUILDLINK_LDFLAGS, BUILDLINK_LDADD and +24.1. What is the difference between MAKEFLAGS, .MAKEFLAGS and MAKE_FLAGS? +24.2. What is the difference between MAKE, GMAKE and MAKE_PROGRAM? +24.3. What is the difference between CC, PKG_CC and PKGSRC_COMPILER? +24.4. What is the difference between BUILDLINK_LDFLAGS, BUILDLINK_LDADD and BUILDLINK_LIBS? -22.5. Why does make show-var VARNAME=BUILDLINK_PREFIX.foo say it's empty? -22.6. What does ${MASTER_SITE_SOURCEFORGE:=package/} mean? I don't understand +24.5. Why does make show-var VARNAME=BUILDLINK_PREFIX.foo say it's empty? +24.6. What does ${MASTER_SITE_SOURCEFORGE:=package/} mean? I don't understand the := inside it. -22.7. Which mailing lists are there for package developers? -22.8. Where is the pkgsrc documentation? -22.9. I have a little time to kill. What shall I do? +24.7. Which mailing lists are there for package developers? +24.8. Where is the pkgsrc documentation? +24.9. I have a little time to kill. What shall I do? -22.1. What is the difference between MAKEFLAGS, .MAKEFLAGS and MAKE_FLAGS? +24.1. What is the difference between MAKEFLAGS, .MAKEFLAGS and MAKE_FLAGS? MAKEFLAGS are the flags passed to the pkgsrc-internal invocations of make (1), while MAKE_FLAGS are the flags that are passed to the MAKE_PROGRAM when building the package. [FIXME: What is .MAKEFLAGS for?] -22.2. What is the difference between MAKE, GMAKE and MAKE_PROGRAM? +24.2. What is the difference between MAKE, GMAKE and MAKE_PROGRAM? MAKE is the path to the make(1) program that is used in the pkgsrc infrastructure. GMAKE is the path to GNU Make, but you need to say USE_TOOLS+=gmake to use that. MAKE_PROGRAM is the path to the Make program that is used for building the package. -22.3. What is the difference between CC, PKG_CC and PKGSRC_COMPILER? +24.3. What is the difference between CC, PKG_CC and PKGSRC_COMPILER? CC is the path to the real C compiler, which can be configured by the pkgsrc user. PKG_CC is the path to the compiler wrapper. PKGSRC_COMPILER is not a path to a compiler, but the type of compiler that should be used. See mk/compiler.mk for more information about the latter variable. -22.4. What is the difference between BUILDLINK_LDFLAGS, BUILDLINK_LDADD and +24.4. What is the difference between BUILDLINK_LDFLAGS, BUILDLINK_LDADD and BUILDLINK_LIBS? [FIXME] -22.5. Why does make show-var VARNAME=BUILDLINK_PREFIX.foo say it's empty? +24.5. Why does make show-var VARNAME=BUILDLINK_PREFIX.foo say it's empty? For optimization reasons, some variables are only available in the " wrapper" phase and later. To "simulate" the wrapper phase, append PKG_PHASE=wrapper to the above command. -22.6. What does ${MASTER_SITE_SOURCEFORGE:=package/} mean? I don't understand +24.6. What does ${MASTER_SITE_SOURCEFORGE:=package/} mean? I don't understand the := inside it. The := is not really an assignment operator, although it looks like it. @@ -7364,7 +7387,7 @@ pkgsrc-users mailing list. string and new_string is package/. That's where the : and the = fall together. -22.7. Which mailing lists are there for package developers? +24.7. Which mailing lists are there for package developers? tech-pkg @@ -7381,7 +7404,7 @@ pkgsrc-users mailing list. Please do not report your bugs here directly; use one of the other mailing lists. -22.8. Where is the pkgsrc documentation? +24.8. Where is the pkgsrc documentation? There are many places where you can find documentation about pkgsrc: @@ -7415,7 +7438,7 @@ pkgsrc-users mailing list. others can find your questions later (see above). To be sure that the developer in charge reads the mail, you may CC him or her. -22.9. I have a little time to kill. What shall I do? +24.9. I have a little time to kill. What shall I do? This is not really an FAQ yet, but here's the answer anyway. @@ -7430,14 +7453,14 @@ pkgsrc-users mailing list. * Review packages for which review was requested on the tech-pkg mailing list. -Chapter 23. GNOME packaging and porting +Chapter 25. GNOME packaging and porting Table of Contents -23.1. Meta packages -23.2. Packaging a GNOME application -23.3. Updating GNOME to a newer version -23.4. Patching guidelines +25.1. Meta packages +25.2. Packaging a GNOME application +25.3. Updating GNOME to a newer version +25.4. Patching guidelines Quoting GNOME's web site: @@ -7471,7 +7494,7 @@ willing to learn new exciting stuff, please jump straight to the pending work list! There is still a long way to go to get a fully-functional GNOME desktop under NetBSD and we need your help to achieve it! -23.1. Meta packages +25.1. Meta packages pkgsrc includes three GNOME-related meta packages: @@ -7500,7 +7523,7 @@ updates: a package may depend on other packages listed before it but not on any listed after it. It is very important to keep this order to ease updates so... do not change it to alphabetical sorting! -23.2. Packaging a GNOME application +25.2. Packaging a GNOME application Almost all GNOME applications are written in C and use a common set of tools as their build system. Things get different with the new bindings to other @@ -7555,30 +7578,30 @@ directories or files. For each of them, the appropriate solution is given. After applying the solution be sure to regenerate the package's file list with make print-PLIST and ensure it is correct. -Table 23.1. PLIST handling for GNOME packages +Table 25.1. PLIST handling for GNOME packages +-----------------------------------------------------------------------------+ | If the package... | Then... | |-------------------------------------------+---------------------------------| -| |See Section 19.6.10, "Packages | +| |See Section 21.6.10, "Packages | |Installs OMF files under share/omf. |installing scrollkeeper/rarian | | |data files". | |-------------------------------------------+---------------------------------| -|Installs icons under the share/icons/ |See Section 19.6.19, "Packages | +|Installs icons under the share/icons/ |See Section 21.6.19, "Packages | |hicolor hierarchy or updates share/icons/ |installing hicolor theme icons". | |hicolor/icon-theme.cache. | | |-------------------------------------------+---------------------------------| -| |See Section 19.6.14, "Packages | +| |See Section 21.6.14, "Packages | |Installs files under share/mime/packages. |installing extensions to the MIME| | |database". | |-------------------------------------------+---------------------------------| -|Installs .desktop files under share/ |See Section 19.6.20, "Packages | +|Installs .desktop files under share/ |See Section 21.6.20, "Packages | |applications and these include MIME |installing desktop files". | |information. | | +-----------------------------------------------------------------------------+ -23.3. Updating GNOME to a newer version +25.3. Updating GNOME to a newer version When seeing GNOME as a whole, there are two kinds of updates: @@ -7655,12 +7678,12 @@ In order to update the GNOME components in pkgsrc to a new stable release package updates and all the corresponding changes to the doc/CHANGES-<YEAR> and pkgsrc/doc/TODO files. -23.4. Patching guidelines +25.4. Patching guidelines GNOME is a very big component in pkgsrc which approaches 100 packages. Please, it is very important that you always, always, always feed back any portability fixes you do to a GNOME package to the mainstream developers (see -Section 11.3.5, "Feedback to the author"). This is the only way to get their +Section 13.3.5, "Feedback to the author"). This is the only way to get their attention on portability issues and to ensure that future versions can be built out-of-the box on NetBSD. The less custom patches in pkgsrc, the easier further updates are. Those developers in charge of issuing major GNOME updates will be @@ -7677,7 +7700,7 @@ Also, please avoid using preprocessor magic to fix portability issues. While the FreeBSD GNOME people are doing a great job in porting GNOME to their operating system, the official GNOME sources are now plagued by conditionals that check for __FreeBSD__ and similar macros. This hurts portability. Please -see our patching guidelines (Section 11.3.4, "Patching guidelines") for more +see our patching guidelines (Section 13.3.4, "Patching guidelines") for more details. Part III. The pkgsrc infrastructure internals @@ -7688,65 +7711,65 @@ maintainer should not need anything from this part. Table of Contents -24. Design of the pkgsrc infrastructure +26. Design of the pkgsrc infrastructure - 24.1. The meaning of variable definitions - 24.2. Avoiding problems before they arise - 24.3. Variable evaluation + 26.1. The meaning of variable definitions + 26.2. Avoiding problems before they arise + 26.3. Variable evaluation - 24.3.1. At load time - 24.3.2. At runtime + 26.3.1. At load time + 26.3.2. At runtime - 24.4. How can variables be specified? - 24.5. Designing interfaces for Makefile fragments + 26.4. How can variables be specified? + 26.5. Designing interfaces for Makefile fragments - 24.5.1. Procedures with parameters - 24.5.2. Actions taken on behalf of parameters + 26.5.1. Procedures with parameters + 26.5.2. Actions taken on behalf of parameters - 24.6. The order in which files are loaded + 26.6. The order in which files are loaded - 24.6.1. The order in bsd.prefs.mk - 24.6.2. The order in bsd.pkg.mk + 26.6.1. The order in bsd.prefs.mk + 26.6.2. The order in bsd.pkg.mk -25. Regression tests +27. Regression tests - 25.1. Running the regression tests - 25.2. Adding a new regression test + 27.1. Running the regression tests + 27.2. Adding a new regression test - 25.2.1. Overridable functions - 25.2.2. Helper functions + 27.2.1. Overridable functions + 27.2.2. Helper functions -26. Porting pkgsrc +28. Porting pkgsrc - 26.1. Porting pkgsrc to a new operating system + 28.1. Porting pkgsrc to a new operating system -Chapter 24. Design of the pkgsrc infrastructure +Chapter 26. Design of the pkgsrc infrastructure Table of Contents -24.1. The meaning of variable definitions -24.2. Avoiding problems before they arise -24.3. Variable evaluation +26.1. The meaning of variable definitions +26.2. Avoiding problems before they arise +26.3. Variable evaluation - 24.3.1. At load time - 24.3.2. At runtime + 26.3.1. At load time + 26.3.2. At runtime -24.4. How can variables be specified? -24.5. Designing interfaces for Makefile fragments +26.4. How can variables be specified? +26.5. Designing interfaces for Makefile fragments - 24.5.1. Procedures with parameters - 24.5.2. Actions taken on behalf of parameters + 26.5.1. Procedures with parameters + 26.5.2. Actions taken on behalf of parameters -24.6. The order in which files are loaded +26.6. The order in which files are loaded - 24.6.1. The order in bsd.prefs.mk - 24.6.2. The order in bsd.pkg.mk + 26.6.1. The order in bsd.prefs.mk + 26.6.2. The order in bsd.pkg.mk The pkgsrc infrastructure consists of many small Makefile fragments. Each such fragment needs a properly specified interface. This chapter explains how such an interface looks like. -24.1. The meaning of variable definitions +26.1. The meaning of variable definitions Whenever a variable is defined in the pkgsrc infrastructure, the location and the way of definition provide much information about the intended use of that @@ -7773,7 +7796,7 @@ Note These conventions are currently not applied consistently to the complete pkgsrc infrastructure. -24.2. Avoiding problems before they arise +26.2. Avoiding problems before they arise All variables that contain lists of things should default to being empty. Two examples that do not follow this rule are USE_LANGUAGES and DISTFILES. These @@ -7790,9 +7813,9 @@ package Makefiles. Similarly for USE_LANGUAGES, but in this case the default value ("c") is so short that it doesn't stand out. Nevertheless it is mentioned in many files. -24.3. Variable evaluation +26.3. Variable evaluation -24.3.1. At load time +26.3.1. At load time Variable evaluation takes place either at load time or at runtime, depending on the context in which they occur. The contexts where variables are evaluated at @@ -7827,26 +7850,26 @@ paragraph, the -Wall is appended to the CFLAGS, but this addition will not appear in CONFIGURE_ARGS. In actual code, the three paragraphs from above typically occur in completely unrelated files. -24.3.2. At runtime +26.3.2. At runtime After all the files have been loaded, the values of the variables cannot be changed anymore. Variables that are used in the shell commands are expanded at this point. -24.4. How can variables be specified? +26.4. How can variables be specified? There are many ways in which the definition and use of a variable can be restricted in order to detect bugs and violations of the (mostly unwritten) policies. A package can be checked with pkglint -Wall to see whether it meets these rules. -24.5. Designing interfaces for Makefile fragments +26.5. Designing interfaces for Makefile fragments Most of the .mk files fall into one of the following classes. Cases where a file falls into more than one class should be avoided as it often leads to subtle bugs. -24.5.1. Procedures with parameters +26.5.1. Procedures with parameters In a traditional imperative programming language some of the .mk files could be described as procedures. They take some input parameters and?after @@ -7874,7 +7897,7 @@ Examples for procedures are mk/bsd.options.mk and mk/buildlink3/bsd.builtin.mk. To express that the parameters are evaluated at load time, they should be assigned using the := operator, which should be used only for this purpose. -24.5.2. Actions taken on behalf of parameters +26.5.2. Actions taken on behalf of parameters Action files take some input parameters and may define runtime variables. They shall not define loadtime variables. There are action files that are included @@ -7883,7 +7906,7 @@ explicitly. An example for action files is mk/subst.mk. -24.6. The order in which files are loaded +26.6. The order in which files are loaded Package Makefiles usually consist of a set of variable definitions, and include the file ../../mk/bsd.pkg.mk in the very last line. Before that, they may also @@ -7895,7 +7918,7 @@ the files are loaded matters. This section describes at which point the various files are loaded and gives reasons for that order. -24.6.1. The order in bsd.prefs.mk +26.6.1. The order in bsd.prefs.mk The very first action in bsd.prefs.mk is to define some essential variables like OPSYS, OS_VERSION and MACHINE_ARCH. @@ -7915,7 +7938,7 @@ As the last steps, some essential variables from the wrapper and the package system flavor are loaded, as well as the variables that have been cached in earlier phases of a package build. -24.6.2. The order in bsd.pkg.mk +26.6.2. The order in bsd.pkg.mk First, bsd.prefs.mk is loaded. @@ -7942,15 +7965,15 @@ execution, though the actual order should not matter. At last, some more files are included that don't set any interesting variables but rather just define make targets to be executed. -Chapter 25. Regression tests +Chapter 27. Regression tests Table of Contents -25.1. Running the regression tests -25.2. Adding a new regression test +27.1. Running the regression tests +27.2. Adding a new regression test - 25.2.1. Overridable functions - 25.2.2. Helper functions + 27.2.1. Overridable functions + 27.2.2. Helper functions The pkgsrc infrastructure consists of a large codebase, and there are many corners where every little bit of a file is well thought out, making pkgsrc @@ -7959,20 +7982,20 @@ changes from breaking anything, a suite of regression tests should go along with every important part of the pkgsrc infrastructure. This chapter describes how regression tests work in pkgsrc and how you can add new tests. -25.1. Running the regression tests +27.1. Running the regression tests You first need to install the pkgtools/pkg_regress package, which provides the pkg_regress command. Then you can simply run that command, which will run all tests in the regress category. -25.2. Adding a new regression test +27.2. Adding a new regression test Every directory in the regress category that contains a file called spec is considered a regression test. This file is a shell program that is included by the pkg_regress command. The following functions can be overridden to suit your needs. -25.2.1. Overridable functions +27.2.1. Overridable functions These functions do not take any parameters. Although they are called in "set -e " mode, they don't stop at the first failing command. See this StackOverflow @@ -8014,7 +8037,7 @@ do_cleanup This function cleans everything up after the test has been run. By default it does nothing. -25.2.2. Helper functions +27.2.2. Helper functions exit_status expected @@ -8036,17 +8059,17 @@ output_prohibit(regex...) () does not match the extended regular expression. If any of the regular expressions matches, the test will fail. -Chapter 26. Porting pkgsrc +Chapter 28. Porting pkgsrc Table of Contents -26.1. Porting pkgsrc to a new operating system +28.1. Porting pkgsrc to a new operating system The pkgsrc system has already been ported to many operating systems, hardware architectures and compilers. This chapter explains the necessary steps to make pkgsrc even more portable. -26.1. Porting pkgsrc to a new operating system +28.1. Porting pkgsrc to a new operating system To port pkgsrc to a new operating system (called MyOS in this example), you need to touch the following files: @@ -8149,7 +8172,7 @@ Create the directory where the package lives, plus any auxiliary directories: # cd bison # mkdir patches -Create Makefile, DESCR and PLIST (see Chapter 11, Package components - files, +Create Makefile, DESCR and PLIST (see Chapter 13, Package components - files, directories and contents) then continue with fetching the distfile: # make fetch @@ -8460,16 +8483,2727 @@ branch of the CVS repository. In these directories there is an additional file called pkgsrc-20xxQy.tar.{bz,gz,xz}, which contains the state of pkgsrc when it was branched. -Appendix D. Editing guidelines for the pkgsrc guide +Appendix D. Help topics + +The following list contains all help topics that are available when running +bmake help topic=:index. + + * #! + + * -lintl + + * 64bit + + * ABI + + * ACCEPTABLE_LICENSES + + * ACROREAD_FONTPATH + + * ADDITIONAL + + * AFAIK + + * AIX + + * ALLOW_VULNERABLE_PACKAGES + + * ALL_ENV + + * ALSA_PC + + * ALTERNATIVES_SRC + + * AMANDA_TMP + + * AMANDA_USER + + * AMANDA_VAR + + * APACHE_GROUP + + * APACHE_MODULE_NAME + + * APACHE_MODULE_SRC + + * APACHE_MODULE_SRCDIR + + * APACHE_PKG_PREFIX + + * APACHE_SUEXEC_CONFIGURE_ARGS + + * APACHE_SUEXEC_DOCROOT + + * APACHE_USER + + * APPEND_ABI + + * APPEND_ELF + + * ARLA_CACHE + + * AUDIT_PACKAGES_FLAGS + + * AUTOCONF_REQD + + * AUTOMAKE_OVERRIDE + + * AUTOMAKE_REQD + + * AUTO_MKDIRS + + * BDB185_DEFAULT + + * BDBBASE + + * BDB_ACCEPTED + + * BDB_DEFAULT + + * BDB_LIBS + + * BDB_TYPE + + * BIND_DIR + + * BIND_GROUP + + * BIND_USER + + * BINPKG_SITES + + * BIN_INSTALL_FLAGS + + * BISON_PKGDATADIR + + * BOOTSTRAP_DEPENDS + + * BOOTSTRAP_SETUPTOOLS + + * BROKEN + + * BROKEN_EXCEPT_ON_PLATFORM + + * BROKEN_ON_PLATFORM + + * BSDSRCDIR + + * BSDXSRCDIR + + * BSD_MAKE_ENV + + * BUILDLINK_AUTO_DIRS + + * BUILDLINK_AUTO_VARS + + * BUILDLINK_CFLAGS + + * BUILDLINK_CONTENTS_FILTER + + * BUILDLINK_CPPFLAGS + + * BUILDLINK_DEPMETHOD + + * BUILDLINK_FILES + + * BUILDLINK_FILES_CMD + + * BUILDLINK_FNAME_TRANSFORM + + * BUILDLINK_LDFLAGS + + * BUILDLINK_LIBS + + * BUILDLINK_OPSYS_SUPPORT_PTHREAD + + * BUILDLINK_PKGNAME + + * BUILDLINK_PREFIX + + * BUILDLINK_RPATHDIRS + + * BUILDLINK_TREE + + * BUILD_DEFS + + * BUILD_DEFS_EFFECTS + + * BUILD_DIRS + + * BUILD_ENV_SHELL + + * BUILD_MAKE_CMD + + * BUILD_MAKE_FLAGS + + * BUILD_TARGET + + * BUILTIN_FIND_FILES + + * BUILTIN_FIND_FILES_VAR + + * BUILTIN_FIND_GREP + + * BUILTIN_FIND_HEADERS + + * BUILTIN_FIND_HEADERS_VAR + + * BUILTIN_PKG + + * BUILTIN_TEST_CURSES_DEFINES + + * BUILTIN_TEST_CURSES_FUNCS + + * BUILTIN_VERSION_SCRIPT + + * BUILTIN_X11_TYPE + + * BUILTIN_X11_VERSION + + * CACTI_GROUP + + * CACTI_USER + + * CANNA_GROUP + + * CANNA_USER + + * CAT + + * CCACHE_BASE + + * CCACHE_DIR + + * CCACHE_LOGFILE + + * CC_VERSION + + * CC_VERSION_STRING + + * CDRECORD_CONF + + * CDROM_PKG_URL_DIR + + * CDROM_PKG_URL_HOST + + * CHECKOUT_DATE + + * CHECK_FAKEHOME + + * CHECK_FILES + + * CHECK_FILES_SKIP + + * CHECK_FILES_STRICT + + * CHECK_HEADERS + + * CHECK_HEADERS_SKIP + + * CHECK_INTERPRETER + + * CHECK_INTERPRETER_SKIP + + * CHECK_PERMS + + * CHECK_PERMS_AUTOFIX + + * CHECK_PERMS_SKIP + + * CHECK_PORTABILITY + + * CHECK_PORTABILITY_SKIP + + * CHECK_RELRO + + * CHECK_RELRO_SKIP + + * CHECK_RELRO_SUPPORTED + + * CHECK_SHLIBS + + * CHECK_SHLIBS_BLACKLIST + + * CHECK_SHLIBS_SKIP + + * CHECK_SHLIBS_SUPPORTED + + * CHECK_SSP + + * CHECK_SSP_SKIP + + * CHECK_SSP_SUPPORTED + + * CHECK_STRIPPED + + * CHECK_STRIPPED_SKIP + + * CHECK_WRKREF + + * CHECK_WRKREF_EXTRA_DIRS + + * CHECK_WRKREF_SKIP + + * CLAMAV_DBDIR + + * CLAMAV_GROUP + + * CLAMAV_USER + + * CLANGBASE + + * CLEANDEPENDS + + * CMAKE_DEPENDENCIES_REWRITE + + * CMAKE_INSTALL_PREFIX + + * CMAKE_MODULE_PATH_OVERRIDE + + * CMAKE_PKGSRC_BUILD_FLAGS + + * CMAKE_PREFIX_PATH + + * CMAKE_USE_GNU_INSTALL_DIRS + + * COMMON_LISP_DOCFILES + + * COMMON_LISP_EXAMPLES + + * COMMON_LISP_EXTRAFILES + + * COMMON_LISP_PACKAGES + + * COMMON_LISP_SYSTEM + + * COMPILER_RPATH_FLAG + + * COMPILER_USE_SYMLINKS + + * CONFIGURE_ARGS + + * CONFIGURE_DIRS + + * CONFIGURE_ENV + + * CONFIGURE_HAS_INFODIR + + * CONFIGURE_HAS_MANDIR + + * CONFIGURE_SCRIPT + + * CONFIG_SHELL + + * CONFIG_SHELL_FLAGS + + * CONF_FILES + + * CONF_FILES_MODE + + * CONF_FILES_PERMS + + * CONSERVER_DEFAULTHOST + + * CONSERVER_DEFAULTPORT + + * CP + + * CPP + + * CPP_PRECOMP_FLAGS + + * CREATE_WRKDIR_SYMLINK + + * CROSSBASE + + * CTFCONVERT + + * CTF_FILES_SKIP + + * CTF_SUPPORTED + + * CTYPE + + * CUPS_GROUP + + * CUPS_SYSTEM_GROUPS + + * CUPS_USER + + * CURSES_DEFAULT + + * CURSES_TYPE + + * CVS_EXTRACTDIR + + * CVS_MODULE + + * CVS_PROJECT + + * CVS_REPOSITORIES + + * CVS_ROOT + + * CVS_ROOT_GNU + + * CVS_ROOT_NONGNU + + * CVS_ROOT_SOURCEFORGE + + * CVS_TAG + + * CXX + + * CYRUS_GROUP + + * CYRUS_IDLE + + * CYRUS_USER + + * DAEMONTOOLS_GROUP + + * DAEMONTOOLS_LOG_USER + + * DBUS_GROUP + + * DBUS_USER + + * DEFANG_GROUP + + * DEFANG_USER + + * DEFAULT_ACCEPTABLE_LICENSES + + * DEFAULT_DISTFILES + + * DEFAULT_IRC_SERVER + + * DEFAULT_SERIAL_DEVICE + + * DEF_UMASK + + * DEINSTALLDEPENDS + + * DEINSTALL_SRC + + * DEINSTALL_TEMPLATES + + * DELAYED_ERROR_MSG + + * DELAYED_WARNING_MSG + + * DEPENDS_TARGET + + * DEPENDS_TYPE + + * DESTDIR + + * DESTDIR_VARNAME + + * DIALER_GROUP + + * DIGEST_REQD + + * DISTDIR + + * DISTFILES + + * DISTINFO_FILE + + * DISTNAME + + * DIST_PATH + + * DIST_SUBDIR + + * DJBDNS_AXFR_USER + + * DJBDNS_CACHE_USER + + * DJBDNS_DJBDNS_GROUP + + * DJBDNS_LOG_USER + + * DJBDNS_RBL_USER + + * DJBDNS_TINY_USER + + * DLOPEN_REQUIRE_PTHREADS + + * DL_AUTO_VARS + + * DL_CFLAGS + + * DL_LDFLAGS + + * DL_LIBS + + * DNS + + * DOWNLOADED_DISTFILE + + * DT_LAYOUT + + * DYNAMIC_SITES_CMD + + * DYNAMIC_SITES_SCRIPT + + * ECHO + + * ECHO_N + + * ELK_GUI + + * EMACS_TYPE + + * EMULDIR + + * EMULSUBDIR + + * EMULSUBDIRSLASH + + * EMUL_ARCH + + * EMUL_DISTRO + + * EMUL_EXEC_FMT + + * EMUL_IS_NATIVE + + * EMUL_MODULES + + * EMUL_OPSYS + + * EMUL_PKG_FMT + + * EMUL_PLATFORM + + * EMUL_PLATFORMS + + * EMUL_PREFER + + * EMUL_REQD + + * EMUL_TYPE + + * ERROR_MSG + + * EXIM_GROUP + + * EXIM_USER + + * EXPORT_SYMBOLS_LDFLAGS + + * EXTRACTOR + + * EXTRACT_CMD + + * EXTRACT_CMD_DEFAULT + + * EXTRACT_DIR + + * EXTRACT_ELEMENTS + + * EXTRACT_ENV + + * EXTRACT_ONLY + + * EXTRACT_OPTS + + * EXTRACT_SUFX + + * EXTRACT_USING + + * FAILOVER_FETCH + + * FAIL_MSG + + * FAKE_NCURSES + + * FAM + + * FAM_ACCEPTED + + * FAM_DEFAULT + + * FAM_SERVER + + * FCPATH + + * FEATURE_CPPFLAGS + + * FEATURE_LDFLAGS + + * FEATURE_LIBS + + * FETCH_AFTER_ARGS + + * FETCH_BEFORE_ARGS + + * FETCH_CMD + + * FETCH_OUTPUT_ARGS + + * FETCH_PROXY + + * FETCH_RESUME_ARGS + + * FETCH_USING + + * FILES_SUBST + + * FILES_SUBST_SED + + * FIX_SYSTEM_HEADERS + + * FLUXBOX_USE_GNOME + + * FLUXBOX_USE_KDE + + * FLUXBOX_USE_XFT + + * FLUXBOX_USE_XINERAMA + + * FONTDIR + + * FONTS_DIRS + + * FONTS_VERBOSE + + * FOO_HACKS_MK + + * FOSSIL_EXTRACTDIR + + * FOSSIL_REPO + + * FOSSIL_REPOSITORIES + + * FOSSIL_VERSION + + * FOX_USE_XUNICODE + + * FREEWNN_GROUP + + * FREEWNN_USER + + * FTP_PKG_URL_DIR + + * FTP_PKG_URL_HOST + + * GAMEDATAMODE + + * GAMEDATA_PERMS + + * GAMEDIRMODE + + * GAMEDIR_PERMS + + * GAMEGRP + + * GAMEMODE + + * GAMEOWN + + * GAMES_GROUP + + * GAMES_USER + + * GCC + + * GCCBASE + + * GCC_REQD + + * GCC_VERSION_SUFFIX + + * GEM_BUILD + + * GEM_CLEANBUILD + + * GEM_CLEANBUILD_EXTENSIONS + + * GEM_DOCDIR + + * GEM_EXTSDIR + + * GEM_HOME + + * GEM_LIBDIR + + * GEM_NAME + + * GEM_PATH + + * GEM_SPECFILE + + * GENERATE_PLIST + + * GHOSTSCRIPT_REQD + + * GITHUB_PROJECT + + * GITHUB_RELEASE + + * GITHUB_TAG + + * GITHUB_TYPE + + * GIT_BRANCH + + * GIT_ENV + + * GIT_EXTRACTDIR + + * GIT_REPO + + * GIT_REPOSITORIES + + * GIT_REVISION + + * GIT_TAG + + * GNU + + * GNU_CONFIGURE + + * GNU_CONFIGURE_INFODIR + + * GNU_CONFIGURE_MANDIR + + * GNU_CONFIGURE_STRICT + + * GO_BUILD_PATTERN + + * GO_DIST_BASE + + * GO_SRCPATH + + * GROUP_SPECIFIC_PKGS + + * GRUB_NETWORK_CARDS + + * GRUB_PRESET_COMMAND + + * GRUB_SCAN_ARGS + + * GZIP + + * HASKELL_COMPILER + + * HASKELL_ENABLE_HADDOCK_DOCUMENTATION + + * HASKELL_ENABLE_LIBRARY_PROFILING + + * HASKELL_ENABLE_SHARED_LIBRARY + + * HAS_CONFIGURE + + * HEADER_TEMPLATES + + * HG_REPO + + * HG_REPOSITORIES + + * HG_TAG + + * HOST_PKGTOOLS_ARGS + + * HOST_SPECIFIC_PKGS + + * HOWL_GROUP + + * HOWL_USER + + * ICCBASE + + * ICECAST_CHROOTDIR + + * ICON_THEMES + + * IDOBASE + + * IGNORE_CCACHE + + * IGNORE_INFO_DIRS + + * IGNORE_INTERACTIVE_FETCH + + * IMAKE + + * IMAKEOPTS + + * IMAKE_MAKE + + * IMAKE_MANINSTALL + + * IMAP_UW_CCLIENT_MBOX_FMT + + * IMDICTDIR + + * INCOMPAT_CURSES + + * INFO_DIR + + * INFO_FILES + + * INFO_FILES_VERBOSE + + * INFO_MSG + + * INIT_SYSTEM + + * INN_DATA_DIR + + * INN_GROUP + + * INN_USER + + * INSTALLATION_DIRS + + * INSTALLATION_DIRS_FROM_PLIST + + * INSTALL_ENV + + * INSTALL_SH_OVERRIDE + + * INSTALL_SRC + + * INSTALL_TEMPLATES + + * INSTALL_UNSTRIPPED + + * IRCD_HYBRID_IRC_GROUP + + * IRCD_HYBRID_IRC_USER + + * IRCD_HYBRID_MAXCONN + + * IRCD_HYBRID_NICLEN + + * IRCD_HYBRID_SYSLOG_EVENTS + + * IRCD_HYBRID_SYSLOG_FACILITY + + * IRCD_HYBRID_TOPICLEN + + * IRIX + + * IRRD_USE_PGP + + * JABBERD_GROUP + + * JABBERD_LOGDIR + + * JABBERD_PIDDIR + + * JABBERD_SPOOLDIR + + * JABBERD_USER + + * JAKARTA_HOME + + * JAVA_APP_PATH + + * JAVA_APP_TARGETS + + * JAVA_BINPREFIX + + * JAVA_CLASSPATH + + * JAVA_HOME + + * JAVA_LD_LIBRARY_PATH + + * JAVA_NAME + + * JAVA_UNLIMIT + + * JAVA_WRAPPERS + + * JPEG_ACCEPTED + + * JPEG_DEFAULT + + * KERBEROS + + * KERMIT_SUID_UUCP + + * KJS_USE_PCRE + + * KNEWS_DOMAIN_FILE + + * KNEWS_DOMAIN_NAME + + * KRB5_ACCEPTED + + * KRB5_DEFAULT + + * LANGUAGES + + * LATEX2HTML_ICONPATH + + * LDCONFIG_ADD_CMD + + * LDCONFIG_REMOVE_CMD + + * LEAFNODE_DATA_DIR + + * LEAFNODE_GROUP + + * LEAFNODE_USER + + * LIBDVDCSS_HOMEPAGE + + * LIBDVDCSS_MASTER_SITES + + * LIBTOOL + + * LIBTOOLIZE_PLIST + + * LIBTOOL_M4_OVERRIDE + + * LIBUSB_TYPE + + * LICENSE + + * LINKER_RPATH_FLAG + + * LINK_RPATH_FLAG + + * LINUX_BASE_NODEPS + + * LINUX_BASE_PREFERRED + + * LINUX_BASE_REQUIRED + + * LINUX_LOCALES + + * LOCALBASE + + * LOCALBASE_LOCKTYPE + + * LOCALPATCHES + + * LOVE_DATA + + * LOVE_GAME + + * LOVE_VERSION + + * LP64PLATFORMS + + * MACHINE_PLATFORM + + * MAILAGENT_DOMAIN + + * MAILAGENT_EMAIL + + * MAILAGENT_FQDN + + * MAILAGENT_ORGANIZATION + + * MAJORDOMO_HOMEDIR + + * MAJOR_OS_VERSION + + * MAKEINFO_ARGS + + * MAKE_DIRS + + * MAKE_DIRS_PERMS + + * MAKE_ENV + + * MAKE_FILE + + * MAKE_FLAGS + + * MAKE_JOBS + + * MAKE_JOBS_SAFE + + * MAKE_PROGRAM + + * MANINSTALL + + * MANZ + + * MASTER_SITES + + * MASTER_SITE_BACKUP + + * MASTER_SITE_CYGWIN + + * MASTER_SITE_GNOME + + * MASTER_SITE_GNU + + * MASTER_SITE_LOCAL + + * MASTER_SITE_MOZILLA + + * MASTER_SITE_OPENOFFICE + + * MASTER_SITE_OVERRIDE + + * MASTER_SITE_PERL_CPAN + + * MASTER_SITE_SUNSITE + + * MASTER_SITE_SUSE + + * MASTER_SITE_TEX_CTAN + + * MASTER_SITE_XCONTRIB + + * MASTER_SITE_XEMACS + + * MASTER_SORT + + * MASTER_SORT_RANDOM + + * MASTER_SORT_REGEX + + * MECAB_CHARSET + + * MEDIATOMB_GROUP + + * MEDIATOMB_USER + + * MIPSPROBASE + + * MIREDO_GROUP + + * MIREDO_USER + + * MISSING_FEATURES + + * MKDIR + + * MLDONKEY_GROUP + + * MLDONKEY_HOME + + * MLDONKEY_USER + + * MONOTONE_GROUP + + * MONOTONE_USER + + * MOTIFBASE + + * MOTIF_TYPE + + * MOTIF_TYPE_DEFAULT + + * MPI_TYPE + + * MSGFMT_STRIP_MSGCTXT + + * MSGFMT_STRIP_MSGID_PLURAL + + * MTOOLS_ENABLE_FLOPPYD + + * MUST + + * MV + + * MYSQL_CHARSET + + * MYSQL_DATADIR + + * MYSQL_EXTRA_CHARSET + + * MYSQL_GROUP + + * MYSQL_PKGSRCDIR + + * MYSQL_USER + + * MYSQL_VERSIONS_ACCEPTED + + * MYSQL_VERSION_DEFAULT + + * NAGIOSCMD_GROUP + + * NAGIOSDIR + + * NAGIOS_GROUP + + * NAGIOS_USER + + * NATIVE_APPEND_ABI + + * NATIVE_APPEND_ELF + + * NATIVE_EXEC_FMT + + * NATIVE_MACHINE_PLATFORM + + * NATIVE_OBJECT_FMT + + * NBPAX_PROGRAM_PREFIX + + * NETBSD_LOGIN_NAME + + * NMH_EDITOR + + * NMH_MTA + + * NMH_PAGER + + * NOLOGIN + + * NONZERO_FILESIZE_P + + * NOTE + + * NOT_FOR_PLATFORM + + * NOT_PAX_ASLR_SAFE + + * NOT_PAX_MPROTECT_SAFE + + * NO_BUILD + + * NO_CHECKSUM + + * NO_CONFIGURE + + * NO_SKIP + + * NS_PREFERRED + + * NULLMAILER_GROUP + + * NULLMAILER_USER + + * OASIS + + * OASIS_BUILD_ARGS + + * OBJHOSTNAME + + * OBJMACHINE + + * OCAML_FINDLIB_DIRS + + * OCAML_FINDLIB_REGISTER + + * OCAML_FINDLIB_REGISTER_VERBOSE + + * OCAML_SITELIBDIR + + * OCAML_TOPKG_DOCDIR + + * OCAML_USE_DUNE + + * OCAML_USE_FINDLIB + + * OCAML_USE_JBUILDER + + * OCAML_USE_OASIS + + * OCAML_USE_OASIS_DYNRUN + + * OCAML_USE_OPAM + + * OCAML_USE_OPT_COMPILER + + * OCAML_USE_TOPKG + + * OMF + + * ONLY_FOR_COMPILER + + * ONLY_FOR_PLATFORM + + * OPENSSH_CHROOT + + * OPENSSH_GROUP + + * OPENSSH_USER + + * OPSYS + + * OPSYS_EMULDIR + + * OSS_TYPE + + * OSX + + * OSX_TOLERATE_SDK_SKEW + + * OS_HAVE_ALSA + + * OS_HAVE_RCD + + * OS_VARIANT + + * OS_VERSION + + * OTF_FONTS_DIR + + * OVERRIDE_DIRDEPTH + + * OVERRIDE_GEMSPEC + + * OVERRIDE_GNU_CONFIG_SCRIPTS + + * OVERRIDE_ROCKSPEC + + * OWN_DIRS + + * OWN_DIRS_PERMS + + * P4GROUP + + * P4PORT + + * P4ROOT + + * P4USER + + * PACKAGES + + * PALMOS_DEFAULT_SDK + + * PAMBASE + + * PAM_DEFAULT + + * PAPERSIZE + + * PASSIVE_FETCH + + * PATCHDIR + + * PATCHFILES + + * PATCH_ARGS + + * PATCH_DEBUG + + * PATCH_DIST_ARGS + + * PATCH_DIST_CAT + + * PATCH_DIST_STRIP + + * PATCH_FUZZ_FACTOR + + * PATCH_STRIP + + * PATH + + * PCCBASE + + * PEAR + + * PEAR_CHANNEL + + * PEAR_CHANNEL_ALIAS + + * PEAR_CHANNEL_VERSION + + * PEAR_CMD + + * PEAR_LIB + + * PEAR_PACKAGE_XML + + * PERL5 + + * PERL5_CONFIGURE + + * PERL5_CONFIGURE_DIRS + + * PERL5_LDFLAGS + + * PERL5_LICENSE + + * PERL5_MODULE_TYPE + + * PERL5_PACKLIST + + * PERL5_PACKLIST_DIR + + * PERL5_PERLBASE + + * PERL5_SITEBASE + + * PERL5_USE_PACKLIST + + * PERL5_VENDORBASE + + * PFCTL + + * PFVAR_H + + * PF_VERSION + + * PGGROUP + + * PGHOME + + * PGPKGSRCDIR + + * PGSQL_TYPE + + * PGSQL_VERSIONS_ACCEPTED + + * PGSQL_VERSION_DEFAULT + + * PGUSER + + * PG_LIB_EXT + + * PHP + + * PHPCOMMON_MK + + * PHPPKGSRCDIR + + * PHP_BASE_VERS + + * PHP_CHECK_INSTALLED + + * PHP_EXTENSION_DIR + + * PHP_INITIAL_TEENY + + * PHP_PKG_PREFIX + + * PHP_VERSION + + * PHP_VERSIONS_ACCEPTED + + * PHP_VERSIONS_INCOMPATIBLE + + * PHP_VERSION_DEFAULT + + * PHP_VERSION_REQD + + * PILRC_USE_GTK + + * PKGCONFIG_BASE + + * PKGCONFIG_FILE + + * PKGCONFIG_OVERRIDE + + * PKGCONFIG_OVERRIDE_STAGE + + * PKGDIR + + * PKGGNUDIR + + * PKGINFODIR + + * PKGLOCALEDIR + + * PKGMANDIR + + * PKGNAME + + * PKGNAME_REQD + + * PKGPATH + + * PKGREVISION + + * PKGSRC_CHANGES + + * PKGSRC_COMPILER + + * PKGSRC_KEEP_BIN_PKGS + + * PKGSRC_LOCKTYPE + + * PKGSRC_MAKE_ENV + + * PKGSRC_MESSAGE_RECIPIENTS + + * PKGSRC_MKPIE + + * PKGSRC_MKREPRO + + * PKGSRC_RUN_TEST + + * PKGSRC_SETENV + + * PKGSRC_SLEEPSECS + + * PKGSRC_TODO + + * PKGSRC_USE_CTF + + * PKGSRC_USE_FORTIFY + + * PKGSRC_USE_RELRO + + * PKGSRC_USE_SSP + + * PKGSRC_USE_STACK_CHECK + + * PKGTASKS_DATAFILE + + * PKGTOOLS_ARGS + + * PKGTOOLS_ENV + + * PKG_ALTERNATIVES + + * PKG_APACHE + + * PKG_APACHE_ACCEPTED + + * PKG_APACHE_DEFAULT + + * PKG_BEST_EXISTS + + * PKG_BUILD_OPTIONS + + * PKG_COMPRESSION + + * PKG_CONFIG + + * PKG_CONFIG_PERMS + + * PKG_CREATE_USERGROUP + + * PKG_DB_TMPDIR + + * PKG_DEBUG_LEVEL + + * PKG_DEFAULT_OPTIONS + + * PKG_DESTDIR_SUPPORT + + * PKG_DEVELOPER + + * PKG_DISABLED_OPTIONS + + * PKG_FATAL_ERRORS + + * PKG_FC + + * PKG_FILELIST_CMD + + * PKG_GECOS + + * PKG_GID + + * PKG_GROUPS + + * PKG_GROUPS_VARS + + * PKG_HOME + + * PKG_INIT_SCRIPTS + + * PKG_JAVA_HOME + + * PKG_JVM + + * PKG_JVMS_ACCEPTED + + * PKG_JVM_DEFAULT + + * PKG_LEGACY_OPTIONS + + * PKG_LIBTOOL + + * PKG_OPTIONS + + * PKG_OPTIONS_DEPRECATED_WARNINGS + + * PKG_OPTIONS_LEGACY_OPTS + + * PKG_OPTIONS_LEGACY_VARS + + * PKG_OPTIONS_NONEMPTY_SETS + + * PKG_OPTIONS_OPTIONAL_GROUPS + + * PKG_OPTIONS_REQUIRED_GROUPS + + * PKG_OPTIONS_VAR + + * PKG_PHP + + * PKG_PHP_MAJOR_VERS + + * PKG_PHP_VERSION + + * PKG_RCD_SCRIPTS + + * PKG_REFCOUNT_DBDIR + + * PKG_REGISTER_SHELLS + + * PKG_RESUME_TRANSFERS + + * PKG_SHELL + + * PKG_SUGGESTED_OPTIONS + + * PKG_SUPPORTED_OPTIONS + + * PKG_SYSCONFBASE + + * PKG_SYSCONFBASEDIR + + * PKG_SYSCONFDIR + + * PKG_SYSCONFDIR_PERMS + + * PKG_SYSCONFSUBDIR + + * PKG_SYSCONFVAR + + * PKG_TOOLS_BIN + + * PKG_UID + + * PKG_UPDATE_FONTS_DB + + * PKG_USERS + + * PKG_USERS_VARS + + * PKG_VERBOSE + + * PLIST + + * PLIST_AWK + + * PLIST_AWK_ENV + + * PLIST_SRC + + * PLIST_SUBST + + * PLIST_TYPE + + * PLIST_VARS + + * POPTOP_USE_MPPE + + * POST_FETCH_HOOK + + * PREFER + + * PREFER_NATIVE + + * PREFER_NATIVE_PTHREADS + + * PREFER_PKGSRC + + * PREFIX + + * PREPEND_PATH + + * PRE_ROOT_CMD + + * PRIVILEGED_STAGES + + * PS + + * PTHREAD_AUTO_VARS + + * PTHREAD_CFLAGS + + * PTHREAD_LDFLAGS + + * PTHREAD_LIBS + + * PTHREAD_OPTS + + * PTHREAD_TYPE + + * PVM_SSH + + * PYPKGPREFIX + + * PYTHON_FOR_BUILD_ONLY + + * PYTHON_SELF_CONFLICT + + * PYTHON_VERSIONED_DEPENDENCIES + + * PYTHON_VERSIONS_ACCEPTED + + * PYTHON_VERSIONS_INCOMPATIBLE + + * PYTHON_VERSION_DEFAULT + + * PYTHON_VERSION_REQD + + * PYVERSSUFFIX + + * PY_NO_EGG + + * QMAILDIR + + * QMAIL_ALIAS_USER + + * QMAIL_DAEMON_USER + + * QMAIL_LOG_USER + + * QMAIL_NOFILES_GROUP + + * QMAIL_PASSWD_USER + + * QMAIL_QMAIL_GROUP + + * QMAIL_QUEUE_DIR + + * QMAIL_QUEUE_EXTRA + + * QMAIL_QUEUE_USER + + * QMAIL_REMOTE_USER + + * QMAIL_ROOT_USER + + * QMAIL_SEND_USER + + * QPOPPER_FAC + + * QPOPPER_SPOOL_DIR + + * QPOPPER_USER + + * RAKE_NAME + + * RASMOL_DEPTH + + * RCD_DIR + + * RCD_ORDER + + * RCD_SCRIPTS + + * RCD_SCRIPTS_DIR + + * RCD_SCRIPTS_EXAMPLEDIR + + * RCD_SCRIPTS_MODE + + * RCD_SCRIPTS_SHELL + + * RCD_SCRIPT_SRC + + * RCD_SUBR + + * RDOC + + * READLINE_DEFAULT + + * READLINE_TYPE + + * REAL_ROOT_GROUP + + * REAL_ROOT_USER + + * RECURSIVE_MAKE + + * RELAY_CTRL_DIR + + * REPLACE_AWK + + * REPLACE_BASH + + * REPLACE_CSH + + * REPLACE_KSH + + * REPLACE_PERL + + * REPLACE_PERL6 + + * REPLACE_PYTHON + + * REPLACE_RUBY + + * REPLACE_RUBY_DIRS + + * REPLACE_RUBY_PAT + + * REPLACE_SH + + * REPLACE_TEXLUA + + * REQD_DIRS + + * REQD_DIRS_PERMS + + * REQD_FILES + + * REQD_FILES_MODE + + * REQD_FILES_PERMS + + * RESOLV_AUTO_VARS + + * RESOLV_LDFLAGS + + * RESOLV_LIBS + + * RM + + * ROCKSPEC_NAME + + * ROCKSPEC_SPECFILE + + * ROOT_CMD + + * ROOT_GROUP + + * ROOT_USER + + * RPCGEN + + * RPM + + * RPM2PKG_PLIST + + * RPM2PKG_PREFIX + + * RPM2PKG_STAGE + + * RPM2PKG_STRIP + + * RPM2PKG_SUBPREFIX + + * RPMFILES + + * RPMIGNOREPATH + + * RPM_DB_PREFIX + + * RSSH_CVS_PATH + + * RSSH_RDIST_PATH + + * RSSH_RSYNC_PATH + + * RSSH_SCP_PATH + + * RSSH_SFTP_SERVER_PATH + + * RUBY + + * RUBYGEM + + * RUBYGEM_NAME + + * RUBYGEM_OPTIONS + + * RUBY_ABI_VERSION + + * RUBY_ARCH + + * RUBY_ARCHINC + + * RUBY_ARCHLIB + + * RUBY_BASE + + * RUBY_BASERIDIR + + * RUBY_BUILD_RDOC + + * RUBY_BUILD_RI + + * RUBY_DLEXT + + * RUBY_DOC + + * RUBY_DYNAMIC_DIRS + + * RUBY_EG + + * RUBY_ENCODING_ARG + + * RUBY_EXTCONF + + * RUBY_EXTCONF_CHECK + + * RUBY_EXTCONF_DEBUG + + * RUBY_EXTCONF_MAKEFILE + + * RUBY_GEM_BASE + + * RUBY_INC + + * RUBY_LIB + + * RUBY_LIB_BASE + + * RUBY_NAME + + * RUBY_NOVERSION + + * RUBY_PKGPREFIX + + * RUBY_RAILS + + * RUBY_RAILS42_VERSION + + * RUBY_RAILS51_VERSION + + * RUBY_RAILS52_VERSION + + * RUBY_RAILS_ACCEPTED + + * RUBY_RAILS_DEFAULT + + * RUBY_RAILS_REQD + + * RUBY_RAILS_STRICT_DEP + + * RUBY_RIDIR + + * RUBY_SETUP + + * RUBY_SHLIB + + * RUBY_SHLIBALIAS + + * RUBY_SHLIBVER + + * RUBY_SIMPLE_INSTALL + + * RUBY_SITEARCHLIB + + * RUBY_SITELIB + + * RUBY_SITELIB_BASE + + * RUBY_SITERIDIR + + * RUBY_SLEXT + + * RUBY_SRCDIR + + * RUBY_STATICLIB + + * RUBY_SUFFIX + + * RUBY_SYSRIDIR + + * RUBY_USE_PTHREAD + + * RUBY_VENDORARCHLIB + + * RUBY_VENDORLIB + + * RUBY_VENDORLIB_BASE + + * RUBY_VER + + * RUBY_VERSION + + * RUBY_VERSIONS_ACCEPTED + + * RUBY_VERSION_DEFAULT + + * RUBY_VERSION_REQD + + * RUBY_VER_DIR + + * RUN + + * RUN_LDCONFIG + + * SAWFISH_THEMES + + * SCO + + * SCREWS_GROUP + + * SCREWS_USER + + * SCRIPTS_ENV + + * SCROLLKEEPER_DATADIR + + * SCROLLKEEPER_REBUILDDB + + * SCROLLKEEPER_UPDATEDB + + * SDIST_PAWD + + * SERIAL_DEVICES + + * SETGIDGAME + + * SETGID_GAMES_PERMS + + * SETUID_ROOT_PERMS + + * SH + + * SHLIB + + * SHORTNAME + + * SIGN_PACKAGES + + * SILC_CLIENT_WITH_PERL + + * SITE_SPECIFIC_PKGS + + * SKIP_DEPENDS + + * SKIP_PORTABILITY_CHECK + + * SMF_INSTANCES + + * SMF_MANIFEST + + * SMF_METHODS + + * SMF_METHOD_SHELL + + * SMF_METHOD_SRC + + * SMF_NAME + + * SMF_PREFIX + + * SMF_SRCDIR + + * SNIPROXY_GROUP + + * SNIPROXY_USER + + * SOURCE_BUFFSIZE + + * SPECIAL_PERMS + + * SPECIFIC_PKGS + + * SSH_SUID + + * SSYNC_PAWD + + * STEP_MSG + + * STRIP + + * STRIP_DBG + + * STRIP_DEBUG + + * STRIP_DEBUG_SUPPORTED + + * STRIP_FILES_SKIP + + * SU + + * SUBDIR + + * SUBST_CLASSES + + * SUBST_FILES + + * SUBST_FILTER_CMD + + * SUBST_MESSAGE + + * SUBST_SED + + * SUBST_SHOW_DIFF + + * SUBST_SKIP_TEXT_CHECK + + * SUBST_STAGE + + * SUBST_VARS + + * SUNWSPROBASE + + * SUSE_PREFER + + * SU_CMD + + * SVN_EXTRACTDIR + + * SVN_REPO + + * SVN_REPOSITORIES + + * SVN_REVISION + + * TERMCAP_TYPE + + * TERMINFO_DEFAULT + + * TERMINFO_TYPE + + * TEST + + * TEST_DIRS + + * TEST_ENV + + * TEST_MAKE_CMD + + * TEST_MAKE_FLAGS + + * TEST_TARGET + + * TEXLIVE_IGNORE_PATTERNS + + * TEXLIVE_REV + + * TEXMFSITE + + * TEX_FORMATS + + * TEX_HYPHEN_DAT + + * TEX_HYPHEN_DEF + + * TEX_TEXMF_DIRS + + * THTTPD_LOG_FACILITY + + * TO + + * TOOLS_ALIASES + + * TOOLS_ARGS + + * TOOLS_BROKEN + + * TOOLS_CMD + + * TOOLS_CREATE + + * TOOLS_DIR + + * TOOLS_FAIL + + * TOOLS_GNU_MISSING + + * TOOLS_LDCONFIG + + * TOOLS_NOOP + + * TOOLS_PATH + + * TOOLS_SCRIPT + + * TTF_FONTDIR + + * TTF_FONTS_DIR + + * TYPE + + * UAC_REQD_EXECS + + * UCSPI_SSL_GROUP + + * UCSPI_SSL_USER + + * UNLIMIT_RESOURCES + + * UNPRIVILEGED + + * UNPRIVILEGED_GROUP + + * UNPRIVILEGED_GROUPS + + * UNPRIVILEGED_USER + + * UNWRAP_FILES + + * UNWRAP_PATTERNS + + * UPDATE_GEMSPEC + + * UPDATE_TARGET + + * URI + + * USA + + * USERGROUP_PHASE + + * USERPPP_GROUP + + * USER_SPECIFIC_PKGS + + * USE_ABI_DEPENDS + + * USE_APR + + * USE_BSD_MAKEFILE + + * USE_BUILTIN + + * USE_CROSS_COMPILE + + * USE_CURSES + + * USE_CWRAPPERS + + * USE_DB185 + + * USE_FEATURES + + * USE_GAMESGROUP + + * USE_GCC_RUNTIME + + * USE_IMAKE + + * USE_JAVA + + * USE_JAVA2 + + * USE_LANGUAGES + + * USE_LIBTOOL + + * USE_NATIVE_GCC + + * USE_NETBSD_REPO + + * USE_PKGSRC_GCC + + * USE_PKGSRC_GCC_RUNTIME + + * USE_PKGTASKS + + * USE_RUBY_EXTCONF + + * USE_RUBY_INSTALL + + * USE_RUBY_SETUP + + * USE_RUBY_SETUP_PKG + + * USE_TOOLS + + * UUCP_GROUP + + * UUCP_USER + + * VARBASE + + * VARNAME + + * VIM_EXTRA_OPTS + + * WARNING_MSG + + * WCALC_CGIDIR + + * WCALC_CGIPATH + + * WCALC_HTMLDIR + + * WCALC_HTMLPATH + + * WDM_MANAGERS + + * WRAPPER_REORDER_CMDS + + * WRKDIR + + * WRKDIR_BASENAME + + * WRKDIR_LOCKTYPE + + * WRKLOG + + * WRKOBJDIR + + * WRKSRC + + * WXGTK_ACCEPTED + + * WXGTK_DEFAULT + + * X10_PORT + + * X11 + + * X11BASE + + * X11_PKGSRCDIR + + * X11_TYPE + + * X509_CERTIFICATE + + * X509_KEY + + * XAW_TYPE + + * XLOCK_DEFAULT_MODE + + * XMKMF_FLAGS + + * XXX + + * XXXX + + * YES + + * ZERO_FILESIZE_P + + * ZSH_STATIC + + * __stdc__ + + * _vargroups + + * add + + * all + + * alternatives + + * aslr + + * asprintf + + * autoconf + + * automake + + * autoreconf + + * awk + + * bash + + * big-endian + + * bin-install + + * binpkg-list + + * bootstrap-depends + + * broken + + * broken_on_platform + + * build + + * build-env + + * buildlink-directories + + * buildlink-oss-soundcard-h + + * c + + * c++ + + * ccache + + * cce + + * cdefs + + * changes + + * changes-entry + + * changes-entry-noupdate + + * check + + * check-clean + + * check-files + + * check-files-clean + + * check-vulnerable + + * checksum + + * checksum-phase + + * clean + + * clean-depends + + * cleandir + + * commit + + * commit-changes-entry + + * compact + + * compiler + + * conf + + * config.guess + + * config.sub + + * configuration + + * configure + + * configure-help + + * configure_args + + * cputime + + * create-usergroup + + * csh + + * ctf + + * cvs + + * debug + + * declaration + + * declare + + * defined + + * depend + + * dependencies + + * depends + + * depends-checksum + + * depends-fetch + + * describe + + * destdir + + * distclean + + * distinfo + + * dl + + * dlopen + + * do-build + + * do-buildlink + + * do-clean + + * do-configure-post-hook + + * do-extract + + * do-fetch + + * do-install + + * emul + + * emulation + + * emulator + + * endian + + * enomem + + * err + + * errx + + * etc + + * feature + + * features + + * fetch + + * fetch-list + + * follows + + * forbids + + * form + + * format + + * fortify + + * fortify_source + + * fossil + + * friend + + * from + + * fts + + * fts_close + + * fts_open + + * fts_read + + * fts_set + + * full + + * gcc + + * getopt_long + + * getprogname + + * gettext + + * git + + * github + + * glob + + * gnu + + * go + + * golang + + * guess-license + + * hashbang + + * heimdal + + * help + + * hg + + * imake + + * increment + + * interp + + * interpreter + + * intl + + * iso + + * kerberos + + * krb + + * krb5 + + * ksh + + * latex + + * libnbcompat + + * libs + + * libtool + + * licence + + * license + + * lintl + + * little-endian + + * lock + + * locking + + * lvalue + + * make + + * makesum + + * memory + + * mercurial + + * meta + + * meta-package + + * meta_package + + * mit-krb5 + + * mk.conf + + * mount + + * mprotect + + * mremap + + * nb + + * nbcompat + + * no + + * obstack + + * obstack_ptr_grow + + * occurs + + * only + + * options + + * options.mk + + * order + + * override + + * override-intltool + + * override-message-intltool + + * package + + * parallel + + * partial + + * path + + * pax + + * paxctl + + * pbulk-index + + * pc + + * perl + + * perl5 + + * perms + + * php + + * pkg-build-options + + * pkg-config + + * pkg_build_options + + * platform + + * plist + + * post-extract + + * post-fetch + + * post-wrapper + + * pre-configure + + * pre-extract + + * pre-fetch + + * print-plist + + * print-summary-data + + * privileged-install-hook + + * pypi + + * python + + * readme-all + + * regcomp + + * relro + + * rename + + * reorder + + * replace + + * replace_interpreter + + * reproducible + + * resolv + + * root + + * ruby + + * setenv + + * setgid + + * setprogname + + * setuid + + * sh + + * show + + * show-all + + * show-build-defs + + * show-depends + + * show-deps + + * show-distfiles + + * show-downlevel + + * show-subdir-var + + * show-tools + + * show-var + + * show-vars + + * snprintf + + * ssp + + * st_mode + + * stage-install + + * strip + + * strong + + * subst + + * subversion + + * sun + + * sunpro + + * sunwspro + + * svn + + * test + + * tex + + * texlive + + * tmp + + * tool + + * tools + + * tools-libtool-m4-override + + * type + + * ulimit + + * undefined + + * undo-replace + + * unlimit + + * unprivileged + + * unprivileged-install-hook + + * unstripped + + * update + + * upload + + * upload-distfiles + + * usage + + * use_tools + + * user + + * utimes + + * vasprintf + + * verbose + + * vsnprintf + + * warn + + * warning + + * warnings + + * warnx + + * weak + + * work + + * wrapper + + * yes + +Appendix E. Editing guidelines for the pkgsrc guide Table of Contents -D.1. Make targets -D.2. Procedure +E.1. Make targets +E.2. Procedure This section contains information on editing the pkgsrc guide itself. -D.1. Make targets +E.1. Make targets The pkgsrc guide's source code is stored in pkgsrc/doc/guide/files, and several files are created from it: @@ -8486,7 +11220,7 @@ files are created from it: * http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps: PostScript version of the pkgsrc guide. -D.2. Procedure +E.2. Procedure The procedure to edit the pkgsrc guide is: |