Annotation of pkgsrc/doc/pkgsrc.html, revision 1.116

1.75      rillig      1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
                      2: <html>
1.1       grant       3: <head>
1.75      rillig      4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
                      5: <title>The pkgsrc guide</title>
1.101     rillig      6: <link rel="stylesheet" href="/global.css" type="text/css">
1.75      rillig      7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
1.91      rillig      8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
1.75      rillig      9: </head>
                     10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" lang="en">
                     11: <div class="titlepage">
                     12: <div>
                     13: <div><h1 class="title">
                     14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
                     15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
                     16: <div><div class="authorgroup">
                     17: <div class="author">
                     18: <h3 class="author">
                     19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
                     20: </h3>
1.110     hubertf    21: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a class="email" href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>&gt;</code></p></div></div>
1.75      rillig     22: </div>
                     23: <div class="author">
                     24: <h3 class="author">
                     25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
                     26: </h3>
1.110     hubertf    27: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a class="email" href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>&gt;</code></p></div></div>
1.75      rillig     28: </div>
                     29: <h3 class="corpauthor">
                     30:         The pkgsrc Developers
                     31:       </h3>
                     32: </div></div>
1.104     rillig     33: <div><p class="copyright">Copyright © 1994-2007 The NetBSD Foundation, Inc</p></div>
1.106     rillig     34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.26 2007/09/18 08:17:21 rillig Exp $</p></div>
1.76      rillig     35: <div><div class="abstract">
1.75      rillig     36: <p class="title"><b>Abstract</b></p>
                     37: <p>pkgsrc is a centralized package management system for
                     38:        Unix-like operating systems. This guide provides information for
                     39:        users and developers of pkgsrc. It covers installation of binary
                     40:        and source packages, creation of binary and source packages and
                     41:        a high-level overview about the infrastructure.</p>
                     42: </div></div>
                     43: </div>
                     44: <hr>
                     45: </div>
                     46: <div class="toc">
                     47: <p><b>Table of Contents</b></p>
                     48: <dl>
                     49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
                     50: <dd><dl>
                     51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig     52: <dd><dl>
                     53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                     54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                     55: </dl></dd>
1.75      rillig     56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                     57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88      wiz        58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75      rillig     59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                     60: </dl></dd>
                     61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
                     62: <dd><dl>
                     63: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
                     64: <dd><dl>
                     65: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                     66: <dd><dl>
                     67: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
                     68: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
1.97      rillig     69: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75      rillig     70: </dl></dd>
                     71: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                     72: <dd><dl>
                     73: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                     74: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                     75: </dl></dd>
                     76: </dl></dd>
                     77: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
                     78: <dd><dl>
1.82      rillig     79: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                     80: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                     81: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                     82: <dd><dl>
                     83: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
                     84: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
                     85: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
                     86: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
                     87: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
                     88: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
                     89: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75      rillig     90: </dl></dd>
                     91: </dl></dd>
                     92: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                     93: <dd><dl>
                     94: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                     95: <dd><dl>
                     96: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                     97: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig     98: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                     99: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                    100: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    101: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                    102: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                    103: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75      rillig    104: </dl></dd>
                    105: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                    106: <dd><dl>
                    107: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                    108: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                    109: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                    110: </dl></dd>
                    111: </dl></dd>
                    112: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    113: <dd><dl>
                    114: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    115: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109     rillig    116: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103     wiz       117: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       118: <dd><dl>
1.103     wiz       119: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.116   ! rillig    120: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (CFLAGS)</a></span></dt>
        !           121: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (LDFLAGS)</a></span></dt>
1.88      wiz       122: </dl></dd>
1.103     wiz       123: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                    124: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75      rillig    125: </dl></dd>
                    126: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    127: <dd><dl>
                    128: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    129: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.106     rillig    130: </dl></dd>
                    131: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
                    132: builds)</a></span></dt>
1.75      rillig    133: <dd><dl>
1.106     rillig    134: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
                    135: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
                    136: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
                    137: <dd><dl>
                    138: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
                    139: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
                    140: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
                    141: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
                    142: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
                    143: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                    144: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
                    145: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
                    146: </dl></dd>
                    147: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.116   ! rillig    148: <dd><dl>
        !           149: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
        !           150: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
        !           151: </dl></dd>
1.106     rillig    152: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                    153: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
                    154: </dl></dd>
                    155: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
                    156: <dd><dl>
1.116   ! rillig    157: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in ${LOCALBASE}</a></span></dt>
        !           158: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in ${VARBASE}</a></span></dt>
1.106     rillig    159: </dl></dd>
                    160: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
                    161: <dd><dl>
                    162: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    163: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
                    164: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
                    165: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
                    166: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
                    167: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
                    168: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.116   ! rillig    169: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell make fetch to do passive FTP?</a></span></dt>
1.106     rillig    170: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.116   ! rillig    171: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does Don't know how to make
        !           172: /usr/share/tmac/tmac.andoc mean?</a></span></dt>
        !           173: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does Could not find bsd.own.mk mean?</a></span></dt>
1.106     rillig    174: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                    175: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                    176: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.116   ! rillig    177: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my CFLAGS?</a></span></dt>
1.106     rillig    178: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
1.116   ! rillig    179: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does Makefile appears to contain unresolved cvs/rcs/??? merge conflicts mean?</a></span></dt>
1.75      rillig    180: </dl></dd>
                    181: </dl></dd>
                    182: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
                    183: <dd><dl>
1.106     rillig    184: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91      rillig    185: <dd><dl>
1.106     rillig    186: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91      rillig    187: <dd><dl>
1.106     rillig    188: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
                    189: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.91      rillig    190: </dl></dd>
1.106     rillig    191: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                    192: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
                    193: </dl></dd>
                    194: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
                    195: <dd><dl>
1.116   ! rillig    196: <dt><span class="sect1"><a href="#components.Makefile">11.1. Makefile</a></span></dt>
        !           197: <dt><span class="sect1"><a href="#components.distinfo">11.2. distinfo</a></span></dt>
1.106     rillig    198: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                    199: <dd><dl>
                    200: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                    201: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                    202: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                    203: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                    204: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                    205: </dl></dd>
                    206: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                    207: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                    208: <dd><dl>
                    209: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                    210: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                    211: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
                    212: </dl></dd>
1.116   ! rillig    213: <dt><span class="sect1"><a href="#work-dir">11.6. work*</a></span></dt>
        !           214: <dt><span class="sect1"><a href="#files-dir">11.7. files/*</a></span></dt>
1.106     rillig    215: </dl></dd>
1.116   ! rillig    216: <dt><span class="chapter"><a href="#makefile">12. Programming in Makefiles</a></span></dt>
1.106     rillig    217: <dd><dl>
                    218: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.116   ! rillig    219: <dt><span class="sect1"><a href="#makefile.variables">12.2. Makefile variables</a></span></dt>
1.106     rillig    220: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                    221: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                    222: <dd><dl>
                    223: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                    224: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                    225: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                    226: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                    227: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
                    228: </dl></dd>
                    229: </dl></dd>
                    230: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
                    231: <dd><dl>
                    232: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.116   ! rillig    233: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic PLIST generation</a></span></dt>
        !           234: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of make print-PLIST</a></span></dt>
1.106     rillig    235: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                    236: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.116   ! rillig    237: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with PLIST_SRC</a></span></dt>
1.106     rillig    238: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
                    239: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
                    240: </dl></dd>
                    241: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
                    242: <dd><dl>
                    243: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.116   ! rillig    244: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing buildlink3.mk files</a></span></dt>
1.106     rillig    245: <dd><dl>
                    246: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.116   ! rillig    247: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating BUILDLINK_API_DEPENDS.pkg in buildlink3.mk files</a></span></dt>
1.106     rillig    248: </dl></dd>
1.116   ! rillig    249: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing builtin.mk files</a></span></dt>
1.106     rillig    250: <dd><dl>
1.116   ! rillig    251: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a builtin.mk file</a></span></dt>
1.106     rillig    252: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                    253: </dl></dd>
                    254: </dl></dd>
                    255: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
                    256: <dd><dl>
                    257: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
                    258: <dd><dl>
                    259: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                    260: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
                    261: </dl></dd>
                    262: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
                    263: <dd><dl>
1.116   ! rillig    264: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How PKG_SYSCONFDIR is set</a></span></dt>
1.106     rillig    265: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                    266: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                    267: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                    268: </dl></dd>
                    269: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                    270: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">15.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
                    271: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                    272: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                    273: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                    274: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                    275: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
                    276: </dl></dd>
                    277: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
                    278: <dd><dl>
                    279: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.116   ! rillig    280: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use bsd.options.mk</a></span></dt>
1.106     rillig    281: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107     rillig    282: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106     rillig    283: </dl></dd>
                    284: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
                    285: <dd><dl>
                    286: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                    287: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                    288: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                    289: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.116   ! rillig    290: <dt><span class="sect1"><a href="#build.fetch">17.5. The fetch phase</a></span></dt>
1.106     rillig    291: <dd><dl>
                    292: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                    293: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                    294: </dl></dd>
1.116   ! rillig    295: <dt><span class="sect1"><a href="#build.checksum">17.6. The checksum phase</a></span></dt>
        !           296: <dt><span class="sect1"><a href="#build.extract">17.7. The extract phase</a></span></dt>
        !           297: <dt><span class="sect1"><a href="#build.patch">17.8. The patch phase</a></span></dt>
        !           298: <dt><span class="sect1"><a href="#build.tools">17.9. The tools phase</a></span></dt>
        !           299: <dt><span class="sect1"><a href="#build.wrapper">17.10. The wrapper phase</a></span></dt>
        !           300: <dt><span class="sect1"><a href="#build.configure">17.11. The configure phase</a></span></dt>
        !           301: <dt><span class="sect1"><a href="#build.build">17.12. The build phase</a></span></dt>
        !           302: <dt><span class="sect1"><a href="#build.test">17.13. The test phase</a></span></dt>
        !           303: <dt><span class="sect1"><a href="#build.install">17.14. The install phase</a></span></dt>
        !           304: <dt><span class="sect1"><a href="#build.package">17.15. The package phase</a></span></dt>
1.106     rillig    305: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                    306: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
                    307: </dl></dd>
                    308: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
                    309: <dd><dl>
                    310: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                    311: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                    312: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                    313: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
                    314: </dl></dd>
                    315: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
                    316: <dd><dl>
                    317: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
                    318: <dd><dl>
                    319: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.116   ! rillig    320: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from ???</a></span></dt>
1.106     rillig    321: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
                    322: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
                    323: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
                    324: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
                    325: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
                    326: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
                    327: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
                    328: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
                    329: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                    330: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                    331: </dl></dd>
1.116   ! rillig    332: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the fetch phase</a></span></dt>
1.106     rillig    333: <dd><dl>
                    334: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                    335: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
                    336: </dl></dd>
1.116   ! rillig    337: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the configure phase</a></span></dt>
1.106     rillig    338: <dd><dl>
                    339: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                    340: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                    341: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                    342: </dl></dd>
                    343: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                    344: <dd><dl>
                    345: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                    346: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                    347: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
                    348: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
                    349: </dl></dd>
1.116   ! rillig    350: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the build phase</a></span></dt>
1.106     rillig    351: <dd><dl>
                    352: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                    353: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.116   ! rillig    354: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to ...</a></span></dt>
1.106     rillig    355: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                    356: </dl></dd>
1.116   ! rillig    357: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the install phase</a></span></dt>
1.106     rillig    358: <dd><dl>
                    359: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                    360: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                    361: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                    362: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                    363: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                    364: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                    365: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                    366: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107     rillig    367: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.106     rillig    368: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper data files</a></span></dt>
                    369: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                    370: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                    371: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                    372: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                    373: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                    374: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                    375: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                    376: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87      wiz       377:     emulation</a></span></dt>
1.106     rillig    378: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                    379: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77      rillig    380: </dl></dd>
1.106     rillig    381: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77      rillig    382: </dl></dd>
1.106     rillig    383: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
                    384: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77      rillig    385: <dd><dl>
1.106     rillig    386: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                    387: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                    388: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
                    389: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
                    390: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
                    391: <dt><span class="sect1"><a href="#moving-package">21.6. Moving a package in pkgsrc</a></span></dt>
                    392: </dl></dd>
                    393: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
                    394: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
                    395: <dd><dl>
                    396: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                    397: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                    398: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                    399: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85      jmmv      400: </dl></dd>
1.75      rillig    401: </dl></dd>
                    402: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
                    403: <dd><dl>
1.106     rillig    404: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig    405: <dd><dl>
1.106     rillig    406: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                    407: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                    408: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81      rillig    409: <dd><dl>
1.106     rillig    410: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                    411: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81      rillig    412: </dl></dd>
1.106     rillig    413: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                    414: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig    415: <dd><dl>
1.106     rillig    416: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                    417: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75      rillig    418: </dl></dd>
1.106     rillig    419: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75      rillig    420: <dd><dl>
1.116   ! rillig    421: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in bsd.prefs.mk</a></span></dt>
        !           422: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in bsd.pkg.mk</a></span></dt>
1.75      rillig    423: </dl></dd>
                    424: </dl></dd>
1.106     rillig    425: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75      rillig    426: <dd><dl>
1.106     rillig    427: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                    428: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                    429: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75      rillig    430: <dd><dl>
1.106     rillig    431: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                    432: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75      rillig    433: </dl></dd>
                    434: </dl></dd>
1.106     rillig    435: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75      rillig    436: <dd><dl>
1.106     rillig    437: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                    438: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75      rillig    439: </dl></dd>
                    440: </dl></dd>
                    441: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
                    442: <dd><dl>
                    443: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                    444: <dd><dl>
                    445: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                    446: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                    447: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.116   ! rillig    448: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75      rillig    449: </dl></dd>
                    450: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                    451: </dl></dd>
                    452: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
                    453: <dd><dl>
                    454: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                    455: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                    456: </dl></dd>
1.76      rillig    457: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
                    458: <dd><dl>
1.116   ! rillig    459: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. bootstrap-pkgsrc: Bootstrap kits</a></span></dt>
        !           460: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. distfiles: The distributed source files</a></span></dt>
        !           461: <dt><span class="sect1"><a href="#ftp-iso">C.3. iso: Currently empty</a></span></dt>
        !           462: <dt><span class="sect1"><a href="#ftp-misc">C.4. misc: Miscellaneous things</a></span></dt>
        !           463: <dt><span class="sect1"><a href="#ftp-packages">C.5. packages: Binary packages</a></span></dt>
        !           464: <dt><span class="sect1"><a href="#ftp-reports">C.6. reports: Bulk build reports</a></span></dt>
        !           465: <dt><span class="sect1"><a href="#ftp-source">C.7. current,
        !           466: pkgsrc-200xQy:
1.76      rillig    467: source packages</a></span></dt>
                    468: </dl></dd>
1.75      rillig    469: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
                    470: <dd><dl>
1.79      rillig    471: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75      rillig    472: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                    473: </dl></dd>
                    474: </dl>
                    475: </div>
1.82      rillig    476: <div class="list-of-tables">
                    477: <p><b>List of Tables</b></p>
                    478: <dl>
                    479: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
                    480: </dt>
1.106     rillig    481: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.85      jmmv      482: </dt>
1.106     rillig    483: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85      jmmv      484: </dt>
1.82      rillig    485: </dl>
                    486: </div>
1.75      rillig    487: <div class="chapter" lang="en">
                    488: <div class="titlepage"><div><div><h2 class="title">
                    489: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h2></div></div></div>
                    490: <div class="toc">
                    491: <p><b>Table of Contents</b></p>
                    492: <dl>
                    493: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig    494: <dd><dl>
                    495: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                    496: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                    497: </dl></dd>
1.75      rillig    498: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                    499: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88      wiz       500: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75      rillig    501: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                    502: </dl>
                    503: </div>
                    504: <div class="sect1" lang="en">
                    505: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    506: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82      rillig    507: <p>There is a lot of software freely available for Unix-based
                    508: systems, which is usually available in form of the source code. Before
                    509: such software can be used, it needs to be configured to the local
                    510: system, compiled and installed, and this is exactly what The NetBSD
                    511: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
                    512: to handle binary packages, so that not every user has to build the
                    513: packages for himself, which is a time-costly task.</p>
1.75      rillig    514: <p>pkgsrc currently contains several thousand packages,
                    515:       including:</p>
                    516: <div class="itemizedlist"><ul type="disc">
1.91      rillig    517: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache/README.html" target="_top"><code class="filename">www/apache</code></a> - The Apache
1.75      rillig    518:          web server</p></li>
1.91      rillig    519: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.75      rillig    520:          web browser</p></li>
1.91      rillig    521: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
1.75      rillig    522:          Desktop Environment</p></li>
1.91      rillig    523: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde3/README.html" target="_top"><code class="filename">meta-pkgs/kde3</code></a> - The K
1.75      rillig    524:          Desktop Environment</p></li>
                    525: </ul></div>
                    526: <p>...just to name a few.</p>
                    527: <p>pkgsrc has built-in support for handling varying dependencies,
                    528:       such as pthreads and X11, and extended features such as IPv6 support on
                    529:       a range of platforms.</p>
1.82      rillig    530: <div class="sect2" lang="en">
                    531: <div class="titlepage"><div><div><h3 class="title">
                    532: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
                    533: <p>
                    534: pkgsrc provides the following key features:
                    535: </p>
                    536: <div class="itemizedlist"><ul type="disc">
                    537: <li><p>Easy building of software from source as well as the creation
                    538:   and installation of binary packages. The source and latest
                    539:   patches are retrieved from a master or mirror download site, checksum
                    540:   verified, then built on your system. Support for binary-only
                    541:   distributions is available for both native platforms and NetBSD
                    542:   emulated platforms.</p></li>
                    543: <li><p>All packages are installed in a consistent directory tree,
                    544:   including binaries, libraries, man pages and other
                    545:   documentation.</p></li>
                    546: <li><p>Package dependencies, including when performing package updates,
                    547:   are handled automatically. The configuration files of various
                    548:   packages are handled automatically during updates, so local changes
                    549:   are preserved.</p></li>
                    550: <li><p>Like NetBSD, pkgsrc is designed with portability in mind and
                    551:   consists of highly portable code. This allows the greatest speed of
                    552:   development when porting to new a platform. This portability also
                    553:   ensures that pkgsrc is <span class="emphasis"><em>consistent across all
                    554:   platforms</em></span>.</p></li>
                    555: <li><p>The installation prefix, acceptable software licenses,
                    556:   international encryption requirements and build-time options for a
                    557:   large number of packages are all set in a simple, central
                    558:   configuration file.</p></li>
                    559: <li><p>The entire source (not including the distribution files) is
                    560:   freely available under a BSD license, so you may extend and adapt
                    561:   pkgsrc to your needs. Support for local packages and patches is
                    562:   available right out of the box, so you can configure it specifically
                    563:   for your environment.</p></li>
                    564: </ul></div>
1.91      rillig    565: <p>The following principles are basic to pkgsrc:</p>
                    566: <div class="itemizedlist"><ul type="disc">
                    567: <li><p>&#8220;<span class="quote">It should only work if it's right.</span>&#8221;
1.114     jmcneill  568: &mdash; That means, if a package contains bugs, it's better to find
1.91      rillig    569: them and to complain about them rather than to just install the package
                    570: and hope that it works. There are numerous checks in pkgsrc that try to
                    571: find such bugs: Static analysis tools (<a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
                    572: of shell scripts), and post-installation checks (installed files,
                    573: references to shared libraries, script interpreters).</p></li>
                    574: <li><p>&#8220;<span class="quote">If it works, it should work everywhere</span>&#8221;
1.114     jmcneill  575: &mdash; Like NetBSD has been ported to many hardware architectures,
1.91      rillig    576: pkgsrc has been ported to many operating systems. Care is taken that
                    577: packages behave the same on all platforms.</p></li>
                    578: </ul></div>
1.82      rillig    579: </div>
                    580: <div class="sect2" lang="en">
                    581: <div class="titlepage"><div><div><h3 class="title">
                    582: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
                    583: <p>pkgsrc consists of both a source distribution and a binary
                    584: distribution for these operating systems. After retrieving the required
                    585: source or binaries, you can be up and running with pkgsrc in just
                    586: minutes!</p>
1.75      rillig    587: <p>pkgsrc was derived from FreeBSD's ports system, and
                    588:       initially developed for NetBSD only. Since then, pkgsrc has
                    589:       grown a lot, and now supports the following platforms:</p>
1.82      rillig    590: <div class="table">
                    591: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.91      rillig    592: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
1.82      rillig    593: <colgroup>
                    594: <col>
                    595: <col>
                    596: </colgroup>
                    597: <thead><tr>
                    598: <th>Platform</th>
                    599: <th>Date Support Added</th>
                    600: </tr></thead>
                    601: <tbody>
                    602: <tr>
1.110     hubertf   603: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82      rillig    604: <td align="center">Aug 1997</td>
                    605: </tr>
                    606: <tr>
1.110     hubertf   607: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82      rillig    608: <td align="center">Mar 1999</td>
                    609: </tr>
                    610: <tr>
1.110     hubertf   611: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.82      rillig    612: <td align="center">Jun 1999</td>
                    613: </tr>
                    614: <tr>
                    615: <td>
1.110     hubertf   616:           <a class="ulink" href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
                    617:           (<a class="ulink" href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
1.82      rillig    618:         </td>
                    619: <td align="center">Oct 2001</td>
                    620: </tr>
                    621: <tr>
1.110     hubertf   622: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82      rillig    623: <td align="center">Nov 2002</td>
                    624: </tr>
                    625: <tr>
1.110     hubertf   626: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82      rillig    627: <td align="center">Nov 2002</td>
                    628: </tr>
                    629: <tr>
1.110     hubertf   630: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82      rillig    631: <td align="center">Dec 2002</td>
                    632: </tr>
                    633: <tr>
                    634: <td>BSD/OS</td>
                    635: <td align="center">Dec 2003</td>
                    636: </tr>
                    637: <tr>
1.110     hubertf   638: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82      rillig    639: <td align="center">Dec 2003</td>
                    640: </tr>
                    641: <tr>
                    642: <td>
1.110     hubertf   643:           <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82      rillig    644:           (Microsoft Windows Services for Unix)
                    645:         </td>
                    646: <td align="center">Mar 2004</td>
                    647: </tr>
                    648: <tr>
1.110     hubertf   649: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82      rillig    650: <td align="center">Oct 2004</td>
                    651: </tr>
                    652: <tr>
1.110     hubertf   653: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82      rillig    654: <td align="center">Nov 2004</td>
                    655: </tr>
1.98      wiz       656: <tr>
1.110     hubertf   657: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98      wiz       658: <td align="center">Apr 2007</td>
                    659: </tr>
1.82      rillig    660: </tbody>
1.91      rillig    661: </table></div>
1.82      rillig    662: </div>
1.91      rillig    663: <br class="table-break">
1.82      rillig    664: </div>
1.75      rillig    665: </div>
                    666: <div class="sect1" lang="en">
                    667: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    668: <a name="overview"></a>1.2. Overview</h2></div></div></div>
                    669: <p>This document is divided into three parts. The first,
1.110     hubertf   670:        <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75      rillig    671:        describes how one can use one of the packages in the Package
                    672:        Collection, either by installing a precompiled binary package,
1.93      rillig    673:        or by building one's own copy using the NetBSD package system.
1.110     hubertf   674:        The second part, <a class="link" href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
1.75      rillig    675:        package so it can be easily built by other NetBSD users without
                    676:        knowing about the package's building details. The third part,
1.110     hubertf   677:        <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75      rillig    678:        is intended for those who want to understand how pkgsrc is
                    679:        implemented.</p>
                    680: <p>This document is available in various formats:
1.110     hubertf   681:        <span class="simplelist"><a class="ulink" href="index.html" target="_top">HTML</a>, <a class="ulink" href="pkgsrc.pdf" target="_top">PDF</a>, <a class="ulink" href="pkgsrc.ps" target="_top">PS</a>, <a class="ulink" href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
1.75      rillig    682: </div>
                    683: <div class="sect1" lang="en">
                    684: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    685: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
                    686: <p>There has been a lot of talk about &#8220;<span class="quote">ports</span>&#8221;,
                    687:       &#8220;<span class="quote">packages</span>&#8221;, etc. so far. Here is a description of all the
                    688:       terminology used within this document.</p>
                    689: <div class="variablelist"><dl>
                    690: <dt><span class="term">Package</span></dt>
                    691: <dd><p>A set of files and building instructions
                    692:            that describe what's necessary
                    693:            to build a certain piece of software using
                    694:             pkgsrc. Packages are traditionally stored under
1.76      rillig    695:            <code class="filename">/usr/pkgsrc</code>.</p></dd>
1.75      rillig    696: <dt><span class="term">The NetBSD package system</span></dt>
1.87      wiz       697: <dd><p>This is the former name of &#8220;<span class="quote">pkgsrc</span>&#8221;.  It
                    698:          is part of the NetBSD operating system and can be bootstrapped
                    699:          to run on non-NetBSD operating systems as well.  It handles
                    700:          building (compiling), installing, and removing of
                    701:          packages.</p></dd>
1.75      rillig    702: <dt><span class="term">Distfile</span></dt>
                    703: <dd><p>This term describes the file or files that are
                    704:            provided by the author of the piece of software to
                    705:            distribute his work. All the changes necessary to build on
                    706:            NetBSD are reflected in the corresponding package. Usually
                    707:            the distfile is in the form of a compressed tar-archive,
                    708:            but other types are possible, too. Distfiles are usually
                    709:            stored below
1.76      rillig    710:            <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75      rillig    711: <dt><span class="term">Port</span></dt>
                    712: <dd><p>This is the term used by FreeBSD and OpenBSD people
                    713:            for what we call a package.
                    714:            In NetBSD terminology, &#8220;<span class="quote">port</span>&#8221; refers to a different
                    715:            architecture.</p></dd>
                    716: <dt><span class="term">Precompiled/binary package</span></dt>
                    717: <dd>
                    718: <p>A set of binaries built with pkgsrc from a distfile
1.76      rillig    719:            and stuffed together in a single <code class="filename">.tgz</code>
1.75      rillig    720:            file so it can be installed on machines of the same
                    721:            machine architecture without the need to
                    722:            recompile. Packages are usually generated in
1.76      rillig    723:            <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.110     hubertf   724:            an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.75      rillig    725: <p>Sometimes, this is referred to by the term &#8220;<span class="quote">package</span>&#8221; too,
                    726:            especially in the context of precompiled packages.</p>
                    727: </dd>
                    728: <dt><span class="term">Program</span></dt>
1.88      wiz       729: <dd><p>The piece of software to be installed which will be
                    730:          constructed from all the files in the distfile by the
                    731:          actions defined in the corresponding package.</p></dd>
1.75      rillig    732: </dl></div>
                    733: <div class="sect2" lang="en">
                    734: <div class="titlepage"><div><div><h3 class="title">
1.88      wiz       735: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.75      rillig    736: <div class="variablelist"><dl>
                    737: <dt><span class="term">pkgsrc users</span></dt>
                    738: <dd>
                    739: <p>The
                    740:        pkgsrc users are people who use the packages provided by pkgsrc.
                    741:        Typically they are system administrators. The people using the
                    742:        software that is inside the packages (maybe called &#8220;<span class="quote">end
                    743:        users</span>&#8221;) are not covered by the pkgsrc guide.</p>
                    744: <p>There are two kinds of pkgsrc users: Some only want to
                    745:        install pre-built binary packages. Others build the pkgsrc
                    746:        packages from source, either for installing them directly or for
1.110     hubertf   747:        building binary packages themselves. For pkgsrc users <a class="xref" href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, &#8220;The pkgsrc user's guide&#8221;</a> should provide all necessary
1.75      rillig    748:        documentation.</p>
                    749: </dd>
                    750: <dt><span class="term">package maintainers</span></dt>
                    751: <dd><p>A
1.110     hubertf   752:        package maintainer creates packages as described in <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, &#8220;The pkgsrc developer's guide&#8221;</a>.</p></dd>
1.75      rillig    753: <dt><span class="term">infrastructure developers</span></dt>
                    754: <dd><p>These people are involved in all those files
1.76      rillig    755:        that live in the <code class="filename">mk/</code> directory and below.
1.110     hubertf   756:        Only these people should need to read through <a class="xref" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, &#8220;The pkgsrc infrastructure internals&#8221;</a>, though others might be curious,
1.75      rillig    757:        too.</p></dd>
                    758: </dl></div>
                    759: </div>
                    760: </div>
                    761: <div class="sect1" lang="en">
                    762: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    763: <a name="typography"></a>1.4. Typography</h2></div></div></div>
                    764: <p>When giving examples for commands, shell prompts are used to
                    765:       show if the command should/can be issued as root, or if
                    766:       &#8220;<span class="quote">normal</span>&#8221; user privileges are sufficient. We use a
                    767:       <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
                    768:       shell prompt, assuming they use the C-shell or tcsh.</p>
                    769: </div>
                    770: </div>
                    771: <div class="part" lang="en">
                    772: <div class="titlepage"><div><div><h1 class="title">
                    773: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
                    774: <div class="toc">
                    775: <p><b>Table of Contents</b></p>
                    776: <dl>
                    777: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
                    778: <dd><dl>
                    779: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    780: <dd><dl>
                    781: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
                    782: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
1.97      rillig    783: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75      rillig    784: </dl></dd>
                    785: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    786: <dd><dl>
                    787: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    788: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    789: </dl></dd>
                    790: </dl></dd>
                    791: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
                    792: <dd><dl>
1.82      rillig    793: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                    794: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                    795: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                    796: <dd><dl>
                    797: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
                    798: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
                    799: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
                    800: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
                    801: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
                    802: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
                    803: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75      rillig    804: </dl></dd>
                    805: </dl></dd>
                    806: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                    807: <dd><dl>
                    808: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                    809: <dd><dl>
                    810: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                    811: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig    812: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                    813: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                    814: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    815: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                    816: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                    817: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75      rillig    818: </dl></dd>
                    819: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                    820: <dd><dl>
                    821: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                    822: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                    823: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                    824: </dl></dd>
                    825: </dl></dd>
                    826: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    827: <dd><dl>
                    828: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    829: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109     rillig    830: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103     wiz       831: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       832: <dd><dl>
1.103     wiz       833: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.116   ! rillig    834: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (CFLAGS)</a></span></dt>
        !           835: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (LDFLAGS)</a></span></dt>
1.88      wiz       836: </dl></dd>
1.103     wiz       837: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                    838: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75      rillig    839: </dl></dd>
                    840: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    841: <dd><dl>
                    842: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    843: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.106     rillig    844: </dl></dd>
                    845: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
                    846: builds)</a></span></dt>
1.75      rillig    847: <dd><dl>
1.106     rillig    848: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
                    849: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
                    850: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
                    851: <dd><dl>
                    852: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
                    853: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
                    854: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
                    855: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
                    856: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
                    857: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                    858: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
                    859: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
                    860: </dl></dd>
                    861: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.116   ! rillig    862: <dd><dl>
        !           863: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
        !           864: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
        !           865: </dl></dd>
1.106     rillig    866: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                    867: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
                    868: </dl></dd>
                    869: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
                    870: <dd><dl>
1.116   ! rillig    871: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in ${LOCALBASE}</a></span></dt>
        !           872: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in ${VARBASE}</a></span></dt>
1.106     rillig    873: </dl></dd>
                    874: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
                    875: <dd><dl>
                    876: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    877: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
                    878: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
                    879: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
                    880: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
                    881: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
                    882: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.116   ! rillig    883: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell make fetch to do passive FTP?</a></span></dt>
1.106     rillig    884: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.116   ! rillig    885: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does Don't know how to make
        !           886: /usr/share/tmac/tmac.andoc mean?</a></span></dt>
        !           887: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does Could not find bsd.own.mk mean?</a></span></dt>
1.106     rillig    888: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                    889: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                    890: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.116   ! rillig    891: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my CFLAGS?</a></span></dt>
1.106     rillig    892: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
1.116   ! rillig    893: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does Makefile appears to contain unresolved cvs/rcs/??? merge conflicts mean?</a></span></dt>
1.75      rillig    894: </dl></dd>
                    895: </dl>
                    896: </div>
                    897: <div class="chapter" lang="en">
                    898: <div class="titlepage"><div><div><h2 class="title">
                    899: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
                    900: <div class="toc">
                    901: <p><b>Table of Contents</b></p>
                    902: <dl>
                    903: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    904: <dd><dl>
                    905: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
                    906: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
1.97      rillig    907: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75      rillig    908: </dl></dd>
                    909: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    910: <dd><dl>
                    911: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    912: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    913: </dl></dd>
                    914: </dl>
                    915: </div>
1.91      rillig    916: <p>Before you download and extract the files, you need to decide
                    917: where you want to extract them. When using pkgsrc as root user, pkgsrc
                    918: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
                    919: free to install the sources and binary packages wherever you want in
                    920: your filesystem, provided that the pathname does not contain white-space
                    921: or other characters that are interpreted specially by the shell and some
                    922: other programs. A safe bet is to use only letters, digits, underscores
                    923: and dashes.</p>
1.75      rillig    924: <div class="sect1" lang="en">
                    925: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    926: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
                    927: <p>Before you download any pkgsrc files, you should decide
                    928:        whether you want the <span class="emphasis"><em>current</em></span> branch or the
                    929:        <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
                    930:        quarterly basis from the current branch and only gets modified
                    931:        for security updates. The names of the stable branches are built
                    932:        from the year and the quarter, for example
1.112     weinem    933:        <code class="literal">2007Q4</code>.</p>
1.75      rillig    934: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
                    935:        want to download pkgsrc. You can get it as a tar file, via SUP,
                    936:        or via CVS. All three ways are described here.</p>
                    937: <div class="sect2" lang="en">
                    938: <div class="titlepage"><div><div><h3 class="title">
                    939: <a name="getting-via-tar"></a>2.1.1. As tar file</h3></div></div></div>
                    940: <p>The primary download location for all pkgsrc files is
1.110     hubertf   941:        <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>. There are a
1.75      rillig    942:        number of subdirectories for different purposes, which are
1.110     hubertf   943:        described in detail in <a class="xref" href="#ftp-layout" title="Appendix C. Directory layout of the pkgsrc FTP server">Appendix C, <i>Directory layout of the pkgsrc FTP server</i></a>.</p>
1.75      rillig    944: <p>The tar file for the current branch is in the directory
1.110     hubertf   945:        <code class="filename">current</code> and is called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.75      rillig    946:        It is autogenerated daily.</p>
1.112     weinem    947: <p>The tar file for the stable branch 2007Q4 is in the
                    948:        directory <code class="filename">pkgsrc-2007Q4</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2007Q4/pkgsrc-2007Q4.tar.gz" target="_top"><code class="filename">pkgsrc-2007Q4.tar.gz</code></a>.</p>
                    949: <p>To download a pkgsrc stable tarball, run:</p>
                    950: <pre class="screen">
                    951: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/<em class="replaceable"><code>pkgsrc-200xQy</code></em>/<em class="replaceable"><code>pkgsrc-200xQy</code></em>.tar.gz</code></strong></pre>
                    952: <p>Where <em class="replaceable"><code>pkgsrc-200xQy</code></em> is the
                    953:        stable branch to be downloaded, for example, 
                    954:        &#8220;<span class="quote">pkgsrc-2007Q4</span>&#8221;.</p>
                    955: <p>Then, extract it with:</p>
                    956: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf <em class="replaceable"><code>pkgsrc-200xQy</code></em>.tar.gz -C /usr</code></strong></pre>
                    957: <p>This will create the directory <code class="filename">pkgsrc/</code>
                    958:        in <code class="filename">/usr/</code> and all the package source will be 
                    959:        stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                    960: <p>To download pkgsrc-current, run:</p>
                    961: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz</code></strong></pre>
1.75      rillig    962: </div>
                    963: <div class="sect2" lang="en">
                    964: <div class="titlepage"><div><div><h3 class="title">
                    965: <a name="getting-via-sup"></a>2.1.2. Via SUP</h3></div></div></div>
                    966: <p>As an alternative to the tar file, you can get pkgsrc via
                    967:        the Software Update Protocol, SUP. To do so, make sure your
                    968:        supfile has a line
1.1       grant     969: 
1.75      rillig    970: </p>
                    971: <pre class="programlisting">
1.100     rillig    972: release=pkgsrc
1.1       grant     973: </pre>
1.75      rillig    974: <p>
1.1       grant     975: 
1.75      rillig    976:        in it, see the examples in
1.76      rillig    977:        <code class="filename">/usr/share/examples/supfiles</code>, and that the
                    978:        <code class="filename">/usr/pkgsrc</code> directory exists. Then, simply
1.113     weinem    979:        run:</p>
                    980: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>sup -v <em class="replaceable"><code>/path/to/your/supfile</code></em></code></strong>.</pre>
1.75      rillig    981: </div>
                    982: <div class="sect2" lang="en">
                    983: <div class="titlepage"><div><div><h3 class="title">
1.97      rillig    984: <a name="getting-via-cvs"></a>2.1.3. Via anonymous CVS</h3></div></div></div>
1.112     weinem    985: <p>To do an initial (full) checkout of pkgsrc, you first
1.75      rillig    986:        have to set some environment variables. For the C-Shell,
                    987:        type:</p>
1.113     weinem    988: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>setenv CVSROOT anoncvs@anoncvs.NetBSD.org:/cvsroot</code></strong>
                    989: <code class="prompt">%</code> <strong class="userinput"><code>setenv CVS_RSH ssh</code></strong>
1.75      rillig    990: </pre>
                    991: <p>Or, the same for the bourne shell:</p>
1.113     weinem    992: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>export CVSROOT="anoncvs@anoncvs.NetBSD.org:/cvsroot"</code></strong>
                    993: <code class="prompt">$</code> <strong class="userinput"><code>export CVS_RSH="ssh"</code></strong>
1.75      rillig    994: </pre>
1.113     weinem    995: <p>By default, CVS doesn't do things like most people would
1.112     weinem    996:        expect it to do. But there is a
1.113     weinem    997:        way to convince CVS, by creating a file called
1.101     rillig    998:        <code class="filename">.cvsrc</code> in your home directory and saving
                    999:        the following lines to it. This file will save you lots of
                   1000:        headache and some bug reports, so we strongly recommend it. You
                   1001:        can find an explanation of this file in the CVS
                   1002:        documentation.</p>
                   1003: <pre class="programlisting">
                   1004: # recommended CVS configuration file from the pkgsrc guide
                   1005: checkout -P
1.103     wiz      1006: update -dP
1.101     rillig   1007: release -d
1.103     wiz      1008: diff -upN
1.101     rillig   1009: cvs -q -z3
                   1010: rdiff -u
                   1011: </pre>
1.112     weinem   1012: <p>To fetch a specific pkgsrc stable branch from scratch, run:</p>
                   1013: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr</code></strong>
1.113     weinem   1014: <code class="prompt">$</code> <strong class="userinput"><code>cvs checkout -r <em class="replaceable"><code>pkgsrc-200xQy</code></em> -P pkgsrc</code></strong></pre>
1.112     weinem   1015: <p>Where <em class="replaceable"><code>pkgsrc-200xQy</code></em> is the stable 
                   1016:        branch to be checked out, for example, &#8220;<span class="quote">pkgsrc-2007Q4</span>&#8221;</p>
                   1017: <p>This will create the directory <code class="filename">pkgsrc/</code> 
                   1018:        in your <code class="filename">/usr/</code> directory and all the package source 
                   1019:        will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                   1020: <p>To fetch the pkgsrc current branch, run:</p>
                   1021: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr</code></strong>
1.113     weinem   1022: <code class="prompt">$</code> <strong class="userinput"><code>cvs checkout -P pkgsrc</code></strong></pre>
1.75      rillig   1023: </div>
                   1024: </div>
                   1025: <div class="sect1" lang="en">
                   1026: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1027: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
                   1028: <p>The preferred way to keep pkgsrc up-to-date is via CVS
                   1029:        (which also works if you have first installed it via a tar
                   1030:        file). It saves bandwidth and hard disk activity, compared to
                   1031:        downloading the tar file again.</p>
                   1032: <div class="sect2" lang="en">
                   1033: <div class="titlepage"><div><div><h3 class="title">
                   1034: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
                   1035: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1036: <h3 class="title">Warning</h3>
1.77      rillig   1037: <p>When updating from a tar file, you first need to
                   1038:        completely remove the old pkgsrc directory. Otherwise those
                   1039:        files that have been removed from pkgsrc in the mean time will
                   1040:        not be removed on your local disk, resulting in inconsistencies.
                   1041:        When removing the old files, any changes that you have done to
                   1042:        the pkgsrc files will be lost after updating. Therefore updating
                   1043:        via CVS is strongly recommended.</p>
1.75      rillig   1044: </div>
1.82      rillig   1045: <p>Note that by default the distfiles and the binary packages
                   1046:        are saved in the pkgsrc tree, so don't forget to rescue them
                   1047:        before updating. You can also configure pkgsrc to use other than
                   1048:        the default directories by setting the
                   1049:        <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.110     hubertf  1050:        variables. See <a class="xref" href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1.75      rillig   1051: <p>To update pkgsrc from a tar file, download the tar file as
                   1052:        explained above. Then, make sure that you have not made any
                   1053:        changes to the files in the pkgsrc directory. Remove the pkgsrc
                   1054:        directory and extract the new tar file. Done.</p>
                   1055: </div>
                   1056: <div class="sect2" lang="en">
                   1057: <div class="titlepage"><div><div><h3 class="title">
                   1058: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
                   1059: <p>To update pkgsrc via CVS, make sure the environment
                   1060:        variable <code class="varname">CVS_RSH</code> is set as above. Then,
1.113     weinem   1061:        change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
                   1062: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   1063: <code class="prompt">$</code> <strong class="userinput"><code>cvs update -dP</code></strong></pre>
1.75      rillig   1064: <div class="sect3" lang="en">
                   1065: <div class="titlepage"><div><div><h4 class="title">
                   1066: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
                   1067: <p>When updating pkgsrc, the CVS program keeps track of the
                   1068:        branch you selected. But if you, for whatever reason, want to
                   1069:        switch from the stable branch to the current one, you can do it
                   1070:        by adding the option &#8220;<span class="quote">-A</span>&#8221; after the
                   1071:        &#8220;<span class="quote">update</span>&#8221; keyword. To switch from the current branch
                   1072:        back to the stable branch, add the
1.113     weinem   1073:        &#8220;<span class="quote">-rpkgsrc-2007Q4</span>&#8221; option.</p>
1.75      rillig   1074: </div>
                   1075: <div class="sect3" lang="en">
                   1076: <div class="titlepage"><div><div><h4 class="title">
                   1077: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
                   1078: <p>When you update pkgsrc, the CVS program will only touch
                   1079:        those files that are registered in the CVS repository. That
                   1080:        means that any packages that you created on your own will stay
                   1081:        unmodified. If you change files that are managed by CVS, later
                   1082:        updates will try to merge your changes with those that have been
                   1083:        done by others. See the CVS manual, chapter
                   1084:        &#8220;<span class="quote">update</span>&#8221; for details.</p>
                   1085: </div>
                   1086: </div>
                   1087: </div>
                   1088: </div>
                   1089: <div class="chapter" lang="en">
                   1090: <div class="titlepage"><div><div><h2 class="title">
                   1091: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
                   1092: <div class="toc">
                   1093: <p><b>Table of Contents</b></p>
                   1094: <dl>
1.82      rillig   1095: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                   1096: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                   1097: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                   1098: <dd><dl>
                   1099: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
                   1100: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
                   1101: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
                   1102: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
                   1103: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
                   1104: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
                   1105: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75      rillig   1106: </dl></dd>
                   1107: </dl>
                   1108: </div>
                   1109: <div class="sect1" lang="en">
                   1110: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82      rillig   1111: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.110     hubertf  1112: <p>See <a class="xref" href="#using-pkg" title="4.1. Using binary packages">Section 4.1, &#8220;Using binary packages&#8221;</a>.</p>
1.82      rillig   1113: </div>
                   1114: <div class="sect1" lang="en">
                   1115: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1116: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
                   1117: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75      rillig   1118: <pre class="screen">
                   1119: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc</code></strong>
                   1120: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87      wiz      1121: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
                   1122:     </pre>
1.110     hubertf  1123: <p>See <a class="xref" href="#getting" title="Chapter 2. Where to get pkgsrc and how to keep it up-to-date">Chapter 2, <i>Where to get pkgsrc and how to keep it up-to-date</i></a> for other ways to get
1.87      wiz      1124:     pkgsrc before bootstrapping. The given
1.110     hubertf  1125:     <span class="command"><strong>bootstrap</strong></span> command will use the defaults of
1.87      wiz      1126:     <code class="filename">/usr/pkg</code> for the
                   1127:     <span class="emphasis"><em>prefix</em></span> where programs will be installed in,
                   1128:     and <code class="filename">/var/db/pkg</code> for the package database
                   1129:     directory where pkgsrc will do its internal bookkeeping.
                   1130:     However, these can also be set using command-line
                   1131:     arguments.</p>
1.75      rillig   1132: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1133: <h3 class="title">Note</h3>
1.110     hubertf  1134: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
                   1135:       Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
                   1136:       For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.87      wiz      1137:       instead of &#8220;<span class="quote">make</span>&#8221;.</p>
1.75      rillig   1138: </div>
                   1139: </div>
                   1140: <div class="sect1" lang="en">
                   1141: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82      rillig   1142: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1.75      rillig   1143: <p>Here are some platform-specific notes you should be aware of.</p>
                   1144: <div class="sect2" lang="en">
                   1145: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1146: <a name="darwin"></a>3.3.1. Darwin (Mac OS X)</h3></div></div></div>
1.85      jmmv     1147: <p>Darwin 5.x and up are supported. There are two methods of using
1.110     hubertf  1148:        pkgsrc on Mac OS X, by using a <a class="link" href="#platform.osx-image" title="3.3.1.1. Using a disk image">disk
                   1149:          image</a>, or a <a class="link" href="#platform.osx-part" title="3.3.1.2. Using a UFS or HFSX partition">UFS or HFSX
1.75      rillig   1150:          partition</a>.</p>
                   1151: <p>Before you start, you will need to download and install the Mac OS X Developer
1.110     hubertf  1152:       Tools from Apple's Developer Connection.  See <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1.87      wiz      1153:       for details.  Also, make sure you install X11 for Mac OS X and the X11 SDK
1.110     hubertf  1154:       from <a class="ulink" href="http://www.apple.com/macosx/x11/download/" target="_top">http://www.apple.com/macosx/x11/download/</a>
1.87      wiz      1155:       if you intend to build packages that use the X11 Window System.</p>
1.89      rillig   1156: <p>If you already have a UFS or HFSX partition, or have a spare partition
                   1157:       that you can format as UFS or HFSX, it is recommended to use that instead of
1.87      wiz      1158:       the disk image. It'll be somewhat faster and will mount automatically
                   1159:       at boot time, where you must manually mount a disk image.</p>
1.75      rillig   1160: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1161: <h3 class="title">Note</h3>
1.85      jmmv     1162: <p>You cannot use an ordinary HFS+ file system for pkgsrc, because pkgsrc currently
1.89      rillig   1163:          requires the file system to be case-sensitive. You can, however, use a case-sensitive HFS+ (aka HFSX) file system as found in Darwin 7.0 and newer.</p>
1.75      rillig   1164: </div>
                   1165: <div class="sect3" lang="en">
                   1166: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1167: <a name="platform.osx-image"></a>3.3.1.1. Using a disk image</h4></div></div></div>
1.75      rillig   1168: <p>Create the disk image:</p>
                   1169: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.95      tron     1170: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage create ~/Documents/NetBSD 1024</code></strong> # megabytes - season to taste
1.85      jmmv     1171: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage mount ~/Documents/NetBSD</code></strong>
1.75      rillig   1172: <code class="prompt">#</code> <strong class="userinput"><code>sudo chown `id -u`:`id -g` /Volumes/NetBSD</code></strong></pre>
1.85      jmmv     1173: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1174: <h3 class="title">Note</h3>
1.109     rillig   1175: <p>darwindiskimage will mount the filesystem nosuid, which will cause problems for packages that depend on setgid.  In the case of UFS, it will also mount the filesystem asynchronous, which is somewhat dangerous according to the mount(8) man page.  In the case of HFSX, it will disable journaling.</p>
1.85      jmmv     1176: </div>
1.89      rillig   1177: <p>Allow suid:</p>
                   1178: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sudo mount -u -o suid /Volumes/NetBSD</code></strong></pre>
1.105     weinem   1179: <p>Changing the build directory:</p>
                   1180: <p>After bootstrapping you need to change the default package build directory to somewhere outside the disk image so it doesn't get filled up in the process of building packages. Add something like that to <code class="filename">mk.conf</code>.</p>
                   1181: <pre class="programlisting">
                   1182:          WRKOBJDIR?=           /tmp/pkgsrc         # build here instead of in pkgsrc
                   1183:        </pre>
1.75      rillig   1184: </div>
                   1185: <div class="sect3" lang="en">
                   1186: <div class="titlepage"><div><div><h4 class="title">
1.89      rillig   1187: <a name="platform.osx-part"></a>3.3.1.2. Using a UFS or HFSX partition</h4></div></div></div>
1.76      rillig   1188: <p>By default, <code class="filename">/usr</code> will be on your root file
1.87      wiz      1189:        system, normally HFS+. It is possible to use the default
                   1190:        <span class="emphasis"><em>prefix</em></span> of <code class="filename">/usr/pkg</code>
                   1191:        by symlinking <code class="filename">/usr/pkg</code> to a directory on a UFS
1.89      rillig   1192:        or HFSX file system. Obviously, another symlink is required if you want to
1.87      wiz      1193:        place the package database directory outside the
                   1194:        <span class="emphasis"><em>prefix</em></span>. e.g.</p>
1.75      rillig   1195: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --pkgdbdir /usr/pkg/pkgdb</code></strong></pre>
                   1196: <p>If you created your partitions at the time of installing Mac OS X
1.89      rillig   1197:        and formatted the target partition as UFS or HFSX, it should automatically
1.87      wiz      1198:        mount on <code class="filename">/Volumes/&lt;volume name&gt;</code> when the
1.89      rillig   1199:        machine boots. If you are (re)formatting a partition as UFS or HFSX, you need
1.87      wiz      1200:        to ensure that the partition map correctly reflects
1.89      rillig   1201:        &#8220;<span class="quote">Apple_UFS</span>&#8221; or &#8220;<span class="quote">Apple_HFSX</span>&#8221; and not &#8220;<span class="quote">Apple_HFS</span>&#8221;.</p>
1.75      rillig   1202: <p>The problem is that none of the disk tools will let you touch a
1.87      wiz      1203:        disk that is booted from. You can unmount the partition, but even if
                   1204:        you newfs it, the partition type will be incorrect and the
                   1205:        automounter won't mount it. It can be mounted manually, but it won't
                   1206:        appear in Finder.</p>
1.75      rillig   1207: <p>You'll need to boot off of the OS X Installation (User) CD.  When
1.87      wiz      1208:        the Installation program starts, go up to the menu and select Disk
                   1209:        Utility.  Now, you will be able to select the partition you want
1.89      rillig   1210:        to be UFS or HFSX, and Format it Apple UFS or HFSX. Quit the Disk Utility, quit the
                   1211:        installer which will reboot your machine. The new UFS or HFSX file system
1.87      wiz      1212:        will appear in Finder.</p>
1.75      rillig   1213: <p>Be aware that the permissions on the new file system will be writable
1.87      wiz      1214:        by root only.</p>
1.75      rillig   1215: <p>This note is as of 10.2 (Jaguar) and applies to earlier versions.
1.87      wiz      1216:        Hopefully Apple will fix Disk Utility in 10.3 (Panther).</p>
1.75      rillig   1217: </div>
                   1218: </div>
                   1219: <div class="sect2" lang="en">
                   1220: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1221: <a name="freebsd"></a>3.3.2. FreeBSD</h3></div></div></div>
1.87      wiz      1222: <p>FreeBSD 4.7 and 5.0 have been tested and are supported,
                   1223:       other versions may work.</p>
1.75      rillig   1224: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87      wiz      1225:       with the FreeBSD userland tools. There are several steps:</p>
1.75      rillig   1226: <div class="orderedlist"><ol type="1">
                   1227: <li><p>FreeBSD stores its ports pkg database in
1.87      wiz      1228:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1229:          recommended that you choose a different location (e.g.
                   1230:          <code class="filename">/usr/pkgdb</code>) by
                   1231:          using the --pkgdbdir option to the bootstrap script.</p></li>
1.75      rillig   1232: <li>
                   1233: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1.87      wiz      1234:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1235: <pre class="screen">
                   1236: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75      rillig   1237: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1238: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1239: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87      wiz      1240: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1241:          </pre>
1.75      rillig   1242: </li>
1.110     hubertf  1243: <li><p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87      wiz      1244:          <code class="filename">/etc/mk.conf.example</code> file
                   1245:          when you use the bootstrap script.</p></li>
1.75      rillig   1246: </ol></div>
                   1247: </div>
                   1248: <div class="sect2" lang="en">
                   1249: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1250: <a name="interix"></a>3.3.3. Interix</h3></div></div></div>
1.75      rillig   1251: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1.87      wiz      1252:       providing a Unix-like environment with a tighter kernel integration than
                   1253:       available with Cygwin.  It is part of the Windows Services for Unix
                   1254:       package, available for free for any licensed copy of Windows 2000, XP
1.110     hubertf  1255:       (not including XP Home), or 2003.  SFU can be downloaded from <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">http://www.microsoft.com/windows/sfu/</a>.</p>
1.93      rillig   1256: <p>Services for Unix 3.5 has been tested.  3.0 or 3.1 may work, but
                   1257:       are not officially supported.  (The main difference in 3.0/3.1 is lack
                   1258:       of pthreads, but other parts of libc may also be lacking.)</p>
                   1259: <p>Services for Unix Applications (aka SUA) is an integrated component
                   1260:       of Windows Server 2003 R2 and Windows Vista.  As of this writing, SUA's
1.95      tron     1261:       Interix 5.x subsystem has not yet been tested with pkgsrc.</p>
1.75      rillig   1262: <div class="sect3" lang="en">
                   1263: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1264: <a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
1.75      rillig   1265: <p>At an absolute minimum, the following packages must be installed from
1.87      wiz      1266:        the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.75      rillig   1267: <div class="itemizedlist"><ul type="disc">
                   1268: <li><p>Utilities -&gt; Base Utilities</p></li>
                   1269: <li><p>Interix GNU Components -&gt; (all)</p></li>
                   1270: <li><p>Remote Connectivity</p></li>
                   1271: <li><p>Interix SDK</p></li>
                   1272: </ul></div>
                   1273: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1.87      wiz      1274:        "UNIX Perl".  That is Perl 5.6 without shared module support, installed to
                   1275:        /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
                   1276:        pkgsrc (or from a binary package).</p>
1.75      rillig   1277: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1.87      wiz      1278:        not need to be installed, but Remote Connectivity itself should be
                   1279:        installed in order to have a working inetd.</p>
1.75      rillig   1280: <p>During installation you may be asked whether to enable setuid
1.87      wiz      1281:        behavior for Interix programs, and whether to make pathnames default to
                   1282:        case-sensitive.  Setuid should be enabled, and case-sensitivity MUST be
                   1283:        enabled.  (Without case-sensitivity, a large number of packages including
                   1284:        perl will not build.)</p>
1.75      rillig   1285: <p>NOTE:  Newer Windows service packs change the way binary execution
1.87      wiz      1286:        works (via the Data Execution Prevention feature).  In order to use
                   1287:        pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
                   1288:        POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
                   1289:        must be installed.  Hotfixes are available from Microsoft through a
1.114     jmcneill 1290:        support contract; however, Debian Interix Port has made most Interix
                   1291:        hotfixes available for personal use from <a class="ulink" href="http://www.debian-interix.net/hotfixes/" target="_top">http://www.debian-interix.net/hotfixes/</a>.</p>
1.93      rillig   1292: <p>In addition to the hotfix noted above, it may be necessary to
                   1293:        disable Data Execution Prevention entirely to make Interix functional.
                   1294:        This may happen only with certain types of CPUs; the cause is not fully
                   1295:        understood at this time.  If gcc or other applications still segfault
                   1296:        repeatedly after installing one of the hotfixes note above, the
                   1297:        following option can be added to the appropriate "boot.ini" line on the
                   1298:        Windows boot drive:  /NoExecute=AlwaysOff
                   1299:        (WARNING, this will disable DEP completely, which may be a security
                   1300:        risk if applications are often run as a user in the Administrators
                   1301:        group!)</p>
1.75      rillig   1302: </div>
                   1303: <div class="sect3" lang="en">
                   1304: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1305: <a name="platform.interix-sfu-postinstall"></a>3.3.3.2. What to do if Interix/SFU is already installed</h4></div></div></div>
1.75      rillig   1306: <p>If SFU is already installed and you wish to alter these settings to work
1.87      wiz      1307:        with pkgsrc, note the following things.</p>
1.75      rillig   1308: <div class="itemizedlist"><ul type="disc">
                   1309: <li><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.87      wiz      1310:            Windows Services for UNIX, then click Change.  In the installer, choose
                   1311:            Add or Remove, then uncheck Utilities-&gt;UNIX Perl.</p></li>
1.75      rillig   1312: <li>
                   1313: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1.87      wiz      1314:            change the following registry key:</p>
1.75      rillig   1315: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
                   1316: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
                   1317: </li>
                   1318: <li>
                   1319: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1.87      wiz      1320:            following registry key:</p>
1.75      rillig   1321: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
                   1322: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
                   1323: </li>
                   1324: </ul></div>
                   1325: </div>
                   1326: <div class="sect3" lang="en">
                   1327: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1328: <a name="platform.interix-notes"></a>3.3.3.3. Important notes for using pkgsrc</h4></div></div></div>
1.75      rillig   1329: <p>The package manager (either the pkgsrc "su" user, or the user
1.87      wiz      1330:        running "pkg_add") must be a member of the local Administrators
                   1331:        group.  Such a user must also be used to run the bootstrap.  This is
                   1332:        slightly relaxed from the normal pkgsrc requirement of "root".</p>
1.75      rillig   1333: <p>The package manager should use a umask of 002.  "make install" will
1.87      wiz      1334:        automatically complain if this is not the case.  This ensures that
                   1335:        directories written in /var/db/pkg are Administrators-group writeable.</p>
1.75      rillig   1336: <p>The popular Interix binary packages from http://www.interopsystems.com/
1.87      wiz      1337:        use an older version of pkgsrc's pkg_* tools.  Ideally, these should
                   1338:        NOT be used in conjunction with pkgsrc.  If you choose to use them at
                   1339:        the same time as the pkgsrc packages, ensure that you use the proper
                   1340:        pkg_* tools for each type of binary package.</p>
1.75      rillig   1341: <p>The TERM setting used for DOS-type console windows (including those
1.87      wiz      1342:        invoked by the csh and ksh startup shortcuts) is "interix".  Most systems
                   1343:        don't have a termcap/terminfo entry for it, but the following .termcap
                   1344:        entry provides adequate emulation in most cases:</p>
1.75      rillig   1345: <pre class="programlisting">
1.100     rillig   1346: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1.87      wiz      1347:        </pre>
1.75      rillig   1348: </div>
                   1349: <div class="sect3" lang="en">
                   1350: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1351: <a name="platform.interix-limits"></a>3.3.3.4. Limitations of the Interix platform</h4></div></div></div>
1.75      rillig   1352: <p>Though Interix suffices as a familiar and flexible substitute
1.87      wiz      1353:        for a full Unix-like platform, it has some drawbacks that should
                   1354:        be noted for those desiring to make the most of Interix.</p>
1.75      rillig   1355: <div class="itemizedlist"><ul type="disc">
                   1356: <li>
                   1357: <p><span class="strong"><strong>X11:</strong></span></p>
                   1358: <p>Interix comes with the standard set of X11R6 client libraries,
1.87      wiz      1359:          and can run X11 based applications, but it does
                   1360:          <span class="emphasis"><em>not</em></span> come with an X server.  Some options are
1.110     hubertf  1361:          <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
                   1362:          <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1.87      wiz      1363:          (available in a trimmed version for Interix from Interop Systems as the
1.110     hubertf  1364:          <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1.87      wiz      1365:          and the free X11 server included with
1.110     hubertf  1366:          <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.75      rillig   1367: </li>
                   1368: <li>
                   1369: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
                   1370: <p>Because Interix runs in a completely different NT subsystem from
1.87      wiz      1371:          Win32 applications, it does not currently support various X11
                   1372:          protocol extensions for acceleration (such as MIT-SHM or DGA).
                   1373:          Most interactive applications to a local X server will run
                   1374:          reasonably fast, but full motion video and other graphics
                   1375:          intensive applications may require a faster-than-expected CPU.</p>
1.75      rillig   1376: </li>
                   1377: <li>
                   1378: <p><span class="strong"><strong>Audio:</strong></span></p>
                   1379: <p>Interix has no native support for audio output.  For audio
1.110     hubertf  1380:          support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1.87      wiz      1381:          audio system on Interix.  Unlike on most platforms, the
1.91      rillig   1382:          <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/audio/esound/README.html" target="_top"><code class="filename">audio/esound</code></a> package does
1.110     hubertf  1383:          <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1.87      wiz      1384:          server component.  To output audio via an Interix host, the
1.91      rillig   1385:          <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/emulators/cygwin_esound/README.html" target="_top"><code class="filename">emulators/cygwin_esound</code></a> package
1.87      wiz      1386:          must also be installed.</p>
1.75      rillig   1387: </li>
                   1388: <li>
                   1389: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
                   1390: <p>Direct device access is not currently supported in Interix, so it
1.87      wiz      1391:          is not currently possible to access CD/DVD drives, USB devices,
                   1392:          or SCSI devices through non-filesystem means.  Among other things,
                   1393:          this makes it impossible to use Interix directly for CD/DVD
                   1394:          burning.</p>
1.75      rillig   1395: </li>
                   1396: <li>
                   1397: <p><span class="strong"><strong>Tape drives:</strong></span></p>
                   1398: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1.87      wiz      1399:          drives are also not directly accessible in Interix.  However,
                   1400:          support is in work to make tape drive access possible by using
                   1401:          Cygwin as a bridge (similarly to audio bridged via Cygwin's
                   1402:          esound server).</p>
1.75      rillig   1403: </li>
                   1404: </ul></div>
                   1405: </div>
                   1406: <div class="sect3" lang="en">
                   1407: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1408: <a name="platform.interix-knownissues"></a>3.3.3.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.75      rillig   1409: <p>It is not necessary, in general, to have a "root" user on the
1.87      wiz      1410:        Windows system; any member of the local Administrators group will
                   1411:        suffice.  However, some packages currently assume that the user
                   1412:        named "root" is the privileged user.  To accommodate these, you
                   1413:        may create such a user; make sure it is in the local group
                   1414:        Administrators (or your language equivalent).</p>
1.110     hubertf  1415: <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1.87      wiz      1416:        0755, not 0775, in <code class="filename">$PKG_DBDIR</code>.  For the
                   1417:        time being, install packages as the local Administrator (or
                   1418:        your language equivalent), or run the following command after
                   1419:        installing a package to work around the issue:</p>
1.75      rillig   1420: <pre class="screen">
1.87      wiz      1421: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
                   1422:        </pre>
1.75      rillig   1423: </div>
                   1424: </div>
                   1425: <div class="sect2" lang="en">
                   1426: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1427: <a name="irix"></a>3.3.4. IRIX</h3></div></div></div>
1.75      rillig   1428: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1.87      wiz      1429:       compiler (cc/c89).  Please set the <code class="varname">CC</code> environment variable
                   1430:       according to your preference.  If you do not have a license for the MIPSpro
1.110     hubertf  1431:       compiler suite, you can download a gcc tardist file from <a class="ulink" href="http://freeware.sgi.com/" target="_top">http://freeware.sgi.com/</a>.</p>
1.75      rillig   1432: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.110     hubertf  1433:       version of IRIX providing support for <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_indextoname+3+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">if_indextoname</span>(3)</span></a>, <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_nametoindex+3+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">if_nametoindex</span>(3)</span></a>,
1.87      wiz      1434:       etc.</p>
1.86      schwarz  1435: <p>At this point in time, pkgsrc only supports one ABI at a time.  That is, you cannot
1.75      rillig   1436:        switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI.  If
                   1437:        you start out using "abi=n32", that's what all your packages will be built
                   1438:        with.</p>
                   1439: <p>Therefore, please make sure that you have no conflicting
1.87      wiz      1440:       <code class="varname">CFLAGS</code> in your environment or the
1.110     hubertf  1441:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Particularly, make sure that you do not
1.87      wiz      1442:       try to link n32 object files with lib64 or vice versa.  Check your
                   1443:       <code class="filename">/etc/compiler.defaults</code>!</p>
1.75      rillig   1444: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1.87      wiz      1445:       please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
                   1446:       as it appears that IRIX linker occasionally runs into issues when trying to
                   1447:       link over a network-mounted file system.</p>
1.75      rillig   1448: <p>The bootstrapping process should set all the right options for programs such
1.87      wiz      1449:       as imake(1), but you may want to set some options depending on your local
                   1450:       setup.  Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
                   1451:       course, your compiler's man pages for details.</p>
1.75      rillig   1452: <p>If you are using SGI's MIPSPro compiler, please set
1.1       grant    1453: 
1.87      wiz      1454:       </p>
1.75      rillig   1455: <pre class="programlisting">
1.100     rillig   1456: PKGSRC_COMPILER=        mipspro
1.87      wiz      1457:       </pre>
1.75      rillig   1458: <p>
1.1       grant    1459: 
1.110     hubertf  1460:       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Otherwise, pkgsrc will assume you
1.87      wiz      1461:       are using gcc and may end up passing invalid flags to the compiler.  Note that
                   1462:       bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
                   1463:       default.</p>
1.75      rillig   1464: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1.93      rillig   1465:       but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1.87      wiz      1466:       to <span class="emphasis"><em>not</em></span> include the location of gcc (often
                   1467:       <code class="filename">/usr/freeware/bin</code>), and (important) pass the
                   1468:       '--preserve-path' flag.</p>
1.75      rillig   1469: </div>
                   1470: <div class="sect2" lang="en">
                   1471: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1472: <a name="linux"></a>3.3.5. Linux</h3></div></div></div>
1.87      wiz      1473: <p>Some versions of Linux (for example Debian GNU/Linux) need
                   1474:       either libtermcap or libcurses (libncurses).  Installing the
                   1475:       distributions libncurses-dev package (or equivalent) should fix
                   1476:       the problem.</p>
                   1477: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
                   1478:       (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
                   1479:       i386 have been tested.</p>
1.75      rillig   1480: <p>To bootstrap using icc, assuming the default icc installation
1.87      wiz      1481:       directory:</p>
1.75      rillig   1482: <pre class="programlisting">
1.100     rillig   1483: env CC=/opt/intel_cc_80/bin/icc LDFLAGS=-static-libcxa \
                   1484: ac_cv___attribute__=yes ./bootstrap
1.87      wiz      1485:       </pre>
1.75      rillig   1486: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1487: <h3 class="title">Note</h3>
                   1488: <p>icc 8.1 needs the `-i-static' argument instead of -static-libcxa.</p>
                   1489: </div>
                   1490: <p>icc supports __attribute__, but the GNU configure test uses a nested
1.87      wiz      1491:       function, which icc does not support. #undef'ing __attribute__ has the
                   1492:       unfortunate side-effect of breaking many of the Linux header files, which
                   1493:       cannot be compiled properly without __attribute__. The test must be
                   1494:       overridden so that __attribute__ is assumed supported by the
                   1495:       compiler.</p>
1.75      rillig   1496: <p>After bootstrapping, you should set <code class="varname">PKGSRC_COMPILER</code>
1.110     hubertf  1497:       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75      rillig   1498: <pre class="programlisting">
1.100     rillig   1499: PKGSRC_COMPILER=        icc
1.87      wiz      1500:       </pre>
1.75      rillig   1501: <p>The default installation directory for icc is
1.87      wiz      1502:       <code class="filename">/opt/intel_cc_80</code>, which
                   1503:       is also the pkgsrc default. If you have installed it into a different
                   1504:       directory, set <code class="varname">ICCBASE</code> in
1.110     hubertf  1505:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75      rillig   1506: <pre class="programlisting">
1.100     rillig   1507: ICCBASE=                /opt/icc
1.87      wiz      1508:       </pre>
1.75      rillig   1509: <p>pkgsrc uses the static linking method of the runtime libraries
1.87      wiz      1510:       provided by icc, so binaries can be run on other systems which do not
                   1511:       have the shared libraries installed.</p>
                   1512: <p>Libtool, however, extracts a list of libraries from the
1.110     hubertf  1513:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> command run when linking a C++ shared library and
1.87      wiz      1514:       records it, throwing away the -Bstatic and -Bdynamic options
                   1515:       interspersed between the libraries.  This means that
                   1516:       libtool-linked C++ shared libraries will have a runtime
                   1517:       dependency on the icc libraries until this is fixed in
                   1518:       libtool.</p>
1.75      rillig   1519: </div>
                   1520: <div class="sect2" lang="en">
                   1521: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1522: <a name="openbsd"></a>3.3.6. OpenBSD</h3></div></div></div>
1.75      rillig   1523: <p>OpenBSD 3.0 and 3.2 are tested and supported.</p>
                   1524: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87      wiz      1525:       with the OpenBSD userland tools. There are several steps:</p>
1.75      rillig   1526: <div class="orderedlist"><ol type="1">
                   1527: <li><p>OpenBSD stores its ports pkg database in
1.87      wiz      1528:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1529:          recommended that you choose a different location (e.g.
                   1530:          <code class="filename">/usr/pkgdb</code>) by
                   1531:          using the --pkgdbdir option to the bootstrap script.</p></li>
1.75      rillig   1532: <li>
                   1533: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1.87      wiz      1534:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1535: <pre class="screen">
                   1536: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75      rillig   1537: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1538: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1539: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87      wiz      1540: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1541:          </pre>
1.75      rillig   1542: </li>
                   1543: <li>
1.110     hubertf  1544: <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87      wiz      1545:          <code class="filename">/etc/mk.conf.example</code> file
                   1546:          when you use the bootstrap script. OpenBSD's make program uses
1.110     hubertf  1547:          <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.87      wiz      1548:          as well. You can work around this by enclosing all the pkgsrc-specific parts
                   1549:          of the file with:</p>
                   1550: <pre class="programlisting">
1.100     rillig   1551: .ifdef BSD_PKG_MK
                   1552: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
                   1553: .else
                   1554: # OpenBSD stuff
                   1555: .endif
1.87      wiz      1556:          </pre>
1.75      rillig   1557: </li>
                   1558: </ol></div>
                   1559: </div>
                   1560: <div class="sect2" lang="en">
                   1561: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1562: <a name="solaris"></a>3.3.7. Solaris</h3></div></div></div>
1.75      rillig   1563: <p>Solaris 2.6 through 9 are supported on both x86 and sparc.
1.87      wiz      1564:       You will need a working C compiler. Both gcc 2.95.3 and
                   1565:       Sun WorkShop 5 have been tested.</p>
1.75      rillig   1566: <p>The following packages are required on Solaris 8 for the bootstrap
1.87      wiz      1567:       process and to build packages.</p>
1.75      rillig   1568: <div class="itemizedlist"><ul type="disc">
                   1569: <li><p>SUNWsprot</p></li>
                   1570: <li><p>SUNWarc</p></li>
                   1571: <li><p>SUNWbtool</p></li>
                   1572: <li><p>SUNWtoo</p></li>
                   1573: <li><p>SUNWlibm</p></li>
                   1574: </ul></div>
1.78      rillig   1575: <p>Please note that the use of GNU binutils on Solaris is
1.87      wiz      1576:       <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1.75      rillig   1577: <p>Whichever compiler you use, please ensure the compiler tools and
1.87      wiz      1578:       your $prefix are in your <code class="varname">PATH</code>. This includes
                   1579:       <code class="filename">/usr/ccs/{bin,lib}</code>
                   1580:       and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.75      rillig   1581: <div class="sect3" lang="en">
                   1582: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1583: <a name="solaris-gcc-note"></a>3.3.7.1. If you are using gcc</h4></div></div></div>
1.75      rillig   1584: <p>It makes life much simpler if you only use the same gcc consistently
1.87      wiz      1585:        for building all packages.</p>
1.75      rillig   1586: <p>It is recommended that an external gcc be used only for bootstrapping,
1.87      wiz      1587:        then either build gcc from
1.91      rillig   1588:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/gcc/README.html" target="_top"><code class="filename">lang/gcc</code></a> or install a binary gcc
1.87      wiz      1589:        package, then remove gcc used during bootstrapping.</p>
1.110     hubertf  1590: <p>Binary packages of gcc can be found through <a class="ulink" href="http://www.sunfreeware.com/" target="_top">http://www.sunfreeware.com/</a>.</p>
1.75      rillig   1591: </div>
                   1592: <div class="sect3" lang="en">
                   1593: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1594: <a name="solaris-sun-workshop-note"></a>3.3.7.2. If you are using Sun WorkShop</h4></div></div></div>
1.75      rillig   1595: <p>You will need at least the following packages installed (from WorkShop
1.87      wiz      1596:        5.0)</p>
1.75      rillig   1597: <div class="itemizedlist"><ul type="disc">
                   1598: <li><p>SPROcc
1.87      wiz      1599:          - Sun WorkShop Compiler C 5.0</p></li>
1.75      rillig   1600: <li><p>SPROcpl
1.87      wiz      1601:          - Sun WorkShop Compiler C++ 5.0</p></li>
1.75      rillig   1602: <li><p>SPROild
1.87      wiz      1603:          - Sun WorkShop Incremental Linker</p></li>
1.75      rillig   1604: <li><p>SPROlang
1.87      wiz      1605:          - Sun WorkShop Compilers common components</p></li>
1.75      rillig   1606: </ul></div>
1.96      rillig   1607: <p>You should set the following variables in your
1.110     hubertf  1608:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.96      rillig   1609: <pre class="programlisting">
1.100     rillig   1610: CC=     cc
                   1611: CXX=    CC
                   1612: CPP=    cc -E
                   1613: CXXCPP= CC -E
1.96      rillig   1614: </pre>
                   1615: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1616: <h3 class="title">Note</h3>
                   1617: <p>The <code class="varname">CPP</code> setting might break some
                   1618:        packages that use the C preprocessor for processing things other
                   1619:        than C source code.</p>
                   1620: </div>
1.75      rillig   1621: </div>
                   1622: <div class="sect3" lang="en">
                   1623: <div class="titlepage"><div><div><h4 class="title">
1.93      rillig   1624: <a name="solaris-sunpro-64"></a>3.3.7.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.96      rillig   1625: <p>To build 64-bit packages, you just need to have the
1.110     hubertf  1626:        following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.75      rillig   1627: <pre class="programlisting">
1.100     rillig   1628: PKGSRC_COMPILER=        sunpro
                   1629: ABI=                    64
1.96      rillig   1630: </pre>
                   1631: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1632: <h3 class="title">Note</h3>
                   1633: <p>This setting has been tested for the SPARC
                   1634:        architecture. Intel and AMD machines need some more
                   1635:        work.</p>
                   1636: </div>
1.75      rillig   1637: </div>
                   1638: <div class="sect3" lang="en">
                   1639: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1640: <a name="plat.sunos.problems"></a>3.3.7.4. Common problems</h4></div></div></div>
1.110     hubertf  1641: <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1.87      wiz      1642:       <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
                   1643:       The workaround is to use another shell for the configure
1.91      rillig   1644:       scripts, for example by installing <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/README.html" target="_top"><code class="filename">shells/bash</code></a> and adding the following lines
1.110     hubertf  1645:       to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.87      wiz      1646: <pre class="programlisting">
1.100     rillig   1647: CONFIG_SHELL=   ${LOCALBASE}/bin/bash
                   1648: WRAPPER_SHELL=  ${LOCALBASE}/bin/bash
1.87      wiz      1649:       </pre>
1.91      rillig   1650: <p>Then, rebuild the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool-base/README.html" target="_top"><code class="filename">devel/libtool-base</code></a> package.</p>
1.75      rillig   1651: </div>
                   1652: </div>
                   1653: </div>
                   1654: </div>
                   1655: <div class="chapter" lang="en">
                   1656: <div class="titlepage"><div><div><h2 class="title">
                   1657: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
                   1658: <div class="toc">
                   1659: <p><b>Table of Contents</b></p>
                   1660: <dl>
                   1661: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                   1662: <dd><dl>
                   1663: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                   1664: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig   1665: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                   1666: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                   1667: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                   1668: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                   1669: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                   1670: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75      rillig   1671: </dl></dd>
                   1672: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                   1673: <dd><dl>
                   1674: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                   1675: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                   1676: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                   1677: </dl></dd>
                   1678: </dl>
                   1679: </div>
                   1680: <p>Basically, there are two ways of using pkgsrc. The first
1.88      wiz      1681: is to only install the package tools and to use binary packages
                   1682: that someone else has prepared. This is the &#8220;<span class="quote">pkg</span>&#8221;
                   1683: in pkgsrc. The second way is to install the &#8220;<span class="quote">src</span>&#8221;
                   1684: of pkgsrc, too. Then you are able to build your own packages,
                   1685: and you can still use binary packages from someone else.</p>
1.75      rillig   1686: <div class="sect1" lang="en">
                   1687: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1688: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.110     hubertf  1689: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.109     rillig   1690:   server and its mirrors, there are collections of binary packages,
                   1691:   ready to be installed. These binary packages have been built using the
                   1692:   default settings for the directories, that is:</p>
                   1693: <div class="itemizedlist"><ul type="disc">
                   1694: <li><p><code class="filename">/usr/pkg</code> for <code class="varname">LOCALBASE</code>, where most of the files are installed,</p></li>
                   1695: <li><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
                   1696: <li><p><code class="filename">/var</code> for <code class="varname">VARBASE</code>, where those files are installed that may change after installation.</p></li>
                   1697: </ul></div>
                   1698: <p>If you cannot use these directories for whatever reasons (maybe
                   1699:   because you're not root), you cannot use these binary packages, but
1.110     hubertf  1700:   have to build the packages yourself, which is explained in <a class="xref" href="#bootstrapping-pkgsrc" title="3.2. Bootstrapping pkgsrc">Section 3.2, &#8220;Bootstrapping pkgsrc&#8221;</a>.</p>
1.75      rillig   1701: <div class="sect2" lang="en">
                   1702: <div class="titlepage"><div><div><h3 class="title">
                   1703: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.105     weinem   1704: <p>To install binary packages, you first need to know from where
                   1705:     to get them. The first place where you should look is on the main
1.110     hubertf  1706:     pkgsrc FTP server in the directory <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top"><code class="filename">/pub/pkgsrc/packages</code></a>.</p>
1.105     weinem   1707: <p>This directory contains binary packages for multiple
                   1708:     platforms. First, select your operating system. (Ignore the
                   1709:     directories with version numbers attached to it, they just exist for
                   1710:     legacy reasons.) Then, select your hardware architecture, and in the
1.109     rillig   1711:     third step, the OS version and the &#8220;<span class="quote">version</span>&#8221; of pkgsrc.</p>
                   1712: <p>In this directory, you often find a file called
                   1713:     <code class="filename">bootstrap.tar.gz</code> which contains the package
                   1714:     management tools. If the file is missing, it is likely that your
                   1715:     operating system already provides those tools. Download the file and
                   1716:     extract it in the <code class="filename">/</code> directory. It will create
                   1717:     the directories <code class="filename">/usr/pkg</code> (containing the tools
                   1718:     for managing binary packages) and <code class="filename">/var/db/pkg</code>
                   1719:     (the database of installed packages).</p>
1.75      rillig   1720: </div>
                   1721: <div class="sect2" lang="en">
                   1722: <div class="titlepage"><div><div><h3 class="title">
                   1723: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.109     rillig   1724: <p>In the directory from the last section, there is a
                   1725:     subdirectory called <code class="filename">All</code>, which contains all the
                   1726:     binary packages that are available for the platform, excluding those
                   1727:     that may not be distributed via FTP or CDROM (depending on which
                   1728:     medium you are using), and the ones that have vulnerabilities and
                   1729:     therefore are considered insecure to install without thinking
                   1730:     before.</p>
                   1731: <p>To install packages directly from an FTP or HTTP server, run
                   1732:     the following commands in a Bourne-compatible shell (be sure to
1.110     hubertf  1733:     <span class="command"><strong>su</strong></span> to root first):</p>
1.109     rillig   1734: <pre class="screen">
                   1735: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
                   1736: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/<em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>VERSIONS</code></em>/All"</code></strong>
                   1737: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
                   1738: </pre>
                   1739: <p>Instead of URLs, you can also use local paths, for example if
                   1740:     you are installing from a set of CDROMs, DVDs or an NFS-mounted
                   1741:     repository. If you want to install packages from multiple sources,
                   1742:     you can separate them by a semicolon in
                   1743:     <code class="varname">PKG_PATH</code>.</p>
                   1744: <p>After these preparations, installing a package is very
                   1745:     easy:</p>
                   1746: <pre class="screen">
                   1747: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
                   1748: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
                   1749: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
                   1750: </pre>
1.75      rillig   1751: <p>Note that any prerequisite packages needed to run the
1.88      wiz      1752:     package in question will be installed, too, assuming they are
                   1753:     present where you install from.</p>
1.109     rillig   1754: <p>As mentioned above, packages for which vulnerabilities get
                   1755:     known are not stored in the <code class="filename">All</code> subdirectory.
                   1756:     They don't get deleted since that could be very frustrating if many
                   1757:     other packages depend on it. Instead, they are moved to the
                   1758:     <code class="filename">vulnerable</code> subdirectory. So you may need to add
                   1759:     this directory to the <code class="varname">PKG_PATH</code> variable. 
1.114     jmcneill 1760:     However, you should run <span class="command"><strong>audit-packages</strong></span>
                   1761:     regularly, especially after installing new packages, and verify
                   1762:     that the vulnerabilities are acceptable for your configuration.</p>
1.75      rillig   1763: <p>After you've installed packages, be sure to have
1.88      wiz      1764:     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
                   1765:     <code class="varname">PATH</code> so you can actually start the just
                   1766:     installed program.</p>
1.75      rillig   1767: </div>
                   1768: <div class="sect2" lang="en">
                   1769: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1770: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
                   1771: <p>To deinstall a package, it does not matter whether it was
1.88      wiz      1772:     installed from source code or from a binary package. The
1.110     hubertf  1773:     <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
                   1774:     To delete a package, you can just run <span class="command"><strong>pkg_delete
1.88      wiz      1775:     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
                   1776:     name can be given with or without version number. Wildcards can
                   1777:     also be used to deinstall a set of packages, for example
                   1778:     <code class="literal">*emacs*</code>. Be sure to include them in quotes,
                   1779:     so that the shell does not expand them before
                   1780:     <code class="literal">pkg_delete</code> sees them.</p>
1.82      rillig   1781: <p>The <code class="option">-r</code> option is very powerful: it
1.88      wiz      1782:     removes all the packages that require the package in question
                   1783:     and then removes the package itself. For example:
1.82      rillig   1784: 
1.88      wiz      1785:     </p>
1.82      rillig   1786: <pre class="screen">
1.88      wiz      1787: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
                   1788:     </pre>
1.82      rillig   1789: <p>
                   1790: 
1.88      wiz      1791:     will remove jpeg and all the packages that used it; this allows
                   1792:     upgrading the jpeg package.</p>
1.82      rillig   1793: </div>
                   1794: <div class="sect2" lang="en">
                   1795: <div class="titlepage"><div><div><h3 class="title">
                   1796: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.110     hubertf  1797: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.88      wiz      1798:     installed packages or binary package files.</p>
1.82      rillig   1799: </div>
                   1800: <div class="sect2" lang="en">
                   1801: <div class="titlepage"><div><div><h3 class="title">
                   1802: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
                   1803: <p>
1.88      wiz      1804:       The NetBSD Security-Officer and Packages Groups maintain a list of
                   1805:       known security vulnerabilities to packages which are (or have been)
                   1806:       included in pkgsrc.  The list is available from the NetBSD
1.110     hubertf  1807:       FTP site at <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
1.88      wiz      1808:     </p>
1.82      rillig   1809: <p>
1.93      rillig   1810:       Through <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>,
1.88      wiz      1811:       this list can be downloaded
                   1812:       automatically, and a security audit of all packages installed on a system
                   1813:       can take place.
                   1814:     </p>
1.82      rillig   1815: <p>
1.93      rillig   1816:       There are two components to
1.91      rillig   1817:       <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>.  The first
1.88      wiz      1818:       component, &#8220;<span class="quote">download-vulnerability-list</span>&#8221;, is for downloading
                   1819:       the list of vulnerabilities from the NetBSD FTP site.  The second
                   1820:       component, &#8220;<span class="quote">audit-packages</span>&#8221;, checks to see if any of your
                   1821:       installed packages are vulnerable.  If a package is vulnerable, you
                   1822:       will see output similar to the following:
                   1823:     </p>
1.82      rillig   1824: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88      wiz      1825:     http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82      rillig   1826: <p>
1.91      rillig   1827:       One can set up <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a> to download the
1.110     hubertf  1828:       <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.88      wiz      1829:       file daily, and include a package audit in the daily security script.
1.110     hubertf  1830:       Details on this are located in the <a class="ulink" href="http://cvsweb.NetBSD.org/bsdweb.cgi/pkgsrc/security/audit-packages/MESSAGE?rev=HEAD&amp;content-type=text/x-cvsweb-markup" target="_top">MESSAGE</a>
1.91      rillig   1831:       file for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>.
1.88      wiz      1832:     </p>
1.82      rillig   1833: </div>
                   1834: <div class="sect2" lang="en">
                   1835: <div class="titlepage"><div><div><h3 class="title">
                   1836: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
                   1837: <p>
1.112     weinem   1838:       Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a> and run
1.110     hubertf  1839:       <span class="command"><strong>lintpkgsrc</strong></span> with the &#8220;<span class="quote">-i</span>&#8221;
1.88      wiz      1840:       argument to check if your packages are up-to-date, e.g.
                   1841:     </p>
                   1842: <pre class="screen">
                   1843: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82      rillig   1844: ...
1.88      wiz      1845: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   1846:     </pre>
1.110     hubertf  1847: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.88      wiz      1848:     package on your system and rebuild any dependencies.
                   1849:     </p>
1.82      rillig   1850: </div>
                   1851: <div class="sect2" lang="en">
                   1852: <div class="titlepage"><div><div><h3 class="title">
                   1853: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.110     hubertf  1854: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88      wiz      1855:     administrative functions on the package system.</p>
1.82      rillig   1856: </div>
                   1857: <div class="sect2" lang="en">
                   1858: <div class="titlepage"><div><div><h3 class="title">
                   1859: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1.75      rillig   1860: <p>Please pay very careful attention to the warnings
1.110     hubertf  1861:     expressed in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> manual page about the
1.88      wiz      1862:     inherent dangers of installing binary packages which you did
                   1863:     not create yourself, and the security holes that can be
                   1864:     introduced onto your system by indiscriminate adding of such
                   1865:     files.</p>
1.75      rillig   1866: <p>The same warning of course applies to every package you
1.88      wiz      1867:     install from source when you haven't completely read and
                   1868:     understood the source code of the package, the compiler that
                   1869:     is used to build the package and all the other tools that are
                   1870:     involved.</p>
1.75      rillig   1871: </div>
                   1872: </div>
                   1873: <div class="sect1" lang="en">
                   1874: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1875: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88      wiz      1876: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
                   1877:   directory now contains a set of packages, organized into
                   1878:   categories. You can browse the online index of packages, or run
1.110     hubertf  1879:   <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88      wiz      1880:   directory to build local <code class="filename">README.html</code> files for
1.91      rillig   1881:   all packages, viewable with any web browser such as <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/README.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
1.88      wiz      1882: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
                   1883:   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
                   1884:   should do so by setting <code class="varname">LOCALBASE</code> in
1.110     hubertf  1885:   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88      wiz      1886:   different <code class="varname">LOCALBASE</code> definitions on the same
                   1887:   system (inside a chroot is an exception). </p>
                   1888: <p>The rest of this chapter assumes that the package is already
1.110     hubertf  1889:   in pkgsrc. If it is not, see <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, &#8220;The pkgsrc developer's guide&#8221;</a> for
1.88      wiz      1890:   instructions how to create your own packages.</p>
1.75      rillig   1891: <div class="sect2" lang="en">
                   1892: <div class="titlepage"><div><div><h3 class="title">
                   1893: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82      rillig   1894: <p>To build packages from source, you need a working C
1.88      wiz      1895:     compiler. On NetBSD, you need to install the
                   1896:     &#8220;<span class="quote">comp</span>&#8221; and the &#8220;<span class="quote">text</span>&#8221; distribution
                   1897:     sets. If you want to build X11-related packages, the
                   1898:     &#8220;<span class="quote">xbase</span>&#8221; and &#8220;<span class="quote">xcomp</span>&#8221; distribution
                   1899:     sets are required, too.</p>
1.75      rillig   1900: </div>
                   1901: <div class="sect2" lang="en">
                   1902: <div class="titlepage"><div><div><h3 class="title">
                   1903: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
                   1904: <p>The first step for building a package is downloading the
1.88      wiz      1905:     distfiles (i.e. the unmodified source). If they have not yet been
                   1906:     downloaded, pkgsrc will fetch them automatically.</p>
                   1907: <p>If you have all files that you need in the
                   1908:     <code class="filename">distfiles</code> directory,
                   1909:     you don't need to connect. If the distfiles are on CD-ROM, you can
                   1910:     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
                   1911:     </p>
1.82      rillig   1912: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
                   1913: <p>
1.110     hubertf  1914:     to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91      rillig   1915: <p>By default a list of distribution sites will be randomly
                   1916:     intermixed to prevent huge load on servers which holding popular
                   1917:     packages (for example, SourceForge.net mirrors). Thus, every
                   1918:     time when you need to fetch yet another distfile all the mirrors
                   1919:     will be tried in new (random) order. You can turn this feature
                   1920:     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
                   1921:     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88      wiz      1922: <p>You can overwrite some of the major distribution sites to
                   1923:     fit to sites that are close to your own.  By setting one or two
                   1924:     variables you can modify the order in which the master sites are
                   1925:     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
                   1926:     delimited list of domain suffixes.
                   1927:     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
                   1928:     contains a whitespace delimited list of regular expressions.  It
                   1929:     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
                   1930:     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
                   1931:     some examples.  This may save some of your bandwidth and
                   1932:     time.</p>
1.75      rillig   1933: <p>You can change these settings either in your shell's environment, or,
1.88      wiz      1934:     if you want to keep the settings, by editing the
1.110     hubertf  1935:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88      wiz      1936:     and adding the definitions there.</p>
1.82      rillig   1937: <p>
1.88      wiz      1938:       If a package depends on many other packages (such as
1.93      rillig   1939:       <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde3/README.html" target="_top"><code class="filename">meta-pkgs/kde3</code></a>), the build process may
1.88      wiz      1940:       alternate between periods of
                   1941:       downloading source, and compiling. To ensure you have all the source
                   1942:       downloaded initially you can run the command:
                   1943:       </p>
1.82      rillig   1944: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
                   1945: <p>
1.88      wiz      1946:       which will output and run a set of shell commands to fetch the
                   1947:       necessary files into the <code class="filename">distfiles</code> directory.  You can
                   1948:       also choose to download the files manually.
                   1949:     </p>
1.75      rillig   1950: </div>
                   1951: <div class="sect2" lang="en">
                   1952: <div class="titlepage"><div><div><h3 class="title">
                   1953: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82      rillig   1954: <p>
1.88      wiz      1955:       Once the software has downloaded, any patches will be applied, then it
                   1956:       will be compiled for you. This may take some time depending on your
                   1957:       computer, and how many other packages the software depends on and their
                   1958:       compile time.
                   1959:     </p>
1.75      rillig   1960: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1961: <h3 class="title">Note</h3>
                   1962: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110     hubertf  1963:     use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.88      wiz      1964:     &#8220;<span class="quote">make</span>&#8221; in the examples in this guide.</p>
1.75      rillig   1965: </div>
1.87      wiz      1966: <p>For example, type</p>
1.88      wiz      1967: <pre class="screen">
                   1968: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   1969: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   1970:     </pre>
1.75      rillig   1971: <p>at the shell prompt to build the various components of the
1.88      wiz      1972:     package.</p>
1.82      rillig   1973: <p>The next stage is to actually install the newly compiled
1.88      wiz      1974:     program onto your system. Do this by entering:
1.82      rillig   1975: 
1.88      wiz      1976:     </p>
1.82      rillig   1977: <pre class="screen">
1.88      wiz      1978: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
                   1979:     </pre>
1.82      rillig   1980: <p>
                   1981: 
1.88      wiz      1982:     while you are still in the directory for whatever package you
                   1983:     are installing.</p>
1.82      rillig   1984: <p>Installing the package on your system may require you to
1.88      wiz      1985:     be root.  However, pkgsrc has a
                   1986:     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
                   1987:     to only become root for the actual installation step.</p>
1.82      rillig   1988: <p>That's it, the software should now be installed and setup for use.
1.88      wiz      1989:     You can now enter:
1.82      rillig   1990: 
1.88      wiz      1991:     </p>
1.82      rillig   1992: <pre class="screen">
1.88      wiz      1993: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
                   1994:     </pre>
1.82      rillig   1995: <p>
                   1996: 
1.88      wiz      1997:     to remove the compiled files in the work directory, as you shouldn't need
                   1998:     them any more. If other packages were also added to your system
                   1999:     (dependencies) to allow your program to compile, you can tidy these up
                   2000:     also with the command:</p>
1.82      rillig   2001: <pre class="screen">
1.88      wiz      2002: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
                   2003:     </pre>
1.75      rillig   2004: <p>Taking the figlet utility as an example, we can install it on our
1.110     hubertf  2005:     system by building as shown in <a class="xref" href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
1.88      wiz      2006: <p>The program is installed under the default root of the
                   2007:     packages tree - <code class="filename">/usr/pkg</code>. Should this not
                   2008:     conform to your tastes, set the <code class="varname">LOCALBASE</code>
                   2009:     variable in your environment, and it will use that value as the
                   2010:     root of your packages tree. So, to use
                   2011:     <code class="filename">/usr/local</code>, set
                   2012:     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
                   2013:     Please note that you should use a directory which is dedicated to
                   2014:     packages and not shared with other programs (i.e., do not try and
                   2015:     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
                   2016:     to add any of your own files or directories (such as
                   2017:     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
                   2018:     <code class="filename">pkgsrc/</code>) below the
                   2019:     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
                   2020:     conflicts between programs and other files installed by the
                   2021:     package system and whatever else may have been installed
                   2022:     there.</p>
1.110     hubertf  2023: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88      wiz      2024:     alter some configuration options at build time.  Have a look at
                   2025:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
                   2026:     of what will be set there by default.  Environment variables such
                   2027:     as <code class="varname">LOCALBASE</code> can be set in
1.110     hubertf  2028:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88      wiz      2029:     set them each time you want to use pkgsrc.</p>
                   2030: <p>Occasionally, people want to &#8220;<span class="quote">look under the
                   2031:     covers</span>&#8221; to see what is going on when a package is building
                   2032:     or being installed. This may be for debugging purposes, or out of
                   2033:     simple curiosity. A number of utility values have been added to
                   2034:     help with this.</p>
1.75      rillig   2035: <div class="orderedlist"><ol type="1">
                   2036: <li>
1.110     hubertf  2037: <p>If you invoke the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.88      wiz      2038:        <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
                   2039:        information will be displayed. For example,</p>
1.75      rillig   2040: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88      wiz      2041: <p>will show all the commands that are invoked, up to and
                   2042:        including the &#8220;<span class="quote">patch</span>&#8221; stage.</p>
1.75      rillig   2043: </li>
                   2044: <li>
1.110     hubertf  2045: <p>If you want to know the value of a certain <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      2046:        definition, then the <code class="varname">VARNAME</code> definition
                   2047:        should be used, in conjunction with the show-var
1.110     hubertf  2048:        target. e.g. to show the expansion of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      2049:        variable <code class="varname">LOCALBASE</code>:</p>
                   2050: <pre class="screen">
                   2051: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75      rillig   2052: /usr/pkg
                   2053: <code class="prompt">%</code>
1.88      wiz      2054:        </pre>
1.75      rillig   2055: </li>
                   2056: </ol></div>
                   2057: <p>If you want to install a binary package that you've either
1.88      wiz      2058:     created yourself (see next section), that you put into
                   2059:     pkgsrc/packages manually or that is located on a remote FTP
                   2060:     server, you can use the "bin-install" target. This target will
1.110     hubertf  2061:     install a binary package - if available - via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
                   2062:     else do a <span class="command"><strong>make package</strong></span>.  The list of remote FTP
1.88      wiz      2063:     sites searched is kept in the variable
                   2064:     <code class="varname">BINPKG_SITES</code>, which defaults to
1.110     hubertf  2065:     ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.88      wiz      2066:     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
                   2067:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
                   2068:     details.</p>
                   2069: <p>A final word of warning: If you set up a system that has a
                   2070:     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
                   2071:     set that before any packages are installed, as you cannot use
                   2072:     several directories for the same purpose. Doing so will result in
                   2073:     pkgsrc not being able to properly detect your installed packages,
                   2074:     and fail miserably. Note also that precompiled binary packages are
                   2075:     usually built with the default <code class="varname">LOCALBASE</code> of
                   2076:     <code class="filename">/usr/pkg</code>, and that you should
                   2077:     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
                   2078:     <code class="varname">LOCALBASE</code>.</p>
1.75      rillig   2079: </div>
                   2080: </div>
                   2081: </div>
                   2082: <div class="chapter" lang="en">
                   2083: <div class="titlepage"><div><div><h2 class="title">
                   2084: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
                   2085: <div class="toc">
                   2086: <p><b>Table of Contents</b></p>
                   2087: <dl>
                   2088: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                   2089: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109     rillig   2090: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103     wiz      2091: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz      2092: <dd><dl>
1.103     wiz      2093: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.116   ! rillig   2094: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (CFLAGS)</a></span></dt>
        !          2095: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (LDFLAGS)</a></span></dt>
1.88      wiz      2096: </dl></dd>
1.103     wiz      2097: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                   2098: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75      rillig   2099: </dl>
                   2100: </div>
1.104     rillig   2101: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89      rillig   2102: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
                   2103: that file depends on the installation. On NetBSD, when you use
1.110     hubertf  2104: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.89      rillig   2105: <code class="filename">/etc/</code>. In all other cases the default location is
                   2106: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
                   2107: bootstrap program to install the binary packages.</p>
                   2108: <p>During the bootstrap, an example configuration file is created. To
                   2109: use that, you have to create the directory
                   2110: <code class="filename">${PREFIX}/etc</code> and copy the example file
                   2111: there.</p>
                   2112: <p>The format of the configuration file is that of the usual
                   2113: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
                   2114: is done by setting variables in this file. Note that you can define all
                   2115: kinds of variables, and no special error checking (for example for
                   2116: spelling mistakes) takes place, so you have to try it out to see if it
                   2117: works.</p>
1.75      rillig   2118: <div class="sect1" lang="en">
                   2119: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2120: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
                   2121: <p>In this section, you can find some variables that apply to all
1.89      rillig   2122:     pkgsrc packages. A complete list of the variables that can be
                   2123:     configured by the user is available in
                   2124:     <code class="filename">mk/defaults/mk.conf</code>, together with some
                   2125:     comments that describe each variable's intent.</p>
1.75      rillig   2126: <div class="itemizedlist"><ul type="disc">
                   2127: <li><p><code class="varname">LOCALBASE</code>: Where
                   2128:            packages will be installed. The default is
1.76      rillig   2129:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75      rillig   2130:            with different <code class="varname">LOCALBASE</code>s!</p></li>
                   2131: <li><p><code class="varname">CROSSBASE</code>: Where
                   2132:            &#8220;<span class="quote">cross</span>&#8221; category packages will be
                   2133:            installed. The default is
1.76      rillig   2134:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.75      rillig   2135: <li><p><code class="varname">X11BASE</code>: Where
                   2136:            X11 is installed on the system. The default is
1.76      rillig   2137:            <code class="filename">/usr/X11R6</code>.</p></li>
1.75      rillig   2138: <li><p><code class="varname">DISTDIR</code>: Where to store the
                   2139:            downloaded copies of the original source distributions used
                   2140:            for building pkgsrc packages. The default is
1.76      rillig   2141:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.97      rillig   2142: <li><p><code class="varname">PKG_DBDIR</code>: Where the
                   2143:            database about installed packages is stored.  The default is
                   2144:            <code class="filename">/var/db/pkg</code>.</p></li>
1.75      rillig   2145: <li><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
                   2146:            If set, override the packages'
                   2147:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
                   2148: <li><p><code class="varname">MASTER_SITE_BACKUP</code>:
                   2149:            Backup location(s) for distribution files and patch files
                   2150:            if not found locally or in
1.76      rillig   2151:            <code class="filename">${MASTER_SITES}</code> or
                   2152:            <code class="filename">${PATCH_SITES}</code> respectively.
1.75      rillig   2153:            The defaults are
1.76      rillig   2154:            <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}/</code>
1.75      rillig   2155:            and
1.76      rillig   2156:            <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.75      rillig   2157: <li><p><code class="varname">BINPKG_SITES</code>:
1.93      rillig   2158:            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
                   2159:            <em class="replaceable"><code>arch</code></em> are replaced with OS
                   2160:            release (&#8220;<span class="quote">2.0</span>&#8221;, etc.) and architecture
                   2161:            (&#8220;<span class="quote">mipsel</span>&#8221;, etc.).</p></li>
1.82      rillig   2162: <li><p><code class="varname">ACCEPTABLE_LICENSES</code>:
                   2163:            List of acceptable licenses. Whenever you try to build a package
                   2164:            whose license is not in this list, you will get an error message
                   2165:            that includes instructions on how to change this variable.</p></li>
1.75      rillig   2166: </ul></div>
                   2167: </div>
                   2168: <div class="sect1" lang="en">
                   2169: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2170: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
                   2171: <p>XXX
                   2172:       </p>
                   2173: <div class="itemizedlist"><ul type="disc">
                   2174: <li><p><code class="varname">PACKAGES</code>: The top level
                   2175:            directory for the binary packages. The default is
1.76      rillig   2176:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.75      rillig   2177: <li><p><code class="varname">WRKOBJDIR</code>:
                   2178:            The top level directory where, if defined, the separate
                   2179:            working directories will get created, and symbolically
1.76      rillig   2180:            linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75      rillig   2181:            This is useful for building packages on several
1.76      rillig   2182:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                   2183:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75      rillig   2184:            is local to every architecture. (It should be noted that
                   2185:            <code class="varname">PKGSRCDIR</code> should not be set by the user
1.114     jmcneill 2186:            &mdash; it is an internal definition which refers to the
1.75      rillig   2187:            root of the pkgsrc tree. It is possible to have many
                   2188:            pkgsrc tree instances.)</p></li>
                   2189: <li><p><code class="varname">LOCALPATCHES</code>:
                   2190:            Directory for local patches that aren't part of pkgsrc.
1.110     hubertf  2191:            See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a> for more
1.93      rillig   2192:            information.</p></li>
1.75      rillig   2193: <li><p><code class="varname">PKGMAKECONF</code>: Location of
1.110     hubertf  2194:            the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75      rillig   2195:            BSD-style Makefile. If this is not set,
                   2196:            <code class="varname">MAKECONF</code> is set to
1.76      rillig   2197:            <code class="filename">/dev/null</code> to avoid picking up
                   2198:            settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.82      rillig   2199: <li><p><code class="varname">DEPENDS_TARGET</code>:
                   2200:            By default, dependencies are only installed, and no binary
                   2201:            package is created for them. You can set this variable to
                   2202:            <code class="literal">package</code> to automatically create binary
                   2203:            packages after installing dependencies.</p></li>
1.75      rillig   2204: </ul></div>
                   2205: </div>
                   2206: <div class="sect1" lang="en">
                   2207: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.109     rillig   2208: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.103     wiz      2209: <p>A growing number of packages support installation into a
                   2210:     subdirectory of <code class="varname">WRKDIR</code>. This allows a package
                   2211:     to be built, before the actual filesystem is touched. DESTDIR
                   2212:     support exists in two variations:</p>
                   2213: <div class="itemizedlist"><ul type="disc">
                   2214: <li><p>Basic DESTDIR support means that the package
                   2215:       installation and packaging is still run as
                   2216:       root.</p></li>
                   2217: <li><p>Full DESTDIR support can run the complete build,
                   2218:       installation and packaging as normal user. Root privileges are
                   2219:       only needed to add packages.</p></li>
                   2220: </ul></div>
                   2221: <p>To use the DESTDIR support, set either
                   2222:     <code class="varname">USE_DESTDIR=yes</code> to use the basic support for
                   2223:     packages that offer it or <code class="varname">USE_DESTDIR=full</code> to
                   2224:     get the full support with fallback to basic
                   2225:     support. <code class="varname">USE_DESTDIR=full</code> needs <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> version 20070802 (or
                   2226:     newer). It might become the default DESTDIR support later.</p>
                   2227: <p>DESTDIR support changes the behaviour of various targets
                   2228:     slightly. To install a package after building it, use
                   2229:     <code class="literal">package-install</code>. <code class="literal">package</code> and
                   2230:     <code class="literal">install</code> don't do that any
                   2231:     longer. <code class="literal">package-install</code> can be used as
                   2232:     <code class="varname">DEPENDS_TARGET</code>.  <code class="literal">bin-install</code>
                   2233:     will ask for the root password to install the package and fail,
                   2234:     <code class="literal">package-install</code> will ask again.</p>
                   2235: <p>With basic DESTDIR support, <strong class="userinput"><code>make
                   2236:     clean</code></strong> needs to be run as root.</p>
                   2237: </div>
                   2238: <div class="sect1" lang="en">
                   2239: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2240: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.78      rillig   2241: <div class="sect2" lang="en">
                   2242: <div class="titlepage"><div><div><h3 class="title">
1.103     wiz      2243: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.89      rillig   2244: <p>By default, pkgsrc will use GCC to build packages.  This may be
                   2245:     overridden by setting the following variables in /etc/mk.conf:</p>
                   2246: <div class="variablelist"><dl>
                   2247: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
                   2248: <dd>
                   2249: <p>This is a list of values specifying the chain of
                   2250:          compilers to invoke when building packages.  Valid values
                   2251:          are:</p>
                   2252: <div class="itemizedlist"><ul type="disc">
                   2253: <li><p><code class="varname">distcc</code>:
                   2254:            distributed C/C++ (chainable)</p></li>
                   2255: <li><p><code class="varname">ccache</code>:
                   2256:            compiler cache (chainable)</p></li>
                   2257: <li><p><code class="varname">gcc</code>:
                   2258:            GNU C/C++ Compiler</p></li>
                   2259: <li><p><code class="varname">mipspro</code>:
                   2260:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
                   2261: <li><p><code class="varname">mipspro</code>:
                   2262:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
                   2263: <li><p><code class="varname">sunpro</code>:
                   2264:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
                   2265: </ul></div>
                   2266: <p>The default is
                   2267:          &#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;.  You can use
                   2268:          <code class="varname">ccache</code> and/or
                   2269:          <code class="varname">distcc</code> with an appropriate
                   2270:          <code class="varname">PKGSRC_COMPILER</code> setting,
                   2271:          e.g. &#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;.  This
1.94      dmcmahil 2272:          variable should always be terminated with a value for
                   2273:          a real compiler.  Note that only one real compiler
                   2274:          should be listed (e.g. &#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;
                   2275:          is not allowed).</p>
1.89      rillig   2276: </dd>
                   2277: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
                   2278: <dd><p>This specifies the minimum version of GCC to use
                   2279:          when building packages.  If the system GCC doesn't
                   2280:          satisfy this requirement, then pkgsrc will build and
                   2281:          install one of the GCC packages to use instead.</p></dd>
                   2282: </dl></div>
                   2283: </div>
                   2284: <div class="sect2" lang="en">
                   2285: <div class="titlepage"><div><div><h3 class="title">
1.103     wiz      2286: <a name="conf.cflags"></a>5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.78      rillig   2287: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
                   2288:        please make sure to use the <code class="literal">+=</code> operator
                   2289:        instead of the <code class="literal">=</code> operator:</p>
                   2290: <pre class="programlisting">
1.100     rillig   2291: CFLAGS+=        -your -flags
1.78      rillig   2292: </pre>
                   2293: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
                   2294:        &#8220;<span class="quote">+</span>&#8221;) may lead to problems with packages that need
                   2295:        to add their own flags.  Also, you may want to take a look at
1.91      rillig   2296:        the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a> package if
1.78      rillig   2297:        you're interested in optimization for the current CPU.</p>
                   2298: </div>
1.88      wiz      2299: <div class="sect2" lang="en">
                   2300: <div class="titlepage"><div><div><h3 class="title">
1.103     wiz      2301: <a name="conf.ldflags"></a>5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.88      wiz      2302: <p>If you want to pass flags to the linker, both in the configure
                   2303: step and the build step, you can do this in two ways.  Either set
                   2304: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
                   2305: between the two is that <code class="varname">LIBS</code> will be appended to
                   2306: the command line, while <code class="varname">LDFLAGS</code> come earlier.
                   2307: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
                   2308: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
                   2309: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
                   2310: <code class="varname">CFLAGS</code>, if you do not wish to override these
                   2311: settings, use the <code class="literal">+=</code> operator:</p>
                   2312: <pre class="programlisting">
1.100     rillig   2313: LDFLAGS+=        -your -linkerflags
1.88      wiz      2314: </pre>
                   2315: </div>
1.78      rillig   2316: </div>
                   2317: <div class="sect1" lang="en">
                   2318: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103     wiz      2319: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.75      rillig   2320: <p>XXX
                   2321:       </p>
                   2322: <div class="itemizedlist"><ul type="disc">
                   2323: <li>
                   2324: <p><code class="varname">PKG_DEVELOPER</code>:
                   2325:            Run some sanity checks that package developers want:
                   2326:            </p>
                   2327: <div class="itemizedlist"><ul type="circle">
1.88      wiz      2328: <li><p>make sure patches apply with zero
                   2329:              fuzz</p></li>
                   2330: <li><p>run check-shlibs to see that all
                   2331:              binaries will find their shared libs.</p></li>
1.75      rillig   2332: </ul></div>
                   2333: <p>
1.87      wiz      2334:        </p>
1.75      rillig   2335: </li>
1.88      wiz      2336: <li><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
                   2337:        of debugging output which is displayed whilst making and
                   2338:        installing the package.  The default value for this is 0,
                   2339:        which will not display the commands as they are executed
                   2340:        (normal, default, quiet operation); the value 1 will display
                   2341:        all shell commands before their invocation, and the value 2
                   2342:        will display both the shell commands before their invocation,
1.110     hubertf  2343:        and their actual execution progress with <span class="command"><strong>set
1.88      wiz      2344:        -x</strong></span> will be displayed.</p></li>
1.75      rillig   2345: </ul></div>
                   2346: <p>
                   2347:     </p>
                   2348: </div>
                   2349: <div class="sect1" lang="en">
                   2350: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103     wiz      2351: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.88      wiz      2352: <p>Some packages have build time options, usually to select
                   2353:     between different dependencies, enable optional support for big
                   2354:     dependencies or enable experimental features.</p>
1.75      rillig   2355: <p>To see which options, if any, a package supports, and which
1.110     hubertf  2356:     options are mutually exclusive, run <span class="command"><strong>make
1.88      wiz      2357:     show-options</strong></span>, for example:</p>
1.75      rillig   2358: <pre class="programlisting">
                   2359:     The following options are supported by this package:
                   2360:         ssl      Enable SSL support.
                   2361:     Exactly one of the following gecko options is required:
                   2362:         firefox  Use firefox as gecko rendering engine.
                   2363:         mozilla  Use mozilla as gecko rendering engine.
                   2364:     At most one of the following database options may be selected:
                   2365:         mysql    Enable support for MySQL database.
                   2366:         pgsql    Enable support for PostgreSQL database.
1.1       grant    2367: 
1.75      rillig   2368:     These options are enabled by default: firefox
                   2369:     These options are currently enabled: mozilla ssl
1.1       grant    2370: </pre>
1.75      rillig   2371: <p>The following variables can be defined in
1.110     hubertf  2372:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88      wiz      2373:     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
                   2374:     which can be used to select or disable options for all packages
                   2375:     that support them, and
                   2376:     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
                   2377:     which can be used to select or disable options specifically for
                   2378:     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
                   2379:     these variables are selected, options preceded by &#8220;<span class="quote">-</span>&#8221;
                   2380:     are disabled. A few examples:</p>
1.75      rillig   2381: <pre class="screen">
1.110     hubertf  2382: <code class="prompt">$</code> <span class="command"><strong>grep "PKG.*OPTION" <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a></strong></span>
1.75      rillig   2383: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   2384: PKG_OPTIONS.kdebase=    debug -sasl
                   2385: PKG_OPTIONS.apache=     suexec </pre>
1.111     rillig   2386: <p>It is important to note that options that were specifically
                   2387:     suggested by the package maintainer must be explicitely removed if
                   2388:     you do not wish to include the option.  If you are unsure you can view
                   2389:     the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88      wiz      2390: <p>The following settings are consulted in the order given, and
                   2391:     the last setting that selects or disables an option is
                   2392:     used:</p>
1.75      rillig   2393: <div class="orderedlist"><ol type="1">
                   2394: <li><p>the default options as suggested by the package
1.88      wiz      2395:       maintainer</p></li>
1.75      rillig   2396: <li><p>the options implied by the settings of legacy
1.88      wiz      2397:       variables (see below)</p></li>
1.75      rillig   2398: <li><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
                   2399: <li><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
                   2400: </ol></div>
                   2401: <p>For groups of mutually exclusive options, the last option
1.88      wiz      2402:     selected is used, all others are automatically disabled.  If an
                   2403:     option of the group is explicitly disabled, the previously
                   2404:     selected option, if any, is used.  It is an error if no option
                   2405:     from a required group of options is selected, and building the
                   2406:     package will fail.</p>
                   2407: <p>Before the options framework was introduced, build options
                   2408:     were selected by setting a variable (often named
                   2409:     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110     hubertf  2410:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option.  To ease
1.88      wiz      2411:     transition to the options framework for the user, these legacy
                   2412:     variables are converted to the appropriate options setting
                   2413:     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
                   2414:     automatically.  A warning is issued to prompt the user to update
1.110     hubertf  2415:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88      wiz      2416:     directly.  Support for the legacy variables will be removed
                   2417:     eventually.</p>
1.75      rillig   2418: </div>
                   2419: </div>
                   2420: <div class="chapter" lang="en">
                   2421: <div class="titlepage"><div><div><h2 class="title">
                   2422: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
                   2423: <div class="toc">
                   2424: <p><b>Table of Contents</b></p>
                   2425: <dl>
                   2426: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                   2427: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
                   2428: </dl>
                   2429: </div>
                   2430: <div class="sect1" lang="en">
                   2431: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2432: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87      wiz      2433: <p>Once you have built and installed a package, you can create
                   2434:     a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.110     hubertf  2435:     another system with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.87      wiz      2436:     the same package on a group of hosts and wasting CPU time. It also
                   2437:     provides a simple means for others to install your package, should
                   2438:     you distribute it.</p>
                   2439: <p>To create a binary package, change into the appropriate
1.110     hubertf  2440:     directory in pkgsrc, and run <span class="command"><strong>make
1.87      wiz      2441:     package</strong></span>:</p>
                   2442: <pre class="screen">
                   2443: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2444: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   2445:     </pre>
                   2446: <p>This will build and install your package (if not already done),
                   2447:     and then build a binary package from what was installed. You can
1.110     hubertf  2448:     then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87      wiz      2449:     it. Binary packages are created by default in
                   2450:     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.110     hubertf  2451:     gzipped tar file. See <a class="xref" href="#logs.package" title="B.2. Packaging figlet">Section B.2, &#8220;Packaging figlet&#8221;</a> for a
1.91      rillig   2452:     continuation of the above <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/misc/figlet/README.html" target="_top"><code class="filename">misc/figlet</code></a> example.</p>
1.110     hubertf  2453: <p>See <a class="xref" href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a> for information on how to submit
1.87      wiz      2454:     such a binary package.</p>
1.75      rillig   2455: </div>
                   2456: <div class="sect1" lang="en">
                   2457: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2458: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.110     hubertf  2459: <p>See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, &#8220;Other helpful targets&#8221;</a>.</p>
1.106     rillig   2460: </div>
                   2461: </div>
                   2462: <div class="chapter" lang="en">
                   2463: <div class="titlepage"><div><div><h2 class="title">
                   2464: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
                   2465: builds)</h2></div></div></div>
                   2466: <div class="toc">
                   2467: <p><b>Table of Contents</b></p>
                   2468: <dl>
                   2469: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
                   2470: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
                   2471: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
                   2472: <dd><dl>
                   2473: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
                   2474: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
                   2475: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
                   2476: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
                   2477: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
                   2478: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                   2479: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
                   2480: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
                   2481: </dl></dd>
                   2482: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.116   ! rillig   2483: <dd><dl>
        !          2484: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
        !          2485: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
        !          2486: </dl></dd>
1.106     rillig   2487: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                   2488: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
                   2489: </dl>
                   2490: </div>
                   2491: <p>When you have multiple machines that should run the same packages,
                   2492: it is wasted time if they all build their packages themselves from
                   2493: source. There are two ways of getting a set of binary packages: The old
                   2494: bulk build system, or the new (as of 2007) parallel bulk build (pbulk)
                   2495: system. This chapter describes how to set them up so that the packages
                   2496: are most likely to be usable later.</p>
                   2497: <div class="sect1" lang="en">
                   2498: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2499: <a name="bulk.pre"></a>7.1. Think first, build later</h2></div></div></div>
                   2500: <p>Since a bulk build takes several days or even weeks to finish, you
                   2501: should think about the setup before you start everything. Pay attention
                   2502: to at least the following points:</p>
                   2503: <div class="itemizedlist"><ul type="disc">
                   2504: <li>
                   2505: <p>If you want to upload the binary packages to
                   2506: ftp.NetBSD.org, make sure the setup complies to the requirements for binary
                   2507: packages:</p>
                   2508: <div class="itemizedlist"><ul type="circle">
                   2509: <li><p>To end up on ftp.NetBSD.org, the packages must be built
                   2510: by a NetBSD developer on a trusted machine (that is, where you and only
                   2511: you have root access).</p></li>
                   2512: <li><p>Packages on ftp.NetBSD.org should only be created from
                   2513: the stable branches (like 2007Q1), so that users browsing the available
                   2514: collections can see at a glance how old the packages
                   2515: are.</p></li>
                   2516: <li><p>The packages must be built as root, since some packages
                   2517: require set-uid binaries at runtime, and creating those packages as
                   2518: unprivileged user doesn't work well at the moment.</p></li>
                   2519: </ul></div>
                   2520: </li>
                   2521: <li><p>Make sure that the bulk build cannot break anything in
                   2522: your system. Most bulk builds run as root, so they should be run at least
                   2523: in a chroot environment or something even more restrictive, depending on
                   2524: what the operating system provides. There have been numerous cases where
                   2525: certain packages tried to install files outside the
                   2526: <code class="filename">LOCALBASE</code> or wanted to edit some files in
                   2527: <code class="filename">/etc</code>. Furthermore, the bulk builds install and
                   2528: deinstall packages in <code class="filename">/usr/pkg</code> (or whatever
                   2529: <code class="filename">LOCALBASE</code> is) during their operation, so be sure
                   2530: that you don't need any package during the build.</p></li>
                   2531: </ul></div>
                   2532: </div>
                   2533: <div class="sect1" lang="en">
                   2534: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2535: <a name="bulk.req"></a>7.2. Requirements of a bulk build</h2></div></div></div>
                   2536: <p>A complete bulk build requires lots of disk space. Some of the
                   2537: disk space can be read-only, some other must be writable. Some can be on
                   2538: remote filesystems (such as NFS) and some should be local. Some can be
                   2539: temporary filesystems, others must survive a sudden reboot.</p>
                   2540: <div class="itemizedlist"><ul type="disc">
                   2541: <li><p>10 GB for the distfiles (read-write, remote, temporary)</p></li>
                   2542: <li><p>10 GB for the binary packages (read-write, remote, permanent)</p></li>
                   2543: <li><p>400 MB for the pkgsrc tree (read-only, remote, permanent)</p></li>
                   2544: <li><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary for pbulk, permanent for old-bulk)</p></li>
                   2545: <li><p>5 GB for the log files (read-write, remote, permanent)</p></li>
                   2546: <li><p>5 GB for temporary files (read-write, local, temporary)</p></li>
                   2547: </ul></div>
1.75      rillig   2548: </div>
                   2549: <div class="sect1" lang="en">
                   2550: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   2551: <a name="bulk.old"></a>7.3. Running an old-style bulk build</h2></div></div></div>
1.116   ! rillig   2552: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
        !          2553: <h3 class="title">Note</h3>
        !          2554: <p>There are two ways of doing a bulk build. The old-style
        !          2555: one and the new-style &#8220;<span class="quote">pbulk</span>&#8221;. The latter is the recommended
        !          2556: way.</p>
1.106     rillig   2557: </div>
1.75      rillig   2558: <div class="sect2" lang="en">
                   2559: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2560: <a name="binary.configuration"></a>7.3.1. Configuration</h3></div></div></div>
1.75      rillig   2561: <div class="sect3" lang="en">
                   2562: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   2563: <a name="binary.bulk.build.conf"></a>7.3.1.1. <code class="filename">build.conf</code>
1.93      rillig   2564: </h4></div></div></div>
1.76      rillig   2565: <p>The <code class="filename">build.conf</code> file is the main
1.87      wiz      2566:        configuration file for bulk builds. You can configure how your
                   2567:        copy of pkgsrc is kept up to date, how the distfiles are
                   2568:        downloaded, how the packages are built and how the report is
                   2569:        generated. You can find an annotated example file in
                   2570:        <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
                   2571:        it, copy <code class="filename">build.conf-example</code> to
                   2572:        <code class="filename">build.conf</code> and edit it, following the
                   2573:        comments in that file.</p>
1.75      rillig   2574: </div>
                   2575: <div class="sect3" lang="en">
                   2576: <div class="titlepage"><div><div><h4 class="title">
1.110     hubertf  2577: <a name="binary.mk.conf"></a>7.3.1.2. <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.104     rillig   2578: </h4></div></div></div>
1.110     hubertf  2579: <p>You may want to set variables in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.87      wiz      2580:        Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
                   2581:        details of the default settings. You will want to ensure that
                   2582:        <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
                   2583:        As used in this example, <code class="varname">_ACCEPTABLE=yes</code>
1.104     rillig   2584:        completely bypasses the license check.</p>
1.87      wiz      2585: <pre class="programlisting">
1.100     rillig   2586: PACKAGES?=      ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
                   2587: WRKOBJDIR?=     /usr/tmp/pkgsrc   # build here instead of in pkgsrc
                   2588: BSDSRCDIR=      /usr/src
                   2589: BSDXSRCDIR=     /usr/xsrc         # for x11/xservers
                   2590: OBJHOSTNAME?=   yes               # use work.`hostname`
                   2591: FAILOVER_FETCH= yes               # insist on the correct checksum
                   2592: PKG_DEVELOPER?= yes
                   2593: _ACCEPTABLE=    yes
                   2594: </pre>
1.75      rillig   2595: <p>Some options that are especially useful for bulk builds
                   2596:        can be found at the top lines of the file
1.76      rillig   2597:        <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
1.75      rillig   2598:        options of these are briefly described here.</p>
                   2599: <div class="itemizedlist"><ul type="disc">
                   2600: <li><p>If you are on a slow machine, you may want to
1.87      wiz      2601:          set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
                   2602:          &#8220;<span class="quote">no</span>&#8221;.</p></li>
1.75      rillig   2603: <li><p>If you are doing bulk builds from a read-only
1.87      wiz      2604:          copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
                   2605:          to the directory where all log files are created. Otherwise the
                   2606:          log files are created in the pkgsrc directory.</p></li>
1.75      rillig   2607: <li><p>Another important variable is
1.87      wiz      2608:          <code class="varname">BULK_PREREQ</code>, which is a list of packages that
                   2609:          should be always available while building other
                   2610:          packages.</p></li>
1.75      rillig   2611: </ul></div>
                   2612: <p>Some other options are scattered in the pkgsrc
                   2613:        infrastructure:</p>
                   2614: <div class="itemizedlist"><ul type="disc">
                   2615: <li><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
1.87      wiz      2616:          should be set to <code class="literal">yes</code>. The purpose of the bulk
                   2617:          builds is creating binary packages, no matter if they are
                   2618:          vulnerable or not. When uploading the packages to a public
                   2619:          server, the vulnerable packages will be put into a directory of
                   2620:          their own. Leaving this variable unset would prevent the bulk
                   2621:          build system from even trying to build them, so possible
                   2622:          building errors would not show up.</p></li>
1.75      rillig   2623: <li><p><code class="varname">CHECK_FILES</code>
1.93      rillig   2624:          (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
1.87      wiz      2625:          &#8220;<span class="quote">yes</span>&#8221; to check that the installed set of files
                   2626:          matches the <code class="filename">PLIST</code>.</p></li>
1.75      rillig   2627: <li><p><code class="varname">CHECK_INTERPRETER</code>
1.93      rillig   2628:          (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
1.87      wiz      2629:          &#8220;<span class="quote">yes</span>&#8221; to check that the installed
                   2630:          &#8220;<span class="quote">#!</span>&#8221;-scripts will find their
                   2631:          interpreter.</p></li>
1.91      rillig   2632: <li><p><code class="varname">PKGSRC_RUN_TEST</code> can be
                   2633:          set to &#8220;<span class="quote"><code class="literal">yes</code></span>&#8221; to run each
                   2634:          package's self-test before installing it. Note that some
                   2635:          packages make heavy use of &#8220;<span class="quote">good</span>&#8221; random
                   2636:          numbers, so you need to assure that the machine on which you
                   2637:          are doing the bulk builds is not completely idle. Otherwise
                   2638:          some test programs will seem to hang, while they are just
                   2639:          waiting for new random data to be
                   2640:          available.</p></li>
1.75      rillig   2641: </ul></div>
                   2642: </div>
                   2643: <div class="sect3" lang="en">
                   2644: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   2645: <a name="pre-build.local"></a>7.3.1.3. <code class="filename">pre-build.local</code>
1.93      rillig   2646: </h4></div></div></div>
1.75      rillig   2647: <p>It is possible to configure the bulk build to perform
1.87      wiz      2648:        certain site-specific tasks at the end of the pre-build
                   2649:        stage.  If the file
                   2650:        <code class="filename">pre-build.local</code> exists in
                   2651:        <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
1.110     hubertf  2652:        (as a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a> script) at the end of the usual pre-build
1.87      wiz      2653:        stage.  An example use of
                   2654:        <code class="filename">pre-build.local</code> is to have the line:</p>
1.75      rillig   2655: <pre class="screen">echo "I do not have enough disk space to build this pig." \
1.87      wiz      2656:        &gt; misc/openoffice/$BROKENF</pre>
1.75      rillig   2657: <p>to prevent the system from trying to build a particular package
1.87      wiz      2658:        which requires nearly 3 GB of disk space.</p>
1.75      rillig   2659: </div>
                   2660: </div>
                   2661: <div class="sect2" lang="en">
                   2662: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2663: <a name="other-environmental-considerations"></a>7.3.2. Other environmental considerations</h3></div></div></div>
1.76      rillig   2664: <p>As <code class="filename">/usr/pkg</code> will be completely
1.87      wiz      2665:       deleted at the start of bulk builds, make sure your login
                   2666:       shell is placed somewhere else. Either drop it into
                   2667:       <code class="filename">/usr/local/bin</code> (and adjust your login
                   2668:       shell in the passwd file), or (re-)install it via
1.110     hubertf  2669:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> from <code class="filename">/etc/rc.local</code>, so
1.87      wiz      2670:       you can login after a reboot (remember that your current
                   2671:       process won't die if the package is removed, you just can't
                   2672:       start any new instances of the shell any more).  Also, if you
                   2673:       use NetBSD earlier than 1.5, or you still want to use the pkgsrc
                   2674:       version of ssh for some reason, be sure to install ssh before
                   2675:       starting it from <code class="filename">rc.local</code>:</p>
                   2676: <pre class="programlisting">
1.100     rillig   2677: (cd /usr/pkgsrc/security/ssh &amp;&amp; make bulk-install)
                   2678: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
                   2679:   /usr/pkg/etc/rc.d/sshd
                   2680: fi
                   2681: </pre>
1.75      rillig   2682: <p>Not doing so will result in you being not able to log in
1.87      wiz      2683:       via ssh after the bulk build is finished or if the machine
                   2684:       gets rebooted or crashes. You have been warned! :)</p>
1.75      rillig   2685: </div>
                   2686: <div class="sect2" lang="en">
                   2687: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2688: <a name="operation"></a>7.3.3. Operation</h3></div></div></div>
1.75      rillig   2689: <p>Make sure you don't need any of the packages still
1.87      wiz      2690:       installed.</p>
1.75      rillig   2691: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2692: <h3 class="title">Warning</h3>
1.99      rillig   2693: <p>During the bulk build, <span class="emphasis"><em>all packages, their
                   2694:        configuration files and some more files from
                   2695:        <code class="filename">/var</code>, <code class="filename">/home</code> and
                   2696:        possibly other locations will be removed! So don't run a bulk
                   2697:        build with privileges that might harm your
                   2698:        system.</em></span></p>
1.75      rillig   2699: </div>
                   2700: <p>Be sure to remove all other things that might
1.87      wiz      2701:       interfere with builds, like some libs installed in
                   2702:       <code class="filename">/usr/local</code>, etc. then become root and type:</p>
                   2703: <pre class="screen">
                   2704: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   2705: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
                   2706:       </pre>
1.75      rillig   2707: <p>If for some reason your last build didn't complete (power
1.87      wiz      2708:       failure, system panic, ...), you can continue it by
                   2709:       running:</p>
1.75      rillig   2710: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
1.87      wiz      2711: <p>At the end of the bulk build, you will get a summary via mail,
                   2712:       and find build logs in the directory specified by
                   2713:       <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
                   2714:       file.</p>
1.75      rillig   2715: </div>
                   2716: <div class="sect2" lang="en">
                   2717: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2718: <a name="what-it-does"></a>7.3.4. What it does</h3></div></div></div>
1.75      rillig   2719: <p>The bulk builds consist of three steps:</p>
                   2720: <div class="variablelist"><dl>
                   2721: <dt><span class="term">1. pre-build</span></dt>
1.87      wiz      2722: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
                   2723:            cleans out any broken distfiles, and removes all
                   2724:            packages installed.</p></dd>
1.75      rillig   2725: <dt><span class="term">2. the bulk build</span></dt>
1.87      wiz      2726: <dd><p>This is basically &#8220;<span class="quote">make bulk-package</span>&#8221; with
                   2727:            an optimised order in which packages will be
                   2728:            built. Packages that don't require other packages will
                   2729:            be built first, and packages with many dependencies will
                   2730:            be built later.</p></dd>
1.75      rillig   2731: <dt><span class="term">3. post-build</span></dt>
1.87      wiz      2732: <dd><p>Generates a report that's placed in the directory
                   2733:            specified in the <code class="filename">build.conf</code> file
                   2734:            named <code class="filename">broken.html</code>, a short version
                   2735:            of that report will also be mailed to the build's
                   2736:            admin.</p></dd>
1.75      rillig   2737: </dl></div>
1.87      wiz      2738: <p>During the build, a list of broken packages will be compiled
                   2739:       in <code class="filename">/usr/pkgsrc/.broken</code> (or
                   2740:       <code class="filename">.../.broken.${MACHINE}</code> if
                   2741:       <code class="varname">OBJMACHINE</code> is set), individual build logs
                   2742:       of broken builds can be found in the package's
                   2743:       directory. These files are used by the bulk-targets to mark
                   2744:       broken builds to not waste time trying to rebuild them, and
                   2745:       they can be used to debug these broken package builds
                   2746:       later.</p>
1.75      rillig   2747: </div>
                   2748: <div class="sect2" lang="en">
                   2749: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2750: <a name="disk-space-requirements"></a>7.3.5. Disk space requirements</h3></div></div></div>
1.75      rillig   2751: <p>Currently, roughly the following requirements are valid for
1.87      wiz      2752:       NetBSD 2.0/i386:</p>
1.75      rillig   2753: <div class="itemizedlist"><ul type="disc">
1.87      wiz      2754: <li><p>10 GB - distfiles (NFS ok)</p></li>
                   2755: <li><p>8 GB - full set of all binaries (NFS ok)</p></li>
                   2756: <li><p>5 GB - temp space for compiling (local disk recommended)</p></li>
                   2757: </ul></div>
                   2758: <p>Note that all pkgs will be de-installed as soon as they are
                   2759:       turned into a binary package, and that sources are removed,
                   2760:       so there is no excessively huge demand to disk
                   2761:       space. Afterwards, if the package is needed again, it will
1.110     hubertf  2762:       be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> instead of building again, so
1.87      wiz      2763:       there are no cycles wasted by recompiling.</p>
1.75      rillig   2764: </div>
                   2765: <div class="sect2" lang="en">
                   2766: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2767: <a name="setting-up-a-sandbox"></a>7.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.87      wiz      2768: <p>If you don't want all the packages nuked from a machine
                   2769:       (rendering it useless for anything but pkg compiling), there
                   2770:       is the possibility of doing the package bulk build inside a
                   2771:       chroot environment.</p>
                   2772: <p>The first step is to set up a chroot sandbox,
                   2773:       e.g. <code class="filename">/usr/sandbox</code>.  This can be done by
                   2774:       using null mounts, or manually.</p>
                   2775: <p>There is a shell script called
                   2776:       <code class="filename">pkgsrc/mk/bulk/mksandbox</code> which will set
                   2777:       up the sandbox environment using null mounts. It will also
                   2778:       create a script called <code class="filename">sandbox</code> in the
                   2779:       root of the sandbox environment, which will allow the null
1.110     hubertf  2780:       mounts to be activated using the <span class="command"><strong>sandbox
1.87      wiz      2781:       mount</strong></span> command and deactivated using the
1.110     hubertf  2782:       <span class="command"><strong>sandbox umount</strong></span> command.</p>
1.87      wiz      2783: <p>To set up a sandbox environment by hand, after extracting all
1.110     hubertf  2784:       the sets from a NetBSD installation or doing a <span class="command"><strong>make
1.87      wiz      2785:       distribution DESTDIR=/usr/sandbox</strong></span> in
                   2786:       <code class="filename">/usr/src/etc</code>, be sure the following items
                   2787:       are present and properly configured:</p>
1.75      rillig   2788: <div class="procedure"><ol type="1">
                   2789: <li>
                   2790: <p>Kernel</p>
                   2791: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
                   2792: </li>
                   2793: <li>
1.76      rillig   2794: <p><code class="filename">/dev/*</code></p>
1.75      rillig   2795: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
                   2796: </li>
                   2797: <li>
1.91      rillig   2798: <p><code class="filename">/etc/resolv.conf</code> (for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/smtpd/README.html" target="_top"><code class="filename">security/smtpd</code></a> and mail):</p>
1.75      rillig   2799: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
                   2800: </li>
                   2801: <li>
                   2802: <p>Working(!) mail config (hostname, sendmail.cf):</p>
                   2803: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
                   2804: </li>
                   2805: <li>
1.91      rillig   2806: <p><code class="filename">/etc/localtime</code> (for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/smtpd/README.html" target="_top"><code class="filename">security/smtpd</code></a>):</p>
1.75      rillig   2807: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
                   2808: </li>
                   2809: <li>
1.76      rillig   2810: <p><code class="filename">/usr/src</code> (system sources,
1.114     jmcneill 2811:          e.&nbsp;g. for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/aperture/README.html" target="_top"><code class="filename">sysutils/aperture</code></a>):</p>
1.75      rillig   2812: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
1.87      wiz      2813:          <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
1.75      rillig   2814: </li>
                   2815: <li>
1.76      rillig   2816: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
1.75      rillig   2817: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
                   2818: </li>
                   2819: <li>
1.76      rillig   2820: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
1.75      rillig   2821: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
                   2822: </li>
                   2823: <li>
                   2824: <p>Checkout pkgsrc via cvs into
1.87      wiz      2825:          <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
                   2826: <pre class="screen">
                   2827: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
                   2828: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
                   2829:          </pre>
1.75      rillig   2830: <p>Do not mount/link this to the copy of your pkgsrc tree
1.87      wiz      2831:          you do development in, as this will likely cause problems!</p>
1.75      rillig   2832: </li>
                   2833: <li><p>Make
1.87      wiz      2834:          <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
                   2835:          <code class="filename">.../distfiles</code> point somewhere
                   2836:          appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.116   ! rillig   2837: <li><p>Edit <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, see <a class="xref" href="#binary.mk.conf" title="7.3.1.2. ???">Section 7.3.1.2, &#8220;???&#8221;</a>.</p></li>
1.76      rillig   2838: <li><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
1.75      rillig   2839: </ol></div>
                   2840: <p>When the chroot sandbox is set up, you can start
1.87      wiz      2841:       the build with the following steps:</p>
                   2842: <pre class="screen">
                   2843: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
                   2844: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
                   2845:       </pre>
                   2846: <p>This will just jump inside the sandbox and start building.  At
                   2847:        the end of the build, mail will be sent with the results of
                   2848:        the build. Created binary pkgs will be in
                   2849:        <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
                   2850:       (wherever that points/mounts to/from).</p>
1.75      rillig   2851: </div>
                   2852: <div class="sect2" lang="en">
                   2853: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2854: <a name="building-a-partial-set"></a>7.3.7. Building a partial set of packages</h3></div></div></div>
1.87      wiz      2855: <p>In addition to building a complete set of all packages in
                   2856:       pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
                   2857:       may be used to build a subset of the packages contained in
                   2858:       pkgsrc.  By setting <code class="varname">SPECIFIC_PKGS</code>
1.110     hubertf  2859:       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the variables</p>
1.75      rillig   2860: <div class="itemizedlist"><ul type="disc">
                   2861: <li><p>SITE_SPECIFIC_PKGS</p></li>
                   2862: <li><p>HOST_SPECIFIC_PKGS</p></li>
                   2863: <li><p>GROUP_SPECIFIC_PKGS</p></li>
                   2864: <li><p>USER_SPECIFIC_PKGS</p></li>
                   2865: </ul></div>
1.87      wiz      2866: <p>will define the set of packages which should be built.
                   2867:       The bulk build code will also include any packages which are
                   2868:       needed as dependencies for the explicitly listed packages.</p>
                   2869: <p>One use of this is to do a bulk build with
                   2870:       <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
                   2871:       periodically to have a complete set of the binary packages
                   2872:       needed for your site available without the overhead of
                   2873:       building extra packages that are not needed.</p>
1.75      rillig   2874: </div>
                   2875: <div class="sect2" lang="en">
                   2876: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2877: <a name="bulk-upload"></a>7.3.8. Uploading results of a bulk build</h3></div></div></div>
1.87      wiz      2878: <p>This section describes how pkgsrc developers can upload binary
                   2879:       pkgs built by bulk builds to ftp.NetBSD.org.</p>
                   2880: <p>If you would like to automatically create checksum files for the
                   2881:       binary packages you intend to upload, remember to set
                   2882:       <code class="varname">MKSUMS=yes</code> in your
                   2883:       <code class="filename">mk/bulk/build.conf</code>.</p>
                   2884: <p>If you would like to PGP sign the checksum files (highly
                   2885:       recommended!), remember to set
                   2886:       <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
                   2887:       <code class="filename">mk/bulk/build.conf</code>.  This will prompt you for
                   2888:       your GPG password to sign the files before uploading everything.</p>
                   2889: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
                   2890:       set properly in your <code class="filename">mk/bulk/build.conf</code>
                   2891:       file, i.e. adjust it to something like one of the following:</p>
1.93      rillig   2892: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload </pre>
                   2893: <p>Please use appropriate values for "packages-200xQy",
1.87      wiz      2894:       "NetBSD-a.b.c" and "arch" here. If your login on ftp.NetBSD.org
                   2895:       is different from your local login, write your login directly
                   2896:       into the variable, e.g. my local account is "feyrer", but for my
                   2897:       login "hubertf", I use:</p>
1.93      rillig   2898: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload</pre>
1.87      wiz      2899: <p>A separate <code class="filename">upload</code> directory is used
                   2900:       here to allow "closing" the directory during upload. To do
                   2901:       so, run the following command on ftp.NetBSD.org next:</p>
1.93      rillig   2902: <pre class="screen">nbftp% <strong class="userinput"><code>mkdir -p -m 750 /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload</code></strong></pre>
1.87      wiz      2903: <p>Please note that <code class="filename">/pub/NetBSD/packages</code> is
                   2904:       only appropriate for packages for the NetBSD operating
                   2905:       system. Binary packages for other operating systems should go
                   2906:       into <code class="filename">/pub/pkgsrc</code>.</p>
                   2907: <p>Before uploading the binary pkgs, ssh authentication needs
                   2908:       to be set up. This example shows how to set up temporary keys
                   2909:       for the root account <span class="emphasis"><em>inside the sandbox</em></span>
                   2910:       (assuming that no keys should be present there usually):</p>
                   2911: <pre class="screen">
                   2912: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
1.75      rillig   2913: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
                   2914: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t dsa</code></strong>
1.87      wiz      2915: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-dsa.pub</code></strong>
                   2916:       </pre>
                   2917: <p>Now take the output of <code class="filename">id-dsa.pub</code> and
                   2918:       append it to your <code class="filename">~/.ssh/authorized_keys</code>
                   2919:       file on ftp.NetBSD.org. You can remove the key after the
                   2920:       upload is done!</p>
                   2921: <p>Next, test if your ssh connection really works:</p>
1.75      rillig   2922: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
1.87      wiz      2923: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
                   2924: <p>Now after all this works, you can exit the sandbox and start
                   2925:       the upload:</p>
                   2926: <pre class="screen">
                   2927: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
1.75      rillig   2928: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
1.87      wiz      2929: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
                   2930:       </pre>
1.110     hubertf  2931: <p>The upload process may take quite some time. Use <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ls+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ls</span>(1)</span></a> or
                   2932:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?du+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">du</span>(1)</span></a> on the FTP server to monitor progress of the
1.87      wiz      2933:       upload. The upload script will take care of not uploading
                   2934:       restricted packages and putting vulnerable packages into the
                   2935:       <code class="filename">vulnerable</code> subdirectory.</p>
                   2936: <p>After the upload has ended, first thing is to revoke ssh access:</p>
1.75      rillig   2937: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
1.87      wiz      2938:       Gdd:x! </pre>
                   2939: <p>Use whatever is needed to remove the key you've entered
                   2940:       before! Last, move the uploaded packages out of the
                   2941:       <code class="filename">upload</code> directory to have them accessible
                   2942:       to everyone:</p>
                   2943: <pre class="screen">
1.93      rillig   2944: nbftp% <strong class="userinput"><code>cd /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch</code></strong>
1.75      rillig   2945: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
                   2946: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
1.87      wiz      2947: nbftp% <strong class="userinput"><code>chmod 755 .</code></strong>
                   2948:       </pre>
1.75      rillig   2949: </div>
                   2950: </div>
                   2951: <div class="sect1" lang="en">
                   2952: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   2953: <a name="bulk.pbulk"></a>7.4. Running a pbulk-style bulk build</h2></div></div></div>
1.116   ! rillig   2954: <p>Running a pbulk-style bulk build works roughly as follows:</p>
        !          2955: <div class="itemizedlist"><ul type="disc">
        !          2956: <li><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
        !          2957: <li><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
        !          2958: </ul></div>
        !          2959: <div class="sect2" lang="en">
        !          2960: <div class="titlepage"><div><div><h3 class="title">
        !          2961: <a name="bulk.pbulk.prepare"></a>7.4.1. Preparation</h3></div></div></div>
        !          2962: <p>First, you need to create a pkgsrc installation for the pbulk infrastructure. No matter on which platform you are (even on NetBSD), you should bootstrap into its own directory. Let's take the directory <code class="filename">/usr/pbulk-outer</code> or <code class="filename">$HOME/pbulk-outer</code> for it. This installation will be bootstrapped and all the tools that are required for the bulk build will be installed there.</p>
        !          2963: <pre class="screen">
        !          2964: $ <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
        !          2965: $ <strong class="userinput"><code>./bootstrap/bootstrap --prefix=/usr/pbulk --varbase=/usr/pbulk/var --workdir=/tmp/pbulk-bootstrap</code></strong>
        !          2966: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-bootstrap</code></strong>
        !          2967: </pre>
        !          2968: <p>Now the basic environment for the pbulk infrastructure is installed. The specific tools are still missing. This is a good time to edit the pkgsrc configuration file <code class="filename">/usr/pbulk/etc/mk.conf</code> to fit your needs. Typical things you might set now are:</p>
        !          2969: <div class="itemizedlist"><ul type="disc">
        !          2970: <li><p><code class="literal"><code class="varname">PKG_DEVELOPER</code>=yes</code>, to enable many consistency checks,</p></li>
        !          2971: <li><p><code class="literal"><code class="varname">WRKOBJDIR</code>=/tmp/pbulk-outer</code>, to keep <code class="filename">/usr/pkgsrc</code> free from any modifications,</p></li>
        !          2972: <li><p><code class="literal"><code class="varname">DISTDIR</code>=/distfiles</code>, to have only one directory in which all distfiles (for the infrastructure and for the actual packages) are downloaded,</p></li>
        !          2973: <li><p><code class="literal"><code class="varname">ACCEPTABLE_LICENSES</code>+=...</code>, to select some licenses additional to the usual Free/Open Source licenses that are acceptable to you,</p></li>
        !          2974: <li><p><code class="literal"><code class="varname">_ACCEPTABLE</code>=yes</code>, to accept all licenses, no matter how restrictive they are.</p></li>
        !          2975: </ul></div>
        !          2976: <p>Now you are ready to build the rest of the pbulk infrastructure.</p>
        !          2977: <pre class="screen">
        !          2978: $ <strong class="userinput"><code>cd pkgtools/pbulk</code></strong>
        !          2979: $ <strong class="userinput"><code>/usr/pbulk/bin/bmake install</code></strong>
        !          2980: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-outer</code></strong>
        !          2981: </pre>
        !          2982: <p>Now the pbulk infrastructure is built and installed. It still needs to be configured, and after some more preparation, we will be able to start the real bulk build.</p>
        !          2983: </div>
1.106     rillig   2984: <div class="sect2" lang="en">
                   2985: <div class="titlepage"><div><div><h3 class="title">
1.116   ! rillig   2986: <a name="bulk.pbulk.conf"></a>7.4.2. Configuration</h3></div></div></div>
1.114     jmcneill 2987: <p>TODO; see pkgsrc/doc/HOWTO-pbulk for more information.</p>
1.116   ! rillig   2988: <p>TODO: continue writing</p>
1.106     rillig   2989: </div>
                   2990: </div>
                   2991: <div class="sect1" lang="en">
                   2992: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2993: <a name="creating-cdroms"></a>7.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87      wiz      2994: <p>After your pkgsrc bulk-build has completed, you may wish to
                   2995:     create a CD-ROM set of the resulting binary packages to assist
                   2996:     in installing packages on other machines.  The
1.91      rillig   2997:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/cdpack/README.html" target="_top"><code class="filename">pkgtools/cdpack</code></a> package provides
1.87      wiz      2998:     a simple tool for creating the ISO 9660 images.
1.110     hubertf  2999:     <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87      wiz      3000:     way that keeps all the dependencies for a given package on the same
                   3001:     CD as that package.</p>
1.75      rillig   3002: <div class="sect2" lang="en">
                   3003: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3004: <a name="cdpack-example"></a>7.5.1. Example of cdpack</h3></div></div></div>
1.87      wiz      3005: <p>Complete documentation for cdpack is found in the cdpack(1)
                   3006:       man page. The following short example assumes that the binary
                   3007:       packages are left in
                   3008:       <code class="filename">/usr/pkgsrc/packages/All</code> and that
                   3009:       sufficient disk space exists in <code class="filename">/u2</code> to
                   3010:       hold the ISO 9660 images.</p>
                   3011: <pre class="screen">
                   3012: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75      rillig   3013: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87      wiz      3014: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
                   3015:       </pre>
                   3016: <p>If you wish to include a common set of files
                   3017:       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
                   3018:       etc.) on each CD in the collection, then you need to create a
                   3019:       directory which contains these files. e.g.</p>
                   3020: <pre class="screen">
                   3021: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75      rillig   3022: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
                   3023: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
                   3024: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
                   3025: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
                   3026: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
1.87      wiz      3027: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
                   3028:       </pre>
1.75      rillig   3029: <p>Now create the images:</p>
                   3030: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
1.76      rillig   3031: <p>Each image will contain <code class="filename">README</code>,
1.87      wiz      3032:       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
                   3033:       in their root directories.</p>
1.75      rillig   3034: </div>
                   3035: </div>
                   3036: </div>
                   3037: <div class="chapter" lang="en">
                   3038: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   3039: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.90      rillig   3040: <div class="toc">
                   3041: <p><b>Table of Contents</b></p>
                   3042: <dl>
1.116   ! rillig   3043: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in ${LOCALBASE}</a></span></dt>
        !          3044: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in ${VARBASE}</a></span></dt>
1.90      rillig   3045: </dl>
                   3046: </div>
                   3047: <p>The files that are installed by pkgsrc are organized in a way that
                   3048: is similar to what you find in the <code class="filename">/usr</code> directory
                   3049: of the base system. But some details are different. This is because
                   3050: pkgsrc initially came from FreeBSD and had adopted its file system
                   3051: hierarchy. Later it was largely influenced by NetBSD. But no matter
                   3052: which operating system you are using pkgsrc with, you can expect the
                   3053: same layout for pkgsrc.</p>
1.91      rillig   3054: <p>There are mainly four root directories for pkgsrc, which are all
                   3055: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
                   3056: When pkgsrc has been installed as root, the default locations
                   3057: are:</p>
                   3058: <pre class="programlisting">
1.100     rillig   3059: LOCALBASE=              /usr/pkg
                   3060: PKG_SYSCONFBASE=        /usr/pkg/etc
                   3061: VARBASE=                /var
                   3062: PKG_DBDIR=              /var/db/pkg
1.91      rillig   3063: </pre>
                   3064: <p>In unprivileged mode (when pkgsrc has been installed as any other
                   3065: user), the default locations are:</p>
                   3066: <pre class="programlisting">
1.100     rillig   3067: LOCALBASE=              ${HOME}/pkg
                   3068: PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   3069: VARBASE=                ${HOME}/pkg/var
                   3070: PKG_DBDIR=              ${HOME}/pkg/var/db/pkg
1.91      rillig   3071: </pre>
                   3072: <p>What these four directories are for, and what they look like is
                   3073: explained below.</p>
1.90      rillig   3074: <div class="itemizedlist"><ul type="disc">
                   3075: <li><p><code class="varname">LOCALBASE</code> corresponds to the
                   3076: <code class="filename">/usr</code> directory in the base system. It is the
                   3077: &#8220;<span class="quote">main</span>&#8221; directory where the files are installed and contains
                   3078: the well-known subdirectories like <code class="filename">bin</code>,
                   3079: <code class="filename">include</code>, <code class="filename">lib</code>,
                   3080: <code class="filename">share</code> and
                   3081: <code class="filename">sbin</code>.</p></li>
                   3082: <li><p><code class="varname">VARBASE</code> corresponds to
                   3083: <code class="filename">/var</code> in the base system. Some programs (especially
                   3084: games, network daemons) need write access to it during normal
                   3085: operation.</p></li>
                   3086: <li><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
                   3087: <code class="filename">/etc</code> in the base system. It contains configuration
1.110     hubertf  3088: files of the packages, as well as pkgsrc's <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.90      rillig   3089: itself.</p></li>
                   3090: </ul></div>
                   3091: <div class="sect1" lang="en">
                   3092: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3093: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93      rillig   3094: </h2></div></div></div>
1.90      rillig   3095: <p>The following directories exist in a typical pkgsrc installation
1.91      rillig   3096: in <code class="filename">${LOCALBASE}</code>.</p>
1.90      rillig   3097: <div class="variablelist"><dl>
                   3098: <dt><span class="term"><code class="filename">bin</code></span></dt>
                   3099: <dd><p>Contains executable programs that are intended to be
                   3100: directly used by the end user.</p></dd>
                   3101: <dt><span class="term"><code class="filename">emul</code></span></dt>
                   3102: <dd><p>Contains files for the emulation layers of various other
                   3103: operating systems, especially for
                   3104: NetBSD.</p></dd>
                   3105: <dt><span class="term"><code class="filename">etc</code> (the usual location of
                   3106: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
                   3107: <dd><p>Contains
                   3108: the configuration files.</p></dd>
                   3109: <dt><span class="term"><code class="filename">include</code></span></dt>
                   3110: <dd><p>Contains headers for the C and C++ programming
                   3111: languages.</p></dd>
                   3112: <dt><span class="term"><code class="filename">info</code></span></dt>
                   3113: <dd><p>Contains GNU info files of various
                   3114: packages.</p></dd>
                   3115: <dt><span class="term"><code class="filename">lib</code></span></dt>
                   3116: <dd><p>Contains shared and static
                   3117: libraries.</p></dd>
                   3118: <dt><span class="term"><code class="filename">libdata</code></span></dt>
                   3119: <dd><p>Contains data files that don't change after
                   3120: installation. Other data files belong into
                   3121: <code class="filename">${VARBASE}</code>.</p></dd>
                   3122: <dt><span class="term"><code class="filename">libexec</code></span></dt>
                   3123: <dd><p>Contains programs that are not intended to be used by
                   3124: end users, such as helper programs or network
                   3125: daemons.</p></dd>
                   3126: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
                   3127: <dd><p>Contains programs that are intended to be executed as
                   3128: CGI scripts by a web server.</p></dd>
                   3129: <dt><span class="term"><code class="filename">man</code> (the usual value of
                   3130: <code class="filename">${PKGMANDIR}</code>)</span></dt>
                   3131: <dd><p>Contains brief
                   3132: documentation in form of manual pages.</p></dd>
                   3133: <dt><span class="term"><code class="filename">sbin</code></span></dt>
                   3134: <dd><p>Contains programs that are intended to be used only by
                   3135: the super-user.</p></dd>
                   3136: <dt><span class="term"><code class="filename">share</code></span></dt>
                   3137: <dd><p>Contains platform-independent data files that don't
                   3138: change after installation.</p></dd>
                   3139: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
                   3140: <dd><p>Contains documentation files provided by the
                   3141: packages.</p></dd>
                   3142: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
                   3143: <dd><p>Contains example files provided by the packages. Among
                   3144: others, the original configuration files are saved here and copied to
                   3145: <code class="filename">${PKG_SYSCONFDIR}</code> during
                   3146: installation.</p></dd>
                   3147: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
                   3148: <dd><p>Contains the original files for rc.d
                   3149: scripts.</p></dd>
                   3150: <dt><span class="term"><code class="filename">var</code> (the usual location of
                   3151: <code class="filename">${VARBASE}</code>)</span></dt>
                   3152: <dd><p>Contains files
                   3153: that may be modified after
                   3154: installation.</p></dd>
                   3155: </dl></div>
                   3156: </div>
                   3157: <div class="sect1" lang="en">
                   3158: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3159: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.93      rillig   3160: </h2></div></div></div>
1.90      rillig   3161: <div class="variablelist"><dl>
                   3162: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
                   3163: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
                   3164: <dd><p>Contains
                   3165: information about the currently installed
                   3166: packages.</p></dd>
                   3167: <dt><span class="term"><code class="filename">games</code></span></dt>
                   3168: <dd><p>Contains highscore
                   3169: files.</p></dd>
                   3170: <dt><span class="term"><code class="filename">log</code></span></dt>
                   3171: <dd><p>Contains log files.</p></dd>
                   3172: <dt><span class="term"><code class="filename">run</code></span></dt>
                   3173: <dd><p>Contains informational files about daemons that are
                   3174: currently running.</p></dd>
                   3175: </dl></div>
                   3176: </div>
                   3177: </div>
                   3178: <div class="chapter" lang="en">
                   3179: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   3180: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   3181: <div class="toc">
                   3182: <p><b>Table of Contents</b></p>
                   3183: <dl>
1.106     rillig   3184: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                   3185: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
                   3186: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
                   3187: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
                   3188: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
                   3189: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
                   3190: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.116   ! rillig   3191: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell make fetch to do passive FTP?</a></span></dt>
1.106     rillig   3192: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.116   ! rillig   3193: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does Don't know how to make
        !          3194: /usr/share/tmac/tmac.andoc mean?</a></span></dt>
        !          3195: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does Could not find bsd.own.mk mean?</a></span></dt>
1.106     rillig   3196: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                   3197: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                   3198: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.116   ! rillig   3199: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my CFLAGS?</a></span></dt>
1.106     rillig   3200: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
1.116   ! rillig   3201: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does Makefile appears to contain unresolved cvs/rcs/??? merge conflicts mean?</a></span></dt>
1.75      rillig   3202: </dl>
                   3203: </div>
                   3204: <p>This section contains hints, tips &amp; tricks on special things in
                   3205: pkgsrc that we didn't find a better place for in the previous chapters, and
                   3206: it contains items for both pkgsrc users and developers.</p>
                   3207: <div class="sect1" lang="en">
                   3208: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3209: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75      rillig   3210: <p>The following mailing lists may be of interest to pkgsrc users:</p>
                   3211: <div class="itemizedlist"><ul type="disc">
1.110     hubertf  3212: <li><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.78      rillig   3213:          This is a general purpose list for most issues regarding
                   3214:          pkgsrc, regardless of platform, e.g. soliciting user help
                   3215:          for pkgsrc configuration, unexpected build failures, using
                   3216:          particular packages, upgrading pkgsrc installations,
                   3217:          questions regarding the pkgsrc release branches, etc.  General announcements or
                   3218:          proposals for changes that impact the pkgsrc user community,
                   3219:          e.g. major infrastructure changes, new features, package
                   3220:          removals, etc., may also be posted.</p></li>
1.110     hubertf  3221: <li><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.75      rillig   3222:          A list where the results of pkgsrc bulk builds are sent and
                   3223:          discussed.</p></li>
1.110     hubertf  3224: <li><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.75      rillig   3225:          This list is for those who are interested in getting a
                   3226:          commit message for every change committed to pkgsrc. It is
                   3227:          also available in digest form, meaning one daily message
                   3228:          containing all commit messages for changes to the package
                   3229:          source tree in that 24 hour period.</p></li>
                   3230: </ul></div>
                   3231: <p>To subscribe, do:</p>
                   3232: <pre class="programlisting">
1.100     rillig   3233: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75      rillig   3234: </pre>
                   3235: <p>Archives for all these mailing lists are available from
1.110     hubertf  3236: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.75      rillig   3237: </div>
                   3238: <div class="sect1" lang="en">
                   3239: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3240: <a name="pkgviews-docs"></a>9.2. Where's the pkgviews documentation?</h2></div></div></div>
1.75      rillig   3241: <p>Pkgviews is tightly integrated with buildlink.  You can find a
                   3242: pkgviews User's guide in
1.76      rillig   3243: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
1.75      rillig   3244: </div>
                   3245: <div class="sect1" lang="en">
                   3246: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3247: <a name="faq-pkgtools"></a>9.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.80      rillig   3248: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75      rillig   3249: a number of useful utilities for both users and developers of pkgsrc.  This
                   3250: section attempts only to make the reader aware of the utilities and when
                   3251: they might be useful, and not to duplicate the documentation that comes
                   3252: with each package.</p>
                   3253: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.91      rillig   3254: <div class="itemizedlist"><ul type="disc"><li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/x11-links/README.html" target="_top"><code class="filename">pkgtools/x11-links</code></a>:
1.75      rillig   3255:       Symlinks for use by buildlink.</p></li></ul></div>
                   3256: <p>OS tool augmentation (automatically installed when needed):</p>
                   3257: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3258: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/README.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.75      rillig   3259:       Calculates various kinds of checksums (including SHA1).</p></li>
1.91      rillig   3260: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/README.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
1.75      rillig   3261:       Compatibility library for pkgsrc tools.</p></li>
1.91      rillig   3262: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mtree/README.html" target="_top"><code class="filename">pkgtools/mtree</code></a>: Installed on
1.87      wiz      3263:       non-BSD systems due to lack of native mtree.</p></li>
1.91      rillig   3264: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>:
1.75      rillig   3265:       Up-to-date replacement for
1.76      rillig   3266:       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75      rillig   3267:       systems where pkg_install is not present.</p></li>
                   3268: </ul></div>
                   3269: <p>Utilities used by pkgsrc (not automatically installed):</p>
                   3270: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3271: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
1.75      rillig   3272:       Create a binary package from an
1.110     hubertf  3273:       already-installed package.  Used by <span class="command"><strong>make replace</strong></span> to
1.75      rillig   3274:       save the old package.</p></li>
1.91      rillig   3275: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/README.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
1.75      rillig   3276:       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
                   3277:       from multiple locations. It currently supports the following
                   3278:       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.91      rillig   3279: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/xpkgwedge/README.html" target="_top"><code class="filename">pkgtools/xpkgwedge</code></a>: Put X11
1.75      rillig   3280:       packages someplace else (enabled by default).</p></li>
1.91      rillig   3281: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>: Determine the
1.75      rillig   3282:       best compiler flags to optimise code for your current CPU and
                   3283:       compiler.</p></li>
                   3284: </ul></div>
                   3285: <p>Utilities for keeping track of installed packages, being up to date,
                   3286: etc:</p>
                   3287: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3288: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a>: Reports on
1.75      rillig   3289:       packages whose installed versions do not match the latest pkgsrc
                   3290:       entries.</p></li>
1.91      rillig   3291: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
1.75      rillig   3292:       dependency graphs of packages, to aid in choosing a strategy for
                   3293:       updating.</p></li>
1.91      rillig   3294: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdepgraph/README.html" target="_top"><code class="filename">pkgtools/pkgdepgraph</code></a>: Makes
                   3295:       graphs from the output of <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a> (uses graphviz).</p></li>
                   3296: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
1.112     weinem   3297:       pkglint(1) program checks a pkgsrc entry for errors.</p></li>
                   3298: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a>: The lintpkgsrc(1) program
1.75      rillig   3299:       does various checks on the complete pkgsrc system.</p></li>
1.91      rillig   3300: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgsurvey/README.html" target="_top"><code class="filename">pkgtools/pkgsurvey</code></a>: Report what
1.75      rillig   3301:       packages you have installed.</p></li>
                   3302: </ul></div>
                   3303: <p>Utilities for people maintaining or creating individual packages:</p>
                   3304: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3305: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
1.75      rillig   3306:       making and maintaining patches for a package (includes pkgdiff,
                   3307:       pkgvi, mkpatches, etc.).</p></li>
1.91      rillig   3308: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>,
                   3309:       <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>: Aids in
1.75      rillig   3310:       converting to pkgsrc.</p></li>
1.91      rillig   3311: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/gensolpkg/README.html" target="_top"><code class="filename">pkgtools/gensolpkg</code></a>: Convert
1.75      rillig   3312:       pkgsrc to a Solaris package.</p></li>
                   3313: </ul></div>
                   3314: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
                   3315: utilities)</p>
                   3316: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3317: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_comp/README.html" target="_top"><code class="filename">pkgtools/pkg_comp</code></a>: Build
1.75      rillig   3318:       packages in a chrooted area.</p></li>
1.91      rillig   3319: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/README.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
1.75      rillig   3320:       kernel version for chrooted cross builds.</p></li>
                   3321: </ul></div>
                   3322: </div>
                   3323: <div class="sect1" lang="en">
                   3324: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3325: <a name="non-root-pkgsrc"></a>9.4. How to use pkgsrc as non-root</h2></div></div></div>
1.75      rillig   3326: <p>If you want to use pkgsrc as non-root user, you can set some
                   3327: variables to make pkgsrc work under these conditions.  At the very least,
                   3328: you need to set <code class="varname">UNPRIVILEGED</code> to &#8220;<span class="quote">yes</span>&#8221;; this
                   3329: will turn on unprivileged mode and set multiple related variables to allow
                   3330: installation of packages as non-root.</p>
                   3331: <p>In case the defaults are not enough, you may want to tune some other
                   3332: variables used.  For example, if the automatic user/group detection leads
                   3333: to incorrect values (or not the ones you would like to use), you can change
                   3334: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
                   3335: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
                   3336: <p>As regards bootstrapping, please note that the
1.110     hubertf  3337: <span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
1.75      rillig   3338: given the &#8220;<span class="quote">--ignore-user-check</span>&#8221; flag, as it will choose and
1.76      rillig   3339: use multiple default directories under <code class="filename">~/pkg</code> as the
1.93      rillig   3340: installation targets.  These directories can be overridden by the
1.75      rillig   3341: &#8220;<span class="quote">--prefix</span>&#8221; flag provided by the script, as well as some others
                   3342: that allow finer tuning of the tree layout.</p>
                   3343: </div>
                   3344: <div class="sect1" lang="en">
                   3345: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3346: <a name="resume-transfers"></a>9.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75      rillig   3347: <p>By default, resuming transfers in pkgsrc is disabled, but you can
                   3348: enable this feature by adding the option
                   3349: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110     hubertf  3350: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  If, during a fetch step, an incomplete
1.75      rillig   3351: distfile is found, pkgsrc will try to resume it.</p>
                   3352: <p>You can also
1.110     hubertf  3353: use a different program than the default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> by changing the
1.75      rillig   3354: <code class="varname">FETCH_CMD</code> variable.  Don't forget to set
                   3355: <code class="varname">FETCH_RESUME_ARGS</code> and
                   3356: <code class="varname">FETCH_OUTPUT_ARGS</code> if you are not using default
                   3357: values.</p>
                   3358: <p>For example, if you want to use
1.76      rillig   3359: <code class="filename">wget</code> to resume downloads, you'll have to use something
1.75      rillig   3360: like:</p>
                   3361: <pre class="programlisting">
1.100     rillig   3362: FETCH_CMD=             wget
                   3363: FETCH_BEFORE_ARGS=     --passive-ftp
                   3364: FETCH_RESUME_ARGS=     -c
1.110     hubertf  3365: FETCH_OUTPUT_ARGS=     -O -nc
1.1       grant    3366: </pre>
1.75      rillig   3367: </div>
                   3368: <div class="sect1" lang="en">
                   3369: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3370: <a name="x.org-from-pkgsrc"></a>9.6. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.103     wiz      3371: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76      rillig   3372: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75      rillig   3373: you will have to add the following line into
1.110     hubertf  3374: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75      rillig   3375: <pre class="programlisting">
1.103     wiz      3376: X11_TYPE=modular
1.1       grant    3377: </pre>
1.75      rillig   3378: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   3379: <h3 class="title">Note</h3>
1.103     wiz      3380: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
                   3381: </p>
1.75      rillig   3382: </div>
                   3383: </div>
                   3384: <div class="sect1" lang="en">
                   3385: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3386: <a name="fetch-behind-firewall"></a>9.7. How to fetch files from behind a firewall</h2></div></div></div>
1.75      rillig   3387: <p>If you are sitting behind a firewall which does not allow direct
                   3388: connections to Internet hosts (i.e. non-NAT), you may specify the
                   3389: relevant proxy hosts.  This is done using an environment variable in the
                   3390: form of a URL, e.g. in Amdahl, the machine
                   3391: &#8220;<span class="quote">orpheus.amdahl.com</span>&#8221; is one of the firewalls, and it uses
                   3392: port 80 as the proxy port number.  So the proxy environment variables
                   3393: are:</p>
                   3394: <pre class="programlisting">
1.100     rillig   3395: ftp_proxy=ftp://orpheus.amdahl.com:80/
                   3396: http_proxy=http://orpheus.amdahl.com:80/
1.1       grant    3397: </pre>
1.75      rillig   3398: </div>
                   3399: <div class="sect1" lang="en">
                   3400: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110     hubertf  3401: <a name="passive-ftp"></a>9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.75      rillig   3402: <p>This depends on which utility is used to retrieve distfiles.  From
1.76      rillig   3403: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75      rillig   3404: the first available command from the following list:</p>
                   3405: <div class="itemizedlist"><ul type="disc">
1.76      rillig   3406: <li><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
                   3407: <li><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75      rillig   3408: </ul></div>
                   3409: <p>On a default NetBSD installation, this will be
1.76      rillig   3410: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75      rillig   3411: connections first, and falls back to active connections if the server
                   3412: refuses to do passive.  For the other tools, add the following to your
1.110     hubertf  3413: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75      rillig   3414: <code class="varname">PASSIVE_FETCH=1</code>.</p>
                   3415: <p>Having that option present will prevent
1.76      rillig   3416: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75      rillig   3417: transfers.</p>
                   3418: </div>
                   3419: <div class="sect1" lang="en">
                   3420: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3421: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.88      wiz      3422: <p>You would like to download all the distfiles in a single batch
1.110     hubertf  3423: from work or university, where you can't run a <span class="command"><strong>make
                   3424: fetch</strong></span>.  There is an archive of distfiles on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/" target="_top">ftp.NetBSD.org</a>,
1.75      rillig   3425: but downloading the entire directory may not be appropriate.</p>
1.110     hubertf  3426: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76      rillig   3427: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75      rillig   3428: resulting list to your machine at work/school and use it there.  If you
1.110     hubertf  3429: don't have a NetBSD-compatible <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.75      rillig   3430: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
                   3431: URL:</p>
                   3432: <p>At home:</p>
                   3433: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   3434: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
                   3435: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
                   3436: <p>At work:</p>
                   3437: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76      rillig   3438: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75      rillig   3439: home.</p>
                   3440: <p>If you have a machine running NetBSD, and you want to get
1.88      wiz      3441: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
                   3442: machine architecture), you can do so by using the above-mentioned
1.110     hubertf  3443: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88      wiz      3444: directly by running:</p>
1.75      rillig   3445: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
                   3446: <p>If you even decide to ignore
                   3447: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
                   3448: by running:</p>
                   3449: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
                   3450: </div>
                   3451: <div class="sect1" lang="en">
                   3452: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3453: <a name="tmac.andoc-missing"></a>9.10. What does &#8220;<span class="quote">Don't know how to make
1.75      rillig   3454: /usr/share/tmac/tmac.andoc</span>&#8221; mean?</h2></div></div></div>
1.91      rillig   3455: <p>When compiling the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>
1.75      rillig   3456: package, you get the error from make that it doesn't know how to make
1.76      rillig   3457: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.75      rillig   3458: you don't have installed the &#8220;<span class="quote">text</span>&#8221; set (nroff, ...) from
                   3459: the NetBSD base distribution on your machine.  It is recommended to do
                   3460: that to format man pages.</p>
1.91      rillig   3461: <p>In the case of the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package, you
1.75      rillig   3462: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110     hubertf  3463: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   3464: </div>
                   3465: <div class="sect1" lang="en">
                   3466: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3467: <a name="bsd.own.mk-missing"></a>9.11. What does &#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221; mean?</h2></div></div></div>
1.87      wiz      3468: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75      rillig   3469: when you installed your NetBSD machine.  Please get and install it, by
1.76      rillig   3470: extracting it in <code class="filename">/</code>:</p>
1.75      rillig   3471: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   3472: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76      rillig   3473: <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
1.110     hubertf  3474: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75      rillig   3475: -r</strong></span>).</p>
                   3476: </div>
                   3477: <div class="sect1" lang="en">
                   3478: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3479: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75      rillig   3480: <p>When installing packages as non-root user and using the just-in-time
1.110     hubertf  3481: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a> feature of pkgsrc, it can become annoying to type in the root
1.75      rillig   3482: password for each required package installed.  To avoid this, the sudo
                   3483: package can be used, which does password caching over a limited time.  To
                   3484: use it, install sudo (either as binary package or from
1.98      wiz      3485: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/sudo/README.html" target="_top"><code class="filename">security/sudo</code></a>) and then put the
1.110     hubertf  3486: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98      wiz      3487: <span class="emphasis"><em>after</em></span> the definition of the
                   3488: <code class="varname">LOCALBASE</code> variable:</p>
1.75      rillig   3489: <pre class="programlisting">
1.100     rillig   3490: .if exists(${LOCALBASE}/bin/sudo)
                   3491: SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
                   3492: .endif
1.1       grant    3493: </pre>
1.75      rillig   3494: </div>
                   3495: <div class="sect1" lang="en">
                   3496: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3497: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.75      rillig   3498: <p>As the system administrator, you can choose where configuration files
                   3499: are installed.  The default settings make all these files go into
1.76      rillig   3500: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75      rillig   3501: be suboptimal depending on your expectations (e.g., a read-only,
                   3502: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
                   3503: configuration of the provided packages).</p>
                   3504: <p>In order to change the defaults, you can modify the
                   3505: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110     hubertf  3506: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76      rillig   3507: directory; some common examples include <code class="filename">/etc</code> or
                   3508: <code class="filename">/etc/pkg</code>.</p>
1.75      rillig   3509: <p>Furthermore, you can change this value on a per-package basis by
                   3510: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
                   3511: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
                   3512: package you would like to modify, that is, the contents of
                   3513: <code class="varname">PKGBASE</code>.</p>
                   3514: <p>Note that after changing these settings, you must rebuild and
                   3515: reinstall any affected packages.</p>
                   3516: </div>
                   3517: <div class="sect1" lang="en">
                   3518: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3519: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.75      rillig   3520: <p>Please be aware that there can often be bugs in third-party software,
                   3521: and some of these bugs can leave a machine vulnerable to exploitation by
                   3522: attackers.  In an effort to lessen the exposure, the NetBSD packages team
                   3523: maintains a database of known-exploits to packages which have at one time
                   3524: been included in pkgsrc.  The database can be downloaded automatically, and
                   3525: a security audit of all packages installed on a system can take place.  To
1.114     jmcneill 3526: do this, refer to the following two tools (installed as part of the
                   3527: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package):</p>
1.75      rillig   3528: <div class="orderedlist"><ol type="1">
                   3529: <li>
1.110     hubertf  3530: <p><span class="command"><strong>download-vulnerability-list</strong></span>, an easy way to
1.75      rillig   3531:     download a list of the security vulnerabilities information.  This list
                   3532:     is kept up to date by the NetBSD security officer and the NetBSD
                   3533:     packages team, and is distributed from the NetBSD ftp server:</p>
1.110     hubertf  3534: <p><a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/pkg-vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/pkg-vulnerabilities</a></p>
1.75      rillig   3535: </li>
1.110     hubertf  3536: <li><p><span class="command"><strong>audit-packages</strong></span>, an easy way to audit the
1.75      rillig   3537:     current machine, checking each vulnerability which is known.  If a
                   3538:     vulnerable package is installed, it will be shown by output to stdout,
                   3539:     including a description of the type of vulnerability, and a URL
                   3540:     containing more information.</p></li>
                   3541: </ol></div>
1.114     jmcneill 3542: <p>Use of these tools is strongly recommended!  After
                   3543: &#8220;<span class="quote">pkg_install</span>&#8221; is installed, please read
1.75      rillig   3544: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.114     jmcneill 3545: pkg_install</code></strong>.</p>
1.87      wiz      3546: <p>If this package is installed, pkgsrc builds will use it to
1.110     hubertf  3547: perform a security check before building any package.  See <a class="xref" href="#variables-affecting-build" title="5.2. Variables affecting the build process">Section 5.2, &#8220;Variables affecting the build process&#8221;</a> for ways to control this
1.87      wiz      3548: check.</p>
1.75      rillig   3549: </div>
                   3550: <div class="sect1" lang="en">
                   3551: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3552: <a name="ufaq-cflags"></a>9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.75      rillig   3553: <p>When you add your own preferences to the
                   3554:        <code class="varname">CFLAGS</code> variable in your
1.110     hubertf  3555:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76      rillig   3556:        environment variables to the <code class="filename">./configure</code>
1.110     hubertf  3557:        scripts and to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.75      rillig   3558:        <code class="varname">CFLAGS</code> from the environment variable by
1.76      rillig   3559:        overriding them in the <code class="filename">Makefile</code>s of their
1.75      rillig   3560:        package.</p>
                   3561: <p>Currently there is no solution to this problem. If you
                   3562:        really need the package to use your <code class="varname">CFLAGS</code>
1.110     hubertf  3563:        you should run <span class="command"><strong>make patch</strong></span> in the package
1.76      rillig   3564:        directory and then inspect any <code class="filename">Makefile</code> and
                   3565:        <code class="filename">Makefile.in</code> for whether they define
1.75      rillig   3566:        <code class="varname">CFLAGS</code> explicitly. Usually you can remove
                   3567:        these lines. But be aware that some &#8220;<span class="quote">smart</span>&#8221;
                   3568:        programmers write so bad code that it only works for the
                   3569:        specific combination of <code class="varname">CFLAGS</code> they have
                   3570:        chosen.</p>
                   3571: </div>
1.80      rillig   3572: <div class="sect1" lang="en">
                   3573: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3574: <a name="ufaq-fail"></a>9.16. A package does not build.  What shall I do?</h2></div></div></div>
1.80      rillig   3575: <div class="procedure"><ol type="1">
                   3576: <li><p>Make sure that your copy of pkgsrc is consistent. A
                   3577:        case that occurs often is that people only update pkgsrc in
                   3578:        parts, because of performance reasons. Since pkgsrc is one large
                   3579:        system, not a collection of many small systems, there are
                   3580:        sometimes changes that only work when the whole pkgsrc tree is
                   3581:        updated.</p></li>
                   3582: <li><p>Make sure that you don't have any CVS conflicts.
                   3583:        Search for &#8220;<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>&#8221; or
                   3584:        &#8220;<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>&#8221; in all your pkgsrc
                   3585:        files.</p></li>
                   3586: <li><p>Make sure that you don't have old copies of the packages
1.110     hubertf  3587:        extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80      rillig   3588:        verify this.</p></li>
                   3589: <li><p>If the problem still exists, write a mail to the
                   3590:        <code class="literal">pkgsrc-users</code> mailing list.</p></li>
                   3591: </ol></div>
                   3592: </div>
1.88      wiz      3593: <div class="sect1" lang="en">
                   3594: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3595: <a name="faq.rcs-conflicts"></a>9.17. What does &#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221; mean?</h2></div></div></div>
1.89      rillig   3596: <p>You have modified a file from pkgsrc, and someone else has
                   3597: modified that same file afterwards in the CVS repository. Both changes
                   3598: are in the same region of the file, so when you updated pkgsrc, the
                   3599: <code class="literal">cvs</code> command marked the conflicting changes in the
                   3600: file. Because of these markers, the file is no longer a valid
                   3601: <code class="filename">Makefile</code>.</p>
                   3602: <p>Have a look at that file, and if you don't need your local changes
1.110     hubertf  3603: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89      rillig   3604: -dP</strong></span> in that directory to download the current version.</p>
                   3605: </div>
1.75      rillig   3606: </div>
                   3607: </div>
                   3608: <div class="part" lang="en">
                   3609: <div class="titlepage"><div><div><h1 class="title">
                   3610: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.77      rillig   3611: <div class="partintro" lang="en">
                   3612: <div></div>
                   3613: <p>This part of the book deals with creating and
                   3614:        modifying packages. It starts with a &#8220;<span class="quote">HOWTO</span>&#8221;-like
                   3615:        guide on creating a new package. The remaining chapters are more
                   3616:        like a reference manual for pkgsrc.</p>
1.75      rillig   3617: <div class="toc">
                   3618: <p><b>Table of Contents</b></p>
                   3619: <dl>
1.106     rillig   3620: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91      rillig   3621: <dd><dl>
1.106     rillig   3622: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91      rillig   3623: <dd><dl>
1.106     rillig   3624: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
                   3625: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.91      rillig   3626: </dl></dd>
1.106     rillig   3627: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   3628: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
                   3629: </dl></dd>
                   3630: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
                   3631: <dd><dl>
1.116   ! rillig   3632: <dt><span class="sect1"><a href="#components.Makefile">11.1. Makefile</a></span></dt>
        !          3633: <dt><span class="sect1"><a href="#components.distinfo">11.2. distinfo</a></span></dt>
1.106     rillig   3634: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                   3635: <dd><dl>
                   3636: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                   3637: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                   3638: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                   3639: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                   3640: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                   3641: </dl></dd>
                   3642: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                   3643: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                   3644: <dd><dl>
                   3645: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                   3646: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                   3647: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
                   3648: </dl></dd>
1.116   ! rillig   3649: <dt><span class="sect1"><a href="#work-dir">11.6. work*</a></span></dt>
        !          3650: <dt><span class="sect1"><a href="#files-dir">11.7. files/*</a></span></dt>
1.106     rillig   3651: </dl></dd>
1.116   ! rillig   3652: <dt><span class="chapter"><a href="#makefile">12. Programming in Makefiles</a></span></dt>
1.106     rillig   3653: <dd><dl>
                   3654: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.116   ! rillig   3655: <dt><span class="sect1"><a href="#makefile.variables">12.2. Makefile variables</a></span></dt>
1.106     rillig   3656: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   3657: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   3658: <dd><dl>
                   3659: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                   3660: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                   3661: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                   3662: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                   3663: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
                   3664: </dl></dd>
                   3665: </dl></dd>
                   3666: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
                   3667: <dd><dl>
                   3668: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.116   ! rillig   3669: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic PLIST generation</a></span></dt>
        !          3670: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of make print-PLIST</a></span></dt>
1.106     rillig   3671: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   3672: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.116   ! rillig   3673: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with PLIST_SRC</a></span></dt>
1.106     rillig   3674: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
                   3675: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
                   3676: </dl></dd>
                   3677: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
                   3678: <dd><dl>
                   3679: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.116   ! rillig   3680: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing buildlink3.mk files</a></span></dt>
1.106     rillig   3681: <dd><dl>
                   3682: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.116   ! rillig   3683: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating BUILDLINK_API_DEPENDS.pkg in buildlink3.mk files</a></span></dt>
1.106     rillig   3684: </dl></dd>
1.116   ! rillig   3685: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing builtin.mk files</a></span></dt>
1.106     rillig   3686: <dd><dl>
1.116   ! rillig   3687: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a builtin.mk file</a></span></dt>
1.106     rillig   3688: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                   3689: </dl></dd>
                   3690: </dl></dd>
                   3691: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
                   3692: <dd><dl>
                   3693: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
                   3694: <dd><dl>
                   3695: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   3696: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
                   3697: </dl></dd>
                   3698: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
                   3699: <dd><dl>
1.116   ! rillig   3700: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How PKG_SYSCONFDIR is set</a></span></dt>
1.106     rillig   3701: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   3702: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   3703: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   3704: </dl></dd>
                   3705: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   3706: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">15.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
                   3707: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   3708: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   3709: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   3710: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   3711: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
                   3712: </dl></dd>
                   3713: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
                   3714: <dd><dl>
                   3715: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.116   ! rillig   3716: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use bsd.options.mk</a></span></dt>
1.106     rillig   3717: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107     rillig   3718: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106     rillig   3719: </dl></dd>
                   3720: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
                   3721: <dd><dl>
                   3722: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   3723: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   3724: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   3725: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.116   ! rillig   3726: <dt><span class="sect1"><a href="#build.fetch">17.5. The fetch phase</a></span></dt>
1.106     rillig   3727: <dd><dl>
                   3728: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   3729: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   3730: </dl></dd>
1.116   ! rillig   3731: <dt><span class="sect1"><a href="#build.checksum">17.6. The checksum phase</a></span></dt>
        !          3732: <dt><span class="sect1"><a href="#build.extract">17.7. The extract phase</a></span></dt>
        !          3733: <dt><span class="sect1"><a href="#build.patch">17.8. The patch phase</a></span></dt>
        !          3734: <dt><span class="sect1"><a href="#build.tools">17.9. The tools phase</a></span></dt>
        !          3735: <dt><span class="sect1"><a href="#build.wrapper">17.10. The wrapper phase</a></span></dt>
        !          3736: <dt><span class="sect1"><a href="#build.configure">17.11. The configure phase</a></span></dt>
        !          3737: <dt><span class="sect1"><a href="#build.build">17.12. The build phase</a></span></dt>
        !          3738: <dt><span class="sect1"><a href="#build.test">17.13. The test phase</a></span></dt>
        !          3739: <dt><span class="sect1"><a href="#build.install">17.14. The install phase</a></span></dt>
        !          3740: <dt><span class="sect1"><a href="#build.package">17.15. The package phase</a></span></dt>
1.106     rillig   3741: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   3742: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
                   3743: </dl></dd>
                   3744: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
                   3745: <dd><dl>
                   3746: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   3747: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   3748: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                   3749: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
                   3750: </dl></dd>
                   3751: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
                   3752: <dd><dl>
                   3753: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
                   3754: <dd><dl>
                   3755: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.116   ! rillig   3756: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from ???</a></span></dt>
1.106     rillig   3757: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
                   3758: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
                   3759: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
                   3760: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
                   3761: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
                   3762: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
                   3763: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
                   3764: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
                   3765: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   3766: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   3767: </dl></dd>
1.116   ! rillig   3768: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the fetch phase</a></span></dt>
1.106     rillig   3769: <dd><dl>
                   3770: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   3771: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
                   3772: </dl></dd>
1.116   ! rillig   3773: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the configure phase</a></span></dt>
1.106     rillig   3774: <dd><dl>
                   3775: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   3776: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   3777: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   3778: </dl></dd>
                   3779: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   3780: <dd><dl>
                   3781: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   3782: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   3783: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
                   3784: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
                   3785: </dl></dd>
1.116   ! rillig   3786: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the build phase</a></span></dt>
1.106     rillig   3787: <dd><dl>
                   3788: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   3789: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.116   ! rillig   3790: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to ...</a></span></dt>
1.106     rillig   3791: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   3792: </dl></dd>
1.116   ! rillig   3793: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the install phase</a></span></dt>
1.106     rillig   3794: <dd><dl>
                   3795: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   3796: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   3797: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   3798: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   3799: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   3800: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   3801: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   3802: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107     rillig   3803: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.106     rillig   3804: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper data files</a></span></dt>
                   3805: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   3806: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   3807: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   3808: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   3809: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   3810: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   3811: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   3812: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87      wiz      3813:     emulation</a></span></dt>
1.106     rillig   3814: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   3815: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77      rillig   3816: </dl></dd>
1.106     rillig   3817: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77      rillig   3818: </dl></dd>
1.106     rillig   3819: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
                   3820: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77      rillig   3821: <dd><dl>
1.106     rillig   3822: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   3823: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   3824: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
                   3825: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
                   3826: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
                   3827: <dt><span class="sect1"><a href="#moving-package">21.6. Moving a package in pkgsrc</a></span></dt>
                   3828: </dl></dd>
                   3829: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
                   3830: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
                   3831: <dd><dl>
                   3832: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   3833: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   3834: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   3835: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85      jmmv     3836: </dl></dd>
1.75      rillig   3837: </dl>
                   3838: </div>
1.77      rillig   3839: </div>
                   3840: <div class="chapter" lang="en">
                   3841: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   3842: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91      rillig   3843: <div class="toc">
                   3844: <p><b>Table of Contents</b></p>
                   3845: <dl>
1.106     rillig   3846: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91      rillig   3847: <dd><dl>
1.106     rillig   3848: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
                   3849: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.91      rillig   3850: </dl></dd>
1.106     rillig   3851: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   3852: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.91      rillig   3853: </dl>
                   3854: </div>
1.77      rillig   3855: <p>When you find a package that is not yet in pkgsrc, you
1.91      rillig   3856: most likely have a URL from where you can download the source
                   3857: code. Starting with this URL, creating a package involves only a
                   3858: few steps.</p>
1.77      rillig   3859: <div class="procedure"><ol type="1">
1.91      rillig   3860: <li><p>First, install the packages <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a> and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>.</p></li>
1.77      rillig   3861: <li><p>Then, choose one of the top-level directories as the
1.91      rillig   3862: category in which you want to place your package. You can also create a
                   3863: directory of your own (maybe called <code class="filename">local</code>). In that
                   3864: category directory, create another directory for your package and change
                   3865: into it.</p></li>
1.110     hubertf  3866: <li><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.91      rillig   3867: you for a URL. Enter the URL of the distribution file (in most cases a
                   3868: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
                   3869: of your package are created automatically. The distribution file is
                   3870: extracted automatically to fill in some details in the
                   3871: <code class="filename">Makefile</code> that would otherwise have to be done
                   3872: manually.</p></li>
                   3873: <li>
                   3874: <p>Examine the extracted files to determine the dependencies of
                   3875: your package. Ideally, this is mentioned in some
                   3876: <code class="filename">README</code> file, but things may differ. For each of
                   3877: these dependencies, look where it exists in pkgsrc, and if there is a
                   3878: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   3879: line to your package <code class="filename">Makefile</code> which includes that
                   3880: file just before the last line. If the
                   3881: <code class="filename">buildlink3.mk</code> file does not exist, add a
                   3882: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   3883: version of the dependency and where it can be found in pkgsrc. This line
                   3884: should be placed in the third paragraph. If the dependency is only
                   3885: needed for building the package, but not when using it, use
                   3886: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
                   3887: Your package may then look like this:</p>
1.77      rillig   3888: <pre class="programlisting">
1.100     rillig   3889: [...]
1.77      rillig   3890: 
1.100     rillig   3891: BUILD_DEPENDS+= lua&gt;=5.0:../../lang/lua
                   3892: DEPENDS+=       screen-[0-9]*:../../misc/screen
                   3893: DEPENDS+=       screen&gt;=4.0:../../misc/screen
1.77      rillig   3894: 
1.100     rillig   3895: [...]
1.77      rillig   3896: 
1.100     rillig   3897: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
                   3898: .include "../../devel/glib2/buildlink3.mk"
                   3899: .include "../../mk/bsd.pkg.mk"
1.77      rillig   3900: </pre>
                   3901: </li>
1.110     hubertf  3902: <li><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.91      rillig   3903: to be done to make your package a &#8220;<span class="quote">good</span>&#8221; one. If you don't
1.110     hubertf  3904: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
                   3905: --explain</strong></span> or <span class="command"><strong>pkglint
1.91      rillig   3906: -e</strong></span>, which outputs additional
                   3907: explanations.</p></li>
                   3908: <li><p>In many cases the package is not yet ready to build. You can
1.110     hubertf  3909: find instructions for the most common cases in the next section, <a class="xref" href="#creating.common" title="10.1. Common types of packages">Section 10.1, &#8220;Common types of packages&#8221;</a>. After you have followed the instructions
1.91      rillig   3910: over there, you can hopefully continue here.</p></li>
1.110     hubertf  3911: <li><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.91      rillig   3912: directory from the extracted files. Besides these files, a lot of cache
                   3913: files and other system information has been saved in the working
                   3914: directory, which may become wrong after you edited the
                   3915: <code class="filename">Makefile</code>.</p></li>
1.110     hubertf  3916: <li><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
                   3917: the various things that can go wrong in this phase, consult <a class="xref" href="#fixes" title="Chapter 19. Making your package work">Chapter 19, <i>Making your package work</i></a>.</p></li>
1.91      rillig   3918: <li><p>When the package builds fine, the next step is to install
1.110     hubertf  3919: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.91      rillig   3920: everything works.</p></li>
                   3921: <li><p>Up to now, the file <code class="filename">PLIST</code>, which
                   3922: contains a list of the files that are installed by the package, is
1.110     hubertf  3923: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.91      rillig   3924: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   3925: the file using your preferred text editor to see if the list of
                   3926: files looks plausible.</p></li>
1.110     hubertf  3927: <li><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.91      rillig   3928: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.110     hubertf  3929: <li><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.91      rillig   3930: has been registered in the database of installed files, but with an
1.110     hubertf  3931: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
                   3932: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.91      rillig   3933: registered with the list of files from
                   3934: <code class="filename">PLIST</code>.</p></li>
1.110     hubertf  3935: <li><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.91      rillig   3936: package from the set of installed files.</p></li>
1.77      rillig   3937: </ol></div>
1.91      rillig   3938: <div class="sect1" lang="en">
                   3939: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3940: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.91      rillig   3941: <div class="sect2" lang="en">
                   3942: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3943: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.91      rillig   3944: <p>Simple Perl modules are handled automatically by
1.110     hubertf  3945: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.91      rillig   3946: </div>
                   3947: <div class="sect2" lang="en">
                   3948: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3949: <a name="creating.kde-app"></a>10.1.2. KDE applications</h3></div></div></div>
1.91      rillig   3950: <p>KDE applications should always include
                   3951: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
                   3952: settings that are typical of KDE packages.</p>
                   3953: </div>
                   3954: </div>
                   3955: <div class="sect1" lang="en">
                   3956: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3957: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.91      rillig   3958: <div class="sect2" lang="en">
                   3959: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3960: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.91      rillig   3961: <div class="sect3" lang="en">
                   3962: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   3963: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.91      rillig   3964: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
                   3965: that the &#8220;<span class="quote">nvu</span>&#8221; package has not yet been imported into
                   3966: pkgsrc. As the description says it has to do with the web, the obvious
                   3967: choice for the category is &#8220;<span class="quote">www</span>&#8221;.</p>
                   3968: <pre class="programlisting">
1.100     rillig   3969: <code class="prompt">$</code> mkdir www/nvu
                   3970: <code class="prompt">$</code> cd www/nvu
1.91      rillig   3971: </pre>
                   3972: <p>The web site says that the sources are available as a tar file, so
1.110     hubertf  3973: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.91      rillig   3974: <pre class="programlisting">
1.100     rillig   3975: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91      rillig   3976: </pre>
                   3977: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   3978: below the <code class="varname">DISTNAME</code> line, as the package name should
                   3979: not have the word &#8220;<span class="quote">sources</span>&#8221; in it. I also filled in the
                   3980: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   3981: <code class="varname">COMMENT</code> fields. Then the package
                   3982: <code class="filename">Makefile</code> looked like that:</p>
                   3983: <pre class="programlisting">
1.100     rillig   3984: # $NetBSD$
                   3985: #
1.91      rillig   3986: 
1.100     rillig   3987: DISTNAME=       nvu-1.0-sources
                   3988: PKGNAME=        nvu-1.0
                   3989: CATEGORIES=     www
                   3990: MASTER_SITES=   http://cvs.nvu.com/download/
                   3991: EXTRACT_SUFX=   .tar.bz2
                   3992: 
                   3993: MAINTAINER=     rillig@NetBSD.org
                   3994: HOMEPAGE=       http://cvs.nvu.com/
                   3995: COMMENT=        Web Authoring System
1.91      rillig   3996: 
1.100     rillig   3997: # url2pkg-marker (please do not remove this line.)
                   3998: .include "../../mk/bsd.pkg.mk"
1.91      rillig   3999: </pre>
                   4000: <p>Then, I quit the editor and watched pkgsrc downloading a large
                   4001: source archive:</p>
                   4002: <pre class="programlisting">
1.100     rillig   4003: url2pkg&gt; Running "make makesum" ...
                   4004: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4005: =&gt; Fetching nvu-1.0-sources.tar.bz2
                   4006: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   4007: 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
                   4008: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   4009: url2pkg&gt; Running "make extract" ...
                   4010: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4011: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   4012: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   4013: work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
                   4014: ===&gt; Installing dependencies for nvu-1.0
                   4015: ===&gt; Overriding tools for nvu-1.0
                   4016: ===&gt; Extracting for nvu-1.0
                   4017: url2pkg&gt; Adjusting the Makefile.
1.91      rillig   4018: 
1.100     rillig   4019: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.91      rillig   4020: 
1.100     rillig   4021: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.91      rillig   4022: </pre>
                   4023: </div>
                   4024: <div class="sect3" lang="en">
                   4025: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   4026: <a name="creating.nvu.problems"></a>10.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
1.91      rillig   4027: <p>Now that the package has been extracted, let's see what's inside
                   4028: it. The package has a <code class="filename">README.txt</code>, but that only
                   4029: says something about mozilla, so it's probably useless for seeing what
                   4030: dependencies this package has. But since there is a GNU configure script
                   4031: in the package, let's hope that it will complain about everything it
                   4032: needs.</p>
                   4033: <pre class="programlisting">
1.100     rillig   4034: <code class="prompt">$</code> bmake
                   4035: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4036: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   4037: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   4038: ===&gt; Patching for nvu-1.0
                   4039: ===&gt; Creating toolchain wrappers for nvu-1.0
                   4040: ===&gt; Configuring for nvu-1.0
                   4041: [...]
                   4042: configure: error: Perl 5.004 or higher is required.
                   4043: [...]
                   4044: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   4045: [...]
1.91      rillig   4046: </pre>
                   4047: <p>That worked quite well. So I opened the package Makefile in my
                   4048: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
                   4049: just appended &#8220;<span class="quote">perl</span>&#8221; to it. Since the dependencies of the
                   4050: package have changed now, and since a perl wrapper is automatically
                   4051: installed in the &#8220;<span class="quote">tools</span>&#8221; phase, I need to build the package
                   4052: from scratch.</p>
                   4053: <pre class="programlisting">
1.100     rillig   4054: <code class="prompt">$</code> bmake clean
                   4055: ===&gt; Cleaning for nvu-1.0
                   4056: <code class="prompt">$</code> bmake
                   4057: [...]
                   4058: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   4059: GNU Make.  You will not be able to build Mozilla without GNU Make.
                   4060: [...]
1.91      rillig   4061: </pre>
                   4062: <p>So I added &#8220;<span class="quote">gmake</span>&#8221; to the
                   4063: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
                   4064: <pre class="programlisting">
1.100     rillig   4065: [...]
                   4066: checking for GTK - version &gt;= 1.2.0... no
                   4067: *** Could not run GTK test program, checking why...
                   4068: [...]
1.91      rillig   4069: </pre>
                   4070: <p>Now to the other dependencies. The first question is: Where is the
                   4071: GTK package hidden in pkgsrc?</p>
                   4072: <pre class="programlisting">
1.100     rillig   4073: <code class="prompt">$</code> echo ../../*/gtk*
                   4074: [many packages ...]
                   4075: <code class="prompt">$</code> echo ../../*/gtk
                   4076: ../../x11/gtk
                   4077: <code class="prompt">$</code> echo ../../*/gtk2
                   4078: ../../x11/gtk2
                   4079: <code class="prompt">$</code> echo ../../*/gtk2/bui*
                   4080: ../../x11/gtk2/buildlink3.mk
1.91      rillig   4081: </pre>
                   4082: <p>The first try was definitely too broad. The second one had exactly
                   4083: one result, which is very good. But there is one pitfall with GNOME
                   4084: packages. Before GNOME 2 had been released, there were already many
                   4085: GNOME 1 packages in pkgsrc. To be able to continue to use these
                   4086: packages, the GNOME 2 packages were imported as separate packages, and
                   4087: their names usually have a &#8220;<span class="quote">2</span>&#8221; appended. So I checked
                   4088: whether this was the case here, and indeed it was.</p>
                   4089: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
                   4090: file, adding the dependency is very easy. I just inserted an
                   4091: <code class="literal">.include</code> line before the last line of the package
                   4092: <code class="filename">Makefile</code>, so that it now looks like this:</p>
                   4093: <pre class="programlisting">
1.100     rillig   4094: [...]
                   4095: .include "../../x11/gtk2/buildlink3.mk"
                   4096: .include "../../mk/bsd.pkg.mk
1.91      rillig   4097: </pre>
1.110     hubertf  4098: <p>After another <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span>, the answer
1.91      rillig   4099: was:</p>
                   4100: <pre class="programlisting">
1.100     rillig   4101: [...]
                   4102: checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   4103: checking for GTK - version &gt;= 1.2.0... no
                   4104: *** Could not run GTK test program, checking why...
                   4105: *** The test program failed to compile or link. See the file config.log for the
                   4106: *** exact error that occured. This usually means GTK was incorrectly installed
                   4107: *** or that you have moved GTK since it was installed. In the latter case, you
                   4108: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   4109: configure: error: Test for GTK failed.
                   4110: [...]
1.91      rillig   4111: </pre>
                   4112: <p>In this particular case, the assumption that &#8220;<span class="quote">every package
                   4113: prefers GNOME 2</span>&#8221; had been wrong. The first of the lines above
                   4114: told me that this package really wanted to have the GNOME 1 version of
                   4115: GTK. If the package had looked for GTK2, it would have looked for
1.110     hubertf  4116: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.91      rillig   4117: So I changed the <code class="literal">x11/gtk2</code> to
                   4118: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
                   4119: and tried again.</p>
                   4120: <pre class="programlisting">
1.100     rillig   4121: [...]
                   4122: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\"   -I../../../dist/include/xpcom -I../../../dist/include -I/tmp/roland/pkgsrc/www/nvu/work.bacc/mozilla/dist/include/nspr -I/usr/X11R6/include   -fPIC -DPIC -I/home/roland/pkg/include -I/usr/include  -I/usr/X11R6/include -Wall -W -Wno-unused -Wpointer-arith -Wcast-align -Wno-long-long -pedantic -O2 -I/home/roland/pkg/include -I/usr/include -Dunix -pthread -pipe  -DDEBUG -D_DEBUG -DDEBUG_roland -DTRACING -g -I/home/roland/pkg/include/glib/glib-1.2 -I/home/roland/pkg/lib/glib/include -I/usr/pkg/include/orbit-1.0   -I/home/roland/pkg/include -I/usr/include  -I/usr/X11R6/include -include ../../../mozilla-config.h -DMOZILLA_CLIENT -Wp,-MD,.deps/xpidl.pp xpidl.c
                   4123: In file included from xpidl.c:42:
                   4124: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   4125: In file included from xpidl.c:42:
                   4126: xpidl.h:132: error: parse error before "IDL_ns"
                   4127: [...]
1.91      rillig   4128: </pre>
                   4129: <p>The package still does not find all of its dependencies. Now the
                   4130: question is: Which package provides the
                   4131: <code class="filename">libIDL/IDL.h</code> header file?</p>
                   4132: <pre class="programlisting">
1.100     rillig   4133: <code class="prompt">$</code> echo ../../*/*idl*
                   4134: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   4135: <code class="prompt">$</code> echo ../../*/*IDL*
                   4136: ../../net/libIDL
1.91      rillig   4137: </pre>
                   4138: <p>Let's take the one from the second try. So I included the
                   4139: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
                   4140: again. But the error didn't change. After digging through some of the
                   4141: code, I concluded that the build process of the package was broken and
                   4142: couldn't have ever worked, but since the Mozilla source tree is quite
                   4143: large, I didn't want to fix it. So I added the following to the package
                   4144: <code class="filename">Makefile</code> and tried again:</p>
                   4145: <pre class="programlisting">
1.100     rillig   4146: CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
                   4147: BUILDLINK_TRANSFORM+=   -l:IDL:IDL-2
1.91      rillig   4148: </pre>
                   4149: <p>The latter line is needed because the package expects the library
                   4150: <code class="filename">libIDL.so</code>, but only
                   4151: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
                   4152: wrapper to rewrite that on the fly.</p>
                   4153: <p>The next problem was related to a recent change of the FreeType
                   4154: interface. I looked up in <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/seamonkey/README.html" target="_top"><code class="filename">www/seamonkey</code></a>
                   4155: which patch files were relevant for this issue and copied them to the
                   4156: <code class="filename">patches</code> directory. Then I retried, fixed the
                   4157: patches so that they applied cleanly and retried again. This time,
                   4158: everything worked.</p>
                   4159: </div>
                   4160: <div class="sect3" lang="en">
                   4161: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   4162: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.91      rillig   4163: <pre class="programlisting">
1.100     rillig   4164: <code class="prompt">$</code> bmake CHECK_FILES=no install
                   4165: [...]
                   4166: <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
                   4167: <code class="prompt">$</code> bmake deinstall
                   4168: <code class="prompt">$</code> bmake install
1.91      rillig   4169: </pre>
                   4170: </div>
                   4171: </div>
                   4172: </div>
1.77      rillig   4173: </div>
1.75      rillig   4174: <div class="chapter" lang="en">
                   4175: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   4176: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.75      rillig   4177: <div class="toc">
                   4178: <p><b>Table of Contents</b></p>
                   4179: <dl>
1.116   ! rillig   4180: <dt><span class="sect1"><a href="#components.Makefile">11.1. Makefile</a></span></dt>
        !          4181: <dt><span class="sect1"><a href="#components.distinfo">11.2. distinfo</a></span></dt>
1.106     rillig   4182: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                   4183: <dd><dl>
                   4184: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                   4185: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                   4186: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                   4187: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                   4188: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                   4189: </dl></dd>
                   4190: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                   4191: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                   4192: <dd><dl>
                   4193: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                   4194: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                   4195: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.78      rillig   4196: </dl></dd>
1.116   ! rillig   4197: <dt><span class="sect1"><a href="#work-dir">11.6. work*</a></span></dt>
        !          4198: <dt><span class="sect1"><a href="#files-dir">11.7. files/*</a></span></dt>
1.75      rillig   4199: </dl>
                   4200: </div>
1.87      wiz      4201: <p>Whenever you're preparing a package, there are a number of
                   4202: files involved which are described in the following
                   4203: sections.</p>
1.75      rillig   4204: <div class="sect1" lang="en">
                   4205: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4206: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.93      rillig   4207: </h2></div></div></div>
1.75      rillig   4208: <p>Building, installation and creation of a binary package are all
1.87      wiz      4209:   controlled by the package's <code class="filename">Makefile</code>.
                   4210:   The <code class="filename">Makefile</code> describes various things about
                   4211:   a package, for example from where to get it, how to configure,
                   4212:   build, and install it.</p>
1.76      rillig   4213: <p>A package <code class="filename">Makefile</code> contains several
1.87      wiz      4214:   sections that describe the package.</p>
1.75      rillig   4215: <p>In the first section there are the following variables, which
1.87      wiz      4216:   should appear exactly in the order given here.  The order and
                   4217:   grouping of the variables is mostly historical and has no further
                   4218:   meaning.</p>
1.75      rillig   4219: <div class="itemizedlist"><ul type="disc">
                   4220: <li><p><code class="varname">DISTNAME</code> is the basename of the
1.87      wiz      4221:     distribution file to be downloaded from the package's
                   4222:     website.</p></li>
1.75      rillig   4223: <li><p><code class="varname">PKGNAME</code> is the name of the
1.87      wiz      4224:     package, as used by pkgsrc. You only need to provide it if
                   4225:     <code class="varname">DISTNAME</code> (which is the default) is not a good
                   4226:     name for the package in pkgsrc.  Usually it is the pkgsrc
                   4227:     directory name together with the version number. It must match the
                   4228:     regular expression
                   4229:     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
                   4230:     starts with a letter or digit, and contains only letters, digits,
                   4231:     dashes, underscores, dots and plus signs.</p></li>
                   4232: <li><p><code class="varname">SVR4_PKGNAME</code> is the name of
                   4233:     the package file to create if the <code class="varname">PKGNAME</code>
                   4234:     isn't unique on a SVR4 system. The default is
                   4235:     <code class="varname">PKGNAME</code>, which may be shortened when you use
1.91      rillig   4236:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/gensolpkg/README.html" target="_top"><code class="filename">pkgtools/gensolpkg</code></a>. Only add
1.87      wiz      4237:     <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
                   4238:     does not produce an unique package name on a SVR4 system.
                   4239:     The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
                   4240:     characters.</p></li>
1.75      rillig   4241: <li>
                   4242: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87      wiz      4243:     which the package fits in. You can choose any of the top-level
                   4244:     directories of pkgsrc for it.</p>
1.75      rillig   4245: <p>Currently the following values are available for
1.87      wiz      4246:     <code class="varname">CATEGORIES</code>. If more than
                   4247:     one is used, they need to be separated by spaces:</p>
1.75      rillig   4248: <pre class="programlisting">
1.100     rillig   4249: archivers     cross         geography     meta-pkgs     security
                   4250: audio         databases     graphics      misc          shells
                   4251: benchmarks    devel         ham           multimedia    sysutils
                   4252: biology       editors       inputmethod   net           textproc
                   4253: cad           emulators     lang          news          time
                   4254: chat          finance       mail          parallel      wm
                   4255: comms         fonts         math          pkgtools      www
                   4256: converters    games         mbone         print         x11
                   4257: </pre>
1.75      rillig   4258: </li>
1.81      rillig   4259: <li><p><code class="varname">MASTER_SITES</code>,
1.87      wiz      4260:     <code class="varname">DYNAMIC_MASTER_SITES</code>,
                   4261:     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
                   4262:     and <code class="varname">DISTFILES</code> are discussed in detail in
1.116   ! rillig   4263:     <a class="xref" href="#build.fetch" title="17.5. The fetch phase">Section 17.5, &#8220;The fetch phase&#8221;</a>.</p></li>
1.75      rillig   4264: </ul></div>
                   4265: <p>The second section contains information about separately
1.87      wiz      4266:   downloaded patches, if any.
                   4267:   </p>
1.75      rillig   4268: <div class="itemizedlist"><ul type="disc">
                   4269: <li><p><code class="varname">PATCHFILES:</code>
1.87      wiz      4270:     Name(s) of additional files that contain distribution patches.
                   4271:     There is no default. pkgsrc will look for them at
                   4272:     <code class="varname">PATCH_SITES</code>.
                   4273:     They will automatically be uncompressed before patching if
                   4274:     the names end with <code class="filename">.gz</code> or
                   4275:     <code class="filename">.Z</code>.</p></li>
1.75      rillig   4276: <li><p><code class="varname">PATCH_SITES</code>:
1.87      wiz      4277:     Primary location(s) for distribution patch files (see
                   4278:     <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
1.75      rillig   4279: </ul></div>
                   4280: <p>The third section contains the following variables.
1.87      wiz      4281:   </p>
1.75      rillig   4282: <div class="itemizedlist"><ul type="disc">
1.114     jmcneill 4283: <li><p><code class="varname">MAINTAINER</code> is the email
                   4284:     address of the person who feels responsible for this package,
                   4285:     and who is most likely to look at problems or questions regarding
                   4286:     this package which have been reported with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
                   4287:     Other developers may contact the <code class="varname">MAINTAINER</code>
                   4288:     before making changes to the package, but are not required to
                   4289:     do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
                   4290:     to yourself. If you really can't maintain the package for future
                   4291:     updates, set it to
1.110     hubertf  4292:     <code class="email">&lt;<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>&gt;</code>.</p></li>
1.114     jmcneill 4293: <li><p><code class="varname">OWNER</code> should be used instead
                   4294:     of <code class="varname">MAINTAINER</code> when you do not want other
                   4295:     developers to update or change the package without contacting
                   4296:     you first. A package Makefile should contain one of
                   4297:     <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
                   4298:     not both.  </p></li>
1.75      rillig   4299: <li><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87      wiz      4300:     find more information about the package.</p></li>
1.75      rillig   4301: <li><p><code class="varname">COMMENT</code> is a one-line
1.87      wiz      4302:     description of the package (should not include the package
                   4303:     name).</p></li>
1.75      rillig   4304: </ul></div>
                   4305: <p>Other variables that affect the build:
1.87      wiz      4306:   </p>
1.75      rillig   4307: <div class="itemizedlist"><ul type="disc"><li>
                   4308: <p><code class="varname">WRKSRC</code>: The directory where the
1.87      wiz      4309:       interesting distribution files of the package are found. The
                   4310:       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
                   4311:       works for most packages.</p>
1.75      rillig   4312: <p>If a package doesn't create a subdirectory for itself
1.87      wiz      4313:       (most GNU software does, for instance), but extracts itself in
                   4314:       the current directory, you should set
                   4315:       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
                   4316: <p>If a package doesn't create a subdirectory with the
                   4317:       name of <code class="varname">DISTNAME</code> but some different name,
                   4318:       set <code class="varname">WRKSRC</code> to point to the proper name in
                   4319:       <code class="filename">${WRKDIR}</code>, for example
                   4320:       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.91      rillig   4321:       <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/tcl/README.html" target="_top"><code class="filename">lang/tcl</code></a> and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/tk/README.html" target="_top"><code class="filename">x11/tk</code></a> for other examples.</p>
1.75      rillig   4322: <p>The name of the working directory created by pkgsrc is
1.87      wiz      4323:       taken from the <code class="varname">WRKDIR_BASENAME</code>
                   4324:       variable. By default, its value is
                   4325:       <code class="filename">work</code>. If you want to use the same
                   4326:       pkgsrc tree for building different kinds of binary packages,
                   4327:       you can change the variable according to your needs. Two
                   4328:       other variables handle common cases of setting
                   4329:       <code class="varname">WRKDIR_BASENAME</code> individually. If
                   4330:       <code class="varname">OBJHOSTNAME</code> is defined in
1.110     hubertf  4331:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.87      wiz      4332:       the host's name is attached to the directory name. If
                   4333:       <code class="varname">OBJMACHINE</code> is defined, the platform name
                   4334:       is attached, which might look like
                   4335:       <code class="filename">work.i386</code> or
                   4336:       <code class="filename">work.sparc</code>.</p>
1.75      rillig   4337: </li></ul></div>
                   4338: <p>Please pay attention to the following gotchas:</p>
                   4339: <div class="itemizedlist"><ul type="disc">
1.87      wiz      4340: <li><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88      wiz      4341:       installed in compressed form by the package.  For packages using
                   4342:       BSD-style makefiles which honor MANZ, there is
                   4343:       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.76      rillig   4344: <li><p>Replace <code class="filename">/usr/local</code> with
1.88      wiz      4345:       &#8220;<span class="quote">${PREFIX}</span>&#8221; in all files (see patches,
                   4346:       below).</p></li>
1.110     hubertf  4347: <li><p>If the package installs any info files, see <a class="xref" href="#faq.info-files" title="19.6.7. Packages installing info files">Section 19.6.7, &#8220;Packages installing info files&#8221;</a>.</p></li>
1.75      rillig   4348: </ul></div>
                   4349: </div>
                   4350: <div class="sect1" lang="en">
                   4351: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4352: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.93      rillig   4353: </h2></div></div></div>
1.76      rillig   4354: <p>The <code class="filename">distinfo</code> file contains the message
1.87      wiz      4355:   digest, or checksum, of each distfile needed for the package. This
                   4356:   ensures that the distfiles retrieved from the Internet have not been
                   4357:   corrupted during transfer or altered by a malign force to introduce
                   4358:   a security hole. Due to recent rumor about weaknesses of digest
                   4359:   algorithms, all distfiles are protected using both SHA1 and RMD160
                   4360:   message digests, as well as the file size.</p>
1.76      rillig   4361: <p>The <code class="filename">distinfo</code> file also contains the
1.87      wiz      4362:   checksums for all the patches found in the
1.110     hubertf  4363:   <code class="filename">patches</code> directory (see <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a>).</p>
1.76      rillig   4364: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.110     hubertf  4365:   <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.87      wiz      4366:   command.</p>
1.75      rillig   4367: <p>Some packages have different sets of distfiles depending on
1.91      rillig   4368:   the platform, for example <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/navigator/README.html" target="_top"><code class="filename">www/navigator</code></a>). These are kept in the same
1.87      wiz      4369:   <code class="filename">distinfo</code> file and care should be taken when
                   4370:   upgrading such a package to ensure distfile information is not
                   4371:   lost.</p>
1.75      rillig   4372: </div>
                   4373: <div class="sect1" lang="en">
                   4374: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4375: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.93      rillig   4376: <p>Many packages still don't work out-of-the box on the various
                   4377:   platforms that are supported by pkgsrc. Therefore, a number of custom
                   4378:   patch files are needed to make the package work. These patch files are
                   4379:   found in the <code class="filename">patches/</code> directory.</p>
                   4380: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
                   4381:   applied to the files in <code class="varname">WRKSRC</code> directory after
1.110     hubertf  4382:   extracting them, in <a class="ulink" href="http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_13_03" target="_top">alphabetic
1.93      rillig   4383:   order</a>, so <code class="filename">patch-aa</code> is applied before
1.87      wiz      4384:   <code class="filename">patch-ab</code>, etc.</p>
1.93      rillig   4385: <div class="sect2" lang="en">
                   4386: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4387: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.76      rillig   4388: <p>The <code class="filename">patch-*</code> files should be in
1.110     hubertf  4389:   <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93      rillig   4390:   problems. (To force patches to apply with fuzz you can set
                   4391:   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94      dmcmahil 4392:   should contain only changes for a single file, and no file should be
1.93      rillig   4393:   patched by more than one patch file. This helps to keep future
                   4394:   modifications simple.</p>
                   4395: <p>Each patch file is structured as follows: In the first line,
                   4396:   there is the RCS Id of the patch itself. The second line should be
                   4397:   empty for aesthetic reasons. After that, there should be a comment for
                   4398:   each change that the patch does. There are a number of standard
                   4399:   cases:</p>
                   4400: <div class="itemizedlist"><ul type="disc">
                   4401: <li><p>Patches that replace the <code class="literal">==</code>
1.110     hubertf  4402:   operator for <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?test+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">test</span>(1)</span></a> with <code class="literal">=</code> in shell scripts
1.111     rillig   4403:   are so common that they don't need a comment at all.</p></li>
1.93      rillig   4404: <li><p>Patches for commonly known vulnerabilities should
                   4405:   mention the vulnerability ID (CAN, CVE).</p></li>
                   4406: <li><p>Patches that change source code should mention the
                   4407:   platform and other environment (for example, the compiler) that the
                   4408:   patch is needed for.</p></li>
                   4409: </ul></div>
                   4410: <p>In all other cases, the patch should be commented so that any
                   4411:   developer who knows the code of the application can make some use of
                   4412:   the patch. Special care should be taken for the upstream developers,
                   4413:   since we generally want that they accept our patches, so we have less
                   4414:   work in the future.</p>
                   4415: </div>
                   4416: <div class="sect2" lang="en">
                   4417: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4418: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.93      rillig   4419: <p>One important thing to mention is to pay attention that no RCS
                   4420:   IDs get stored in the patch files, as these will cause problems when
1.87      wiz      4421:   later checked into the NetBSD CVS tree. Use the
1.110     hubertf  4422:   <span class="command"><strong>pkgdiff</strong></span> command from the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package to avoid these
1.93      rillig   4423:   problems.</p>
1.87      wiz      4424: <p>For even more automation, we recommend using
1.110     hubertf  4425:   <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.87      wiz      4426:   whole set of patches. You just have to backup files before you
                   4427:   edit them to <code class="filename">filename.orig</code>, e.g. with
1.110     hubertf  4428:   <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
                   4429:   using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.87      wiz      4430:   you upgrade a package this way, you can easily compare the new
                   4431:   set of patches with the previously existing one with
1.110     hubertf  4432:   <span class="command"><strong>patchdiff</strong></span>. Copy the patches you want to use
1.87      wiz      4433:   or update from the <code class="filename">work/.newpatches</code>
                   4434:   directory to <code class="filename">patches/</code>.</p>
                   4435: <p>When you have finished a package, remember to generate
1.110     hubertf  4436:   the checksums for the patch files by using the <span class="command"><strong>make
1.116   ! rillig   4437:   makepatchsum</strong></span> command, see <a class="xref" href="#components.distinfo" title="11.2. distinfo">Section 11.2, &#8220;distinfo&#8221;</a>.</p>
1.87      wiz      4438: <p>When adding a patch that corrects a problem in the
                   4439:   distfile (rather than e.g. enforcing pkgsrc's view of where
                   4440:   man pages should go), send the patch as a bug report to the
                   4441:   maintainer.  This benefits non-pkgsrc users of the package,
                   4442:   and usually makes it possible to remove the patch in future
                   4443:   version.</p>
1.101     rillig   4444: <p>The file names of the patch files are usually of the form
                   4445:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>.</p>
1.93      rillig   4446: </div>
                   4447: <div class="sect2" lang="en">
                   4448: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4449: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.87      wiz      4450: <p>If you want to share patches between multiple packages
                   4451:   in pkgsrc, e.g. because they use the same distfiles, set
                   4452:   <code class="varname">PATCHDIR</code> to the path where the patch files
                   4453:   can be found, e.g.:</p>
                   4454: <pre class="programlisting">
1.100     rillig   4455: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93      rillig   4456: </pre>
1.75      rillig   4457: <p>Patch files that are distributed by the author or other
1.87      wiz      4458:     maintainers can be listed in
                   4459:     <code class="varname">PATCHFILES</code>.</p>
                   4460: <p>If it is desired to store any patches that should not be
                   4461:     committed into pkgsrc, they can be kept outside the pkgsrc
                   4462:     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
                   4463:     directory tree there is expected to have the same
                   4464:     &#8220;<span class="quote">category/package</span>&#8221; structure as pkgsrc, and
                   4465:     patches are expected to be stored inside these dirs (also
                   4466:     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
                   4467:     example, if you want to keep a private patch for
                   4468:     <code class="filename">pkgsrc/graphics/png</code>, keep it in
                   4469:     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
                   4470:     files in the named directory are expected to be patch files,
                   4471:     and <span class="emphasis"><em>they are applied after pkgsrc patches are
                   4472:     applied</em></span>.</p>
1.93      rillig   4473: </div>
1.85      jmmv     4474: <div class="sect2" lang="en">
                   4475: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4476: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.85      jmmv     4477: <p>When fixing a portability issue in the code do not use
                   4478:       preprocessor magic to check for the current operating system nor
                   4479:       platform.  Doing so hurts portability to other platforms because
                   4480:       the OS-specific details are not abstracted appropriately.</p>
                   4481: <p>The general rule to follow is: instead of checking for the
                   4482:       operating system the application is being built on, check for the
                   4483:       specific <span class="emphasis"><em>features</em></span> you need.  For example,
                   4484:       instead of assuming that kqueue is available under NetBSD and
                   4485:       using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.114     jmcneill 4486:       kqueue support, add a check that detects kqueue itself &mdash;
1.85      jmmv     4487:       yes, this generally involves patching the
1.110     hubertf  4488:       <span class="command"><strong>configure</strong></span> script.  There is absolutely nothing
1.85      jmmv     4489:       that prevents some OSes from adopting interfaces from other OSes
                   4490:       (e.g. Linux implementing kqueue), something that the above checks
                   4491:       cannot take into account.</p>
                   4492: <p>Of course, checking for features generally involves more
                   4493:       work on the developer's side, but the resulting changes are
1.87      wiz      4494:       cleaner and there are chances they will work on many other
1.85      jmmv     4495:       platforms.  Not to mention that there are higher chances of being
                   4496:       later integrated into the mainstream sources.  Remember:
                   4497:       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
                   4498: <p>Some typical examples:</p>
                   4499: <div class="table">
1.106     rillig   4500: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.91      rillig   4501: <div class="table-contents"><table summary="Patching examples" border="1">
1.85      jmmv     4502: <colgroup>
                   4503: <col>
                   4504: <col>
                   4505: <col>
                   4506: </colgroup>
                   4507: <thead><tr>
                   4508: <th>Where</th>
                   4509: <th>Incorrect</th>
                   4510: <th>Correct</th>
                   4511: </tr></thead>
                   4512: <tbody>
                   4513: <tr>
                   4514: <td>configure script</td>
                   4515: <td>
1.100     rillig   4516: <pre class="programlisting">
                   4517: case ${target_os} in
                   4518: netbsd*) have_kvm=yes ;;
                   4519: *)       have_kvm=no  ;;
                   4520: esac
                   4521: </pre>
1.85      jmmv     4522:              </td>
                   4523: <td>
1.100     rillig   4524: <pre class="programlisting">
                   4525: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
                   4526: </pre>
1.85      jmmv     4527:              </td>
                   4528: </tr>
                   4529: <tr>
                   4530: <td>C source file</td>
                   4531: <td>
1.100     rillig   4532: <pre class="programlisting">
                   4533: #if defined(__NetBSD__)
                   4534: #  include &lt;sys/event.h&gt;
                   4535: #endif
                   4536: </pre>
1.85      jmmv     4537:              </td>
                   4538: <td>
1.100     rillig   4539: <pre class="programlisting">
                   4540: #if defined(HAVE_SYS_EVENT_H)
                   4541: #  include &lt;sys/event.h&gt;
                   4542: #endif
                   4543: </pre>
1.85      jmmv     4544:              </td>
                   4545: </tr>
                   4546: <tr>
                   4547: <td>C source file</td>
                   4548: <td>
1.100     rillig   4549: <pre class="programlisting">
                   4550: int
                   4551: monitor_file(...)
                   4552: {
                   4553: #if defined(__NetBSD__)
                   4554:         int fd = kqueue();
                   4555:         ...
                   4556: #else
                   4557:         ...
                   4558: #endif
                   4559: }
                   4560: </pre>
1.85      jmmv     4561:              </td>
                   4562: <td>
1.100     rillig   4563: <pre class="programlisting">
                   4564: int
                   4565: monitor_file(...)
                   4566: {
                   4567: #if defined(HAVE_KQUEUE)
                   4568:         int fd = kqueue();
                   4569:         ...
                   4570: #else
                   4571:        ...
                   4572: #endif
                   4573: }
                   4574: </pre>
1.85      jmmv     4575:              </td>
                   4576: </tr>
                   4577: </tbody>
1.91      rillig   4578: </table></div>
1.85      jmmv     4579: </div>
1.91      rillig   4580: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.110     hubertf  4581:       packager-friendly software</em></span> article (<a class="ulink" href="http://www.onlamp.com/pub/a/onlamp/2005/03/31/packaging.html" target="_top">part
                   4582:       1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.85      jmmv     4583:       2</a>).  It summarizes multiple details on how to make
                   4584:       software easier to package; all the suggestions in it were
                   4585:       collected from our experience in pkgsrc work, so they are possibly
                   4586:       helpful when creating patches too.</p>
                   4587: </div>
                   4588: <div class="sect2" lang="en">
                   4589: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4590: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.85      jmmv     4591: <p>Always, always, <span class="strong"><strong>always</strong></span>
                   4592:       feed back any <span class="emphasis"><em>portability fixes</em></span> or
                   4593:       improvements you do to a package to the mainstream developers.
                   4594:       This is the only way to get their attention on portability issues
                   4595:       and to ensure that future versions can be built out-of-the box on
                   4596:       NetBSD.  Furthermore, any user that gets newer distfiles will get
                   4597:       the fixes straight from the packaged code.</p>
1.93      rillig   4598: <p>This generally involves cleaning up the patches
                   4599:       (because sometimes the patches that are
1.85      jmmv     4600:       added to pkgsrc are quick hacks), filling bug reports in the
                   4601:       appropriate trackers for the projects and working with the
                   4602:       mainstream authors to accept your changes.  It is
                   4603:       <span class="emphasis"><em>extremely important</em></span> that you do it so that
                   4604:       the packages in pkgsrc are kept simple and thus further changes
                   4605:       can be done without much hassle.</p>
                   4606: <p>Support the idea of free software!</p>
                   4607: </div>
1.75      rillig   4608: </div>
                   4609: <div class="sect1" lang="en">
                   4610: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4611: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.75      rillig   4612: <div class="variablelist"><dl>
1.76      rillig   4613: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75      rillig   4614: <dd><p>A multi-line description of the piece of software.  This should include
1.87      wiz      4615:          any credits where they are due.  Please bear in mind that others do not
                   4616:          share your sense of humour (or spelling idiosyncrasies), and that others
                   4617:          will read everything that you write here.</p></dd>
1.76      rillig   4618: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87      wiz      4619: <dd><p>This file governs the files that are installed on your
                   4620:          system: all the binaries, manual pages, etc. There are other
                   4621:          directives which may be entered in this file, to control the
                   4622:          creation and deletion of directories, and the location of
1.110     hubertf  4623:          inserted files.  See <a class="xref" href="#plist" title="Chapter 13. PLIST issues">Chapter 13, <i>PLIST issues</i></a> for more
1.87      wiz      4624:          information.</p></dd>
1.75      rillig   4625: </dl></div>
                   4626: </div>
                   4627: <div class="sect1" lang="en">
                   4628: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4629: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.78      rillig   4630: <div class="sect2" lang="en">
                   4631: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4632: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.75      rillig   4633: <div class="variablelist"><dl>
1.76      rillig   4634: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.110     hubertf  4635: <dd><p>This shell script is invoked twice by <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.87      wiz      4636:            First time after package extraction and before files are
                   4637:            moved in place, the second time after the files to install
                   4638:            are moved in place. This can be used to do any custom
                   4639:            procedures not possible with @exec commands in
1.110     hubertf  4640:            <code class="filename">PLIST</code>. See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
                   4641:            <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.  See also <a class="xref" href="#files-and-dirs-outside-prefix" title="15.1. Files and directories outside the installation prefix">Section 15.1, &#8220;Files and directories outside the installation prefix&#8221;</a>.</p></dd>
1.76      rillig   4642: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75      rillig   4643: <dd><p>This script is executed before and after any files are removed.  It is
1.87      wiz      4644:            this script's responsibility to clean up any additional messy details
                   4645:            around the package's installation, since all pkg_delete knows is how to
                   4646:            delete the files created in the original distribution.
1.110     hubertf  4647:            See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
                   4648:            and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.</p></dd>
1.76      rillig   4649: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75      rillig   4650: <dd>
                   4651: <p>This file is displayed after installation of the package.
1.87      wiz      4652:            Useful for things like legal notices on almost-free
                   4653:            software and hints for updating config files after
                   4654:            installing modules for apache, PHP etc.
                   4655:            Please note that you can modify variables in it easily by using
                   4656:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   4657:            <code class="filename">Makefile</code>:</p>
1.75      rillig   4658: <pre class="programlisting">
1.100     rillig   4659: MESSAGE_SUBST+=  SOMEVAR="somevalue"
                   4660: </pre>
1.75      rillig   4661: <p>replaces "${SOMEVAR}" with &#8220;<span class="quote">somevalue</span>&#8221; in
1.87      wiz      4662:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   4663:            performed for <code class="varname">PKGNAME</code>,
                   4664:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
                   4665:            <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
                   4666:            <code class="varname">X11BASE</code>,
                   4667:            <code class="varname">PKG_SYSCONFDIR</code>,
                   4668:            <code class="varname">ROOT_GROUP</code>, and
                   4669:            <code class="varname">ROOT_GROUP</code>.</p>
                   4670: <p>You can display a different or additional files by
                   4671:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   4672:            default is <code class="filename">MESSAGE</code>, if the file
                   4673:            exists.</p>
1.75      rillig   4674: </dd>
1.78      rillig   4675: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
                   4676: <dd><p>FIXME: There is no documentation on the
                   4677:        alternatives framework.</p></dd>
                   4678: </dl></div>
                   4679: </div>
                   4680: <div class="sect2" lang="en">
                   4681: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4682: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.78      rillig   4683: <div class="variablelist"><dl>
                   4684: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   4685: <dd><p>This file contains arbitrary things that could
                   4686:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   4687:        to be used by more than one package. This file should only be
                   4688:        used when the packages that will use the file are known in
                   4689:        advance. For other purposes it is often better to write a
                   4690:        <code class="filename">*.mk</code> file and give it a good name that
                   4691:        describes what it does.</p></dd>
                   4692: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   4693: <dd><p>This file contains the dependency information
1.110     hubertf  4694:        for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p></dd>
1.78      rillig   4695: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   4696: <dd><p>This file contains workarounds for compiler bugs
                   4697:        and similar things. It is included automatically by the pkgsrc
                   4698:        infrastructure, so you don't need an extra
                   4699:        <code class="literal">.include</code> line for
                   4700:        it.</p></dd>
                   4701: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   4702: <dd><p>This file contains the code for the
1.110     hubertf  4703:        package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
1.78      rillig   4704:        selected by the user. If a package has only one or two options,
                   4705:        it is equally acceptable to put the code directly into the
                   4706:        <code class="filename">Makefile</code>.</p></dd>
                   4707: </dl></div>
                   4708: </div>
                   4709: <div class="sect2" lang="en">
                   4710: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4711: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.78      rillig   4712: <div class="variablelist"><dl>
                   4713: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   4714: <dd><p>These files do not take place in the creation of
                   4715:        a package and thus are purely informative to the package
                   4716:        developer.</p></dd>
                   4717: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   4718: <dd><p>This file contains things that need to be done
                   4719:        to make the package even
                   4720:        better.</p></dd>
1.75      rillig   4721: </dl></div>
                   4722: </div>
1.78      rillig   4723: </div>
1.75      rillig   4724: <div class="sect1" lang="en">
                   4725: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4726: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.93      rillig   4727: </h2></div></div></div>
1.110     hubertf  4728: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.87      wiz      4729:     unpacked into the directory denoted by
                   4730:     <code class="varname">WRKDIR</code>. It can be removed by running
1.110     hubertf  4731:     <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.87      wiz      4732:     directory is also used to keep various timestamp files.
                   4733:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   4734:     The default is <code class="filename">${.CURDIR}/work</code>
                   4735:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   4736:     if <code class="varname">OBJMACHINE</code> is set.</p>
1.75      rillig   4737: </div>
                   4738: <div class="sect1" lang="en">
                   4739: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4740: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.93      rillig   4741: </h2></div></div></div>
1.75      rillig   4742: <p>If you have any files that you wish to be placed in the package prior
1.87      wiz      4743:     to configuration or building, you could place these files here and use
1.110     hubertf  4744:     a <span class="command"><strong>${CP}</strong></span> command in the
1.87      wiz      4745:     &#8220;<span class="quote">pre-configure</span>&#8221; target to achieve
                   4746:     this. Alternatively, you could simply diff the file against
                   4747:     <code class="filename">/dev/null</code> and use the patch mechanism to manage
                   4748:     the creation of this file.</p>
                   4749: <p>If you want to share files in this way with other
                   4750:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   4751:     to the other package's <code class="filename">files</code> directory,
                   4752:     e.g.:</p>
                   4753: <pre class="programlisting">
1.100     rillig   4754: FILESDIR=${.CURDIR}/../xemacs/files
                   4755: </pre>
1.75      rillig   4756: </div>
                   4757: </div>
                   4758: <div class="chapter" lang="en">
                   4759: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   4760: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75      rillig   4761: <div class="toc">
                   4762: <p><b>Table of Contents</b></p>
                   4763: <dl>
1.106     rillig   4764: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.116   ! rillig   4765: <dt><span class="sect1"><a href="#makefile.variables">12.2. Makefile variables</a></span></dt>
1.106     rillig   4766: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   4767: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   4768: <dd><dl>
                   4769: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                   4770: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                   4771: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                   4772: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                   4773: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
1.75      rillig   4774: </dl></dd>
                   4775: </dl>
                   4776: </div>
1.76      rillig   4777: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75      rillig   4778:   each of which forms a well-defined part of the pkgsrc system. Using
1.110     hubertf  4779:   the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.75      rillig   4780:   like pkgsrc requires some discipline to keep the code correct and
                   4781:   understandable.</p>
1.76      rillig   4782: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75      rillig   4783:   programming are variables (which are actually macros) and shell
                   4784:   commands. Among these shell commands may even be more complex ones
1.110     hubertf  4785:   like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?awk+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.75      rillig   4786:   as intended it is necessary to quote all variables correctly when they
                   4787:   are used.</p>
                   4788: <p>This chapter describes some patterns, that appear quite often in
1.76      rillig   4789:   <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75      rillig   4790:   with them.</p>
                   4791: <div class="sect1" lang="en">
                   4792: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4793: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.97      rillig   4794: <div class="itemizedlist"><ul type="disc"><li>
                   4795: <p>When you are creating a file as a
                   4796:     target of a rule, always write the data to a temporary file first
                   4797:     and finally rename that file. Otherwise there might occur an error
                   4798:     in the middle of generating the file, and when the user runs
1.110     hubertf  4799:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
1.97      rillig   4800:     regenerated properly. Example:</p>
                   4801: <pre class="programlisting">
1.100     rillig   4802: wrong:
                   4803:         @echo "line 1" &gt; ${.TARGET}
                   4804:         @echo "line 2" &gt;&gt; ${.TARGET}
                   4805:         @false
                   4806: 
                   4807: correct:
                   4808:         @echo "line 1" &gt; ${.TARGET}.tmp
                   4809:         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
                   4810:         @false
                   4811:         @mv ${.TARGET}.tmp ${.TARGET}
1.97      rillig   4812: </pre>
1.110     hubertf  4813: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.97      rillig   4814:     <code class="filename">wrong</code> will exist, although there was an error
1.110     hubertf  4815:     message in the first run. On the other hand, running <span class="command"><strong>make
1.97      rillig   4816:     correct</strong></span> gives an error message twice, as expected.</p>
1.110     hubertf  4817: <p>You might remember that <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.97      rillig   4818:     <code class="literal">${.TARGET}</code> in case of error, but this only
                   4819:     happens when it is interrupted, for example by pressing
                   4820:     <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.110     hubertf  4821:     when one of the commands fails (like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?false+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.97      rillig   4822: </li></ul></div>
                   4823: </div>
                   4824: <div class="sect1" lang="en">
                   4825: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4826: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76      rillig   4827: <p><code class="filename">Makefile</code> variables contain strings that
1.75      rillig   4828:     can be processed using the five operators ``='', ``+='', ``?='',
1.110     hubertf  4829:     ``:='', and ``!='', which are described in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.75      rillig   4830:     page.</p>
                   4831: <p>When a variable's value is parsed from a
1.76      rillig   4832:     <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75      rillig   4833:     backslash character ``\'' are handled specially. If a backslash is
                   4834:     followed by a newline, any whitespace immediately in front of the
                   4835:     backslash, the backslash, the newline, and any whitespace
                   4836:     immediately behind the newline are replaced with a single space. A
                   4837:     backslash character and an immediately following hash character are
                   4838:     replaced with a single hash character. Otherwise, the backslash is
                   4839:     passed as is. In a variable assignment, any hash character that is
                   4840:     not preceded by a backslash starts a comment that continues upto the
                   4841:     end of the logical line.</p>
                   4842: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
                   4843:     the only way to create a variable consisting of a single backslash
                   4844:     is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
                   4845: <p>So far for defining variables. The other thing you can do with
                   4846:     variables is evaluating them. A variable is evaluated when it is
                   4847:     part of the right side of the ``:='' or the ``!='' operator, or
                   4848:     directly before executing a shell command which the variable is part
1.110     hubertf  4849:     of. In all other cases, <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> performs lazy evaluation, that
1.75      rillig   4850:     is, variables are not evaluated until there's no other way. The
                   4851:     ``modifiers'' mentioned in the man page also evaluate the
                   4852:     variable.</p>
                   4853: <p>Some of the modifiers split the string into words and then
                   4854:     operate on the words, others operate on the string as a whole. When
                   4855:     a string is split into words, it is split as you would expect
1.110     hubertf  4856:     it from <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.114     jmcneill 4857: <p>No rule without exception&mdash;the <span class="command"><strong>.for</strong></span>
1.75      rillig   4858:     loop does not follow the shell quoting rules but splits at sequences
                   4859:     of whitespace.</p>
                   4860: <p>There are several types of variables that should be handled
                   4861:     differently. Strings and two types of lists.</p>
                   4862: <div class="itemizedlist"><ul type="disc">
                   4863: <li><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
                   4864:       characters. Nevertheless, you should restrict yourself to only
                   4865:       using printable characters. Examples are
                   4866:       <code class="varname">PREFIX</code> and
                   4867:       <code class="varname">COMMENT</code>.</p></li>
                   4868: <li><p><span class="emphasis"><em>Internal lists</em></span> are lists that
                   4869:       are never exported to any shell command. Their elements are
                   4870:       separated by whitespace. Therefore, the elements themselves cannot
                   4871:       have embedded whitespace. Any other characters are allowed.
1.110     hubertf  4872:       Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.75      rillig   4873:       Examples are <code class="varname">DEPENDS</code> and
                   4874:       <code class="varname">BUILD_DEPENDS</code>.</p></li>
                   4875: <li><p><span class="emphasis"><em>External lists</em></span> are lists that
                   4876:       may be exported to a shell command. Their elements can contain any
                   4877:       characters, including whitespace. That's why they cannot be used
1.110     hubertf  4878:       in <span class="command"><strong>.for</strong></span> loops. Examples are
1.75      rillig   4879:       <code class="varname">DISTFILES</code> and
                   4880:       <code class="varname">MASTER_SITES</code>.</p></li>
                   4881: </ul></div>
                   4882: <div class="sect2" lang="en">
                   4883: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4884: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.75      rillig   4885: <div class="itemizedlist"><ul type="disc">
                   4886: <li><p>All variable names starting with an underscore
                   4887:        are reserved for use by the pkgsrc infrastructure. They shall
                   4888:        not be used by package
1.76      rillig   4889:        <code class="filename">Makefile</code>s.</p></li>
1.110     hubertf  4890: <li><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.75      rillig   4891:        lowercase variable names for the iteration
                   4892:        variables.</p></li>
                   4893: <li><p>All list variables should have a ``plural''
                   4894:        name, e.g. <code class="varname">PKG_OPTIONS</code> or
                   4895:        <code class="varname">DISTFILES</code>.</p></li>
                   4896: </ul></div>
                   4897: </div>
                   4898: </div>
                   4899: <div class="sect1" lang="en">
                   4900: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4901: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.75      rillig   4902: <p>This section presents you with some code snippets you should
                   4903:     use in your own code. If you don't find anything appropriate here,
                   4904:     you should test your code and add it here.</p>
                   4905: <div class="sect2" lang="en">
                   4906: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4907: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.75      rillig   4908: <pre class="programlisting">
1.100     rillig   4909: STRING=                 foo * bar `date`
                   4910: INT_LIST=               # empty
                   4911: ANOTHER_INT_LIST=       apache-[0-9]*:../../www/apache
                   4912: EXT_LIST=               # empty
                   4913: ANOTHER_EXT_LIST=       a=b c=d
                   4914: 
                   4915: INT_LIST+=              ${STRING}               # 1
                   4916: INT_LIST+=              ${ANOTHER_INT_LIST}     # 2
                   4917: EXT_LIST+=              ${STRING:Q}             # 3
                   4918: EXT_LIST+=              ${ANOTHER_EXT_LIST}     # 4
1.1       grant    4919: </pre>
1.75      rillig   4920: <p>When you add a string to an external list (example 3), it
                   4921:       must be quoted. In all other cases, you must not add a quoting
                   4922:       level. You must not merge internal and external lists, unless you
                   4923:       are sure that all entries are correctly interpreted in both
                   4924:       lists.</p>
                   4925: </div>
                   4926: <div class="sect2" lang="en">
                   4927: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4928: <a name="converting-internal-to-external"></a>12.3.2. Converting an internal list into an external list</h3></div></div></div>
1.75      rillig   4929: <pre class="programlisting">
1.100     rillig   4930: EXT_LIST=       # empty
                   4931: .for i in ${INT_LIST}
                   4932: EXT_LIST+=      ${i:Q}""
                   4933: .endfor
1.1       grant    4934: </pre>
1.75      rillig   4935: <p>This code converts the internal list
                   4936:       <code class="varname">INT_LIST</code> into the external list
                   4937:       <code class="varname">EXT_LIST</code>. As the elements of an internal list
                   4938:       are unquoted they must be quoted here. The reason for appending
                   4939:       <code class="varname">""</code> is explained below.</p>
                   4940: </div>
                   4941: <div class="sect2" lang="en">
                   4942: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4943: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.79      rillig   4944: <p>Sometimes you may want to print an arbitrary string. There
                   4945:        are many ways to get it wrong and only few that can handle every
                   4946:        nastiness.</p>
1.75      rillig   4947: <pre class="programlisting">
1.100     rillig   4948: STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
                   4949: EXT_LIST=       string=${STRING:Q} x=second\ item
1.1       grant    4950: 
1.100     rillig   4951: all:
                   4952:         echo ${STRING}                  # 1
                   4953:         echo "${STRING}"                # 2
                   4954:         echo "${STRING:Q}"              # 3
                   4955:         echo ${STRING:Q}                # 4
                   4956:         echo x${STRING:Q} | sed 1s,.,,  # 5
                   4957:         printf "%s\\n" ${STRING:Q}""    # 6
                   4958:         env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
1.1       grant    4959: </pre>
1.75      rillig   4960: <p>Example 1 leads to a syntax error in the shell, as the
                   4961:       characters are just copied.</p>
                   4962: <p>Example 2 leads to a syntax error too, and if you leave out
                   4963:       the last " character from <code class="varname">${STRING}</code>,
1.110     hubertf  4964:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?date+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">date</span>(1)</span></a> will be executed. The <code class="varname">$HOME</code> shell
1.75      rillig   4965:       variable would be evaluated, too.</p>
                   4966: <p>Example 3 outputs each space character preceded by a
                   4967:       backslash (or not), depending on the implementation of the
1.110     hubertf  4968:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command.</p>
1.75      rillig   4969: <p>Example 4 handles correctly every string that does not start
                   4970:       with a dash. In that case, the result depends on the
1.110     hubertf  4971:       implementation of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command. As long as you can
1.75      rillig   4972:       guarantee that your input does not start with a dash, this form is
                   4973:       appropriate.</p>
                   4974: <p>Example 5 handles even the case of a leading dash
                   4975:       correctly.</p>
1.79      rillig   4976: <p>Example 6 also works with every string and is the
                   4977:       light-weight solution, since it does not involve a pipe, which has
                   4978:       its own problems.</p>
1.75      rillig   4979: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
                   4980:       because the quoting has already been done when adding elements to
                   4981:       the list.</p>
                   4982: <p>As internal lists shall not be passed to the shell, there is
                   4983:       no example for it.</p>
                   4984: </div>
                   4985: <div class="sect2" lang="en">
                   4986: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4987: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.75      rillig   4988: <p>There are many possible sources of wrongly quoted variables.
                   4989:       This section lists some of the commonly known ones.</p>
                   4990: <div class="itemizedlist"><ul type="disc">
                   4991: <li>
                   4992: <p>Whenever you use the value of a list, think
                   4993:        about what happens to leading or trailing whitespace. If the
                   4994:        list is a well-formed shell expression, you can apply the
                   4995:        <code class="varname">:M*</code> modifier to strip leading and trailing
                   4996:        whitespace from each word. The <code class="varname">:M</code> operator
                   4997:        first splits its argument according to the rules of the shell,
                   4998:        and then creates a new list consisting of all words that match
                   4999:        the shell glob expression <code class="varname">*</code>, that is: all.
                   5000:        One class of situations where this is needed is when adding a
                   5001:        variable like <code class="varname">CPPFLAGS</code> to
                   5002:        <code class="varname">CONFIGURE_ARGS</code>. If the configure script
                   5003:        invokes other configure scripts, it strips the leading and
                   5004:        trailing whitespace from the variable and then passes it to the
                   5005:        other configure scripts. But these configure scripts expect the
                   5006:        (child) <code class="varname">CPPFLAGS</code> variable to be the same as
                   5007:        the parent <code class="varname">CPPFLAGS</code>. That's why we better
                   5008:        pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
                   5009:        here is how we do it:</p>
                   5010: <pre class="programlisting">
1.100     rillig   5011: CPPFLAGS=               # empty
                   5012: CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX:Q}\"
                   5013: CPPFLAGS+=              ${MY_CPPFLAGS}
                   5014: 
                   5015: CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
                   5016: 
                   5017: all:
                   5018:         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
                   5019:         echo x${CONFIGURE_ARGS}x        # properly trimmed
1.1       grant    5020: </pre>
1.75      rillig   5021: </li>
                   5022: <li><p>The example above contains one bug: The
                   5023:        <code class="varname">${PREFIX}</code> is a properly quoted shell
                   5024:        expression, but there is the C compiler after it, which also
                   5025:        expects a properly quoted string (this time in C syntax). The
                   5026:        version above is therefore only correct if
                   5027:        <code class="varname">${PREFIX}</code> does not have embedded backslashes
                   5028:        or double quotes. If you want to allow these, you have to add
                   5029:        another layer of quoting to each variable that is used as a C
                   5030:        string literal. You cannot use the <code class="varname">:Q</code>
                   5031:        operator for it, as this operator only works for the
                   5032:        shell.</p></li>
                   5033: <li>
                   5034: <p>Whenever a variable can be empty, the
                   5035:        <code class="varname">:Q</code> operator can have surprising results. Here
                   5036:        are two completely different cases which can be solved with the
                   5037:        same trick.</p>
                   5038: <pre class="programlisting">
1.100     rillig   5039: EMPTY=                  # empty
                   5040: empty_test:
                   5041:         for i in a ${EMPTY:Q} c; do \
                   5042:             echo "$$i"; \
                   5043:         done
                   5044: 
                   5045: for_test:
                   5046: .for i in a:\ a:\test.txt
                   5047:         echo ${i:Q}
                   5048:         echo "foo"
                   5049: .endfor
1.1       grant    5050: </pre>
1.75      rillig   5051: <p>The first example will only print two of the three lines
                   5052:        we might have expected. This is because
                   5053:        <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
                   5054:        the shell cannot see. The workaround is to write
                   5055:        <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
                   5056:        as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
                   5057:        -f ${FNAME:Q}</code> (both of these are wrong).</p>
                   5058: <p>The second example will only print three lines instead of
                   5059:        four. The first line looks like <code class="varname">a:\ echo foo</code>.
                   5060:        This is because the backslash of the value
                   5061:        <code class="varname">a:\</code> is interpreted as a line-continuation by
1.110     hubertf  5062:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, which makes the second line the arguments of the
                   5063:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command from the first line. To avoid this, write
1.75      rillig   5064:        <code class="varname">${i:Q}""</code>.</p>
                   5065: </li>
                   5066: </ul></div>
                   5067: </div>
                   5068: <div class="sect2" lang="en">
                   5069: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5070: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.75      rillig   5071: <p>The pkgsrc bmake program does not handle the following
                   5072:       assignment correctly. In case <code class="varname">_othervar_</code>
                   5073:       contains a ``-'' character, one of the closing braces is included
                   5074:       in <code class="varname">${VAR}</code> after this code executes.</p>
                   5075: <pre class="programlisting">
1.100     rillig   5076: VAR:=   ${VAR:N${_othervar_:C/-//}}
1.1       grant    5077: </pre>
1.75      rillig   5078: <p>For a more complex code snippet and a workaround, see the
1.91      rillig   5079:       package <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/regress/make-quoting/README.html" target="_top"><code class="filename">regress/make-quoting</code></a>, testcase
1.75      rillig   5080:       <code class="varname">bug1</code>.</p>
                   5081: </div>
                   5082: </div>
                   5083: </div>
                   5084: <div class="chapter" lang="en">
                   5085: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   5086: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.75      rillig   5087: <div class="toc">
                   5088: <p><b>Table of Contents</b></p>
                   5089: <dl>
1.106     rillig   5090: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.116   ! rillig   5091: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic PLIST generation</a></span></dt>
        !          5092: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of make print-PLIST</a></span></dt>
1.106     rillig   5093: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   5094: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.116   ! rillig   5095: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with PLIST_SRC</a></span></dt>
1.106     rillig   5096: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
                   5097: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
1.75      rillig   5098: </dl>
                   5099: </div>
1.87      wiz      5100: <p>The <code class="filename">PLIST</code> file contains a package's
                   5101:   &#8220;<span class="quote">packing list</span>&#8221;, i.e. a list of files that belong to
                   5102:   the package (relative to the <code class="filename">${PREFIX}</code>
                   5103:   directory it's been installed in) plus some additional statements
1.110     hubertf  5104:   - see the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.87      wiz      5105:   This chapter addresses some issues that need attention when
                   5106:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   5107:   below!).</p>
1.75      rillig   5108: <div class="sect1" lang="en">
                   5109: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5110: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.87      wiz      5111: <p>Be sure to add a RCS ID line as the first thing in any
                   5112:     <code class="filename">PLIST</code> file you write:</p>
1.75      rillig   5113: <pre class="programlisting">
1.100     rillig   5114: @comment $NetBSD$
1.87      wiz      5115:     </pre>
1.75      rillig   5116: </div>
                   5117: <div class="sect1" lang="en">
                   5118: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5119: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.110     hubertf  5120: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.87      wiz      5121:     to output a PLIST that matches any new files since the package
1.110     hubertf  5122:     was extracted.  See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, &#8220;Other helpful targets&#8221;</a> for
1.87      wiz      5123:     more information on this target.</p>
1.75      rillig   5124: </div>
                   5125: <div class="sect1" lang="en">
                   5126: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110     hubertf  5127: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.93      rillig   5128: </h2></div></div></div>
1.87      wiz      5129: <p>If you have used any of the *-dirs packages, as explained in
1.110     hubertf  5130:     <a class="xref" href="#faq.common-dirs" title="13.8. Sharing directories between packages">Section 13.8, &#8220;Sharing directories between packages&#8221;</a>, you may have noticed that
                   5131:     <span class="command"><strong>make print-PLIST</strong></span> outputs a set of
1.87      wiz      5132:     <code class="varname">@comment</code>s instead of real
                   5133:     <code class="varname">@dirrm</code> lines.  You can also do this for
                   5134:     specific directories and files, so that the results of that
                   5135:     command are very close to reality. This helps <span class="emphasis"><em>a
                   5136:     lot</em></span> during the update of packages.</p>
                   5137: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   5138:     of AWK patterns and actions that are used to filter the output of
                   5139:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   5140:     scripting you like to it, but be careful with quoting.</p>
                   5141: <p>For example, to get all files inside the
                   5142:     <code class="filename">libdata/foo</code> directory removed from the
                   5143:     resulting PLIST:</p>
                   5144: <pre class="programlisting">
1.100     rillig   5145: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
1.87      wiz      5146:     </pre>
                   5147: <p>And to get all the <code class="varname">@dirrm</code> lines referring
                   5148:     to a specific (shared) directory converted to
                   5149:     <code class="varname">@comment</code>s:</p>
1.75      rillig   5150: <pre class="programlisting">
1.100     rillig   5151: PRINT_PLIST_AWK+=       /^@dirrm share\/specific/ { print "@comment " $$0; next; }
1.87      wiz      5152:     </pre>
1.75      rillig   5153: </div>
                   5154: <div class="sect1" lang="en">
                   5155: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5156: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.87      wiz      5157: <p>A number of variables are substituted automatically in
                   5158:     PLISTs when a package is installed on a system. This includes the
                   5159:     following variables:</p>
1.75      rillig   5160: <div class="variablelist"><dl>
                   5161: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   5162: <dd>
                   5163: <p>Some packages like emacs and perl embed information
1.87      wiz      5164:          about which architecture they were built on into the
                   5165:          pathnames where they install their files. To handle this
                   5166:          case, PLIST will be preprocessed before actually used, and
                   5167:          the symbol
                   5168:          &#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221; will be
1.110     hubertf  5169:          replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.87      wiz      5170:          same is done if the string
                   5171:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   5172:          PLIST somewhere - use this on packages that have GNU
                   5173:          autoconf-created configure scripts.</p>
1.75      rillig   5174: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   5175: <h3 class="title">Legacy note</h3>
                   5176: <p>There used to be a symbol
1.87      wiz      5177:            &#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221; that
1.110     hubertf  5178:            was replaced by the output of <span class="command"><strong>uname
1.87      wiz      5179:            -m</strong></span>, but that's no longer supported and has
                   5180:            been removed.</p>
1.75      rillig   5181: </div>
                   5182: </dd>
                   5183: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   5184: <dd>
                   5185: <p>Some packages want to embed the OS name and version
1.87      wiz      5186:          into some paths.  To do this, use these variables in the
                   5187:          <code class="filename">PLIST</code>:
                   5188:          </p>
1.75      rillig   5189: <div class="itemizedlist"><ul type="disc">
1.110     hubertf  5190: <li><p><code class="varname">${OPSYS}</code> - output of &#8220;<span class="quote"><span class="command"><strong>uname -s</strong></span></span>&#8221;</p></li>
1.75      rillig   5191: <li><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. &#8220;<span class="quote">solaris</span>&#8221;)</p></li>
1.110     hubertf  5192: <li><p><code class="varname">${OS_VERSION}</code> - &#8220;<span class="quote"><span class="command"><strong>uname -r</strong></span></span>&#8221;</p></li>
1.75      rillig   5193: </ul></div>
                   5194: </dd>
                   5195: </dl></div>
1.87      wiz      5196: <p>For a complete list of values which are replaced by
                   5197:     default, please look in <code class="filename">bsd.pkg.mk</code> (and
                   5198:     search for <code class="varname">PLIST_SUBST</code>).</p>
                   5199: <p>If you want to change other variables not listed above, you
                   5200:     can add variables and their expansions to this variable in the
1.110     hubertf  5201:     following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a class="xref" href="#components.optional" title="11.5. Optional files">Section 11.5, &#8220;Optional files&#8221;</a>):</p>
1.75      rillig   5202: <pre class="programlisting">
1.100     rillig   5203: PLIST_SUBST+=   SOMEVAR="somevalue"
1.87      wiz      5204:     </pre>
1.75      rillig   5205: <p>This replaces all occurrences of &#8220;<span class="quote">${SOMEVAR}</span>&#8221;
1.87      wiz      5206:     in the <code class="filename">PLIST</code> with
                   5207:     &#8220;<span class="quote">somevalue</span>&#8221;.</p>
1.75      rillig   5208: </div>
                   5209: <div class="sect1" lang="en">
                   5210: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5211: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.75      rillig   5212: <p>Man pages should be installed in compressed form if
1.87      wiz      5213:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   5214:     and uncompressed otherwise. To handle this in the
                   5215:     <code class="filename">PLIST</code> file, the suffix &#8220;<span class="quote">.gz</span>&#8221; is
                   5216:     appended/removed automatically for man pages according to
                   5217:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   5218:     or not, see above for details. This modification of the
                   5219:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   5220:     <code class="filename">PLIST</code> itself.</p>
1.75      rillig   5221: </div>
                   5222: <div class="sect1" lang="en">
                   5223: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5224: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.93      rillig   5225: </h2></div></div></div>
1.76      rillig   5226: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87      wiz      5227:     in generating the binary package, set the variable
                   5228:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.110     hubertf  5229:     The files are later concatenated using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cat+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.87      wiz      5230:     important. The default for <code class="varname">PLIST_SRC</code> is
                   5231:     <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75      rillig   5232: </div>
                   5233: <div class="sect1" lang="en">
                   5234: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5235: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75      rillig   5236: <p>Some packages decide to install a different set of files based on
1.87      wiz      5237:     the operating system being used. These differences can be
                   5238:     automatically handled by using the following files:</p>
1.75      rillig   5239: <div class="itemizedlist"><ul type="disc">
1.76      rillig   5240: <li><p><code class="filename">PLIST.common</code></p></li>
                   5241: <li><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   5242: <li><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   5243: <li><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   5244: <li><p><code class="filename">PLIST.common_end</code></p></li>
1.75      rillig   5245: </ul></div>
                   5246: </div>
                   5247: <div class="sect1" lang="en">
                   5248: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5249: <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
1.87      wiz      5250: <p>A &#8220;<span class="quote">shared directory</span>&#8221; is a directory where
                   5251:     multiple (and unrelated) packages install files.  These
                   5252:     directories are problematic because you have to add special tricks
                   5253:     in the PLIST to conditionally remove them, or have some
                   5254:     centralized package handle them.</p>
                   5255: <p>Within pkgsrc, you'll find both approaches.  If a directory
                   5256:     is shared by a few unrelated packages, it's often not worth to add
                   5257:     an extra package to remove it.  Therefore, one simply does:</p>
                   5258: <pre class="programlisting">
1.100     rillig   5259: @unexec ${RMDIR} %D/path/to/shared/directory 2&gt;/dev/null || ${TRUE}
1.87      wiz      5260:     </pre>
                   5261: <p>in the PLISTs of all affected packages, instead of the
                   5262:     regular "@dirrm" line.</p>
                   5263: <p>However, if the directory is shared across many packages, two
                   5264:     different solutions are available:</p>
1.75      rillig   5265: <div class="orderedlist"><ol type="1">
1.87      wiz      5266: <li><p>If the packages have a common dependency, the directory
                   5267:        can be removed in that.  For example, see
1.91      rillig   5268:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/scrollkeeper/README.html" target="_top"><code class="filename">textproc/scrollkeeper</code></a>, which
1.87      wiz      5269:        removes the shared directory
                   5270:        <code class="filename">share/omf</code>.</p></li>
                   5271: <li><p>If the packages using the directory are not related at
                   5272:        all (they have no common dependencies), a *-dirs package is
                   5273:        used.</p></li>
1.75      rillig   5274: </ol></div>
1.87      wiz      5275: <p>From now on, we'll discuss the second solution.  To get an
                   5276:     idea of the *-dirs packages available, issue:</p>
1.75      rillig   5277: <pre class="programlisting">
1.100     rillig   5278: <code class="prompt">%</code> cd .../pkgsrc
                   5279: <code class="prompt">%</code> ls -d */*-dirs
1.87      wiz      5280:     </pre>
                   5281: <p>Their use from other packages is very simple.  The
                   5282:     <code class="varname">USE_DIRS</code> variable takes a list of package names
                   5283:     (without the &#8220;<span class="quote">-dirs</span>&#8221; part) together with the required
                   5284:     version number (always pick the latest one when writing new
                   5285:     packages).</p>
                   5286: <p>For example, if a package installs files under
                   5287:     <code class="filename">share/applications</code>, it should have the
                   5288:     following line in it:</p>
                   5289: <pre class="programlisting">
1.100     rillig   5290: USE_DIRS+=      xdg-1.1
1.87      wiz      5291:     </pre>
1.110     hubertf  5292: <p>After regenerating the PLIST using <span class="command"><strong>make
1.87      wiz      5293:     print-PLIST</strong></span>, you should get the right (commented out)
                   5294:     lines.</p>
                   5295: <p>Note that even if your package is using
                   5296:     <code class="filename">$X11BASE</code>, it must not depend on the
                   5297:     *-x11-dirs packages.  Just specify the name without that part and
                   5298:     pkgsrc (in particular, <code class="filename">mk/dirs.mk</code>) will take
                   5299:     care of it.</p>
1.75      rillig   5300: </div>
                   5301: </div>
                   5302: <div class="chapter" lang="en">
                   5303: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   5304: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.75      rillig   5305: <div class="toc">
                   5306: <p><b>Table of Contents</b></p>
                   5307: <dl>
1.106     rillig   5308: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.116   ! rillig   5309: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing buildlink3.mk files</a></span></dt>
1.75      rillig   5310: <dd><dl>
1.106     rillig   5311: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.116   ! rillig   5312: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating BUILDLINK_API_DEPENDS.pkg in buildlink3.mk files</a></span></dt>
1.75      rillig   5313: </dl></dd>
1.116   ! rillig   5314: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing builtin.mk files</a></span></dt>
1.75      rillig   5315: <dd><dl>
1.116   ! rillig   5316: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a builtin.mk file</a></span></dt>
1.106     rillig   5317: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.75      rillig   5318: </dl></dd>
                   5319: </dl>
                   5320: </div>
                   5321: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87      wiz      5322:   are seen by a package's configure and build processes.  This is implemented
                   5323:   in a two step process:</p>
1.75      rillig   5324: <div class="orderedlist"><ol type="1">
                   5325: <li><p>Symlink headers and libraries for dependencies into
1.87      wiz      5326:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   5327:       of <code class="varname">WRKDIR</code>.</p></li>
1.75      rillig   5328: <li><p>Create wrapper scripts that are used in place of the normal compiler
1.87      wiz      5329:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   5330:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   5331:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   5332:       native compiler on some operating systems look like GCC, so that
                   5333:       packages that expect GCC won't require modifications to build with
                   5334:       those native compilers.</p></li>
1.75      rillig   5335: </ol></div>
                   5336: <p>This normalizes the environment in which a package is built so that the
1.87      wiz      5337:   package may be built consistently despite what other software may be
                   5338:   installed. Please note that the normal system header and library paths,
                   5339:   e.g. <code class="filename">/usr/include</code>,
                   5340:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   5341:   designed to insulate the package build from non-system-supplied
                   5342:   software.</p>
1.75      rillig   5343: <div class="sect1" lang="en">
                   5344: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5345: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.75      rillig   5346: <p>The process of converting packages to use the buildlink3
1.87      wiz      5347:     framework (&#8220;<span class="quote">bl3ifying</span>&#8221;) is fairly straightforward.
                   5348:     The things to keep in mind are:</p>
1.75      rillig   5349: <div class="orderedlist"><ol type="1">
1.87      wiz      5350: <li><p>Ensure that the build always calls the wrapper scripts
                   5351:        instead of the actual toolchain.  Some packages are tricky,
                   5352:        and the only way to know for sure is the check
                   5353:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   5354:        wrappers are being invoked.</p></li>
                   5355: <li><p>Don't override <code class="varname">PREFIX</code> from within
                   5356:        the package Makefile, e.g. Java VMs, standalone shells,
                   5357:        etc., because the code to symlink files into
                   5358:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
                   5359:        relative to &#8220;<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>&#8221;.
                   5360:        </p></li>
                   5361: <li><p>Remember that <span class="emphasis"><em>only</em></span> the
                   5362:        <code class="filename">buildlink3.mk</code> files that you list in a
                   5363:        package's Makefile are added as dependencies for that package.
                   5364:        </p></li>
1.75      rillig   5365: </ol></div>
1.87      wiz      5366: <p>If a dependency on a particular package is required for its libraries and
                   5367:     headers, then we replace:</p>
1.75      rillig   5368: <pre class="programlisting">
1.100     rillig   5369: DEPENDS+=       foo&gt;=1.1.0:../../category/foo
                   5370: </pre>
1.75      rillig   5371: <p>with</p>
                   5372: <pre class="programlisting">
1.100     rillig   5373: .include "../../category/foo/buildlink3.mk"
                   5374: </pre>
1.75      rillig   5375: <p>The buildlink3.mk files usually define the required dependencies.
                   5376:     If you need a newer version of the dependency when using buildlink3.mk
1.87      wiz      5377:     files, then you can define it in your Makefile; for example:</p>
1.75      rillig   5378: <pre class="programlisting">
1.100     rillig   5379: BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
                   5380: .include "../../category/foo/buildlink3.mk"
                   5381: </pre>
1.76      rillig   5382: <p>There are several <code class="filename">buildlink3.mk</code>
1.87      wiz      5383:     files in <code class="filename">pkgsrc/mk</code>
                   5384:     that handle special package issues:</p>
1.75      rillig   5385: <div class="itemizedlist"><ul type="disc">
1.76      rillig   5386: <li><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87      wiz      5387:        the native or a pkgsrc Berkeley DB implementation based on
                   5388:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   5389:        <code class="varname">BDB_DEFAULT</code>.</p></li>
1.76      rillig   5390: <li><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87      wiz      5391:        comes with neither Curses nor NCurses, this will take care
1.91      rillig   5392:        to install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/ncurses/README.html" target="_top"><code class="filename">devel/ncurses</code></a> package.</p></li>
1.76      rillig   5393: <li><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87      wiz      5394:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   5395:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   5396:        require a Kerberos 5 implementation.</p></li>
1.88      wiz      5397: <li><p><code class="filename">motif.buildlink3.mk</code> checks for a
                   5398:        system-provided Motif installation or adds a dependency on
1.91      rillig   5399:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/README.html" target="_top"><code class="filename">x11/lesstif</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/openmotif/README.html" target="_top"><code class="filename">x11/openmotif</code></a>.  The user can set
1.88      wiz      5400:        <code class="varname">MOTIF_TYPE</code> to &#8220;<span class="quote">dt</span>&#8221;,
                   5401:        &#8220;<span class="quote">lesstif</span>&#8221;, or &#8220;<span class="quote">openmotif</span>&#8221; to choose
                   5402:        which Motif version will be used.</p></li>
1.76      rillig   5403: <li><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87      wiz      5404:        variables that may be used by packages that use the
                   5405:        Open Sound System (OSS) API.</p></li>
1.76      rillig   5406: <li><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.93      rillig   5407:        either Postgres 8.0, 8.1, or 8.2, whichever is found installed. See
1.87      wiz      5408:        the file for more information.</p></li>
1.76      rillig   5409: <li><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87      wiz      5410:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.91      rillig   5411:        a dependency on <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/pth/README.html" target="_top"><code class="filename">devel/pth</code></a> as needed.</p></li>
1.76      rillig   5412: <li><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87      wiz      5413:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   5414:        library.</p></li>
1.75      rillig   5415: </ul></div>
1.76      rillig   5416: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87      wiz      5417:     files provide a more complete
                   5418:     description of how to use them properly.</p>
1.75      rillig   5419: </div>
                   5420: <div class="sect1" lang="en">
                   5421: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5422: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.107     rillig   5423: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.87      wiz      5424:     included by Makefiles to indicate the need to compile and link
                   5425:     against header files and libraries provided by the package.  A
                   5426:     <code class="filename">buildlink3.mk</code> file should always provide
                   5427:     enough information to add the correct type of dependency
                   5428:     relationship and include any other
                   5429:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   5430:     headers and libraries that it needs in turn.</p>
                   5431: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.91      rillig   5432:     file for further editing, Rene Hexel's <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/createbuildlink/README.html" target="_top"><code class="filename">pkgtools/createbuildlink</code></a>
1.87      wiz      5433:     package is highly recommended.  For most packages, the following
                   5434:     command will generate a good starting point for
                   5435:     <code class="filename">buildlink3.mk</code> files:</p>
                   5436: <pre class="screen">
                   5437: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   5438: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   5439:     </pre>
1.75      rillig   5440: <div class="sect2" lang="en">
                   5441: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5442: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75      rillig   5443: <p>The following real-life example
1.87      wiz      5444:       <code class="filename">buildlink3.mk</code> is taken
                   5445:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75      rillig   5446: <pre class="programlisting">
1.100     rillig   5447: # $NetBSD: buildlink3.mk,v 1.7 2004/03/18 09:12:12 jlam Exp $
1.1       grant    5448: 
1.100     rillig   5449: BUILDLINK_DEPTH:=       ${BUILDLINK_DEPTH}+
                   5450: TIFF_BUILDLINK3_MK:=    ${TIFF_BUILDLINK3_MK}+
1.1       grant    5451: 
1.100     rillig   5452: .if ${BUILDLINK_DEPTH} == "+"
                   5453: BUILDLINK_DEPENDS+=     tiff
                   5454: .endif
1.87      wiz      5455: 
1.100     rillig   5456: BUILDLINK_PACKAGES:=    ${BUILDLINK_PACKAGES:Ntiff}
                   5457: BUILDLINK_PACKAGES+=    tiff
1.87      wiz      5458: 
1.100     rillig   5459: .if ${TIFF_BUILDLINK3_MK} == "+"
                   5460: BUILDLINK_API_DEPENDS.tiff+=        tiff&gt;=3.6.1
                   5461: BUILDLINK_PKGSRCDIR.tiff?=      ../../graphics/tiff
                   5462: .endif  # TIFF_BUILDLINK3_MK
1.87      wiz      5463: 
1.100     rillig   5464: .include "../../devel/zlib/buildlink3.mk"
                   5465: .include "../../graphics/jpeg/buildlink3.mk"
1.87      wiz      5466: 
1.100     rillig   5467: BUILDLINK_DEPTH:=       ${BUILDLINK_DEPTH:S/+$//}
                   5468: </pre>
1.87      wiz      5469: <p>The header and footer manipulate
                   5470:       <code class="varname">BUILDLINK_DEPTH</code>, which is common across all
                   5471:       <code class="filename">buildlink3.mk</code> files and is used to track
                   5472:       at what depth we are including
                   5473:       <code class="filename">buildlink3.mk</code> files.</p>
                   5474: <p>The first section controls if the dependency on
                   5475:       <em class="replaceable"><code>pkg</code></em> is added.
                   5476:       <code class="varname">BUILDLINK_DEPENDS</code> is the global list of
                   5477:       packages for which dependencies are added by
                   5478:       buildlink3.</p>
                   5479: <p>The second section advises pkgsrc that the
                   5480:       <code class="filename">buildlink3.mk</code> file for
                   5481:       <em class="replaceable"><code>pkg</code></em> has been included at some point.
                   5482:       <code class="varname">BUILDLINK_PACKAGES</code> is the global list of
                   5483:       packages for which <code class="filename">buildlink3.mk</code> files
                   5484:       have been included.  It must <span class="emphasis"><em>always</em></span> be
                   5485:       appended to within a <code class="filename">buildlink3.mk</code>
                   5486:       file.</p>
                   5487: <p>The third section is protected from multiple inclusion
                   5488:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   5489:       added.  Several important variables are set in the section:</p>
                   5490: <div class="itemizedlist"><ul type="disc">
                   5491: <li><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5492:          is the actual dependency recorded in the installed
                   5493:          package; this should always be set using
1.110     hubertf  5494:          <span class="command"><strong>+=</strong></span> to ensure that
1.87      wiz      5495:          we're appending to any pre-existing list of values.  This
                   5496:          variable should be set to the first version of the
                   5497:          package that had an API change.
                   5498:          </p></li>
                   5499: <li><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
                   5500:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   5501:          pkgsrc directory.</p></li>
                   5502: <li><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   5503:          (not shown above) controls whether we use
                   5504:          <code class="varname">BUILD_DEPENDS</code> or
                   5505:          <code class="varname">DEPENDS</code> to add the dependency on
                   5506:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   5507:          selected by setting
                   5508:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   5509:          to &#8220;<span class="quote">build</span>&#8221;.  By default, the full dependency is
                   5510:          used.</p></li>
                   5511: <li><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5512:            and
                   5513:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   5514:            (not shown above) are lists of subdirectories of
1.76      rillig   5515:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   5516:            to add to the header and library search paths.  These
                   5517:            default to &#8220;<span class="quote">include</span>&#8221; and &#8220;<span class="quote">lib</span>&#8221;
1.87      wiz      5518:          respectively.</p></li>
                   5519: <li><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5520:            (not shown above) is the list of preprocessor flags to add
                   5521:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
                   5522:            configure and build phases.  The &#8220;<span class="quote">-I</span>&#8221; option
                   5523:            should be avoided and instead be handled using
                   5524:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87      wiz      5525:          above.</p></li>
1.75      rillig   5526: </ul></div>
1.87      wiz      5527: <p>The following variables are all optionally defined within
                   5528:       this second section (protected against multiple inclusion) and
                   5529:       control which package files are symlinked into
                   5530:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   5531:       transformed during the symlinking:</p>
1.75      rillig   5532: <div class="itemizedlist"><ul type="disc">
1.87      wiz      5533: <li><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5534:            (not shown above) is a shell glob pattern relative to
1.76      rillig   5535:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   5536:            to be symlinked into
1.76      rillig   5537:            <code class="filename">${BUILDLINK_DIR}</code>,
1.87      wiz      5538:          e.g. <code class="filename">include/*.h</code>.</p></li>
                   5539: <li><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
                   5540:            (not shown above) is a shell pipeline that
                   5541:            outputs to stdout a list of files relative to
                   5542:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   5543:            The resulting files are to be symlinked
                   5544:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   5545:            this takes the <code class="filename">+CONTENTS</code> of a
                   5546:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   5547:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
                   5548: <li><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5549:            (not shown above) is a filter command that filters
1.76      rillig   5550:            <code class="filename">+CONTENTS</code> input into a list of files
1.75      rillig   5551:            relative to
1.76      rillig   5552:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   5553:            on stdout.  By default for overwrite packages,
                   5554:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76      rillig   5555:            outputs the contents of the <code class="filename">include</code>
                   5556:            and <code class="filename">lib</code> directories in the package
                   5557:            <code class="filename">+CONTENTS</code>, and for pkgviews packages,
1.75      rillig   5558:            it outputs any libtool archives in
1.87      wiz      5559:            <code class="filename">lib</code> directories.</p></li>
1.95      tron     5560: <li><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5561:            (not shown above) is a list of sed arguments used to
                   5562:            transform the name of the source filename into a
1.110     hubertf  5563:            destination filename, e.g. <span class="command"><strong>-e
1.87      wiz      5564:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75      rillig   5565: </ul></div>
1.87      wiz      5566: <p>The last section includes any
                   5567:       <code class="filename">buildlink3.mk</code> needed for
                   5568:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   5569:       Including these <code class="filename">buildlink3.mk</code> files
                   5570:       means that the headers and libraries for these
                   5571:       dependencies are also symlinked into
                   5572:       <code class="filename">${BUILDLINK_DIR}</code>
                   5573:       whenever the <em class="replaceable"><code>pkg</code></em>
                   5574:       <code class="filename">buildlink3.mk</code>
                   5575:       file is included.</p>
1.75      rillig   5576: </div>
                   5577: <div class="sect2" lang="en">
                   5578: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5579: <a name="updating-buildlink-depends"></a>14.2.2. Updating <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code> in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
1.87      wiz      5580: <p>The situation that requires increasing the dependency listed in
1.75      rillig   5581:        <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5582:        after a package update is when the API or interface to the
1.87      wiz      5583:       header files change.</p>
                   5584: <p>In this case,
                   5585:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5586:       should be adjusted to require at least the new package
                   5587:       version.  In some cases, the packages that depend on this new
                   5588:       version may need their <code class="varname">PKGREVISION</code>s
                   5589:       increased and, if they have <code class="filename">buildlink3.mk</code>
                   5590:       files, their
                   5591:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5592:       adjusted, too.  This is needed so pkgsrc will require the
                   5593:       correct package dependency and not settle for an older one
                   5594:       when building the source.</p>
                   5595: <p><code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5596:        should be increased when the binary interface or sonames
                   5597:        (major number of the library version) of any installed
                   5598:        shared libraries change.  This is needed so that binary
                   5599:        packages made using it will require the correct package
                   5600:        dependency and not settle for an older one which will not
1.87      wiz      5601:       contain the necessary shared libraries.</p>
1.110     hubertf  5602: <p>See <a class="xref" href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, &#8220;Handling dependencies&#8221;</a> for
1.75      rillig   5603:        more information about dependencies on other packages,
                   5604:        including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87      wiz      5605:       <code class="varname">ABI_DEPENDS</code> definitions.</p>
                   5606: <p>Please take careful consideration before adjusting
                   5607:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5608:       or
                   5609:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5610:       as we don't want to cause unneeded package deletions and
                   5611:       rebuilds.  In many cases, new versions of packages work just
                   5612:       fine with older dependencies.</p>
                   5613: <p>Also it is not needed to set
1.75      rillig   5614:        <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5615:        when it is identical to
1.87      wiz      5616:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.        </p>
1.75      rillig   5617: </div>
                   5618: </div>
                   5619: <div class="sect1" lang="en">
                   5620: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5621: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87      wiz      5622: <p>Some packages in pkgsrc install headers and libraries that
1.75      rillig   5623:       coincide with headers and libraries present in the base system.
1.76      rillig   5624:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   5625:       packages should also include a <code class="filename">builtin.mk</code>
1.75      rillig   5626:       file that includes the necessary checks to decide whether using
                   5627:       the built-in software or the pkgsrc software is
1.87      wiz      5628:     appropriate.</p>
                   5629: <p>The only requirements of a builtin.mk file for
                   5630:     <em class="replaceable"><code>pkg</code></em> are:</p>
1.75      rillig   5631: <div class="orderedlist"><ol type="1">
1.87      wiz      5632: <li><p>It should set
                   5633:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5634:        to either &#8220;<span class="quote">yes</span>&#8221; or &#8220;<span class="quote">no</span>&#8221;
                   5635:        after it is included.</p></li>
                   5636: <li><p>It should <span class="emphasis"><em>not</em></span> override any
                   5637:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5638:        which is already set before the
                   5639:        <code class="filename">builtin.mk</code> file is included.</p></li>
                   5640: <li><p>It should be written to allow multiple inclusion.  This
                   5641:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   5642:        attention to <code class="filename">Makefile</code> coding.</p></li>
1.75      rillig   5643: </ol></div>
                   5644: <div class="sect2" lang="en">
                   5645: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5646: <a name="anatomy-of-builtin.mk"></a>14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
1.75      rillig   5647: <p>The following is the recommended template for builtin.mk
1.87      wiz      5648:       files:</p>
1.75      rillig   5649: <pre class="programlisting">
1.100     rillig   5650: .if !defined(IS_BUILTIN.foo)
                   5651: #
                   5652: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   5653: # genuinely exists in the system or not.
                   5654: #
                   5655: IS_BUILTIN.foo?=        no
                   5656: 
                   5657: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   5658: # version can be determined.
                   5659: #
                   5660: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   5661: BUILTIN_PKG.foo?=       foo-1.0
                   5662: .  endif
                   5663: .endif  # IS_BUILTIN.foo
                   5664: 
                   5665: .if !defined(USE_BUILTIN.foo)
                   5666: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   5667: .  if defined(BUILTIN_PKG.foo)
                   5668: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   5669: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   5670: USE_BUILTIN.foo!=                                                       \
                   5671:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
                   5672:         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
                   5673: .      endif
                   5674: .    endfor
                   5675: .  endif
                   5676: .endif  # USE_BUILTIN.foo
                   5677: 
                   5678: CHECK_BUILTIN.foo?=     no
                   5679: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   5680: #
                   5681: # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   5682: # "yes" or "no".
                   5683: #
                   5684: .endif  # CHECK_BUILTIN.foo
                   5685: </pre>
1.87      wiz      5686: <p>The first section sets
                   5687:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5688:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   5689:       in the base system.  This should not be a base system software
                   5690:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
                   5691:       it should only be &#8220;<span class="quote">yes</span>&#8221; if the actual package is
                   5692:       included as part of the base system.  This variable is only
                   5693:       used internally within the <code class="filename">builtin.mk</code>
                   5694:       file.</p>
                   5695: <p>The second section sets
                   5696:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5697:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   5698:       system if it exists (if
                   5699:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5700:       is &#8220;<span class="quote">yes</span>&#8221;).  This variable is only used internally
                   5701:       within the <code class="filename">builtin.mk</code> file.</p>
                   5702: <p>The third section sets
                   5703:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5704:       and is <span class="emphasis"><em>required</em></span> in all
                   5705:       <code class="filename">builtin.mk</code> files.  The code in this
                   5706:       section must make the determination whether the built-in
                   5707:       software is adequate to satisfy the dependencies listed in
                   5708:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5709:       This is typically done by comparing
                   5710:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5711:       against each of the dependencies in
                   5712:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5713:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5714:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   5715:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   5716:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5717:       may be &#8220;<span class="quote">yes</span>&#8221; even if
                   5718:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5719:       is &#8220;<span class="quote">no</span>&#8221; because we may make the determination
                   5720:       that the built-in version of the software is similar enough to
                   5721:       be used as a replacement.</p>
                   5722: <p>The last section is guarded by
                   5723:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   5724:       and includes code that uses the value of
                   5725:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5726:       set in the previous section.  This typically includes, e.g.,
                   5727:       adding additional dependency restrictions and listing additional
                   5728:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   5729:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75      rillig   5730: </div>
                   5731: <div class="sect2" lang="en">
                   5732: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5733: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87      wiz      5734: <p>When building packages, it's possible to choose whether to set
                   5735:        a global preference for using either the built-in (native)
                   5736:        version or the pkgsrc version of software to satisfy a
                   5737:        dependency.  This is controlled by setting
                   5738:        <code class="varname">PREFER_PKGSRC</code> and
                   5739:        <code class="varname">PREFER_NATIVE</code>.  These variables take values
                   5740:        of either &#8220;<span class="quote">yes</span>&#8221;, &#8220;<span class="quote">no</span>&#8221;, or a list of
                   5741:        packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
                   5742:        use the pkgsrc versions of software, while
                   5743:        <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
                   5744:        built-in versions.  Preferences are determined by the most
                   5745:        specific instance of the package in either
                   5746:        <code class="varname">PREFER_PKGSRC</code> or
                   5747:        <code class="varname">PREFER_NATIVE</code>.  If a package is specified
                   5748:        in neither or in both variables, then
                   5749:        <code class="varname">PREFER_PKGSRC</code> has precedence over
                   5750:        <code class="varname">PREFER_NATIVE</code>.  For example, to require
                   5751:        using pkgsrc versions of software for all but the most basic
                   5752:       bits on a NetBSD system, you can set:</p>
                   5753: <pre class="programlisting">
1.100     rillig   5754: PREFER_PKGSRC=  yes
                   5755: PREFER_NATIVE=  getopt skey tcp_wrappers
                   5756: </pre>
1.87      wiz      5757: <p>A package <span class="emphasis"><em>must</em></span> have a
                   5758:       <code class="filename">builtin.mk</code>
                   5759:       file to be listed in <code class="varname">PREFER_NATIVE</code>,
                   5760:       otherwise it is simply ignored in that list.</p>
1.75      rillig   5761: </div>
                   5762: </div>
                   5763: </div>
                   5764: <div class="chapter" lang="en">
                   5765: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   5766: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.75      rillig   5767: <div class="toc">
                   5768: <p><b>Table of Contents</b></p>
                   5769: <dl>
1.106     rillig   5770: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
1.75      rillig   5771: <dd><dl>
1.106     rillig   5772: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   5773: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.75      rillig   5774: </dl></dd>
1.106     rillig   5775: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.75      rillig   5776: <dd><dl>
1.116   ! rillig   5777: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How PKG_SYSCONFDIR is set</a></span></dt>
1.106     rillig   5778: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   5779: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   5780: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   5781: </dl></dd>
                   5782: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   5783: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">15.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
                   5784: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   5785: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   5786: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   5787: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   5788: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.75      rillig   5789: </dl>
                   5790: </div>
                   5791: <p>This chapter describes the framework known as
                   5792: <code class="literal">pkginstall</code>, whose key features are:</p>
                   5793: <div class="itemizedlist"><ul type="disc">
                   5794: <li><p>Generic installation and manipulation of directories and files
                   5795:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
                   5796: <li><p>Automatic handling of configuration files during installation,
                   5797:     provided that packages are correctly designed.</p></li>
                   5798: <li><p>Generation and installation of system startup scripts.</p></li>
                   5799: <li><p>Registration of system users and groups.</p></li>
                   5800: <li><p>Registration of system shells.</p></li>
                   5801: <li><p>Automatic updating of fonts databases.</p></li>
                   5802: </ul></div>
                   5803: <p>The following sections inspect each of the above points in detail.</p>
                   5804: <p>You may be thinking that many of the things described here could be
                   5805: easily done with simple code in the package's post-installation target
                   5806: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   5807: as the code in them is only executed when building from source.  Machines
                   5808: using binary packages could not benefit from it at all (as the code itself
                   5809: could be unavailable).  Therefore, the only way to achieve any of the items
                   5810: described above is by means of the installation scripts, which are
                   5811: automatically generated by pkginstall.</p>
                   5812: <div class="sect1" lang="en">
                   5813: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5814: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76      rillig   5815: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75      rillig   5816: of files and directories that belong to a package.  The names used in it
1.76      rillig   5817: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75      rillig   5818: which means that it cannot register files outside this directory (absolute
                   5819: path names are not allowed).  Despite this restriction, some packages need
                   5820: to install files outside this location; e.g., under
1.76      rillig   5821: <code class="filename">${VARBASE}</code> or
1.87      wiz      5822: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   5823: is to create such files during installation time by using
                   5824: installation scripts.</p>
                   5825: <p>The generic installation scripts are shell scripts that can
                   5826: contain arbitrary code.  The list of scripts to execute is taken from
                   5827: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   5828: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   5829: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   5830: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   5831: commands, so they have the potential to create and manage files
                   5832: anywhere in the file system.</p>
                   5833: <p>Using these general installation files is not recommended, but
                   5834: may be needed in some special cases.  One reason for avoiding them is
                   5835: that the user has to trust the packager that there is no unwanted or
                   5836: simply erroneous code included in the installation script. Also,
                   5837: previously there were many similar scripts for the same functionality,
                   5838: and fixing a common error involved finding and changing all of
                   5839: them.</p>
                   5840: <p>The pkginstall framework offers another, standardized way.  It
                   5841: provides generic scripts to abstract the manipulation of such files
                   5842: and directories based on variables set in the package's
                   5843: <code class="filename">Makefile</code>.  The rest of this section describes
                   5844: these variables.</p>
1.75      rillig   5845: <div class="sect2" lang="en">
                   5846: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5847: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.75      rillig   5848: <p>The following variables can be set to request the creation of
                   5849: directories anywhere in the file system:</p>
                   5850: <div class="itemizedlist"><ul type="disc">
                   5851: <li><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
                   5852:     contain a list of directories that should be created and should attempt
                   5853:     to be destroyed by the installation scripts.  The difference between
                   5854:     the two is that the latter prompts the administrator to remove any
                   5855:     directories that may be left after deinstallation (because they were
                   5856:     not empty), while the former does not.</p></li>
                   5857: <li>
                   5858: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   5859:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   5860:     which directories should be created and should attempt to be destroyed
                   5861:     by the installation scripts.  Each tuple holds the following values,
                   5862:     separated by spaces: the directory name, its owner, its group and its
                   5863:     numerical mode.  For example:</p>
                   5864: <pre class="programlisting">
1.100     rillig   5865: MAKE_DIRS_PERMS+=         ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
1.1       grant    5866: </pre>
1.75      rillig   5867: <p>The difference between the two is exactly the same as their
                   5868:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5869: </li>
                   5870: </ul></div>
                   5871: </div>
                   5872: <div class="sect2" lang="en">
                   5873: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5874: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.75      rillig   5875: <p>Creating non-empty files outside the installation prefix is tricky
1.76      rillig   5876: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75      rillig   5877: To overcome this problem, the only solution is to extract the file in the
                   5878: known place (i.e., inside the installation prefix) and copy it to the
                   5879: appropriate location during installation (done by the installation scripts
                   5880: generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
                   5881: file</em></span> in the following paragraphs, which describe the variables
                   5882: that can be used to automatically and consistently handle files outside the
                   5883: installation prefix:</p>
                   5884: <div class="itemizedlist"><ul type="disc">
                   5885: <li>
                   5886: <p><code class="varname">CONF_FILES</code> and
                   5887:     <code class="varname">SUPPORT_FILES</code> are pairs of master and target files.
                   5888:     During installation time, the master file is copied to the target one
                   5889:     if and only if the latter does not exist.  Upon deinstallation, the
                   5890:     target file is removed provided that it was not modified by the
                   5891:     installation.</p>
                   5892: <p>The difference between the two is that the latter prompts the
                   5893:     administrator to remove any files that may be left after
                   5894:     deinstallation (because they were not empty), while the former does
                   5895:     not.</p>
                   5896: </li>
                   5897: <li>
                   5898: <p><code class="varname">CONF_FILES_PERMS</code> and
                   5899:     <code class="varname">SUPPORT_FILES_PERMS</code> contain tuples describing master
                   5900:     files as well as their target locations.  For each of them, it also
                   5901:     specifies their owner, their group and their numeric permissions, in
                   5902:     this order.  For example:</p>
                   5903: <pre class="programlisting">
1.100     rillig   5904: SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1       grant    5905: </pre>
1.75      rillig   5906: <p>The difference between the two is exactly the same as their
                   5907:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5908: </li>
                   5909: </ul></div>
                   5910: </div>
                   5911: </div>
                   5912: <div class="sect1" lang="en">
                   5913: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5914: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.75      rillig   5915: <p>Configuration files are special in the sense that they are installed
                   5916: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
                   5917: need special treatment during installation (most of which is automated by
                   5918: pkginstall).  The main concept you must bear in mind is that files marked
                   5919: as configuration files are automatically copied to the right place (somewhere
                   5920: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
                   5921: and only if</em></span> they didn't exist before.  Similarly, they will not
                   5922: be removed if they have local modifications.  This ensures that
                   5923: administrators never lose any custom changes they may have made.</p>
                   5924: <div class="sect2" lang="en">
                   5925: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5926: <a name="conf-files-sysconfdir"></a>15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
1.75      rillig   5927: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   5928: specifies where configuration files shall be installed.  Its contents are
                   5929: set based upon the following variables:</p>
                   5930: <div class="itemizedlist"><ul type="disc">
                   5931: <li><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76      rillig   5932:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75      rillig   5933:     be overridden by the user to point to his preferred location (e.g.,
1.76      rillig   5934:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75      rillig   5935:     Packages must not use it directly.</p></li>
                   5936: <li>
                   5937: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   5938:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   5939:     for the package being built shall be installed.  The definition of this
                   5940:     variable only makes sense in the package's
1.76      rillig   5941:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75      rillig   5942: <p>As an example, consider the Apache package,
1.91      rillig   5943:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache2/README.html" target="_top"><code class="filename">www/apache2</code></a>, which places its
1.75      rillig   5944:     configuration files under the
1.76      rillig   5945:     <code class="filename">httpd/</code> subdirectory of
1.75      rillig   5946:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   5947:     Makefile.</p>
                   5948: </li>
                   5949: <li><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
                   5950:     variable that holds this package's configuration directory (if
                   5951:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   5952:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   5953:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
                   5954: <li><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
                   5955:     directory where the configuration files for the package identified by
                   5956:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   5957: </ul></div>
                   5958: <p>Based on the above variables, pkginstall determines the value of
                   5959: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
                   5960: variable that can be used within a package to refer to its configuration
                   5961: directory.  The algorithm used to set its value is basically the
                   5962: following:</p>
                   5963: <div class="orderedlist"><ol type="1">
                   5964: <li><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
                   5965:     its value is used.</p></li>
                   5966: <li><p>If the previous variable is not defined but
                   5967:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76      rillig   5968:     <code class="filename">Makefile</code>, the resulting value is
                   5969:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.75      rillig   5970: <li><p>Otherwise, it is set to
1.76      rillig   5971:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75      rillig   5972: </ol></div>
1.76      rillig   5973: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.110     hubertf  5974: automatically added to <code class="filename">OWN_DIRS</code>.  See <a class="xref" href="#dirs-outside-prefix" title="15.1.1. Directory manipulation">Section 15.1.1, &#8220;Directory manipulation&#8221;</a> what this means.</p>
1.75      rillig   5975: </div>
                   5976: <div class="sect2" lang="en">
                   5977: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5978: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75      rillig   5979: <p>Given that pkgsrc (and users!) expect configuration files to be in a
                   5980: known place, you need to teach each package where it shall install its
                   5981: files.  In some cases you will have to patch the package Makefiles to
                   5982: achieve it.  If you are lucky, though, it may be as easy as passing an
                   5983: extra flag to the configuration script; this is the case of GNU Autoconf-
                   5984: generated files:</p>
                   5985: <pre class="programlisting">
1.100     rillig   5986: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1       grant    5987: </pre>
1.75      rillig   5988: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
                   5989: for</em></span> its configuration files, not where they will be originally
                   5990: installed (although the difference is never explicit,
                   5991: unfortunately).</p>
                   5992: </div>
                   5993: <div class="sect2" lang="en">
                   5994: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5995: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.75      rillig   5996: <p>As said before, pkginstall automatically handles configuration files.
                   5997: This means that <span class="strong"><strong>the packages themselves must not
1.76      rillig   5998: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75      rillig   5999: directly</strong></span>.  Bad news is that many software installation scripts
                   6000: will, out of the box, mess with the contents of that directory.  So what is
                   6001: the correct procedure to fix this issue?</p>
                   6002: <p>You must teach the package (usually by manually patching it) to
                   6003: install any configuration files under the examples hierarchy,
1.76      rillig   6004: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   6005: <code class="filename">PLIST</code> registers them and the administrator always
1.75      rillig   6006: has the original copies available.</p>
                   6007: <p>Once the required configuration files are in place (i.e., under the
                   6008: examples hierarchy), the pkginstall framework can use them as master copies
                   6009: during the package installation to update what is in
1.76      rillig   6010: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
1.75      rillig   6011: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.110     hubertf  6012: used.  Check out <a class="xref" href="#files-outside-prefix" title="15.1.2. File manipulation">Section 15.1.2, &#8220;File manipulation&#8221;</a> for information
1.75      rillig   6013: about their syntax and their purpose.  Here is an example, taken from the
1.91      rillig   6014: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/mail/mutt/README.html" target="_top"><code class="filename">mail/mutt</code></a> package:</p>
1.75      rillig   6015: <pre class="programlisting">
1.100     rillig   6016: EGDIR=        ${PREFIX}/share/doc/mutt/samples
                   6017: CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1       grant    6018: </pre>
1.75      rillig   6019: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
                   6020: package and has no meaning outside it.</p>
                   6021: </div>
                   6022: <div class="sect2" lang="en">
                   6023: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6024: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75      rillig   6025: <p>The automatic copying of config files can be toggled by setting the
                   6026: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   6027: installation.</p>
                   6028: </div>
                   6029: </div>
                   6030: <div class="sect1" lang="en">
                   6031: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6032: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.75      rillig   6033: <p>System startup scripts are special files because they must be
                   6034: installed in a place known by the underlying OS, usually outside the
1.110     hubertf  6035: installation prefix.  Therefore, the same rules described in <a class="xref" href="#files-and-dirs-outside-prefix" title="15.1. Files and directories outside the installation prefix">Section 15.1, &#8220;Files and directories outside the installation prefix&#8221;</a> apply, and the same solutions
1.75      rillig   6036: can be used.  However, pkginstall provides a special mechanism to handle
                   6037: these files.</p>
                   6038: <p>In order to provide system startup scripts, the package has
                   6039: to:</p>
                   6040: <div class="orderedlist"><ol type="1">
1.76      rillig   6041: <li><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75      rillig   6042:     the <code class="literal">.sh</code> suffix appended.  Considering the
1.91      rillig   6043:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/cups/README.html" target="_top"><code class="filename">print/cups</code></a> package as an example, it has a
1.76      rillig   6044:     <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.75      rillig   6045: <li>
                   6046: <p>Tell pkginstall to handle it, appending the name of the script,
                   6047:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   6048:     Continuing the previous example:</p>
                   6049: <pre class="programlisting">
1.100     rillig   6050: RCD_SCRIPTS+=   cupsd
1.1       grant    6051: </pre>
1.75      rillig   6052: </li>
                   6053: </ol></div>
                   6054: <p>Once this is done, pkginstall will do the following steps for each
                   6055: script in an automated fashion:</p>
                   6056: <div class="orderedlist"><ol type="1">
                   6057: <li><p>Process the file found in the files directory applying all the
1.76      rillig   6058:     substitutions described in the <code class="filename">FILES_SUBST</code>
1.75      rillig   6059:     variable.</p></li>
                   6060: <li><p>Copy the script from the files directory to the examples
1.76      rillig   6061:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
1.75      rillig   6062:     that this master file must be explicitly registered in the
1.76      rillig   6063:     <code class="filename">PLIST</code>.</p></li>
1.75      rillig   6064: <li><p>Add code to the installation scripts to copy the startup script
                   6065:     from the examples hierarchy into the system-wide startup scripts
                   6066:     directory.</p></li>
                   6067: </ol></div>
                   6068: <div class="sect2" lang="en">
                   6069: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6070: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75      rillig   6071: <p>The automatic copying of config files can be toggled by setting the
                   6072: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   6073: installation.  Note that the scripts will be always copied inside the
1.76      rillig   6074: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75      rillig   6075: matter what the value of this variable is.</p>
                   6076: </div>
                   6077: </div>
                   6078: <div class="sect1" lang="en">
                   6079: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6080: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.75      rillig   6081: <p>If a package needs to create special users and/or groups during
                   6082: installation, it can do so by using the pkginstall framework.</p>
                   6083: <p>Users can be created by adding entries to the
                   6084: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   6085: syntax:</p>
                   6086: <pre class="programlisting">
1.100     rillig   6087: user:group
1.1       grant    6088: </pre>
1.87      wiz      6089: <p>Further specification of user details may be done by setting
                   6090: per-user variables.
                   6091: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   6092: numeric UID for the user.
                   6093: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   6094: user's description or comment.
                   6095: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   6096: user's home directory, and defaults to
                   6097: <code class="filename">/nonexistent</code> if not specified.
                   6098: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94      dmcmahil 6099: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87      wiz      6100: not specified.</p>
1.75      rillig   6101: <p>Similarly, groups can be created by adding entries to the
                   6102: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   6103: <pre class="programlisting">
1.100     rillig   6104: group
1.1       grant    6105: </pre>
1.93      rillig   6106: <p>The numeric GID of the group may be set by defining
1.75      rillig   6107: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   6108: <p>If a package needs to create the users and groups at an earlier
                   6109: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
                   6110: either <code class="literal">configure</code> or <code class="literal">build</code> to
                   6111: indicate the phase before which the users and groups are created.  In
                   6112: this case, the numeric UIDs and GIDs of the created users and groups
                   6113: are automatically hardcoded into the final installation scripts.</p>
                   6114: </div>
                   6115: <div class="sect1" lang="en">
                   6116: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6117: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.75      rillig   6118: <p>Packages that install system shells should register them in the shell
1.76      rillig   6119: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75      rillig   6120: administrator.  This must be done from the installation scripts to keep
                   6121: binary packages working on any system.  pkginstall provides an easy way to
                   6122: accomplish this task.</p>
                   6123: <p>When a package provides a shell interpreter, it has to set the
                   6124: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   6125: add some hooks to the installation scripts to handle it.  Consider the
1.91      rillig   6126: following example, taken from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/zsh/README.html" target="_top"><code class="filename">shells/zsh</code></a>:</p>
1.75      rillig   6127: <pre class="programlisting">
1.100     rillig   6128: PKG_SHELL=      ${PREFIX}/bin/zsh
1.1       grant    6129: </pre>
1.75      rillig   6130: <div class="sect2" lang="en">
                   6131: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6132: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.75      rillig   6133: <p>The automatic registration of shell interpreters can be disabled by
1.76      rillig   6134: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75      rillig   6135: environment variable to <code class="literal">NO</code>.</p>
                   6136: </div>
                   6137: </div>
                   6138: <div class="sect1" lang="en">
                   6139: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6140: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.75      rillig   6141: <p>Packages that install X11 fonts should update the database files
                   6142: that index the fonts within each fonts directory.  This can easily be
                   6143: accomplished within the pkginstall framework.</p>
                   6144: <p>When a package installs X11 fonts, it must list the directories in
                   6145: which fonts are installed in the
                   6146: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
                   6147: where <em class="replaceable"><code>type</code></em> can be one of &#8220;<span class="quote">ttf</span>&#8221;,
                   6148: &#8220;<span class="quote">type1</span>&#8221; or &#8220;<span class="quote">x11</span>&#8221;.  This will add hooks to the
                   6149: installation scripts to run the appropriate commands to update the fonts
                   6150: database files within each of those directories.  For convenience, if the
                   6151: directory path is relative, it is taken to be relative to the package's
1.91      rillig   6152: installation prefix.  Consider the following example, taken from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/fonts/dbz-ttf/README.html" target="_top"><code class="filename">fonts/dbz-ttf</code></a>:</p>
1.75      rillig   6153: <pre class="programlisting">
1.100     rillig   6154: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
1.1       grant    6155: </pre>
1.75      rillig   6156: <div class="sect2" lang="en">
                   6157: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6158: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75      rillig   6159: <p>The automatic update of fonts databases can be disabled by
1.76      rillig   6160: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75      rillig   6161: environment variable to <code class="literal">NO</code>.</p>
                   6162: </div>
                   6163: </div>
                   6164: </div>
                   6165: <div class="chapter" lang="en">
                   6166: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   6167: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.75      rillig   6168: <div class="toc">
                   6169: <p><b>Table of Contents</b></p>
                   6170: <dl>
1.106     rillig   6171: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.116   ! rillig   6172: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use bsd.options.mk</a></span></dt>
1.106     rillig   6173: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107     rillig   6174: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.75      rillig   6175: </dl>
                   6176: </div>
                   6177: <p>Many packages have the ability to be built to support different
1.76      rillig   6178: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
1.75      rillig   6179: in pkgsrc that provides generic handling of those options that
                   6180: determine different ways in which the packages can be built.  It's
                   6181: possible for the user to specify exactly which sets of options will be
                   6182: built into a package or to allow a set of global default options
                   6183: apply.</p>
1.107     rillig   6184: <p>There are two broad classes of behaviors that one might want to
                   6185: control via options.  One is whether some particular feature is
                   6186: enabled in a program that will be built anyway, often by including or
                   6187: not including a dependency on some other package.  The other is
                   6188: whether or not an additional program will be built as part of the
                   6189: package.  Generally, it is better to make a split package for such
                   6190: additional programs instead of using options, because it enables
                   6191: binary packages to be built which can then be added separately.  For
                   6192: example, the foo package might have minimal dependencies (those
                   6193: packages without which foo doesn't make sense), and then the foo-gfoo
                   6194: package might include the GTK frontend program gfoo.  This is better
                   6195: than including a gtk option to foo that adds gfoo, because either that
                   6196: option is default, in which case binary users can't get foo without
                   6197: gfoo, or not default, in which case they can't get gfoo.  With split
                   6198: packages, they can install foo without having GTK, and later decide to
                   6199: install gfoo (pulling in GTK at that time).  This is an advantage to
                   6200: source users too, avoiding the need for rebuilds.</p>
                   6201: <p>Plugins with widely varying dependencies should usually be split
                   6202: instead of options.</p>
                   6203: <p>It is often more work to maintain split packages, especially if
                   6204: the upstream package does not support this.  The decision of split
                   6205: vs. option should be made based on the likelihood that users will want
                   6206: or object to the various pieces, the size of the dependencies that are
                   6207: included, and the amount of work.</p>
                   6208: <p>A further consideration is licensing.  Non-free parts, or parts
                   6209: that depend on non-free dependencies (especially plugins) should
                   6210: almost always be split if feasible.</p>
1.75      rillig   6211: <div class="sect1" lang="en">
                   6212: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6213: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.75      rillig   6214: <p>Global default options are listed in
                   6215: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   6216: that should be built into every package if that option is supported.
1.110     hubertf  6217: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   6218: </div>
                   6219: <div class="sect1" lang="en">
                   6220: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6221: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.93      rillig   6222: </h2></div></div></div>
1.75      rillig   6223: <p>The following example shows how
1.76      rillig   6224: <code class="filename">bsd.options.mk</code> should be used
1.75      rillig   6225: by the hypothetical ``wibble'' package, either in the package
1.76      rillig   6226: <code class="filename">Makefile</code>, or in a file,
                   6227: e.g. <code class="filename">options.mk</code>, that is included by the
                   6228: main package <code class="filename">Makefile</code>.</p>
1.75      rillig   6229: <pre class="programlisting">
1.100     rillig   6230: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   6231: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   6232: PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   6233: PKG_OPTIONS_GROUP.database=     mysql pgsql
                   6234: PKG_SUGGESTED_OPTIONS=          wibble-foo
                   6235: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   6236: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
                   6237: 
                   6238: .include "../../mk/bsd.prefs.mk"
                   6239: 
                   6240: # this package was previously named wibble2
                   6241: .if defined(PKG_OPTIONS.wibble2)
                   6242: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   6243: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
                   6244:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
                   6245: .endif
                   6246: 
                   6247: .include "../../mk/bsd.options.mk"
                   6248: 
                   6249: # Package-specific option-handling
                   6250: 
                   6251: ###
                   6252: ### FOO support
                   6253: ###
                   6254: .if !empty(PKG_OPTIONS:Mwibble-foo)
                   6255: CONFIGURE_ARGS+=    --enable-foo
                   6256: .endif
                   6257: 
                   6258: ###
                   6259: ### LDAP support
                   6260: ###
                   6261: .if !empty(PKG_OPTIONS:Mldap)
                   6262: .  include "../../databases/openldap-client/buildlink3.mk"
                   6263: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
                   6264: .endif
                   6265: 
                   6266: ###
                   6267: ### database support
                   6268: ###
                   6269: .if !empty(PKG_OPTIONS:Mmysql)
                   6270: .  include "../../mk/mysql.buildlink3.mk"
                   6271: .endif
                   6272: .if !empty(PKG_OPTIONS:Mpgsql)
                   6273: .  include "../../mk/pgsql.buildlink3.mk"
                   6274: .endif
1.75      rillig   6275: </pre>
                   6276: <p>The first section contains the information about which build
                   6277: options are supported by the package, and any default options settings
                   6278: if needed.</p>
                   6279: <div class="orderedlist"><ol type="1">
                   6280: <li><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.110     hubertf  6281: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.75      rillig   6282: options.  It should be set to
1.78      rillig   6283: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   6284: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   6285: at the point where the options are processed.</p></li>
1.75      rillig   6286: <li><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
                   6287: build options supported by the package.</p></li>
                   6288: <li><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
                   6289: list of names of groups of mutually exclusive options.  The options in
                   6290: each group are listed in
                   6291: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   6292: The most specific setting of any option from the group takes
                   6293: precedence over all other options in the group.  Options from the
                   6294: groups will be automatically added to
                   6295: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
                   6296: <li><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
                   6297: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   6298: packages will fail if no option from the group is
                   6299: selected.</p></li>
                   6300: <li><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
                   6301: of names of sets of options.  At least one option from each set must
                   6302: be selected.  The options in each set are listed in
                   6303: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   6304: Options from the sets will be automatically added to
                   6305: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   6306: fail if no option from the set is selected.</p></li>
                   6307: <li><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
                   6308: build options which are enabled by default.</p></li>
                   6309: <li><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
                   6310: of
                   6311: &#8220;<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>&#8221;
1.110     hubertf  6312: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.75      rillig   6313: their option counterparts.  Pairs should be added with
                   6314: &#8220;<span class="quote">+=</span>&#8221; to keep the listing of global legacy variables.  A
                   6315: warning will be issued if the user uses a legacy
                   6316: variable.</p></li>
                   6317: <li><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
                   6318: of
                   6319: &#8220;<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>&#8221;
                   6320: pairs that map options that have been renamed to their new
                   6321: counterparts.  Pairs should be added with &#8220;<span class="quote">+=</span>&#8221; to keep
                   6322: the listing of global legacy options.  A warning will be issued if
                   6323: the user uses a legacy option.</p></li>
                   6324: <li><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
                   6325: options implied by deprecated variables used.  This can be used for
                   6326: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   6327: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   6328: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
                   6329: <li><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
                   6330: a list of warnings about deprecated variables or options used, and
                   6331: what to use instead.</p></li>
                   6332: </ol></div>
                   6333: <p>A package should never modify
                   6334: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   6335: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   6336: To suggest a default set of options, use
                   6337: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   6338: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76      rillig   6339: including <code class="filename">bsd.options.mk</code>.  If none of
1.75      rillig   6340: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   6341: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   6342: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   6343: happen with platform-specific options if none of them is supported on
                   6344: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   6345: empty list and the package is otherwise treated as not using the
                   6346: options framework.</p>
1.76      rillig   6347: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75      rillig   6348: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   6349: build options, properly filtered to remove unsupported and duplicate
                   6350: options.</p>
                   6351: <p>The remaining sections contain the logic that is specific to
                   6352: each option.  The correct way to check for an option is to check
                   6353: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   6354: <pre class="programlisting">
1.100     rillig   6355: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75      rillig   6356: </pre>
                   6357: </div>
                   6358: <div class="sect1" lang="en">
                   6359: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6360: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.75      rillig   6361: <p>Options that enable similar features in different packages (like
                   6362: optional support for a library) should use a common name in all
                   6363: packages that support it (like the name of the library).  If another
                   6364: package already has an option with the same meaning, use the same
                   6365: name.</p>
                   6366: <p>Options that enable features specific to one package, where it's
                   6367: unlikely that another (unrelated) package has the same (or a similar)
                   6368: optional feature, should use a name prefixed with
                   6369: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   6370: <p>If a group of related packages share an optional feature
                   6371: specific to that group, prefix it with the name of the
                   6372: &#8220;<span class="quote">main</span>&#8221; package
                   6373: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   6374: <p>For new options, add a line to
1.76      rillig   6375: <code class="filename">mk/defaults/options.description</code>.  Lines have two
1.75      rillig   6376: fields, separated by tab.  The first field is the option name, the
                   6377: second its description.  The description should be a whole sentence
                   6378: (starting with an uppercase letter and ending with a period) that
                   6379: describes what enabling the option does.  E. g. &#8220;<span class="quote">Enable ispell
                   6380: support.</span>&#8221; The file is sorted by option names.</p>
                   6381: </div>
1.107     rillig   6382: <div class="sect1" lang="en">
                   6383: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6384: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.110     hubertf  6385: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
1.107     rillig   6386: different dependencies based on the options with which the package was
                   6387: built. For querying these options, the file
                   6388: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
                   6389: typical example looks like this:</p>
                   6390: <pre class="programlisting">
                   6391: pkgbase := libpurple
                   6392: .include "../../mk/pkg-build-options.mk"
                   6393: 
                   6394: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
                   6395: ...
                   6396: .endif
                   6397: </pre>
                   6398: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
                   6399: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
                   6400: options of the libpurple package, which can then be queried like
                   6401: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
                   6402: file. See the file <code class="filename">pkg-build-options.mk</code> for more
                   6403: details.</p>
                   6404: </div>
1.75      rillig   6405: </div>
                   6406: <div class="chapter" lang="en">
                   6407: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   6408: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.75      rillig   6409: <div class="toc">
                   6410: <p><b>Table of Contents</b></p>
                   6411: <dl>
1.106     rillig   6412: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   6413: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   6414: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   6415: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.116   ! rillig   6416: <dt><span class="sect1"><a href="#build.fetch">17.5. The fetch phase</a></span></dt>
1.106     rillig   6417: <dd><dl>
                   6418: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   6419: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   6420: </dl></dd>
1.116   ! rillig   6421: <dt><span class="sect1"><a href="#build.checksum">17.6. The checksum phase</a></span></dt>
        !          6422: <dt><span class="sect1"><a href="#build.extract">17.7. The extract phase</a></span></dt>
        !          6423: <dt><span class="sect1"><a href="#build.patch">17.8. The patch phase</a></span></dt>
        !          6424: <dt><span class="sect1"><a href="#build.tools">17.9. The tools phase</a></span></dt>
        !          6425: <dt><span class="sect1"><a href="#build.wrapper">17.10. The wrapper phase</a></span></dt>
        !          6426: <dt><span class="sect1"><a href="#build.configure">17.11. The configure phase</a></span></dt>
        !          6427: <dt><span class="sect1"><a href="#build.build">17.12. The build phase</a></span></dt>
        !          6428: <dt><span class="sect1"><a href="#build.test">17.13. The test phase</a></span></dt>
        !          6429: <dt><span class="sect1"><a href="#build.install">17.14. The install phase</a></span></dt>
        !          6430: <dt><span class="sect1"><a href="#build.package">17.15. The package phase</a></span></dt>
1.106     rillig   6431: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   6432: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.75      rillig   6433: </dl>
                   6434: </div>
                   6435: <div class="sect1" lang="en">
                   6436: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6437: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.75      rillig   6438: <p>This chapter gives a detailed description on how a package is
1.87      wiz      6439:     built. Building a package is separated into different
                   6440:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   6441:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
                   6442:     described in the following sections. Each phase is splitted into
                   6443:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   6444:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   6445:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   6446:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   6447:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97      rillig   6448: <p>Never override the regular targets (like
                   6449:     <code class="varname">fetch</code>), if you have to, override the
                   6450:     <code class="varname">do-*</code> ones instead.</p>
1.75      rillig   6451: <p>The basic steps for building a program are always the same.  First
1.87      wiz      6452:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   6453:     the local system and then extracted. After any pkgsrc-specific patches
                   6454:     to compile properly are applied, the software can be configured, then
                   6455:     built (usually by compiling), and finally the generated binaries, etc.
                   6456:     can be put into place on the system.</p>
1.97      rillig   6457: <p>To get more details about what is happening at each step,
                   6458:     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
                   6459:     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
                   6460:     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75      rillig   6461: </div>
                   6462: <div class="sect1" lang="en">
                   6463: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6464: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.75      rillig   6465: <p>Before outlining the process performed by the NetBSD package system in
1.87      wiz      6466:     the next section, here's a brief discussion on where programs are
                   6467:     installed, and which variables influence this.</p>
1.75      rillig   6468: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87      wiz      6469:     where all files of the final program shall be installed. It is
                   6470:     usually set to <code class="varname">LOCALBASE</code>
                   6471:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88      wiz      6472:     for pkgs in the <code class="filename">cross</code> category.  The value of
1.87      wiz      6473:     <code class="varname">PREFIX</code> needs to be put
                   6474:     into the various places in the program's source where paths to
1.110     hubertf  6475:     these files are encoded.  See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a> and <a class="xref" href="#fixes.libtool" title="19.3.1. Shared libraries - libtool">Section 19.3.1, &#8220;Shared libraries - libtool&#8221;</a> for more details.</p>
1.75      rillig   6476: <p>When choosing which of these variables to use,
1.87      wiz      6477:     follow the following rules:</p>
1.75      rillig   6478: <div class="itemizedlist"><ul type="disc">
1.88      wiz      6479: <li><p><code class="varname">PREFIX</code> always points to the location
                   6480:        where the current pkg will be installed.  When referring to a
                   6481:        pkg's own installation path, use
                   6482:        &#8220;<span class="quote">${PREFIX}</span>&#8221;.</p></li>
                   6483: <li><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
                   6484:        are installed.  If you need to construct a -I or -L argument
                   6485:        to the compiler to find includes and libraries installed by
                   6486:        another non-X11 pkg, use &#8220;<span class="quote">${LOCALBASE}</span>&#8221;. The name
1.87      wiz      6487:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   6488:        installed all packages in <code class="filename">/usr/local</code>. As
                   6489:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   6490:        administrator, this variable is a misnomer.</p></li>
1.88      wiz      6491: <li><p><code class="varname">X11BASE</code> is where the actual X11
                   6492:        distribution (from xsrc, etc.) is installed. When looking for
                   6493:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
                   6494:        installed by a package), use &#8220;<span class="quote">${X11BASE}</span>&#8221;.</p></li>
                   6495: <li>
                   6496: <p>X11-based packages are special in that they may be
                   6497:        installed in either <code class="varname">X11BASE</code> or
                   6498:        <code class="varname">LOCALBASE</code>.</p>
1.75      rillig   6499: <p>Usually, X11 packages should be installed under
1.88      wiz      6500:        <code class="varname">LOCALBASE</code> whenever possible.  Note that you
                   6501:        will need to include
                   6502:        <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
                   6503:        request the presence of X11 and to get the right compilation
                   6504:        flags.</p>
1.75      rillig   6505: <p>Even though, there are some packages that cannot be installed
1.87      wiz      6506:        under <code class="varname">LOCALBASE</code>: those that come with app-defaults
                   6507:        files. These packages are special and they must be placed under
                   6508:        <code class="varname">X11BASE</code>. To accomplish this, set either
                   6509:        <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
                   6510:        your package.</p>
1.75      rillig   6511: <p>Some notes: If you need
1.87      wiz      6512:        to find includes or libraries installed by a pkg that has
                   6513:        <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
                   6514:        its pkg <code class="filename">Makefile</code>, you need to look in
                   6515:        <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
                   6516:        <code class="filename">${LOCALBASE}</code>. To force installation of
                   6517:        all X11 packages in <code class="varname">LOCALBASE</code>, the
1.91      rillig   6518:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/xpkgwedge/README.html" target="_top"><code class="filename">pkgtools/xpkgwedge</code></a> package
1.87      wiz      6519:        is enabled by default.</p>
1.75      rillig   6520: </li>
1.88      wiz      6521: <li><p><code class="varname">X11PREFIX</code> should be used to refer to
                   6522:        the installed location of an X11
                   6523:        package. <code class="varname">X11PREFIX</code> will be set to
                   6524:        <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
                   6525:        to <code class="varname">LOCALBASE</code> if xpkgwedge is
                   6526:        installed.</p></li>
                   6527: <li>
                   6528: <p>If xpkgwedge is installed, it is possible to have some
                   6529:        packages installed in <code class="varname">X11BASE</code> and some in
                   6530:        <code class="varname">LOCALBASE</code>.  To determine the prefix of an
                   6531:        installed package, the <code class="varname">EVAL_PREFIX</code>
                   6532:        definition can be used. It takes pairs in the format
1.110     hubertf  6533:        &#8220;<span class="quote">DIRNAME=&lt;package&gt;</span>&#8221;, and the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      6534:        variable <code class="varname">DIRNAME</code> will be set to the prefix
                   6535:        of the installed package &lt;package&gt;, or
                   6536:        &#8220;<span class="quote">${X11PREFIX}</span>&#8221; if the package is not
                   6537:        installed.</p>
1.75      rillig   6538: <p>This is best illustrated by example.</p>
                   6539: <p>The following lines are taken from
1.87      wiz      6540:        <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75      rillig   6541: <pre class="programlisting">
1.100     rillig   6542: EVAL_PREFIX+=           GTKDIR=gtk+
                   6543: CONFIGURE_ARGS+=        --with-guile-prefix=${LOCALBASE:Q}
                   6544: CONFIGURE_ARGS+=        --with-gtk-prefix=${GTKDIR:Q}
                   6545: CONFIGURE_ARGS+=        --enable-multibyte
                   6546: </pre>
1.88      wiz      6547: <p>Specific defaults can be defined for the packages
                   6548:        evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
                   6549:        definition of the form:</p>
1.75      rillig   6550: <pre class="programlisting">
1.100     rillig   6551: GTKDIR_DEFAULT= ${LOCALBASE}
                   6552: </pre>
1.75      rillig   6553: <p>where <code class="varname">GTKDIR</code> corresponds
1.87      wiz      6554:        to the first definition in
                   6555:        the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75      rillig   6556: </li>
1.76      rillig   6557: <li><p>Within <code class="filename">${PREFIX}</code>, packages should
1.110     hubertf  6558:        install files according to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?hier+7+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.87      wiz      6559:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   6560:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75      rillig   6561: </ul></div>
                   6562: </div>
                   6563: <div class="sect1" lang="en">
                   6564: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6565: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.114     jmcneill 6566: <p>When building a package, various directories are used to store
1.87      wiz      6567:     source files, temporary files, pkgsrc-internal files, and so on. These
                   6568:     directories are explained here.</p>
1.75      rillig   6569: <p>Some of the directory variables contain relative pathnames. There
1.87      wiz      6570:     are two common base directories for these relative directories:
                   6571:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   6572:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   6573:     inside the package itself.</p>
1.75      rillig   6574: <div class="variablelist"><dl>
                   6575: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   6576: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87      wiz      6577:       root directory. Generally, you don't need
                   6578:       it.</p></dd>
1.97      rillig   6579: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
                   6580: <dd><p>This is an absolute pathname that points to the
                   6581:       current package.</p></dd>
1.75      rillig   6582: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
                   6583: <dd><p>This is a pathname relative to
1.87      wiz      6584:       <code class="varname">PKGSRCDIR</code> that points to the current
                   6585:       package.</p></dd>
1.75      rillig   6586: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   6587: <dd><p>This is an absolute pathname pointing to the directory
1.93      rillig   6588:       where all work takes place. The distfiles are extracted to this
1.87      wiz      6589:       directory. It also contains temporary directories and log files used by
                   6590:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   6591:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75      rillig   6592: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   6593: <dd><p>This is an absolute pathname pointing to the directory
1.87      wiz      6594:       where the distfiles are extracted. It is usually a direct subdirectory
                   6595:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   6596:       that isn't hidden. This variable may be changed by a package
                   6597:       <code class="filename">Makefile</code>.</p></dd>
1.75      rillig   6598: </dl></div>
1.114     jmcneill 6599: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
                   6600:     the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.116   ! rillig   6601:     to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.114     jmcneill 6602:     <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
                   6603:     If users would like to have their pkgsrc trees behave in a
                   6604:     read-only manner, then the value of
                   6605:     <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
                   6606:     <span class="emphasis"><em>no</em></span>.</p>
1.75      rillig   6607: </div>
                   6608: <div class="sect1" lang="en">
                   6609: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6610: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.110     hubertf  6611: <p>You can run a particular phase by typing <span class="command"><strong>make
1.87      wiz      6612:     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
                   6613:     phase. This will automatically run all phases that are required for this
                   6614:     phase. The default phase is <code class="varname">build</code>, that is, when you
1.110     hubertf  6615:     run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.87      wiz      6616:     the package will be built, but not installed.</p>
1.75      rillig   6617: </div>
                   6618: <div class="sect1" lang="en">
                   6619: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6620: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81      rillig   6621: <p>The first step in building a package is to fetch the
1.88      wiz      6622:     distribution files (distfiles) from the sites that are providing
                   6623:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   6624:     phase.</p>
1.81      rillig   6625: <div class="sect2" lang="en">
                   6626: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6627: <a name="build.fetch.what"></a>17.5.1. What to fetch and where to get it from</h3></div></div></div>
1.88      wiz      6628: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   6629:       defines all URLs from where the distfile, whose name is
                   6630:       derived from the <code class="varname">DISTNAME</code> variable, is
                   6631:       fetched. The more complicated cases are described
                   6632:       below.</p>
                   6633: <p>The variable <code class="varname">DISTFILES</code> specifies
                   6634:       the list of distfiles that have to be fetched. Its value
                   6635:       defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
                   6636:       so that most packages don't need to define it at all.
                   6637:       <code class="varname">EXTRACT_SUFX</code> is
                   6638:       <code class="literal">.tar.gz</code> by default, but can be changed
                   6639:       freely. Note that if your package requires additional
                   6640:       distfiles to the default one, you cannot just append the
                   6641:       additional filenames using the <code class="literal">+=</code>
                   6642:       operator, but you have write for example:</p>
1.81      rillig   6643: <pre class="programlisting">
1.100     rillig   6644: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
                   6645: </pre>
1.88      wiz      6646: <p>Each distfile is fetched from a list of sites, usually
                   6647:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   6648:       <code class="varname">DISTFILES</code> or multiple
                   6649:       <code class="varname">PATCHFILES</code> from different sites, you can
                   6650:       set
                   6651:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   6652:       to the list of URLs where the file
                   6653:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   6654:       (including the suffix) can be found.</p>
                   6655: <pre class="programlisting">
1.100     rillig   6656: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   6657: DISTFILES+=     foo-file.tar.gz
                   6658: SITES.foo-file.tar.gz= \
                   6659: http://www.somewhere.com/somehow/ \
                   6660: http://www.somewhereelse.com/mirror/somehow/
                   6661: </pre>
1.81      rillig   6662: <p>When actually fetching the distfiles, each item from
1.88      wiz      6663:       <code class="varname">MASTER_SITES</code> or
                   6664:       <code class="varname">SITES.*</code> gets the name of each distfile
                   6665:       appended to it, without an intermediate slash. Therefore,
                   6666:       all site values have to end with a slash or other separator
                   6667:       character. This allows for example to set
                   6668:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   6669:       that gets the name of the distfile as a parameter. In this
                   6670:       case, the definition would look like:</p>
1.81      rillig   6671: <pre class="programlisting">
1.100     rillig   6672: MASTER_SITES=   http://www.example.com/download.cgi?file=
                   6673: </pre>
1.81      rillig   6674: <p>There are some predefined values for
1.88      wiz      6675:       <code class="varname">MASTER_SITES</code>, which can be used in
                   6676:       packages.  The names of the variables should speak for
                   6677:       themselves.</p>
                   6678: <pre class="programlisting">
1.100     rillig   6679: ${MASTER_SITE_APACHE}
                   6680: ${MASTER_SITE_BACKUP}
                   6681: ${MASTER_SITE_CYGWIN}
                   6682: ${MASTER_SITE_DEBIAN}
                   6683: ${MASTER_SITE_FREEBSD}
                   6684: ${MASTER_SITE_FREEBSD_LOCAL}
                   6685: ${MASTER_SITE_GENTOO}
                   6686: ${MASTER_SITE_GNOME}
                   6687: ${MASTER_SITE_GNU}
                   6688: ${MASTER_SITE_GNUSTEP}
                   6689: ${MASTER_SITE_IFARCHIVE}
                   6690: ${MASTER_SITE_KDE}
                   6691: ${MASTER_SITE_MOZILLA}
                   6692: ${MASTER_SITE_MYSQL}
                   6693: ${MASTER_SITE_OPENOFFICE}
                   6694: ${MASTER_SITE_PERL_CPAN}
                   6695: ${MASTER_SITE_PGSQL}
                   6696: ${MASTER_SITE_R_CRAN}
                   6697: ${MASTER_SITE_SOURCEFORGE}
                   6698: ${MASTER_SITE_SOURCEFORGE_JP}
                   6699: ${MASTER_SITE_SUNSITE}
                   6700: ${MASTER_SITE_SUSE}
                   6701: ${MASTER_SITE_TEX_CTAN}
                   6702: ${MASTER_SITE_XCONTRIB}
                   6703: ${MASTER_SITE_XEMACS}
                   6704: </pre>
1.88      wiz      6705: <p>Some explanations for the less self-explaining ones:
                   6706:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.110     hubertf  6707:       for packages that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/%24%7BDIST_SUBDIR%7D" target="_top">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}</a>.  <code class="varname">MASTER_SITE_LOCAL</code> contains local
                   6708:       package source distributions that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/LOCAL_PORTS/" target="_top">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/LOCAL_PORTS/</a>.</p>
1.88      wiz      6709: <p>If you choose one of these predefined sites, you may
                   6710:       want to specify a subdirectory of that site. Since these
                   6711:       macros may expand to more than one actual site, you
                   6712:       <span class="emphasis"><em>must</em></span> use the following construct to
                   6713:       specify a subdirectory:</p>
1.81      rillig   6714: <pre class="programlisting">
1.100     rillig   6715: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   6716: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
                   6717: </pre>
1.81      rillig   6718: <p>Note the trailing slash after the subdirectory
1.88      wiz      6719:       name.</p>
1.81      rillig   6720: </div>
                   6721: <div class="sect2" lang="en">
                   6722: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6723: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.88      wiz      6724: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   6725:       all the distfiles exist in a local directory
1.93      rillig   6726:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88      wiz      6727:       user). If the files do not exist, they are fetched using
                   6728:       commands of the form</p>
1.75      rillig   6729: <pre class="programlisting">
1.100     rillig   6730: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   6731: </pre>
1.88      wiz      6732: <p>where <code class="literal">${site}</code> varies through
                   6733:       several possibilities in turn: first,
                   6734:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   6735:       sites specified in either <code class="varname">SITES.file</code> if
                   6736:       defined, else <code class="varname">MASTER_SITES</code> or
                   6737:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   6738:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91      rillig   6739:       all except the first and the last can be optionally sorted
                   6740:       by the user, via setting either
                   6741:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   6742:       <code class="varname">MASTER_SORT_AWK</code> or
1.88      wiz      6743:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.97      rillig   6744: <p>The distfiles mirror run by the NetBSD Foundation uses the
                   6745:       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
                   6746:       distfiles, if they are freely distributable.  Packages setting
                   6747:       <code class="varname">NO_SRC_ON_FTP</code> (usually to
                   6748:       &#8220;<span class="quote">${RESTRICTED}</span>&#8221;) will not have their distfiles
                   6749:       mirrored.</p>
1.81      rillig   6750: </div>
1.75      rillig   6751: </div>
                   6752: <div class="sect1" lang="en">
                   6753: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6754: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88      wiz      6755: <p>After the distfile(s) are fetched, their checksum is
                   6756:     generated and compared with the checksums stored in the
                   6757:     distinfo file. If the checksums don't match, the build is
                   6758:     aborted. This is to ensure the same distfile is used for
                   6759:     building, and that the distfile wasn't changed, e.g. by some
                   6760:     malign force, deliberately changed distfiles on the master
                   6761:     distribution site or network lossage.</p>
1.75      rillig   6762: </div>
                   6763: <div class="sect1" lang="en">
                   6764: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6765: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75      rillig   6766: <p>When the distfiles are present on the local system, they
1.88      wiz      6767:     need to be extracted, as they usually come in the form of some
                   6768:     compressed archive format.</p>
1.75      rillig   6769: <p>By default, all <code class="varname">DISTFILES</code> are
1.88      wiz      6770:     extracted. If you only need some of them, you can set the
                   6771:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   6772:     files.</p>
                   6773: <p>Extracting the files is usually done by a little
1.93      rillig   6774:     program, <code class="filename">mk/extract/extract</code>, which
1.88      wiz      6775:     already knows how to extract various archive formats, so most
                   6776:     likely you will not need to change anything here. But if you
                   6777:     need, the following variables may help you:</p>
1.75      rillig   6778: <div class="variablelist"><dl>
                   6779: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   6780: <dd><p>Use these variables to override the default
1.88      wiz      6781:       options for an extract command, which are defined in
1.93      rillig   6782:       <code class="filename">mk/extract/extract</code>.</p></dd>
1.75      rillig   6783: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   6784: <dd><p>This variable can be set to
1.114     jmcneill 6785:       <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
                   6786:       (which is the default value), <code class="literal">pax</code>, or an
1.88      wiz      6787:       absolute pathname pointing to the command with which tar
1.114     jmcneill 6788:       archives should be extracted.  It is preferred to choose bsdtar over gtar
                   6789:       if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75      rillig   6790: </dl></div>
1.88      wiz      6791: <p>If the <code class="filename">extract</code> program doesn't
                   6792:     serve your needs, you can also override the
                   6793:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   6794:     command used for extracting the files. This command is
                   6795:     executed in the <code class="filename">${WRKSRC}</code>
                   6796:     directory. During execution of this command, the shell
                   6797:     variable <code class="varname">extract_file</code> holds the absolute
                   6798:     pathname of the file that is going to be extracted.</p>
1.75      rillig   6799: <p>And if that still does not suffice, you can override the
1.88      wiz      6800:     <code class="varname">do-extract</code> target in the package
                   6801:     Makefile.</p>
1.75      rillig   6802: </div>
                   6803: <div class="sect1" lang="en">
                   6804: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6805: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75      rillig   6806: <p>After extraction, all the patches named by the
1.88      wiz      6807:     <code class="varname">PATCHFILES</code>, those present in the patches
                   6808:     subdirectory of the package as well as in
                   6809:     $LOCALPATCHES/$PKGPATH (e.g.
                   6810:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   6811:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   6812:     <code class="filename">.gz</code> are uncompressed before they are
                   6813:     applied, files ending in <code class="filename">.orig</code> or
                   6814:     <code class="filename">.rej</code> are ignored. Any special options to
1.110     hubertf  6815:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
                   6816:     <code class="varname">PATCH_DIST_ARGS</code>.  See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a> for more details.</p>
                   6817: <p>By default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special args to make
1.88      wiz      6818:     it fail if the patches apply with some lines of fuzz. Please
                   6819:     fix (regen) the patches so that they apply cleanly. The
                   6820:     rationale behind this is that patches that don't apply cleanly
                   6821:     may end up being applied in the wrong place, and cause severe
                   6822:     harm there.</p>
1.75      rillig   6823: </div>
                   6824: <div class="sect1" lang="en">
                   6825: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6826: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.110     hubertf  6827: <p>This is covered in <a class="xref" href="#tools" title="Chapter 18. Tools needed for building or running">Chapter 18, <i>Tools needed for building or running</i></a>.
1.88      wiz      6828:     </p>
1.75      rillig   6829: </div>
                   6830: <div class="sect1" lang="en">
                   6831: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6832: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75      rillig   6833: <p>This phase creates wrapper programs for the compilers and
1.88      wiz      6834:     linkers. The following variables can be used to tweak the
                   6835:     wrappers.</p>
1.75      rillig   6836: <div class="variablelist"><dl>
                   6837: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   6838: <dd><p>The command used to print progress
1.88      wiz      6839:       messages. Does nothing by default. Set to
                   6840:       <code class="literal">${ECHO}</code> to see the progress
                   6841:       messages.</p></dd>
1.75      rillig   6842: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   6843: <dd><p>This variable can be set to
1.88      wiz      6844:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   6845:       depending on whether you want additional information in the
                   6846:       wrapper log file.</p></dd>
1.75      rillig   6847: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   6848: <dd><p>This variable can be set to
1.88      wiz      6849:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   6850:       on whether the wrapper should use its cache, which will
                   6851:       improve the speed. The default value is
                   6852:       <code class="literal">yes</code>, but is forced to
                   6853:       <code class="literal">no</code> if the platform does not support
                   6854:       it.</p></dd>
1.75      rillig   6855: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88      wiz      6856: <dd><p>A list of reordering commands. A reordering
                   6857:       command has the form
                   6858:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   6859:       It ensures that that
                   6860:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   6861:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   6862:       </p></dd>
1.75      rillig   6863: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
                   6864: <dd><p>A list of transformation commands. [TODO:
1.88      wiz      6865:       investigate further]</p></dd>
1.75      rillig   6866: </dl></div>
                   6867: </div>
                   6868: <div class="sect1" lang="en">
                   6869: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6870: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88      wiz      6871: <p>Most pieces of software need information on the header
                   6872:     files, system calls, and library routines which are available
                   6873:     on the platform they run on. The process of determining this
                   6874:     information is known as configuration, and is usually
                   6875:     automated. In most cases, a script is supplied with the
                   6876:     distfiles, and its invocation results in generation of header
                   6877:     files, Makefiles, etc.</p>
                   6878: <p>If the package contains a configure script, this can be
                   6879:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
                   6880:     &#8220;<span class="quote">yes</span>&#8221;. If the configure script is a GNU autoconf
                   6881:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
                   6882:     &#8220;<span class="quote">yes</span>&#8221; instead. What happens in the
                   6883:     <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
                   6884: <pre class="programlisting">
1.100     rillig   6885: .for d in ${CONFIGURE_DIRS}
                   6886:         cd ${WRKSRC} \
                   6887:         &amp;&amp; cd ${d} \
                   6888:         &amp;&amp; env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
                   6889: .endfor
                   6890: </pre>
1.88      wiz      6891: <p><code class="varname">CONFIGURE_DIRS</code> (default:
                   6892:     &#8220;<span class="quote">.</span>&#8221;) is a list of pathnames relative to
                   6893:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   6894:     configure script is run with the environment
                   6895:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   6896:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   6897:     <code class="varname">CONFIGURE_ENV</code>,
                   6898:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
                   6899:     &#8220;<span class="quote">./configure</span>&#8221;) and
                   6900:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   6901:     package.</p>
                   6902: <p>If the program uses an <code class="filename">Imakefile</code>
                   6903:     for configuration, the appropriate steps can be invoked by
                   6904:     setting <code class="varname">USE_IMAKE</code> to
                   6905:     &#8220;<span class="quote">yes</span>&#8221;. (If you only want the package installed in
                   6906:     <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
1.97      rillig   6907:     <code class="varname">USE_X11BASE</code> instead.)  You can add variables to
                   6908:     xmkmf's environment by adding them to the
                   6909:     <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.111     rillig   6910: <p>If the program uses <code class="filename">cmake</code>
                   6911:     for configuration, the appropriate steps can be invoked by
                   6912:     setting <code class="varname">USE_CMAKE</code> to &#8220;<span class="quote">yes</span>&#8221;.
                   6913:     You can add variables to cmake's environment by adding them to the
                   6914:     <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
                   6915:     by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
                   6916:     The top directory argument is given by the
                   6917:     <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
                   6918:     &#8220;<span class="quote">.</span>&#8221; (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.97      rillig   6919: <p>If there is no configure step at all, set
                   6920:     <code class="varname">NO_CONFIGURE</code> to &#8220;<span class="quote">yes</span>&#8221;.</p>
1.75      rillig   6921: </div>
                   6922: <div class="sect1" lang="en">
                   6923: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6924: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88      wiz      6925: <p>For building a package, a rough equivalent of the
                   6926:     following code is executed.</p>
1.75      rillig   6927: <pre class="programlisting">
1.100     rillig   6928: .for d in ${BUILD_DIRS}
                   6929:         cd ${WRKSRC} \
                   6930:         &amp;&amp; cd ${d} \
                   6931:         &amp;&amp; env ${MAKE_ENV} \
                   6932:             ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
                   6933:                 -f ${MAKE_FILE} \
                   6934:                 ${BUILD_TARGET}
                   6935: .endfor
                   6936: </pre>
1.88      wiz      6937: <p><code class="varname">BUILD_DIRS</code> (default:
                   6938:     &#8220;<span class="quote">.</span>&#8221;) is a list of pathnames relative to
                   6939:     <code class="varname">WRKSRC</code>. In each of these directories,
                   6940:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   6941:     <code class="varname">MAKE_ENV</code> and arguments
                   6942:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   6943:     <code class="varname">MAKE_ENV</code>,
                   6944:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   6945:     <code class="varname">MAKE_FILE</code> and
                   6946:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   6947:     package.</p>
1.75      rillig   6948: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.88      wiz      6949:     &#8220;<span class="quote">gmake</span>&#8221; if <code class="varname">USE_TOOLS</code> contains
                   6950:     &#8220;<span class="quote">gmake</span>&#8221;, &#8220;<span class="quote">make</span>&#8221; otherwise. The
                   6951:     default value of <code class="varname">MAKE_FILE</code> is
                   6952:     &#8220;<span class="quote">Makefile</span>&#8221;, and <code class="varname">BUILD_TARGET</code>
                   6953:     defaults to &#8220;<span class="quote">all</span>&#8221;.</p>
1.97      rillig   6954: <p>If there is no build step at all, set
                   6955:     <code class="varname">NO_BUILD</code> to &#8220;<span class="quote">yes</span>&#8221;.</p>
1.75      rillig   6956: </div>
                   6957: <div class="sect1" lang="en">
                   6958: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6959: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75      rillig   6960: <p>[TODO]</p>
                   6961: </div>
                   6962: <div class="sect1" lang="en">
                   6963: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6964: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75      rillig   6965: <p>Once the build stage has completed, the final step is to
1.88      wiz      6966:     install the software in public directories, so users can
                   6967:     access the programs and files.</p>
1.75      rillig   6968: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88      wiz      6969:     equivalent of the following code is executed. Additionally,
                   6970:     before and after this code, much magic is performed to do
                   6971:     consistency checks, registering the package, and so on.</p>
                   6972: <pre class="programlisting">
1.100     rillig   6973: .for d in ${INSTALL_DIRS}
                   6974:         cd ${WRKSRC} \
                   6975:         &amp;&amp; cd ${d} \
                   6976:         &amp;&amp; env ${MAKE_ENV} \
                   6977:             ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
                   6978:                 -f ${MAKE_FILE} \
                   6979:                 ${INSTALL_TARGET}
                   6980: .endfor
                   6981: </pre>
1.75      rillig   6982: <p>The variable's meanings are analogous to the ones in the
1.88      wiz      6983:     <span class="emphasis"><em>build</em></span> phase.
                   6984:     <code class="varname">INSTALL_DIRS</code> defaults to
                   6985:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
                   6986:     is &#8220;<span class="quote">install</span>&#8221; by default, plus
                   6987:     &#8220;<span class="quote">install.man</span>&#8221; if <code class="varname">USE_IMAKE</code> is
                   6988:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   6989:     defined.</p>
1.75      rillig   6990: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88      wiz      6991:     variables are useful. They are all variations of the
1.110     hubertf  6992:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.88      wiz      6993:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   6994:     install command. The specialized variants, together with their
                   6995:     intended use, are:</p>
1.75      rillig   6996: <div class="variablelist"><dl>
                   6997: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88      wiz      6998: <dd><p>directories that contain
                   6999:       binaries</p></dd>
1.75      rillig   7000: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88      wiz      7001: <dd><p>directories that contain
                   7002:       scripts</p></dd>
1.75      rillig   7003: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88      wiz      7004: <dd><p>directories that contain shared and static
                   7005:       libraries</p></dd>
1.75      rillig   7006: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88      wiz      7007: <dd><p>directories that contain data
                   7008:       files</p></dd>
1.75      rillig   7009: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88      wiz      7010: <dd><p>directories that contain man
                   7011:       pages</p></dd>
1.75      rillig   7012: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88      wiz      7013: <dd><p>binaries that can be stripped from debugging
                   7014:       symbols</p></dd>
1.75      rillig   7015: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88      wiz      7016: <dd><p>binaries that cannot be
                   7017:       stripped</p></dd>
1.75      rillig   7018: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88      wiz      7019: <dd><p>game
                   7020:       binaries</p></dd>
1.75      rillig   7021: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88      wiz      7022: <dd><p>shared and static
                   7023:       libraries</p></dd>
1.75      rillig   7024: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   7025: <dd><p>data files</p></dd>
                   7026: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88      wiz      7027: <dd><p>data files for
                   7028:       games</p></dd>
1.75      rillig   7029: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   7030: <dd><p>man pages</p></dd>
                   7031: </dl></div>
                   7032: <p>Some other variables are:</p>
                   7033: <div class="variablelist"><dl>
                   7034: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   7035: <dd><p>A list of directories relative to
1.88      wiz      7036:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98      wiz      7037:       beginning of the <span class="emphasis"><em>install</em></span> phase.
                   7038:       The package is supposed to create all needed directories itself
                   7039:       before installing files to it and list all other directories here.
                   7040:       </p></dd>
1.75      rillig   7041: </dl></div>
1.97      rillig   7042: <p>In the rare cases that a package shouldn't install anything,
                   7043:     set <code class="varname">NO_INSTALL</code> to &#8220;<span class="quote">yes</span>&#8221;. This is
                   7044:     mostly relevant for packages in the <code class="filename">regress</code>
                   7045:     category.</p>
1.75      rillig   7046: </div>
                   7047: <div class="sect1" lang="en">
                   7048: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7049: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88      wiz      7050: <p>Once the install stage has completed, a binary package of
                   7051:     the installed files can be built.  These binary packages can be
                   7052:     used for quick installation without previous compilation, e.g. by
1.110     hubertf  7053:     the <span class="command"><strong>make bin-install</strong></span> or by using
                   7054:     <span class="command"><strong>pkg_add</strong></span>.</p>
1.88      wiz      7055: <p>By default, the binary packages are created in
                   7056:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   7057:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   7058:     one for each category in the <code class="varname">CATEGORIES</code>
                   7059:     variable.  <code class="varname">PACKAGES</code> defaults to
                   7060:     <code class="filename">pkgsrc/packages</code>.</p>
1.97      rillig   7061: <p>If there should be no binary package, set
                   7062:     <code class="varname">NO_PACKAGE</code> to &#8220;<span class="quote">yes</span>&#8221;.
                   7063:     This should only be used in rare cases, like when a package
                   7064:     definitely is only usable on the machine where it is built and even
                   7065:     then, a binary package can be useful.</p>
1.88      wiz      7066: </div>
                   7067: <div class="sect1" lang="en">
                   7068: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7069: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.88      wiz      7070: <p>Once you're finished with a package, you can clean the work
1.110     hubertf  7071:     directory by running <span class="command"><strong>make clean</strong></span>.  If you want
1.88      wiz      7072:     to clean the work directories of all dependencies too, use
1.110     hubertf  7073:     <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75      rillig   7074: </div>
                   7075: <div class="sect1" lang="en">
                   7076: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7077: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.75      rillig   7078: <div class="variablelist"><dl>
                   7079: <dt><span class="term">pre/post-*</span></dt>
1.88      wiz      7080: <dd><p>For any of the main targets described in the
                   7081:          previous section, two auxiliary targets exist with
1.87      wiz      7082:          &#8220;<span class="quote">pre-</span>&#8221; and &#8220;<span class="quote">post-</span>&#8221; used as a
                   7083:          prefix for the main target's name.  These targets are
1.88      wiz      7084:          invoked before and after the main target is called,
                   7085:          allowing extra configuration or installation steps be
                   7086:          performed from a package's Makefile, for example, which
                   7087:          a program's configure script or install target
                   7088:          omitted.</p></dd>
1.75      rillig   7089: <dt><span class="term">do-*</span></dt>
1.88      wiz      7090: <dd><p>Should one of the main targets do the wrong thing,
                   7091:          and should there be no variable to fix this, you can
                   7092:          redefine it with the do-* target.  (Note that redefining
                   7093:          the target itself instead of the do-* target is a bad
                   7094:          idea, as the pre-* and post-* targets won't be called
                   7095:          anymore, etc.) You will not usually need to do
                   7096:          this.</p></dd>
1.75      rillig   7097: <dt><span class="term">reinstall</span></dt>
1.88      wiz      7098: <dd>
1.110     hubertf  7099: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.88      wiz      7100:          you noticed some file was not installed properly, you
                   7101:          can repeat the installation with this target, which will
                   7102:          ignore the &#8220;<span class="quote">already installed</span>&#8221; flag.</p>
                   7103: <p>This is the default value of
                   7104:          <code class="varname">DEPENDS_TARGET</code> except in the case of
1.110     hubertf  7105:          <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.88      wiz      7106:          package</strong></span>, where the defaults are
                   7107:          &#8220;<span class="quote">package</span>&#8221; and &#8220;<span class="quote">update</span>&#8221;,
                   7108:          respectively.</p>
                   7109: </dd>
1.75      rillig   7110: <dt><span class="term">deinstall</span></dt>
                   7111: <dd>
1.110     hubertf  7112: <p>This target does a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.88      wiz      7113:          current directory, effectively de-installing the
                   7114:          package. The following variables can be used to tune the
                   7115:          behaviour:</p>
1.75      rillig   7116: <div class="variablelist"><dl>
                   7117: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.110     hubertf  7118: <dd><p>Add a "-v" to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.75      rillig   7119: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88      wiz      7120: <dd><p>Remove all packages that require (depend on)
                   7121:                the given package.  This can be used to remove any
                   7122:                packages that may have been pulled in by a given
1.110     hubertf  7123:                package, e.g. if <span class="command"><strong>make deinstall
1.87      wiz      7124:                DEINSTALLDEPENDS=1</strong></span> is done in
1.88      wiz      7125:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   7126:                likely to remove whole KDE. Works by adding
1.110     hubertf  7127:                &#8220;<span class="quote">-R</span>&#8221; to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.88      wiz      7128:                command line.</p></dd>
1.75      rillig   7129: </dl></div>
                   7130: </dd>
1.88      wiz      7131: <dt><span class="term">bin-install</span></dt>
                   7132: <dd><p>Install a binary package from local disk and via FTP
                   7133:          from a list of sites (see the
                   7134:          <code class="varname">BINPKG_SITES</code> variable), and do a
1.110     hubertf  7135:          <span class="command"><strong>make package</strong></span> if no binary package is
1.88      wiz      7136:          available anywhere.  The arguments given to
1.110     hubertf  7137:          <span class="command"><strong>pkg_add</strong></span> can be set via
1.88      wiz      7138:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   7139:          operation, etc.</p></dd>
1.75      rillig   7140: <dt><span class="term">update</span></dt>
                   7141: <dd>
1.88      wiz      7142: <p>This target causes the current package to be
                   7143:          updated to the latest version.  The package and all
                   7144:          depending packages first get de-installed, then current
                   7145:          versions of the corresponding packages get compiled and
                   7146:          installed.  This is similar to manually noting which
                   7147:          packages are currently installed, then performing a
1.110     hubertf  7148:          series of <span class="command"><strong>make deinstall</strong></span> and
                   7149:          <span class="command"><strong>make install</strong></span> (or whatever
1.88      wiz      7150:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   7151:          packages.</p>
                   7152: <p>You can use the &#8220;<span class="quote">update</span>&#8221; target to
1.110     hubertf  7153:          resume package updating in case a previous <span class="command"><strong>make
1.88      wiz      7154:          update</strong></span> was interrupted for some reason.
                   7155:          However, in this case, make sure you don't call
1.110     hubertf  7156:          <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.88      wiz      7157:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   7158:          Otherwise, you lose the ability to automatically update
                   7159:          the current package along with the dependent packages
                   7160:          you have installed.</p>
1.110     hubertf  7161: <p>Resuming an interrupted <span class="command"><strong>make
1.88      wiz      7162:          update</strong></span> will only work as long as the package
                   7163:          tree remains unchanged.  If the source code for one of
                   7164:          the packages to be updated has been changed, resuming
1.110     hubertf  7165:          <span class="command"><strong>make update</strong></span> will most certainly
1.88      wiz      7166:          fail!</p>
                   7167: <p>The following variables can be used either on the
1.110     hubertf  7168:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
                   7169:          alter the behaviour of <span class="command"><strong>make
1.88      wiz      7170:          update</strong></span>:</p>
1.75      rillig   7171: <div class="variablelist"><dl>
                   7172: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88      wiz      7173: <dd><p>Install target to recursively use for the
                   7174:                updated package and the dependent packages.
                   7175:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
                   7176:                set, &#8220;<span class="quote">install</span>&#8221; otherwise for
1.110     hubertf  7177:                <span class="command"><strong>make update</strong></span>.  Other good
1.88      wiz      7178:                targets are &#8220;<span class="quote">package</span>&#8221; or
                   7179:                &#8220;<span class="quote">bin-install</span>&#8221;.  Do not set this to
                   7180:                &#8220;<span class="quote">update</span>&#8221; or you will get stuck in an
                   7181:                endless loop!</p></dd>
1.75      rillig   7182: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88      wiz      7183: <dd><p>Don't clean up after updating.  Useful if
                   7184:                you want to leave the work sources of the updated
                   7185:                packages around for inspection or other purposes.
                   7186:                Be sure you eventually clean up the source tree
                   7187:                (see the &#8220;<span class="quote">clean-update</span>&#8221; target below)
                   7188:                or you may run into troubles with old source code
                   7189:                still lying around on your next
1.110     hubertf  7190:                <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.88      wiz      7191:                update</strong></span>.</p></dd>
1.75      rillig   7192: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88      wiz      7193: <dd><p>Deinstall each package before installing
                   7194:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   7195:                may be necessary if the
                   7196:                &#8220;<span class="quote">clean-update</span>&#8221; target (see below) was
1.110     hubertf  7197:                called after interrupting a running <span class="command"><strong>make
1.88      wiz      7198:                update</strong></span>.</p></dd>
1.75      rillig   7199: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88      wiz      7200: <dd><p>Allows you to disable recursion and hardcode
                   7201:                the target for packages.  The default is
                   7202:                &#8220;<span class="quote">update</span>&#8221; for the update target,
                   7203:                facilitating a recursive update of prerequisite
                   7204:                packages.  Only set
                   7205:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   7206:                disable recursive updates. Use
                   7207:                <code class="varname">UPDATE_TARGET</code> instead to just
                   7208:                set a specific target for each package to be
1.110     hubertf  7209:                installed during <span class="command"><strong>make update</strong></span>
1.88      wiz      7210:                (see above).</p></dd>
1.75      rillig   7211: </dl></div>
                   7212: </dd>
                   7213: <dt><span class="term">clean-update</span></dt>
                   7214: <dd>
1.88      wiz      7215: <p>Clean the source tree for all packages that would
1.110     hubertf  7216:          get updated if <span class="command"><strong>make update</strong></span> was called
1.88      wiz      7217:          from the current directory.  This target should not be
                   7218:          used if the current package (or any of its depending
                   7219:          packages) have already been de-installed (e.g., after
1.110     hubertf  7220:          calling <span class="command"><strong>make update</strong></span>) or you may lose
1.88      wiz      7221:          some packages you intended to update. As a rule of
                   7222:          thumb: only use this target <span class="emphasis"><em>before</em></span>
1.110     hubertf  7223:          the first time you run <span class="command"><strong>make update</strong></span>
1.88      wiz      7224:          and only if you have a dirty package tree (e.g., if you
                   7225:          used <code class="varname">NOCLEAN</code>).</p>
                   7226: <p>If you are unsure about whether your tree is
1.110     hubertf  7227:          clean, you can either perform a <span class="command"><strong>make
1.88      wiz      7228:          clean</strong></span> at the top of the tree, or use the
                   7229:          following sequence of commands from the directory of the
                   7230:          package you want to update (<span class="emphasis"><em>before</em></span>
1.110     hubertf  7231:          running <span class="command"><strong>make update</strong></span> for the first
1.88      wiz      7232:          time, otherwise you lose all the packages you wanted to
                   7233:          update!):</p>
1.87      wiz      7234: <pre class="screen">
                   7235: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75      rillig   7236: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87      wiz      7237: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   7238:          </pre>
1.88      wiz      7239: <p>The following variables can be used either on the
1.110     hubertf  7240:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
                   7241:          <span class="command"><strong>make clean-update</strong></span>:</p>
1.75      rillig   7242: <div class="variablelist"><dl>
                   7243: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.110     hubertf  7244: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.88      wiz      7245:                reconstruct the list of directories to update for
1.110     hubertf  7246:                this package.  Only use this if <span class="command"><strong>make
1.88      wiz      7247:                update</strong></span> successfully installed all
                   7248:                packages you wanted to update.  Normally, this is
1.110     hubertf  7249:                done automatically on <span class="command"><strong>make
1.88      wiz      7250:                update</strong></span>, but may have been suppressed by
                   7251:                the <code class="varname">NOCLEAN</code> variable (see
                   7252:                above).</p></dd>
1.75      rillig   7253: </dl></div>
                   7254: </dd>
1.88      wiz      7255: <dt><span class="term">replace</span></dt>
                   7256: <dd>
                   7257: <p>Update the installation of the current package.  This
                   7258:          differs from update in that it does not replace dependent
1.93      rillig   7259:          packages.  You will need to install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a> for this
1.88      wiz      7260:          target to work.</p>
                   7261: <p><span class="emphasis"><em>Be careful when using this
                   7262:          target!</em></span> There are no guarantees that dependent
                   7263:          packages will still work, in particular they will most
1.110     hubertf  7264:          certainly break if you <span class="command"><strong>make replace</strong></span> a
1.88      wiz      7265:          library package whose shared library major version changed
                   7266:          between your installed version and the new one.  For this
                   7267:          reason, this target is not officially supported and only
                   7268:          recommended for advanced users.</p>
                   7269: </dd>
1.75      rillig   7270: <dt><span class="term">info</span></dt>
1.110     hubertf  7271: <dd><p>This target invokes <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.88      wiz      7272:          package. You can use this to check which version of a
                   7273:          package is installed.</p></dd>
                   7274: <dt><span class="term">index</span></dt>
                   7275: <dd>
                   7276: <p>This is a top-level command, i.e. it should be used in
                   7277:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   7278:          database of all packages in the local pkgsrc tree, including
                   7279:          dependencies, comment, maintainer, and some other useful
                   7280:          information.  Individual entries are created by running
1.110     hubertf  7281:          <span class="command"><strong>make describe</strong></span> in the packages'
1.88      wiz      7282:          directories.  This index file is saved as
                   7283:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
1.110     hubertf  7284:          verbose format by running <span class="command"><strong>make
1.88      wiz      7285:          print-index</strong></span>.  You can search in it with
1.110     hubertf  7286:          <span class="command"><strong>make search
1.88      wiz      7287:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   7288:          extract a list of all packages that depend on a particular
1.110     hubertf  7289:          one by running <span class="command"><strong>make show-deps
1.88      wiz      7290:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   7291: <p>Running this command takes a very long time, some
                   7292:          hours even on fast machines!</p>
                   7293: </dd>
1.75      rillig   7294: <dt><span class="term">readme</span></dt>
1.88      wiz      7295: <dd>
                   7296: <p>This target generates a
                   7297:          <code class="filename">README.html</code> file, which can be
1.91      rillig   7298:          viewed using a browser such as <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/links/README.html" target="_top"><code class="filename">www/links</code></a>.  The generated files
1.88      wiz      7299:          contain references to any packages which are in the
                   7300:          <code class="varname">PACKAGES</code> directory on the local
                   7301:          host. The generated files can be made to refer to URLs
                   7302:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   7303:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
                   7304:          wanted to generate <code class="filename">README.html</code>
                   7305:          files which pointed to binary packages on the local
                   7306:          machine, in the directory
                   7307:          <code class="filename">/usr/packages</code>, set
                   7308:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   7309:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   7310:          <code class="varname">${PACKAGES}</code> directory and its
                   7311:          subdirectories will be searched for all the binary
                   7312:          packages.</p>
                   7313: <p>The target can be run at the toplevel or in category
                   7314:          directories, in which case it descends recursively.</p>
                   7315: </dd>
1.75      rillig   7316: <dt><span class="term">readme-all</span></dt>
1.88      wiz      7317: <dd><p>This is a top-level command, run it in
                   7318:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   7319:          file <code class="filename">README-all.html</code> which contains a
                   7320:          list of all packages currently available in the NetBSD
                   7321:          Packages Collection, together with the category they belong
                   7322:          to and a short description. This file is compiled from the
                   7323:          <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.110     hubertf  7324:          to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.88      wiz      7325:          readme</strong></span>.</p></dd>
1.75      rillig   7326: <dt><span class="term">cdrom-readme</span></dt>
1.88      wiz      7327: <dd><p>This is very much the same as the
                   7328:          &#8220;<span class="quote">readme</span>&#8221; target (see above), but is to be
                   7329:          used when generating a pkgsrc tree to be written to a
                   7330:          CD-ROM.  This target also produces
                   7331:          <code class="filename">README.html</code> files, and can be made
                   7332:          to refer to URLs based on
                   7333:          <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87      wiz      7334:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75      rillig   7335: <dt><span class="term">show-distfiles</span></dt>
1.88      wiz      7336: <dd><p>This target shows which distfiles and patchfiles
                   7337:          are needed to build the package
                   7338:          (<code class="varname">ALLFILES</code>, which contains all
                   7339:          <code class="varname">DISTFILES</code> and
1.87      wiz      7340:          <code class="varname">PATCHFILES</code>, but not
                   7341:          <code class="filename">patches/*</code>).</p></dd>
1.75      rillig   7342: <dt><span class="term">show-downlevel</span></dt>
1.88      wiz      7343: <dd><p>This target shows nothing if the package is not
                   7344:          installed. If a version of this package is installed,
                   7345:          but is not the version provided in this version of
                   7346:          pkgsrc, then a warning message is displayed. This target
                   7347:          can be used to show which of your installed packages are
                   7348:          downlevel, and so the old versions can be deleted, and
                   7349:          the current ones added.</p></dd>
1.75      rillig   7350: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88      wiz      7351: <dd><p>This target shows the directory in the pkgsrc
                   7352:          hierarchy from which the package can be built and
                   7353:          installed. This may not be the same directory as the one
                   7354:          from which the package was installed. This target is
                   7355:          intended to be used by people who may wish to upgrade
                   7356:          many packages on a single host, and can be invoked from
                   7357:          the top-level pkgsrc Makefile by using the
1.87      wiz      7358:          &#8220;<span class="quote">show-host-specific-pkgs</span>&#8221; target.</p></dd>
1.75      rillig   7359: <dt><span class="term">show-installed-depends</span></dt>
1.88      wiz      7360: <dd><p>This target shows which installed packages match
                   7361:          the current package's <code class="varname">DEPENDS</code>. Useful
                   7362:          if out of date dependencies are causing build
                   7363:          problems.</p></dd>
1.75      rillig   7364: <dt><span class="term">check-shlibs</span></dt>
1.88      wiz      7365: <dd><p>After a package is installed, check all its
                   7366:          binaries and (on ELF platforms) shared libraries to see
                   7367:          if they find the shared libs they need.  Run by default
1.110     hubertf  7368:          if <code class="varname">PKG_DEVELOPER</code> is set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></dd>
1.75      rillig   7369: <dt><span class="term">print-PLIST</span></dt>
                   7370: <dd>
                   7371: <p>After a &#8220;<span class="quote">make install</span>&#8221; from a new or
1.88      wiz      7372:          upgraded pkg, this prints out an attempt to generate a
1.110     hubertf  7373:          new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.88      wiz      7374:          -newer work/.extract_done</strong></span>.  An attempt is made
                   7375:          to care for shared libs etc., but it is
1.87      wiz      7376:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   7377:          result before putting it into
                   7378:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   7379:          diff the output of this command against an already
                   7380:          existing <code class="filename">PLIST</code> file.</p>
1.110     hubertf  7381: <p>If the package installs files via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.88      wiz      7382:          other methods that don't update file access times, be
                   7383:          sure to add these files manually to your
1.87      wiz      7384:          <code class="filename">PLIST</code>, as the &#8220;<span class="quote">find
                   7385:          -newer</span>&#8221; command used by this target won't catch
                   7386:          them!</p>
1.116   ! rillig   7387: <p>See <a class="xref" href="#print-PLIST" title="13.3. Tweaking output of make print-PLIST">Section 13.3, &#8220;Tweaking output of make print-PLIST&#8221;</a> for more
1.87      wiz      7388:          information on this target.</p>
1.75      rillig   7389: </dd>
                   7390: <dt><span class="term">bulk-package</span></dt>
                   7391: <dd>
1.88      wiz      7392: <p>Used to do bulk builds. If an appropriate binary
                   7393:          package already exists, no action is taken. If not, this
                   7394:          target will compile, install and package it (and its
                   7395:          depends, if <code class="varname">PKG_DEPENDS</code> is set
1.110     hubertf  7396:          properly. See <a class="xref" href="#binary.configuration" title="7.3.1. Configuration">Section 7.3.1, &#8220;Configuration&#8221;</a>).
1.88      wiz      7397:          After creating the binary package, the sources, the
                   7398:          just-installed package and its required packages are
                   7399:          removed, preserving free disk space.</p>
                   7400: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7401:          all packages installed on a system!</em></span></p>
1.75      rillig   7402: </dd>
                   7403: <dt><span class="term">bulk-install</span></dt>
                   7404: <dd>
1.88      wiz      7405: <p>Used during bulk-installs to install required
                   7406:          packages. If an up-to-date binary package is available,
1.110     hubertf  7407:          it will be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. If not,
                   7408:          <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.87      wiz      7409:          but the installed binary won't be removed.</p>
1.88      wiz      7410: <p>A binary package is considered
                   7411:          &#8220;<span class="quote">up-to-date</span>&#8221; to be installed via
1.110     hubertf  7412:          <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> if:</p>
1.88      wiz      7413: <div class="itemizedlist"><ul type="disc">
                   7414: <li><p>None of the package's files
                   7415:              (<code class="filename">Makefile</code>, ...) were modified
                   7416:              since it was built.</p></li>
                   7417: <li><p>None of the package's required (binary)
                   7418:              packages were modified since it was built.</p></li>
1.75      rillig   7419: </ul></div>
1.88      wiz      7420: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7421:          all packages installed on a system!</em></span></p>
1.75      rillig   7422: </dd>
                   7423: </dl></div>
                   7424: </div>
                   7425: </div>
                   7426: <div class="chapter" lang="en">
                   7427: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   7428: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.75      rillig   7429: <div class="toc">
                   7430: <p><b>Table of Contents</b></p>
                   7431: <dl>
1.106     rillig   7432: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   7433: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   7434: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                   7435: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.75      rillig   7436: </dl>
                   7437: </div>
1.87      wiz      7438: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75      rillig   7439: by pkgsrc and also for individual packages to define what commands
                   7440: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
                   7441: or for later run-time of an installed packaged (such as
                   7442: <code class="varname">DEPENDS</code>).
                   7443: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87      wiz      7444: package will not be used.</p>
                   7445: <p>When building a package, the replacement tools are
1.75      rillig   7446: made available in a directory (as symlinks or wrapper scripts)
                   7447: that is early in the executable search path. Just like the buildlink
1.87      wiz      7448: system, this helps with consistent builds.</p>
                   7449: <p>A tool may be needed to help build a specific package. For example,
                   7450: perl, GNU make (gmake) or yacc may be needed.</p>
                   7451: <p>Also a tool may be needed, for example, because the native system's supplied
1.75      rillig   7452: tool may be inefficient for building a package with pkgsrc.
                   7453: For example, a package may need GNU awk, bison (instead of
1.87      wiz      7454: yacc) or a better sed.</p>
                   7455: <p>The tools used by a package can be listed by running
1.110     hubertf  7456: <span class="command"><strong>make show-tools</strong></span>.</p>
1.75      rillig   7457: <div class="sect1" lang="en">
                   7458: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7459: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.87      wiz      7460: <p>The default set of tools used by pkgsrc is defined in
1.76      rillig   7461: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.110     hubertf  7462: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
                   7463: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.75      rillig   7464: These can be seen by running:
1.110     hubertf  7465: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.87      wiz      7466: <p>If a package needs a specific program to build
1.75      rillig   7467: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87      wiz      7468: to define the tools needed.</p>
1.75      rillig   7469: </div>
                   7470: <div class="sect1" lang="en">
                   7471: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7472: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.87      wiz      7473: <p>In the following examples, the :pkgsrc means to use the pkgsrc version
1.75      rillig   7474: and not the native version for a build dependency.
                   7475: And the :run means that it is used for a
                   7476: run-time dependencies also (and becomes a DEPENDS).
                   7477: The default is a build dependency which can be set with
                   7478: :build. (So in this example, it is the same as gmake:build
1.87      wiz      7479: and pkg-config:build.)</p>
1.75      rillig   7480: <pre class="programlisting">
                   7481: USE_TOOLS+=     mktemp:pkgsrc
                   7482: USE_TOOLS+=     gmake perl:run pkg-config
                   7483: </pre>
1.87      wiz      7484: <p>When using the tools framework, a
1.75      rillig   7485: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   7486: which contains the full path to the appropriate tool. For example,
                   7487: <code class="varname">TOOLS_PATH.bash</code> could be &#8220;<span class="quote">/bin/bash</span>&#8221;
1.87      wiz      7488: on Linux systems.</p>
                   7489: <p>If you always need a pkgsrc version of the
1.75      rillig   7490: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   7491: </p>
                   7492: </div>
                   7493: <div class="sect1" lang="en">
                   7494: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7495: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.87      wiz      7496: <p>When improving or porting pkgsrc to a new platform, have a look
1.75      rillig   7497: at (or create) the corresponding platform specific make file fragment under
1.76      rillig   7498: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75      rillig   7499: the name of the common tools. For example:</p>
                   7500: <pre class="programlisting">
                   7501: .if exists(/usr/bin/bzcat)
                   7502: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   7503: .elif exists(/usr/bin/bzip2)
                   7504: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   7505: .endif
1.69      rillig   7506: 
1.75      rillig   7507: TOOLS_PLATFORM.true?=           true                    # shell builtin
                   7508: </pre>
                   7509: </div>
1.97      rillig   7510: <div class="sect1" lang="en">
                   7511: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7512: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.97      rillig   7513: <div class="qandaset">
                   7514: <dl>
1.106     rillig   7515: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.97      rillig   7516: </dt>
1.106     rillig   7517: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.97      rillig   7518:        tools?</a>
                   7519: </dt>
1.106     rillig   7520: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.97      rillig   7521:        package is using while being built? I want to know whether it
                   7522:        uses sed or not.</a>
                   7523: </dt>
                   7524: </dl>
                   7525: <table border="0" summary="Q and A Set">
                   7526: <col align="left" width="1%">
                   7527: <tbody>
                   7528: <tr class="question">
                   7529: <td align="left" valign="top">
1.116   ! rillig   7530: <a name="tools.new"></a><a name="id364453"></a><p><b>18.4.1.</b></p>
1.97      rillig   7531: </td>
                   7532: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
                   7533: </tr>
                   7534: <tr class="answer">
                   7535: <td align="left" valign="top"></td>
                   7536: <td align="left" valign="top"><p>TODO</p></td>
                   7537: </tr>
                   7538: <tr class="question">
                   7539: <td align="left" valign="top">
1.116   ! rillig   7540: <a name="tools.listall"></a><a name="id364465"></a><p><b>18.4.2.</b></p>
1.97      rillig   7541: </td>
                   7542: <td align="left" valign="top"><p>How do I get a list of all available
                   7543:        tools?</p></td>
                   7544: </tr>
                   7545: <tr class="answer">
                   7546: <td align="left" valign="top"></td>
                   7547: <td align="left" valign="top"><p>TODO</p></td>
                   7548: </tr>
                   7549: <tr class="question">
                   7550: <td align="left" valign="top">
1.116   ! rillig   7551: <a name="tools.used"></a><a name="id364476"></a><p><b>18.4.3.</b></p>
1.97      rillig   7552: </td>
                   7553: <td align="left" valign="top"><p>How can I get a list of all the tools that a
                   7554:        package is using while being built? I want to know whether it
                   7555:        uses sed or not.</p></td>
                   7556: </tr>
                   7557: <tr class="answer">
                   7558: <td align="left" valign="top"></td>
                   7559: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
                   7560:        to do it.)</p></td>
                   7561: </tr>
                   7562: </tbody>
                   7563: </table>
                   7564: </div>
                   7565: </div>
1.75      rillig   7566: </div>
                   7567: <div class="chapter" lang="en">
                   7568: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   7569: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.75      rillig   7570: <div class="toc">
                   7571: <p><b>Table of Contents</b></p>
                   7572: <dl>
1.106     rillig   7573: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.75      rillig   7574: <dd><dl>
1.106     rillig   7575: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.116   ! rillig   7576: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from ???</a></span></dt>
1.106     rillig   7577: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
                   7578: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
                   7579: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
                   7580: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
                   7581: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
                   7582: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
                   7583: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
                   7584: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
                   7585: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   7586: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   7587: </dl></dd>
1.116   ! rillig   7588: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the fetch phase</a></span></dt>
1.106     rillig   7589: <dd><dl>
                   7590: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   7591: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
                   7592: </dl></dd>
1.116   ! rillig   7593: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the configure phase</a></span></dt>
1.106     rillig   7594: <dd><dl>
                   7595: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   7596: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   7597: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   7598: </dl></dd>
                   7599: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   7600: <dd><dl>
                   7601: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   7602: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   7603: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
                   7604: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
                   7605: </dl></dd>
1.116   ! rillig   7606: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the build phase</a></span></dt>
1.106     rillig   7607: <dd><dl>
                   7608: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   7609: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.116   ! rillig   7610: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to ...</a></span></dt>
1.106     rillig   7611: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   7612: </dl></dd>
1.116   ! rillig   7613: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the install phase</a></span></dt>
1.106     rillig   7614: <dd><dl>
                   7615: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   7616: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   7617: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   7618: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   7619: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   7620: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   7621: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   7622: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107     rillig   7623: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.106     rillig   7624: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper data files</a></span></dt>
                   7625: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   7626: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   7627: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   7628: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   7629: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   7630: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   7631: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   7632: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87      wiz      7633:     emulation</a></span></dt>
1.106     rillig   7634: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   7635: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.75      rillig   7636: </dl></dd>
1.106     rillig   7637: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.75      rillig   7638: </dl>
                   7639: </div>
                   7640: <div class="sect1" lang="en">
                   7641: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7642: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.75      rillig   7643: <div class="sect2" lang="en">
                   7644: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7645: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.78      rillig   7646: <p>One appealing feature of pkgsrc is that it runs on many
1.87      wiz      7647:     different platforms. As a result, it is important to ensure,
                   7648:     where possible, that packages in pkgsrc are portable. This
                   7649:     chapter mentions some particular details you should pay
                   7650:     attention to while working on pkgsrc.</p>
1.78      rillig   7651: </div>
                   7652: <div class="sect2" lang="en">
                   7653: <div class="titlepage"><div><div><h3 class="title">
1.110     hubertf  7654: <a name="pulling-vars-from-etc-mk.conf"></a>19.1.2. How to pull in user-settable variables from <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.93      rillig   7655: </h3></div></div></div>
1.78      rillig   7656: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87      wiz      7657:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110     hubertf  7658:     which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87      wiz      7659:     want to use those variables in the preprocessor directives of
1.110     hubertf  7660:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.87      wiz      7661:     <code class="literal">.for</code>), you need to include the file
                   7662:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   7663:     loads the user preferences.</p>
1.78      rillig   7664: <p>But note that some variables may not be completely defined
1.87      wiz      7665:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
                   7666:     included, as they may contain references to variables that are
                   7667:     not yet defined. In shell commands this is no problem, since
                   7668:     variables are actually macros, which are only expanded when they
                   7669:     are used. But in the preprocessor directives mentioned above and
                   7670:     in dependency lines (of the form <code class="literal">target:
                   7671:     dependencies</code>) the variables are expanded at load
                   7672:     time.</p>
1.78      rillig   7673: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   7674: <h3 class="title">Note</h3>
                   7675: <p>Currently there is no exhaustive list of all
1.87      wiz      7676:     variables that tells you whether they can be used at load time
                   7677:     or only at run time, but it is in preparation.</p>
1.78      rillig   7678: </div>
                   7679: </div>
                   7680: <div class="sect2" lang="en">
                   7681: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7682: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.88      wiz      7683: <p>Occasionally, packages require interaction from the user,
                   7684:     and this can be in a number of ways:</p>
1.78      rillig   7685: <div class="itemizedlist"><ul type="disc">
1.79      rillig   7686: <li><p>When fetching the distfiles, some packages require user
1.87      wiz      7687:        interaction such as entering username/password or accepting a
                   7688:        license on a web page.</p></li>
1.88      wiz      7689: <li><p>When extracting the distfiles, some packages may ask for
                   7690:        passwords.</p></li>
1.78      rillig   7691: <li><p>help to configure the package before it is built</p></li>
                   7692: <li><p>help during the build process</p></li>
                   7693: <li><p>help during the installation of a package</p></li>
                   7694: </ul></div>
1.88      wiz      7695: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
                   7696:     provided to notify the pkgsrc mechanism of an interactive stage
                   7697:     which will be needed, and this should be set in the package's
                   7698:     <code class="filename">Makefile</code>, e.g.:</p>
1.75      rillig   7699: <pre class="programlisting">
1.100     rillig   7700: INTERACTIVE_STAGE=      build
1.87      wiz      7701:     </pre>
1.78      rillig   7702: <p>Multiple interactive stages can be specified:</p>
1.75      rillig   7703: <pre class="programlisting">
1.100     rillig   7704: INTERACTIVE_STAGE=      configure install
1.87      wiz      7705:     </pre>
1.88      wiz      7706: <p>The user can then decide to skip this package by setting the
                   7707:     <code class="varname">BATCH</code> variable.</p>
1.75      rillig   7708: </div>
                   7709: <div class="sect2" lang="en">
                   7710: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7711: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.98      wiz      7712: <p>Authors of software can choose the licence under which
                   7713:     software can be copied.  This is due to copyright law, and reasons
                   7714:     for license choices are outside the scope of pkgsrc.  The pkgsrc
                   7715:     system recognizes that there are a number of licenses which some
                   7716:     users may find objectionable or difficult or impossible to comply
                   7717:     with.  The Free Software Foundation has declared some licenses
                   7718:     "Free", and the Open Source Initiative has a definition of "Open
                   7719:     Source".  The pkgsrc system, as a policy choice, does not label
                   7720:     packages which have licenses that are Free or Open Source.
                   7721:     However, packages without a license meeting either of those tests
                   7722:     are labeled with a license tag denoting the license.  Note that a
                   7723:     package with no license to copy trivially does not meet either the
                   7724:     Free or Open Source test.</p>
                   7725: <p>For packages which are not Free or Open Source, pkgsrc will
                   7726:     not build the package unless the user has indicated to pkgsrc that
                   7727:     packages with that particular license may be built.  Note that
                   7728:     this documentation avoids the term "accepted the license".  The
                   7729:     pkgsrc system is merely providing a mechanism to avoid
1.99      rillig   7730:     accidentally building a package with a non-free license;
1.98      wiz      7731:     judgement and responsibility remain with the user.  (Installation
                   7732:     of binary packages are not currently subject to this mechanism;
                   7733:     this is a bug.)</p>
                   7734: <p>One might want to only install packages with a BSD license,
                   7735:     or the GPL, and not the other.  The pkgsrc license tag mechanism
                   7736:     does not provide a way to do this.  It might be possible to put in
                   7737:     tags for free licenses, and have a default
                   7738:     <code class="varname">ACCEPTABLE_LICENSES</code> variable value, but this is
                   7739:     widely viewed as having a very poor ratio of benefit to
                   7740:     work.</p>
1.78      rillig   7741: <p>The license tag mechanism is intended to address
1.87      wiz      7742:     copyright-related issues surrounding building, installing and
                   7743:     using a package, and not to address redistribution issues (see
                   7744:     <code class="varname">RESTRICTED</code> and
                   7745:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).  However, the above
                   7746:     definition of licenses for which tags are not needed implies
                   7747:     that packages with redistribution restrictions should have
1.98      wiz      7748:     tags, because Free or Open Source programs do not have
                   7749:     redistribution restrictions.</p>
                   7750: <p>Denoting that a package may be copied according to a
                   7751:     particular license is done by placing the license in
1.87      wiz      7752:     <code class="filename">pkgsrc/licenses</code> and setting the
                   7753:     <code class="varname">LICENSE</code> variable to a string identifying the
1.91      rillig   7754:     license, e.g. in <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/xv/README.html" target="_top"><code class="filename">graphics/xv</code></a>:</p>
1.87      wiz      7755: <pre class="programlisting">
1.100     rillig   7756: LICENSE=        xv-license
1.87      wiz      7757:     </pre>
                   7758: <p>When trying to build, the user will get a notice that the
1.98      wiz      7759:     package is covered by a license which has not been placed in the
                   7760:     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87      wiz      7761: <pre class="programlisting">
1.100     rillig   7762: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   7763: ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
                   7764: ===&gt;     To view the license, enter "/usr/bin/make show-license".
                   7765: ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
                   7766: ===&gt;     ACCEPTABLE_LICENSES+=xv-license
                   7767: *** Error code 1
1.87      wiz      7768:     </pre>
1.110     hubertf  7769: <p>The license can be viewed with <span class="command"><strong>make
1.98      wiz      7770:     show-license</strong></span>, and if the user so chooses, the line
1.110     hubertf  7771:     printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98      wiz      7772:     convey to pkgsrc that it should not in the future fail because of
                   7773:     that license:</p>
1.78      rillig   7774: <pre class="programlisting">
1.100     rillig   7775: ACCEPTABLE_LICENSES+=xv-license
1.87      wiz      7776:     </pre>
1.98      wiz      7777: <p>When adding a package with a new license, the license text
                   7778:     should be added to <code class="filename">pkgsrc/licenses</code> for
                   7779:     displaying.  A list of known licenses can be seen in this
1.91      rillig   7780:     directory.</p>
1.98      wiz      7781: <p>When the license changes (in a way other than formatting),
                   7782:     please make sure that the new license has a different name (e.g.,
                   7783:     append the version number if it exists, or the date).  Just
                   7784:     because a user told pkgsrc to build programs under a previous
                   7785:     version of a license does not mean that pkgsrc should build
1.99      rillig   7786:     programs under the new licenses.  The higher-level point is that
1.98      wiz      7787:     pkgsrc does not evaluate licenses for reasonableness; the only
                   7788:     test is a mechanistic test of whether a particular text has been
                   7789:     approved by either of two bodies.</p>
1.78      rillig   7790: <p>The use of <code class="varname">LICENSE=shareware</code>,
1.98      wiz      7791:     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
                   7792:     is deprecated because it does not crisply refer to a particular
                   7793:     license text.  Another problem with such usage is that it does not
                   7794:     enable a user to tell pkgsrc to proceed for a single package
                   7795:     without also telling pkgsrc to proceed for all packages with that
                   7796:     tag.</p>
1.75      rillig   7797: </div>
                   7798: <div class="sect2" lang="en">
                   7799: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7800: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.75      rillig   7801: <p>Some licenses restrict how software may be re-distributed.
1.98      wiz      7802:     Because a license tag is required unless the package is Free or
                   7803:     Open Source, all packages with restrictions should have license
                   7804:     tags.  By declaring the restrictions, package tools can
                   7805:     automatically refrain from e.g. placing binary packages on FTP
                   7806:     sites.</p>
                   7807: <p>There are four restrictions that may be encoded, which are
                   7808:     the cross product of sources (distfiles) and binaries not being
                   7809:     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
                   7810:     language in any license, and because non-Free licenses tend to be
                   7811:     different from each other, pkgsrc adopts a definition of FTP and
                   7812:     CD-ROM.  Pkgsrc uses "FTP" to mean that the source or binary file
                   7813:     should not be made available over the Internet at no charge.
                   7814:     Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
                   7815:     made available on some kind of media, together with other source
                   7816:     and binary packages, and which is sold for a distribution charge.
                   7817:     </p>
                   7818: <p>In order to encode these restrictions, the package system
1.87      wiz      7819:     defines five make variables that can be set to note these
                   7820:     restrictions:</p>
1.75      rillig   7821: <div class="itemizedlist"><ul type="disc">
                   7822: <li>
                   7823: <p><code class="varname">RESTRICTED</code></p>
                   7824: <p>This variable should be set whenever a restriction
1.87      wiz      7825:        exists (regardless of its kind).  Set this variable to a
1.98      wiz      7826:        string containing the reason for the restriction.  It should
                   7827:        be understood that those wanting to understand the restriction
                   7828:        will have to read the license, and perhaps seek advice of
                   7829:        counsel.</p>
1.75      rillig   7830: </li>
                   7831: <li>
                   7832: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98      wiz      7833: <p>Binaries may not be placed on CD-ROM containing other
                   7834:        binary packages, for which a distribution charge may be made.
                   7835:        In this case, set this variable to
                   7836:        <code class="varname">${RESTRICTED}</code>.</p>
1.75      rillig   7837: </li>
                   7838: <li>
                   7839: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98      wiz      7840: <p>Binaries may not made available on the Internet without
                   7841:        charge.  In this case, set this variable to
                   7842:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7843:        binary packages will not be included on ftp.NetBSD.org.</p>
1.75      rillig   7844: </li>
                   7845: <li>
                   7846: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98      wiz      7847: <p>Distfiles may not be placed on CD-ROM, together with
                   7848:        other distfiles, for which a fee may be charged.  In this
                   7849:        case, set this variable to <code class="varname">${RESTRICTED}</code>.
                   7850:        </p>
1.75      rillig   7851: </li>
                   7852: <li>
                   7853: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98      wiz      7854: <p>Distfiles may not made available via FTP at no charge.
                   7855:        In this case, set this variable to
                   7856:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7857:        the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75      rillig   7858: </li>
                   7859: </ul></div>
                   7860: <p>Please note that the use of <code class="varname">NO_PACKAGE</code>,
1.87      wiz      7861:     <code class="varname">IGNORE</code>, <code class="varname">NO_CDROM</code>, or other
                   7862:     generic make variables to denote restrictions is deprecated,
                   7863:     because they unconditionally prevent users from generating
                   7864:     binary packages!</p>
1.75      rillig   7865: </div>
                   7866: <div class="sect2" lang="en">
                   7867: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7868: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.75      rillig   7869: <p>Your package may depend on some other package being present
1.88      wiz      7870:     - and there are various ways of expressing this dependency.
                   7871:     pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
                   7872:     <code class="varname">DEPENDS</code> definitions, the
                   7873:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   7874:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   7875:     to handle dependencies, and which uses the variables named above.
1.110     hubertf  7876:     See <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a> for more information.</p>
1.75      rillig   7877: <p>The basic difference between the two variables is as
1.87      wiz      7878:     follows: The <code class="varname">DEPENDS</code> definition registers
                   7879:     that pre-requisite in the binary package so it will be pulled in
                   7880:     when the binary package is later installed, whilst the
                   7881:     <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
                   7882:     dependency that is only needed for building the package.</p>
1.75      rillig   7883: <p>This means that if you only need a package present whilst
1.87      wiz      7884:     you are building, it should be noted as a
                   7885:     <code class="varname">BUILD_DEPENDS</code>.</p>
1.75      rillig   7886: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87      wiz      7887:     <code class="varname">DEPENDS</code> definition is:</p>
1.75      rillig   7888: <pre class="programlisting">
1.100     rillig   7889: &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
1.87      wiz      7890:     </pre>
1.75      rillig   7891: <p>Please note that the &#8220;<span class="quote">pre-req-package-name</span>&#8221;
1.87      wiz      7892:     may include any of the wildcard version numbers recognized by
1.110     hubertf  7893:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.75      rillig   7894: <div class="orderedlist"><ol type="1">
                   7895: <li>
                   7896: <p>If your package needs another package's binaries or
1.87      wiz      7897:        libraries to build or run, and if that package has a
                   7898:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75      rillig   7899: <pre class="programlisting">
1.100     rillig   7900: .include "../../graphics/jpeg/buildlink3.mk"
1.87      wiz      7901:        </pre>
1.75      rillig   7902: </li>
                   7903: <li>
                   7904: <p>If your package needs to use another package to build
1.87      wiz      7905:        itself and there is no <code class="filename">buildlink3.mk</code>
                   7906:        file available, use the <code class="varname">BUILD_DEPENDS</code>
                   7907:        definition:</p>
1.75      rillig   7908: <pre class="programlisting">
1.100     rillig   7909: BUILD_DEPENDS+= autoconf-2.13:../../devel/autoconf
1.87      wiz      7910:        </pre>
1.75      rillig   7911: </li>
                   7912: <li>
                   7913: <p>If your package needs a library with which to link and
1.76      rillig   7914:        again there is no <code class="filename">buildlink3.mk</code> file
1.87      wiz      7915:        available, this is specified using the
                   7916:        <code class="varname">DEPENDS</code> definition. For example:</p>
1.75      rillig   7917: <pre class="programlisting">
1.100     rillig   7918: DEPENDS+=       xpm-3.4j:../../graphics/xpm
1.87      wiz      7919:        </pre>
1.109     rillig   7920: <p>You can also use wildcards in package dependencies:</p>
1.75      rillig   7921: <pre class="programlisting">
1.100     rillig   7922: DEPENDS+=       xpm-[0-9]*:../../graphics/xpm
1.87      wiz      7923:        </pre>
1.75      rillig   7924: <p>Note that such wildcard dependencies are retained when
1.87      wiz      7925:        creating binary packages.  The dependency is checked when
                   7926:        installing the binary package and any package which matches
                   7927:        the pattern will be used.  Wildcard dependencies should be
                   7928:        used with care.</p>
1.75      rillig   7929: <p>The &#8220;<span class="quote">-[0-9]*</span>&#8221; should be used instead of
1.87      wiz      7930:        &#8220;<span class="quote">-*</span>&#8221; to avoid potentially ambiguous matches
                   7931:        such as &#8220;<span class="quote">tk-postgresql</span>&#8221; matching a
                   7932:        &#8220;<span class="quote">tk-*</span>&#8221; <code class="varname">DEPENDS</code>.</p>
1.75      rillig   7933: <p>Wildcards can also be used to specify that a package
1.87      wiz      7934:        will only build against a certain minimum version of a
                   7935:        pre-requisite:</p>
1.75      rillig   7936: <pre class="programlisting">
1.100     rillig   7937: DEPENDS+=       tiff&gt;=3.5.4:../../graphics/tiff
1.87      wiz      7938:        </pre>
1.75      rillig   7939: <p>This means that the package will build against version
1.87      wiz      7940:        3.5.4 of the tiff library or newer.  Such a dependency may
                   7941:        be warranted if, for example, the API of the library has
                   7942:        changed with version 3.5.4 and a package would not compile
                   7943:        against an earlier version of tiff.</p>
1.75      rillig   7944: <p>Please note that such dependencies should only be
1.87      wiz      7945:        updated if a package requires a newer pre-requisite, but
1.93      rillig   7946:        not to denote recommendations such as
1.87      wiz      7947:        ABI changes that do not prevent a package from building
                   7948:        correctly.  Such recommendations can be expressed using
                   7949:        <code class="varname">ABI_DEPENDS</code>:</p>
1.75      rillig   7950: <pre class="programlisting">
1.100     rillig   7951: ABI_DEPENDS+=   tiff&gt;=3.6.1:../../graphics/tiff
1.87      wiz      7952:        </pre>
1.75      rillig   7953: <p>In addition to the above <code class="varname">DEPENDS</code>
1.87      wiz      7954:        line, this denotes that while a package will build against
                   7955:        tiff&gt;=3.5.4, at least version 3.6.1 is recommended.
                   7956:        <code class="varname">ABI_DEPENDS</code> entries will be turned into
                   7957:        dependencies unless explicitly ignored (in which case a
                   7958:        warning will be printed).</p>
1.75      rillig   7959: <p>To ignore these ABI dependency recommendations and just
1.87      wiz      7960:        use the required <code class="varname">DEPENDS</code>, set
                   7961:        <code class="varname">USE_ABI_DEPENDS=NO</code>.   This may make
                   7962:        it easier and faster to update packages built using pkgsrc,
                   7963:        since older compatible dependencies can continue to be
                   7964:        used. This is useful for people who watch their rebuilds
                   7965:        very carefully; it is not very good as a general-purpose
                   7966:        hammer.  If you use it, you need to be mindful of possible
                   7967:        ABI changes, including those from the underlying OS.</p>
1.75      rillig   7968: <p>Packages that are built with recommendations ignored
1.87      wiz      7969:        may not be uploaded to ftp.NetBSD.org by developers and
                   7970:        should not be used across different systems that may have
                   7971:        different versions of binary packages installed.</p>
1.75      rillig   7972: <p>For security fixes, please update the package
1.110     hubertf  7973:        vulnerabilities file. See <a class="xref" href="#security-handling" title="19.1.10. Handling packages with security problems">Section 19.1.10, &#8220;Handling packages with security problems&#8221;</a> for more
1.87      wiz      7974:        information.</p>
1.75      rillig   7975: </li>
                   7976: <li>
                   7977: <p>If your package needs some executable to be able to run
1.87      wiz      7978:        correctly and if there's no
                   7979:        <code class="filename">buildlink3.mk</code> file, this is specified
                   7980:        using the <code class="varname">DEPENDS</code> variable. The
1.91      rillig   7981:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/lyx/README.html" target="_top"><code class="filename">print/lyx</code></a> package needs to
1.87      wiz      7982:        be able to execute the latex binary from the teTeX package
                   7983:        when it runs, and that is specified:</p>
1.75      rillig   7984: <pre class="programlisting">
1.100     rillig   7985: DEPENDS+=        teTeX-[0-9]*:../../print/teTeX
1.87      wiz      7986:        </pre>
1.75      rillig   7987: <p>The comment about wildcard dependencies from previous
1.87      wiz      7988:        paragraph applies here, too.</p>
1.75      rillig   7989: </li>
                   7990: </ol></div>
                   7991: <p>If your package needs files from another package to build,
1.87      wiz      7992:     add the relevant distribution files to
                   7993:     <code class="varname">DISTFILES</code>, so they will be extracted
1.91      rillig   7994:     automatically. See the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/ghostscript/README.html" target="_top"><code class="filename">print/ghostscript</code></a> package for an example.
1.87      wiz      7995:     (It relies on the jpeg sources being present in source form
                   7996:     during the build.)</p>
1.75      rillig   7997: </div>
                   7998: <div class="sect2" lang="en">
                   7999: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8000: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.75      rillig   8001: <p>Your package may conflict with other packages a user might
1.87      wiz      8002:     already have installed on his system, e.g. if your package
1.88      wiz      8003:     installs the same set of files as another package in the pkgsrc
                   8004:     tree.</p>
1.75      rillig   8005: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
1.87      wiz      8006:     space-separated list of packages (including version string) your
                   8007:     package conflicts with.</p>
1.91      rillig   8008: <p>For example, <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/Xaw3d/README.html" target="_top"><code class="filename">x11/Xaw3d</code></a>
                   8009:     and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/Xaw-Xpm/README.html" target="_top"><code class="filename">x11/Xaw-Xpm</code></a>
1.87      wiz      8010:     install the same shared library, thus you set in
                   8011:     <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
                   8012: <pre class="programlisting">
1.100     rillig   8013: CONFLICTS=      Xaw-Xpm-[0-9]*
1.87      wiz      8014:     </pre>
                   8015: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
1.75      rillig   8016: <pre class="programlisting">
1.100     rillig   8017: CONFLICTS=      Xaw3d-[0-9]*
1.87      wiz      8018:     </pre>
1.75      rillig   8019: <p>Packages will automatically conflict with other packages
1.87      wiz      8020:     with the name prefix and a different version
                   8021:     string. &#8220;<span class="quote">Xaw3d-1.5</span>&#8221; e.g. will automatically
                   8022:     conflict with the older version &#8220;<span class="quote">Xaw3d-1.3</span>&#8221;.</p>
1.75      rillig   8023: </div>
                   8024: <div class="sect2" lang="en">
                   8025: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8026: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.75      rillig   8027: <p>There are several reasons why a package might be
1.88      wiz      8028:     instructed to not build under certain circumstances.  If the
1.87      wiz      8029:     package builds and runs on most platforms, the exceptions
                   8030:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
                   8031:     the package builds and runs on a small handful of platforms,
                   8032:     set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
                   8033:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   8034:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   8035:     (OS-version-platform) that can use glob-style
                   8036:     wildcards.</p>
1.88      wiz      8037: <p>Some packages are tightly bound to a specific version of an
1.91      rillig   8038:     operating system, e.g. LKMs or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/lsof/README.html" target="_top"><code class="filename">sysutils/lsof</code></a>.  Such binary packages are not
1.88      wiz      8039:     backwards compatible with other versions of the OS, and should be
                   8040:     uploaded to a version specific directory on the FTP server.  Mark
                   8041:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
                   8042:     &#8220;<span class="quote">yes</span>&#8221;.  This variable is not currently used by any of
                   8043:     the package system internals, but may be used in the
                   8044:     future.</p>
1.75      rillig   8045: <p>If the package should be skipped (for example, because it
1.87      wiz      8046:     provides functionality already provided by the system), set
1.88      wiz      8047:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   8048:     the package should fail because some preconditions are not met,
                   8049:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87      wiz      8050:     message.</p>
1.75      rillig   8051: </div>
                   8052: <div class="sect2" lang="en">
                   8053: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8054: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.75      rillig   8055: <p>To ensure that a package may not be deleted, once it has been
1.87      wiz      8056:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   8057:     be set in the package Makefile. This will be carried into any
                   8058:     binary package that is made from this pkgsrc entry. A
                   8059:     &#8220;<span class="quote">preserved</span>&#8221; package will
1.110     hubertf  8060:     not be deleted using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.87      wiz      8061:     &#8220;<span class="quote">-f</span>&#8221; option is used.</p>
1.75      rillig   8062: </div>
                   8063: <div class="sect2" lang="en">
                   8064: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8065: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.75      rillig   8066: <p>When a vulnerability is found, this should be noted in
1.87      wiz      8067:     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.110     hubertf  8068:     and after committing that file, use <span class="command"><strong>make upload</strong></span>
1.87      wiz      8069:     in the same directory to update the file on ftp.NetBSD.org.</p>
1.75      rillig   8070: <p>After fixing the vulnerability by a patch, its
1.87      wiz      8071:     <code class="varname">PKGREVISION</code> should be increased (this
                   8072:     is of course not necessary if the problem is fixed by using
                   8073:     a newer release of the software).</p>
1.75      rillig   8074: <p>Also, if the fix should be applied to the stable pkgsrc
1.87      wiz      8075:     branch, be sure to submit a pullup request!</p>
1.75      rillig   8076: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87      wiz      8077:     semi-automatically by a weekly cron job.</p>
1.75      rillig   8078: </div>
                   8079: <div class="sect2" lang="en">
                   8080: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8081: <a name="bumping-pkgrevision"></a>19.1.11. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.75      rillig   8082: <p>When making fixes to an existing package it can be useful
1.87      wiz      8083:     to change the version number in <code class="varname">PKGNAME</code>. To
                   8084:     avoid conflicting with future versions by the original author, a
                   8085:     &#8220;<span class="quote">nb1</span>&#8221;, &#8220;<span class="quote">nb2</span>&#8221;, ... suffix can be used
                   8086:     on package versions by setting <code class="varname">PKGREVISION=1</code>
                   8087:     (2, ...). The &#8220;<span class="quote">nb</span>&#8221; is treated like a
                   8088:     &#8220;<span class="quote">.</span>&#8221; by the package tools. e.g.</p>
                   8089: <pre class="programlisting">
1.100     rillig   8090: DISTNAME=       foo-17.42
                   8091: PKGREVISION=    9
1.87      wiz      8092:     </pre>
1.75      rillig   8093: <p>will result in a <code class="varname">PKGNAME</code> of
1.87      wiz      8094:     &#8220;<span class="quote">foo-17.42nb9</span>&#8221;. If you want to use the original
                   8095:     value of <code class="varname">PKGNAME</code> without the &#8220;<span class="quote">nbX</span>&#8221;
                   8096:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   8097:     <code class="varname">PKGNAME_NOREV</code>.</p>
1.75      rillig   8098: <p>When a new release of the package is released, the
1.87      wiz      8099:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   8100:     minor release of the above package, things should be like:</p>
1.75      rillig   8101: <pre class="programlisting">
1.100     rillig   8102: DISTNAME=       foo-17.43
1.87      wiz      8103:     </pre>
                   8104: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   8105:     non-trivial change in the resulting binary package.  Without a
                   8106:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   8107:     version installed has no way of knowing that their package is out
                   8108:     of date.  Thus, changes without increasing
                   8109:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   8110:     trivial that no reasonable person would want to upgrade", and this
                   8111:     is the rough test for when increasing
                   8112:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   8113:     changes that do not merit increasing
                   8114:     <code class="varname">PKGREVISION</code> are:</p>
1.100     rillig   8115: <div class="itemizedlist"><ul type="disc">
1.114     jmcneill 8116: <li><p>Changing <code class="varname">HOMEPAGE</code>,
                   8117:       <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.100     rillig   8118:       or comments in Makefile.</p></li>
                   8119: <li><p>
                   8120:       Changing build variables if the resulting binary package is the same.</p></li>
                   8121: <li><p>
                   8122:       Changing <code class="filename">DESCR</code>.</p></li>
                   8123: <li><p>
                   8124:       Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
                   8125: </ul></div>
1.87      wiz      8126: <p>Examples of changes that do merit an increase to
                   8127:     <code class="varname">PKGREVISION</code> include:</p>
1.100     rillig   8128: <div class="itemizedlist"><ul type="disc">
                   8129: <li><p>
                   8130:       Security fixes</p></li>
                   8131: <li><p>
                   8132:       Changes or additions to a patch file</p></li>
                   8133: <li><p>
                   8134:       Changes to the <code class="filename">PLIST</code></p></li>
1.112     weinem   8135: <li><p>A dependency is changed or renamed.</p></li>
1.100     rillig   8136: </ul></div>
1.78      rillig   8137: <p>PKGREVISION must also be incremented when dependencies have ABI
                   8138:     changes.</p>
1.75      rillig   8139: </div>
1.79      rillig   8140: <div class="sect2" lang="en">
                   8141: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8142: <a name="fixes.subst"></a>19.1.12. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.79      rillig   8143: <p>When you want to replace the same text in multiple files
1.87      wiz      8144:     or when the replacement text varies, patches alone cannot help.
                   8145:     This is where the SUBST framework comes in. It provides an
                   8146:     easy-to-use interface for replacing text in files.
                   8147:     Example:</p>
                   8148: <pre class="programlisting">
1.100     rillig   8149: SUBST_CLASSES+=                 fix-paths
                   8150: SUBST_STAGE.fix-paths=          pre-configure
                   8151: SUBST_MESSAGE.fix-paths=        Fixing absolute paths.
                   8152: SUBST_FILES.fix-paths=          src/*.c
                   8153: SUBST_FILES.fix-paths+=         scripts/*.sh
                   8154: SUBST_SED.fix-paths=            -e 's,"/usr/local,"${PREFIX},g'
                   8155: SUBST_SED.fix-paths+=           -e 's,"/var/log,"${VARBASE}/log,g'
1.87      wiz      8156:     </pre>
1.79      rillig   8157: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87      wiz      8158:     that are used to identify the different SUBST blocks that are
                   8159:     defined. The SUBST framework is heavily used by pkgsrc, so it is
                   8160:     important to always use the <code class="literal">+=</code> operator with
                   8161:     this variable. Otherwise some substitutions may be
                   8162:     skipped.</p>
1.79      rillig   8163: <p>The remaining variables of each SUBST block are
1.87      wiz      8164:     parameterized with the identifier from the first line
                   8165:     (<code class="literal">fix-paths</code> in this case.) They can be seen as
                   8166:     parameters to a function call.</p>
1.79      rillig   8167: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87      wiz      8168:     which the replacement will take place. All combinations of
                   8169:     <code class="literal">pre-</code>, <code class="literal">do-</code> and
                   8170:     <code class="literal">post-</code> together with a phase name are
                   8171:     possible, though only few are actually used. Most commonly used
                   8172:     are <code class="literal">post-patch</code> and
                   8173:     <code class="literal">pre-configure</code>. Of these two,
                   8174:     <code class="literal">pre-configure</code> should be preferred because
1.110     hubertf  8175:     then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.87      wiz      8176:     have the state after applying the patches but before making any
                   8177:     other changes. This is especially useful when you are debugging
                   8178:     a package in order to create new patches for it. Similarly,
                   8179:     <code class="literal">post-build</code> is preferred over
                   8180:     <code class="literal">pre-install</code>, because the install phase should
                   8181:     generally be kept as simple as possible. When you use
                   8182:     <code class="literal">post-build</code>, you have the same files in the
                   8183:     working directory that will be installed later, so you can check
                   8184:     if the substitution has succeeded.</p>
1.79      rillig   8185: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87      wiz      8186:     that is printed just before the substitution is done.</p>
1.79      rillig   8187: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87      wiz      8188:     globbing patterns that specifies the files in which the
                   8189:     substitution will take place. The patterns are interpreted
                   8190:     relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79      rillig   8191: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.110     hubertf  8192:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that specify the actual substitution. Every sed
1.87      wiz      8193:     command should be prefixed with <code class="literal">-e</code>, so that
                   8194:     all SUBST blocks look uniform.</p>
1.79      rillig   8195: <p>There are some more variables, but they are so seldomly
1.87      wiz      8196:     used that they are only documented in the
                   8197:     <code class="filename">mk/subst.mk</code> file.</p>
1.79      rillig   8198: </div>
1.75      rillig   8199: </div>
                   8200: <div class="sect1" lang="en">
                   8201: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8202: <a name="fixes.fetch"></a>19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.75      rillig   8203: <div class="sect2" lang="en">
                   8204: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8205: <a name="no-plain-download"></a>19.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.75      rillig   8206: <p>If you need to download from a dynamic URL you can set
1.110     hubertf  8207:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87      wiz      8208:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   8209:     with the name of each file to download as an argument, expecting
                   8210:     it to output the URL of the directory from which to download
1.91      rillig   8211:     it. <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/ns-cult3d/README.html" target="_top"><code class="filename">graphics/ns-cult3d</code></a> is an
1.87      wiz      8212:     example of this usage.</p>
1.75      rillig   8213: <p>If the download can't be automated, because the user must
1.87      wiz      8214:     submit personal information to apply for a password, or must pay
                   8215:     for the source, or whatever, you can set
                   8216:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   8217:     displayed to the user before aborting the build. Example:</p>
                   8218: <pre class="programlisting">
1.100     rillig   8219: FETCH_MESSAGE=  "Please download the files"
                   8220: FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   8221: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.87      wiz      8222:     </pre>
1.75      rillig   8223: </div>
                   8224: <div class="sect2" lang="en">
                   8225: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8226: <a name="modified-distfiles-same-name"></a>19.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.75      rillig   8227: <p>Sometimes authors of a software package make some
1.87      wiz      8228:     modifications after the software was released, and they put up a
                   8229:     new distfile without changing the package's version number. If a
                   8230:     package is already in pkgsrc at that time, the checksum will
                   8231:     no longer match. The contents of the new distfile should be
                   8232:     compared against the old one before changing anything, to make
                   8233:     sure the distfile was really updated on purpose, and that
                   8234:     no trojan horse or so crept in.
1.97      rillig   8235:     Please mention that the distfiles were compared and what was found
                   8236:     in your commit message.
1.87      wiz      8237:     Then, the correct way to work around this is to
                   8238:     set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
                   8239:     usually based on <code class="varname">PKGNAME_NOREV</code>. All
                   8240:     <code class="varname">DISTFILES</code> and
1.93      rillig   8241:     <code class="varname">PATCHFILES</code> for this package will be put in that
1.97      rillig   8242:     subdirectory of the local distfiles directory.
1.110     hubertf  8243:     (See <a class="xref" href="#bumping-pkgrevision" title="19.1.11. How to handle incrementing versions when fixing an existing package">Section 19.1.11, &#8220;How to handle incrementing versions when fixing an existing package&#8221;</a> for more details.)
1.97      rillig   8244:     In case this
1.87      wiz      8245:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
                   8246:     including the <code class="filename">nbX</code> suffix) or a date stamp
                   8247:     can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
                   8248:     Do not forget regenerating the <code class="filename">distinfo</code> file
                   8249:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   8250:     path in the filenames.
1.97      rillig   8251:     Also increase the PKGREVISION if the installed package is different.
1.87      wiz      8252:     Furthermore, a mail to the package's authors seems appropriate
                   8253:     telling them that changing distfiles after releases without
                   8254:     changing the file names is not good practice.</p>
1.75      rillig   8255: </div>
                   8256: </div>
                   8257: <div class="sect1" lang="en">
                   8258: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8259: <a name="fixes.configure"></a>19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.75      rillig   8260: <div class="sect2" lang="en">
                   8261: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8262: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.75      rillig   8263: <p>pkgsrc supports many different machines, with different
1.87      wiz      8264:     object formats like a.out and ELF, and varying abilities to do
                   8265:     shared library and dynamic loading at all. To accompany this,
                   8266:     varying commands and options have to be passed to the
                   8267:     compiler, linker, etc. to get the Right Thing, which can be
                   8268:     pretty annoying especially if you don't have all the machines
                   8269:     at your hand to test things.  The
1.91      rillig   8270:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/README.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
1.87      wiz      8271:     can help here, as it just &#8220;<span class="quote">knows</span>&#8221; how to build
                   8272:     both static and dynamic libraries from a set of source files,
                   8273:     thus being platform-independent.</p>
                   8274: <p>Here's how to use libtool in a package in seven simple
                   8275:     steps:</p>
1.75      rillig   8276: <div class="orderedlist"><ol type="1">
                   8277: <li><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87      wiz      8278:        Makefile.</p></li>
1.75      rillig   8279: <li><p>For library objects, use &#8220;<span class="quote">${LIBTOOL} --mode=compile
1.87      wiz      8280:        ${CC}</span>&#8221; in place of &#8220;<span class="quote">${CC}</span>&#8221;. You could even
                   8281:        add it to the definition of <code class="varname">CC</code>, if only
                   8282:        libraries are being built in a given Makefile. This one command
                   8283:        will build both PIC and non-PIC library objects, so you need not
                   8284:        have separate shared and non-shared library rules.</p></li>
1.75      rillig   8285: <li>
                   8286: <p>For the linking of the library, remove any
1.87      wiz      8287:        &#8220;<span class="quote">ar</span>&#8221;, &#8220;<span class="quote">ranlib</span>&#8221;, and &#8220;<span class="quote">ld
                   8288:        -Bshareable</span>&#8221; commands, and instead use:</p>
1.75      rillig   8289: <pre class="programlisting">
1.100     rillig   8290: ${LIBTOOL} --mode=link \
                   8291:     ${CC} -o ${.TARGET:.a=.la} \
                   8292:         ${OBJS:.o=.lo} \
                   8293:         -rpath ${PREFIX}/lib \
                   8294:         -version-info major:minor
1.87      wiz      8295:        </pre>
1.75      rillig   8296: <p>Note that the library is changed to have a
1.87      wiz      8297:        <code class="filename">.la</code> extension, and the objects are
                   8298:        changed to have a <code class="filename">.lo</code>
                   8299:        extension. Change <code class="varname">OBJS</code> as
                   8300:        necessary. This automatically creates all of the
                   8301:        <code class="filename">.a</code>,
                   8302:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   8303:        necessary) in the build directory. Be sure to include
                   8304:        &#8220;<span class="quote">-version-info</span>&#8221;, especially when major and
                   8305:        minor are zero, as libtool will otherwise strip off the
                   8306:        shared library version.</p>
1.75      rillig   8307: <p>From the libtool manual:</p>
                   8308: <pre class="programlisting">
1.100     rillig   8309: So, libtool library versions are described by three integers:
1.69      rillig   8310: 
1.100     rillig   8311: CURRENT
                   8312: The most recent interface number that this library implements.
1.69      rillig   8313: 
1.100     rillig   8314: REVISION
                   8315: The implementation number of the CURRENT interface.
1.69      rillig   8316: 
1.100     rillig   8317: AGE
                   8318: The difference between the newest and oldest interfaces that
                   8319: this library implements.  In other words, the library implements
                   8320: all the interface numbers in the range from number `CURRENT -
                   8321: AGE' to `CURRENT'.
1.1       grant    8322: 
1.100     rillig   8323: If two libraries have identical CURRENT and AGE numbers, then the
                   8324: dynamic linker chooses the library with the greater REVISION number.
1.87      wiz      8325:        </pre>
1.75      rillig   8326: <p>The &#8220;<span class="quote">-release</span>&#8221; option will produce
1.87      wiz      8327:        different results for a.out and ELF (excluding symlinks)
                   8328:        in only one case. An ELF library of the form
                   8329:        &#8220;<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;
                   8330:        will have a symlink of
                   8331:        &#8220;<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;
                   8332:        on an a.out platform. This is handled
                   8333:        automatically.</p>
1.75      rillig   8334: <p>The &#8220;<span class="quote">-rpath argument</span>&#8221; is the install
1.87      wiz      8335:        directory of the library being built.</p>
1.76      rillig   8336: <p>In the <code class="filename">PLIST</code>, include only the
1.87      wiz      8337:        <code class="filename">.la</code> file, the other files will be
                   8338:        added automatically.</p>
1.75      rillig   8339: </li>
                   8340: <li>
1.76      rillig   8341: <p>When linking shared object (<code class="filename">.so</code>)
1.110     hubertf  8342:        files, i.e. files that are loaded via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?dlopen+3+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.87      wiz      8343:        shared libraries, use &#8220;<span class="quote">-module
                   8344:        -avoid-version</span>&#8221; to prevent them getting version
                   8345:        tacked on.</p>
1.76      rillig   8346: <p>The <code class="filename">PLIST</code> file gets the
1.87      wiz      8347:        <code class="filename">foo.so</code> entry.</p>
1.75      rillig   8348: </li>
                   8349: <li>
                   8350: <p>When linking programs that depend on these libraries
1.87      wiz      8351:        <span class="emphasis"><em>before</em></span> they are installed, preface
1.110     hubertf  8352:        the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cc+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">cc</span>(1)</span></a> or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with &#8220;<span class="quote">${LIBTOOL}
1.87      wiz      8353:        --mode=link</span>&#8221;, and it will find the correct
                   8354:        libraries (static or shared), but please be aware that
                   8355:        libtool will not allow you to specify a relative path in
                   8356:        -L (such as &#8220;<span class="quote">-L../somelib</span>&#8221;), because it
                   8357:        expects you to change that argument to be the
                   8358:        <code class="filename">.la</code> file. e.g.</p>
1.75      rillig   8359: <pre class="programlisting">
1.100     rillig   8360: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.87      wiz      8361:        </pre>
1.75      rillig   8362: <p>should be changed to:</p>
                   8363: <pre class="programlisting">
1.100     rillig   8364: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.87      wiz      8365:        </pre>
1.75      rillig   8366: <p>and it will do the right thing with the libraries.</p>
                   8367: </li>
                   8368: <li>
1.110     hubertf  8369: <p>When installing libraries, preface the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
                   8370:        or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cp+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with &#8220;<span class="quote">${LIBTOOL}
1.87      wiz      8371:        --mode=install</span>&#8221;, and change the library name to
                   8372:        <code class="filename">.la</code>. e.g.</p>
1.75      rillig   8373: <pre class="programlisting">
1.100     rillig   8374: ${LIBTOOL} --mode=install ${BSD_INSTALL_DATA} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.87      wiz      8375:        </pre>
1.76      rillig   8376: <p>This will install the static <code class="filename">.a</code>,
1.87      wiz      8377:        shared library, any needed symlinks, and run
1.110     hubertf  8378:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ldconfig+8+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.75      rillig   8379: </li>
1.76      rillig   8380: <li><p>In your <code class="filename">PLIST</code>, include only
1.87      wiz      8381:        the <code class="filename">.la</code>
                   8382:        file (this is a change from previous behaviour).</p></li>
1.75      rillig   8383: </ol></div>
                   8384: </div>
                   8385: <div class="sect2" lang="en">
                   8386: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8387: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75      rillig   8388: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87      wiz      8389:     package Makefile. This will override the package's own libtool
                   8390:     in most cases.  For older libtool using packages,  libtool is
                   8391:     made by ltconfig script during the do-configure step; you can
1.110     hubertf  8392:     check the libtool script location by doing <span class="command"><strong>make
1.87      wiz      8393:     configure; find work*/ -name libtool</strong></span>.</p>
1.75      rillig   8394: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87      wiz      8395:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
                   8396:     default, it is set to &#8220;<span class="quote">libtool */libtool
                   8397:     */*/libtool</span>&#8221;.  If this does not match the location of the
                   8398:     package's libtool script(s), set it as appropriate.</p>
1.76      rillig   8399: <p>If you do not need <code class="filename">*.a</code> static
1.87      wiz      8400:     libraries built and installed, then use
                   8401:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75      rillig   8402: <p>If your package makes use of the platform-independent library
1.87      wiz      8403:     for loading dynamic shared objects, that comes with libtool
                   8404:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   8405: <p>Some packages use libtool incorrectly so that the package
                   8406:     may not work or build in some circumstances. Some of the more
                   8407:     common errors are:</p>
1.75      rillig   8408: <div class="itemizedlist"><ul type="disc">
                   8409: <li>
                   8410: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87      wiz      8411:        executable or library. This in itself isn't a problem if one of two things
                   8412:        has been done:</p>
1.75      rillig   8413: <div class="orderedlist"><ol type="1">
                   8414: <li><p>The shared object is named correctly, i.e.
1.87      wiz      8415:            <code class="filename">libfoo.la</code>, not
                   8416:            <code class="filename">foo.la</code></p></li>
1.75      rillig   8417: <li><p>The -dlopen option is used when linking an executable.</p></li>
                   8418: </ol></div>
                   8419: </li>
                   8420: <li><p>The use of libltdl without the correct calls to initialisation routines.
1.87      wiz      8421:        The function lt_dlinit() should be called and the macro
                   8422:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   8423:        executables.</p></li>
1.75      rillig   8424: </ul></div>
                   8425: </div>
                   8426: <div class="sect2" lang="en">
                   8427: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8428: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75      rillig   8429: <p>If a package needs GNU autoconf or automake to be executed
1.87      wiz      8430:     to regenerate the configure script and Makefile.in makefile
                   8431:     templates, then they should be executed in a pre-configure
                   8432:     target.</p>
1.75      rillig   8433: <p>For packages that need only autoconf:</p>
                   8434: <pre class="programlisting">
1.100     rillig   8435: AUTOCONF_REQD=  2.50            # if default version is not good enough
                   8436: USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
                   8437: ...
1.1       grant    8438: 
1.100     rillig   8439: pre-configure:
                   8440:         cd ${WRKSRC} &amp;&amp; autoconf
1.1       grant    8441: 
1.100     rillig   8442: ...
1.87      wiz      8443:     </pre>
1.75      rillig   8444: <p>and for packages that need automake and autoconf:</p>
                   8445: <pre class="programlisting">
1.100     rillig   8446: AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
                   8447: USE_TOOLS+=     automake        # use "automake14" for automake-1.4
                   8448: ...
                   8449: 
                   8450: pre-configure:
                   8451:         set -e; cd ${WRKSRC}; \
                   8452:         aclocal; autoheader; automake -a --foreign -i; autoconf
1.1       grant    8453: 
1.100     rillig   8454: ...
1.87      wiz      8455:     </pre>
1.75      rillig   8456: <p>Packages which use GNU Automake will almost certainly
1.87      wiz      8457:     require GNU Make.</p>
1.75      rillig   8458: <p>There are times when the configure process makes
1.87      wiz      8459:     additional changes to the generated files, which then causes
                   8460:     the build process to try to re-execute the automake sequence.
                   8461:     This is prevented by touching various files in the configure
                   8462:     stage. If this causes problems with your package you can set
                   8463:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   8464:     Makefile.</p>
1.75      rillig   8465: </div>
                   8466: </div>
                   8467: <div class="sect1" lang="en">
                   8468: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8469: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.87      wiz      8470: <div class="sect2" lang="en">
                   8471: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8472: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.87      wiz      8473: <p>Compilers for the C, C++, and Fortran languages comes with
                   8474:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   8475:     is written in C and will hide all other compilers (via the wrapper
1.110     hubertf  8476:     framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.87      wiz      8477: <p>To declare which language's compiler a package needs, set
                   8478:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
                   8479:     currently are &#8220;<span class="quote">c</span>&#8221;, &#8220;<span class="quote">c++</span>&#8221;, and
                   8480:     &#8220;<span class="quote">fortran</span>&#8221; (and any combination).  The default is
                   8481:     &#8220;<span class="quote">c</span>&#8221;.  Packages using GNU configure scripts, even if
                   8482:     written in C++, usually need a C compiler for the configure
                   8483:     phase.</p>
                   8484: </div>
                   8485: <div class="sect2" lang="en">
                   8486: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8487: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.87      wiz      8488: <p>If a program is written in Java, use the Java framework in
                   8489:     pkgsrc.  The package must include
                   8490:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   8491:     provides the following variables:</p>
                   8492: <div class="itemizedlist"><ul type="disc">
                   8493: <li><p><code class="varname">USE_JAVA</code> defines if a build
                   8494:       dependency on the JDK is added.  If
                   8495:       <code class="varname">USE_JAVA</code> is set to &#8220;<span class="quote">run</span>&#8221;, then
                   8496:       there is only a runtime dependency on the JDK.  The default is
                   8497:       &#8220;<span class="quote">yes</span>&#8221;, which also adds a build dependency on the
                   8498:       JDK.</p></li>
                   8499: <li><p>Set <code class="varname">USE_JAVA2</code> to declare that
                   8500:       a package needs a Java2 implementation.  The supported values
                   8501:       are &#8220;<span class="quote">yes</span>&#8221;, &#8220;<span class="quote">1.4</span>&#8221;, and
                   8502:       &#8220;<span class="quote">1.5</span>&#8221;.  &#8220;<span class="quote">yes</span>&#8221; accepts any Java2
                   8503:       implementation, &#8220;<span class="quote">1.4</span>&#8221; insists on versions 1.4 or
                   8504:       above, and &#8220;<span class="quote">1.5</span>&#8221; only accepts versions 1.5 or
                   8505:       above. This variable is not set by default.</p></li>
                   8506: </ul></div>
                   8507: </div>
                   8508: <div class="sect2" lang="en">
                   8509: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8510: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.87      wiz      8511: <p>If your package contains interpreted perl scripts, add
                   8512:     &#8220;<span class="quote">perl</span>&#8221; to the <code class="varname">USE_TOOLS</code> variable
                   8513:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   8514:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   8515:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
                   8516:     that you want adjusted.  Every occurrence of
                   8517:     <code class="filename">*/bin/perl</code> will be replaced with the full
                   8518:     path to the perl executable.</p>
                   8519: <p>If a particular version of perl is needed, set the
                   8520:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
                   8521:     default is &#8220;<span class="quote">5.0</span>&#8221;.</p>
1.110     hubertf  8522: <p>See <a class="xref" href="#perl-modules" title="19.6.6. Packages installing perl modules">Section 19.6.6, &#8220;Packages installing perl modules&#8221;</a> for information
1.87      wiz      8523:     about handling perl modules.</p>
                   8524: </div>
                   8525: <div class="sect2" lang="en">
                   8526: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8527: <a name="other-programming-languages"></a>19.4.4. Other programming languages</h3></div></div></div>
1.87      wiz      8528: <p>Currently, there is no special handling for other languages
                   8529:     in pkgsrc.  If a compiler package provides a
                   8530:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   8531:     just add a (build) dependency on the appropriate compiler
                   8532:     package.</p>
                   8533: </div>
                   8534: </div>
                   8535: <div class="sect1" lang="en">
                   8536: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8537: <a name="fixes.build"></a>19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77      rillig   8538: <p>The most common failures when building a package are that
                   8539:        some platforms do not provide certain header files, functions or
                   8540:        libraries, or they provide the functions in a library that the
                   8541:        original package author didn't know. To work around this, you
                   8542:        can rewrite the source code in most cases so that it does not
                   8543:        use the missing functions or provides a replacement function.</p>
                   8544: <div class="sect2" lang="en">
                   8545: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8546: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77      rillig   8547: <p>If a package already comes with a GNU configure script, the
                   8548:        preferred way to fix the build failure is to change the
                   8549:        configure script, not the code. In the other cases, you can
                   8550:        utilize the C preprocessor, which defines certain macros
                   8551:        depending on the operating system and hardware architecture it
                   8552:        compiles for. These macros can be queried using for example
                   8553:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   8554:        system, hardware architecture and compiler has its own macro.
                   8555:        For example, if the macros <code class="varname">__GNUC__</code>,
                   8556:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   8557:        are all defined, you know that you are using NetBSD on an i386
                   8558:        compatible CPU, and your compiler is GCC.</p>
                   8559: <p>The list of the following macros for hardware and
                   8560:        operating system depends on the compiler that is used. For
                   8561:        example, if you want to conditionally compile code on Solaris,
                   8562:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   8563:        does not define it. Use <code class="varname">__sun</code> instead.</p>
1.75      rillig   8564: <div class="sect3" lang="en">
                   8565: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   8566: <a name="fixes.build.cpp.os"></a>19.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.75      rillig   8567: <p>To distinguish between 4.4 BSD-derived systems and the
                   8568:         rest of the world, you should use the following code.</p>
                   8569: <pre class="programlisting">
1.100     rillig   8570: #include &lt;sys/param.h&gt;
                   8571: #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
                   8572: /* BSD-specific code goes here */
                   8573: #else
                   8574: /* non-BSD-specific code goes here */
                   8575: #endif
1.75      rillig   8576: </pre>
1.77      rillig   8577: <p>If this distinction is not fine enough, you can also test
                   8578:        for the following macros.</p>
1.75      rillig   8579: <pre class="programlisting">
1.100     rillig   8580: FreeBSD     __FreeBSD__
                   8581: DragonFly   __DragonFly__
                   8582: Interix     __INTERIX
                   8583: IRIX        __sgi (TODO: get a definite source for this)
                   8584: Linux       linux, __linux, __linux__
                   8585: NetBSD      __NetBSD__
                   8586: OpenBSD     __OpenBSD__
                   8587: Solaris     sun, __sun
1.75      rillig   8588: </pre>
                   8589: </div>
                   8590: <div class="sect3" lang="en">
                   8591: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   8592: <a name="fixes.build.cpp.arch"></a>19.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.75      rillig   8593: <pre class="programlisting">
1.100     rillig   8594: i386        i386, __i386, __i386__
                   8595: MIPS        __mips
                   8596: SPARC       sparc, __sparc
1.75      rillig   8597: </pre>
                   8598: </div>
                   8599: <div class="sect3" lang="en">
                   8600: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   8601: <a name="fixes.build.cpp.compiler"></a>19.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.75      rillig   8602: <pre class="programlisting">
1.100     rillig   8603: GCC         __GNUC__ (major version), __GNUC_MINOR__
                   8604: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
                   8605: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
                   8606: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75      rillig   8607: </pre>
                   8608: </div>
                   8609: </div>
1.78      rillig   8610: <div class="sect2" lang="en">
                   8611: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8612: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.78      rillig   8613: <p>Some source files trigger bugs in the compiler, based on
1.87      wiz      8614:         combinations of compiler version and architecture and almost
                   8615:         always relation to optimisation being enabled.  Common symptoms
                   8616:         are gcc internal errors or never finishing compiling a
1.78      rillig   8617:        file.</p>
                   8618: <p>Typically, a workaround involves testing the
                   8619:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   8620:         optimisation for that combination of file,
                   8621:        <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
1.87      wiz      8622:        in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
1.78      rillig   8623:        number of examples.</p>
                   8624: </div>
                   8625: <div class="sect2" lang="en">
                   8626: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8627: <a name="undefined-reference"></a>19.5.3. Undefined reference to &#8220;<span class="quote">...</span>&#8221;</h3></div></div></div>
1.92      rillig   8628: <p>This error message often means that a package did not
1.78      rillig   8629:        link to a shared library it needs. The following functions are
                   8630:        known to cause this error message over and over.</p>
                   8631: <div class="informaltable">
                   8632: <a name="undefined-reference-functions"></a><table border="1">
                   8633: <colgroup>
                   8634: <col>
                   8635: <col>
                   8636: <col>
                   8637: </colgroup>
                   8638: <thead><tr>
                   8639: <th>Function</th>
                   8640: <th>Library</th>
                   8641: <th>Affected platforms</th>
                   8642: </tr></thead>
                   8643: <tbody>
                   8644: <tr>
                   8645: <td>accept, bind, connect</td>
                   8646: <td>-lsocket</td>
                   8647: <td>Solaris</td>
                   8648: </tr>
                   8649: <tr>
                   8650: <td>crypt</td>
                   8651: <td>-lcrypt</td>
                   8652: <td>DragonFly, NetBSD</td>
                   8653: </tr>
                   8654: <tr>
                   8655: <td>dlopen, dlsym</td>
                   8656: <td>-ldl</td>
                   8657: <td>Linux</td>
                   8658: </tr>
                   8659: <tr>
                   8660: <td>gethost*</td>
                   8661: <td>-lnsl</td>
                   8662: <td>Solaris</td>
                   8663: </tr>
                   8664: <tr>
                   8665: <td>inet_aton</td>
                   8666: <td>-lresolv</td>
                   8667: <td>Solaris</td>
                   8668: </tr>
                   8669: <tr>
                   8670: <td>nanosleep, sem_*, timer_*</td>
                   8671: <td>-lrt</td>
                   8672: <td>Solaris</td>
                   8673: </tr>
                   8674: <tr>
                   8675: <td>openpty</td>
                   8676: <td>-lutil</td>
                   8677: <td>Linux</td>
                   8678: </tr>
                   8679: </tbody>
                   8680: </table>
                   8681: </div>
                   8682: <p>To fix these linker errors, it is often sufficient to say
1.87      wiz      8683:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   8684:     -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110     hubertf  8685:     <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87      wiz      8686:     bmake</strong></span>.</p>
1.92      rillig   8687: <div class="sect3" lang="en">
                   8688: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   8689: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92      rillig   8690: <p>When you are using the SunPro compiler, there is another
                   8691: possibility. That compiler cannot handle the following code:</p>
                   8692: <pre class="programlisting">
1.100     rillig   8693: extern int extern_func(int);
1.93      rillig   8694: 
1.100     rillig   8695: static inline int
                   8696: inline_func(int x)
                   8697: {
1.92      rillig   8698:         return extern_func(x);
1.100     rillig   8699: }
1.93      rillig   8700: 
1.100     rillig   8701: int main(void)
                   8702: {
1.92      rillig   8703:         return 0;
1.100     rillig   8704: }
1.92      rillig   8705: </pre>
                   8706: <p>It generates the code for <code class="function">inline_func</code> even if
                   8707: that function is never used. This code then refers to
                   8708: <code class="function">extern_func</code>, which can usually not be resolved. To
                   8709: solve this problem you can try to tell the package to disable inlining
                   8710: of functions.</p>
                   8711: </div>
1.87      wiz      8712: </div>
                   8713: <div class="sect2" lang="en">
                   8714: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8715: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.87      wiz      8716: <p>Sometimes packages fail to build because the compiler runs
                   8717:     into an operating system specific soft limit.  With the
                   8718:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
                   8719:     to unlimit the resources.  Currently, the allowed values are
                   8720:     &#8220;<span class="quote">datasize</span>&#8221; and &#8220;<span class="quote">stacksize</span>&#8221; (or both).
                   8721:     Setting this variable is similar to running the shell builtin
1.110     hubertf  8722:     <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87      wiz      8723:     segment size or maximum stack size of a process, respectively, to
                   8724:     their hard limits.</p>
1.78      rillig   8725: </div>
1.75      rillig   8726: </div>
                   8727: <div class="sect1" lang="en">
                   8728: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8729: <a name="fixes.install"></a>19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75      rillig   8730: <div class="sect2" lang="en">
                   8731: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8732: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.110     hubertf  8733: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87      wiz      8734:     with some operating systems cannot create more than one
                   8735:     directory at a time. As such, you should call
                   8736:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   8737: <pre class="programlisting">
1.100     rillig   8738: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   8739: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.87      wiz      8740:     </pre>
1.78      rillig   8741: <p>You can also just append &#8220;<span class="quote"><code class="literal">dir1
1.87      wiz      8742:     dir2</code></span>&#8221; to the
                   8743:     <code class="varname">INSTALLATION_DIRS</code> variable, which will
                   8744:     automatically do the right thing.</p>
1.75      rillig   8745: </div>
                   8746: <div class="sect2" lang="en">
                   8747: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8748: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.83      wiz      8749: <p>In general, documentation should be installed into
1.87      wiz      8750:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8751:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
                   8752:     includes the version number of the package).</p>
1.84      wiz      8753: <p>Many modern packages using GNU autoconf allow to set the
1.87      wiz      8754:     directory where HTML documentation is installed with the
                   8755:     &#8220;<span class="quote">--with-html-dir</span>&#8221; option. Sometimes using this flag
                   8756:     is needed because otherwise the documentation ends up in
                   8757:     <code class="filename">${PREFIX}/share/doc/html</code> or other
                   8758:     places.</p>
                   8759: <p>An exception to the above is that library API documentation
1.91      rillig   8760:     generated with the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/gtk-doc/README.html" target="_top"><code class="filename">textproc/gtk-doc</code></a> tools, for use by special
1.87      wiz      8761:     browsers (devhelp) should be left at their default location, which
                   8762:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   8763:     documentation can be recognized from files ending in
                   8764:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   8765:     (It is also acceptable to install such files in
                   8766:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8767:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   8768:     <code class="filename">.devhelp*</code> file must be directly in that
                   8769:     directory then, no additional subdirectory level is allowed in
                   8770:     this case. This is usually achieved by using
                   8771:     &#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;.
                   8772:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   8773:     though.)</p>
1.75      rillig   8774: </div>
                   8775: <div class="sect2" lang="en">
                   8776: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8777: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.75      rillig   8778: <p>Certain packages, most of them in the games category, install
1.87      wiz      8779:     a score file that allows all users on the system to record their
                   8780:     highscores.  In order for this to work, the binaries need to be
                   8781:     installed setgid and the score files owned by the appropriate
                   8782:     group and/or owner (traditionally the "games" user/group).  The
                   8783:     following variables, documented in more detail in
                   8784:     <code class="filename">mk/defaults/mk.conf</code>, control this
                   8785:     behaviour: <code class="varname">SETGIDGAME</code>,
                   8786:     <code class="varname">GAMEDATAMODE</code>, <code class="varname">GAMEGRP</code>,
                   8787:     <code class="varname">GAMEMODE</code>, <code class="varname">GAMEOWN</code>.</p>
1.75      rillig   8788: <p>Note that per default, setgid installation of games is
1.87      wiz      8789:     disabled;  setting <code class="varname">SETGIDGAME=YES</code> will set all
                   8790:     the other variables accordingly.</p>
1.114     jmcneill 8791: <p>A package should therefore never hard code file ownership or
1.87      wiz      8792:     access permissions but rely on <code class="varname">INSTALL_GAME</code> and
                   8793:     <code class="varname">INSTALL_GAME_DATA</code> to set these
                   8794:     correctly.</p>
1.75      rillig   8795: </div>
                   8796: <div class="sect2" lang="en">
                   8797: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8798: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114     jmcneill 8799: <p><code class="varname">DESTDIR</code> support means that a package
                   8800:     installs into a staging directory, not the final location of the
                   8801:     files. Then a binary package is created which can be used for
                   8802:     installation as usual. There are two ways: Either the package must
                   8803:     install as root (&#8220;<span class="quote">destdir</span>&#8221;) or the package can
                   8804:     install as non-root user (&#8220;<span class="quote">user-destdir</span>&#8221;).</p>
                   8805: <div class="itemizedlist"><ul type="disc">
                   8806: <li><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
                   8807:       set to &#8220;<span class="quote">destdir</span>&#8221; or &#8220;<span class="quote">user-destdir</span>&#8221;. If
                   8808:       bsd.prefs.mk is included in the Makefile,
                   8809:       <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
                   8810:       the inclusion.</p></li>
1.103     wiz      8811: <li><p>All installation operations have to be prefixed with
                   8812:       <code class="filename">${DESTDIR}</code>.</p></li>
                   8813: <li><p>automake gets this DESTDIR mostly right
                   8814:       automatically. Many manual rules and pre/post-install often are
                   8815:       incorrect; fix them.</p></li>
                   8816: <li><p>If files are installed with special owner/group
                   8817:       either use @owner/@group in the <code class="filename">PLIST</code>
                   8818:       (preferred) or use <code class="varname">SPECIAL_PERMS</code>
                   8819:       (discouraged). Note that @owner/@group are sticky during
                   8820:       install, keep this in mind.</p></li>
                   8821: <li><p>In general, packages should support
                   8822:       <code class="varname">UNPRIVILEGED</code> to be able to use
                   8823:       DESTDIR.</p></li>
                   8824: </ul></div>
                   8825: </div>
                   8826: <div class="sect2" lang="en">
                   8827: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8828: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87      wiz      8829: <p>Your package may also contain scripts with hardcoded paths to
                   8830:       other interpreters besides (or as well as) perl.  To correct the
                   8831:       full pathname to the script interpreter, you need to set the
                   8832:       following definitions in your <code class="filename">Makefile</code> (we
1.110     hubertf  8833:     shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87      wiz      8834: <pre class="programlisting">
1.100     rillig   8835: REPLACE_INTERPRETER+=   tcl
                   8836: REPLACE.tcl.old=        .*/bin/tclsh
                   8837: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   8838: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   8839: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.87      wiz      8840:     </pre>
1.75      rillig   8841: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   8842: <h3 class="title">Note</h3>
                   8843: <p>Before March 2006, these variables were called
1.87      wiz      8844:     <code class="varname">_REPLACE.*</code> and
                   8845:     <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75      rillig   8846: </div>
                   8847: </div>
                   8848: <div class="sect2" lang="en">
                   8849: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8850: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.75      rillig   8851: <p>Makefiles of packages providing perl5 modules should include
1.87      wiz      8852:     the Makefile fragment
                   8853:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
1.110     hubertf  8854:     <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87      wiz      8855:     configuration for such modules as well as various hooks to tune
                   8856:     this configuration.  See comments in this file for
                   8857:     details.</p>
1.75      rillig   8858: <p>Perl5 modules will install into different places depending
1.87      wiz      8859:     on the version of perl used during the build process.  To
                   8860:     address this, pkgsrc will append lines to the
                   8861:     <code class="filename">PLIST</code> corresponding to the files listed in
                   8862:     the installed <code class="filename">.packlist</code> file generated by
                   8863:     most perl5 modules.  This is invoked by defining
                   8864:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
                   8865:     paths to packlist files, e.g.:</p>
1.75      rillig   8866: <pre class="programlisting">
1.100     rillig   8867: PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
1.87      wiz      8868:     </pre>
1.75      rillig   8869: <p>The variables <code class="varname">PERL5_SITELIB</code>,
1.87      wiz      8870:     <code class="varname">PERL5_SITEARCH</code>, and
                   8871:     <code class="varname">PERL5_ARCHLIB</code> represent the three locations
                   8872:     in which perl5 modules may be installed, and may be used by
                   8873:     perl5 packages that don't have a packlist.  These three
                   8874:     variables are also substituted for in the
                   8875:     <code class="filename">PLIST</code>.</p>
1.75      rillig   8876: </div>
                   8877: <div class="sect2" lang="en">
                   8878: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8879: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.75      rillig   8880: <p>Some packages install info files or use the
1.87      wiz      8881:     &#8220;<span class="quote">makeinfo</span>&#8221;  or &#8220;<span class="quote">install-info</span>&#8221;
                   8882:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   8883:     the package Makefile so that <code class="filename">INSTALL</code> and
                   8884:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   8885:     handle registration of the info files in the Info directory
                   8886:     file. The &#8220;<span class="quote">install-info</span>&#8221; command used for the info
                   8887:     files registration is either provided by the system, or by a
                   8888:     special purpose package automatically added as dependency if
                   8889:     needed.</p>
1.75      rillig   8890: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87      wiz      8891:     <code class="filename">${PREFIX}</code> where info files are primarily
                   8892:     located. <code class="varname">PKGINFODIR</code> defaults to
                   8893:     &#8220;<span class="quote">info</span>&#8221; and can be overridden by the user.</p>
1.75      rillig   8894: <p>The info files for the package should be listed in the
1.87      wiz      8895:     package <code class="filename">PLIST</code>; however any split info files
                   8896:     need not be listed.</p>
1.75      rillig   8897: <p>A package which needs the &#8220;<span class="quote">makeinfo</span>&#8221; command
1.87      wiz      8898:     at build time must add &#8220;<span class="quote">makeinfo</span>&#8221; to
                   8899:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
                   8900:     version of the &#8220;<span class="quote">makeinfo</span>&#8221; command is needed it
                   8901:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   8902:     variable in the package <code class="filename">Makefile</code>. By
                   8903:     default, a minimum version of 3.12 is required. If the system
1.110     hubertf  8904:     does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87      wiz      8905:     does not match the required minimum, a build dependency on the
1.91      rillig   8906:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/gtexinfo/README.html" target="_top"><code class="filename">devel/gtexinfo</code></a> package will
1.87      wiz      8907:     be added automatically.</p>
1.75      rillig   8908: <p>The build and installation process of the software provided
1.87      wiz      8909:     by the package should not use the
1.110     hubertf  8910:     <span class="command"><strong>install-info</strong></span> command as the registration of
1.87      wiz      8911:     info files is the task of the package
                   8912:     <code class="filename">INSTALL</code> script, and it must use the
1.110     hubertf  8913:     appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75      rillig   8914: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110     hubertf  8915:     overriding scripts for the <span class="command"><strong>install-info</strong></span> and
                   8916:     <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87      wiz      8917:     in <code class="varname">PATH</code>.</p>
1.110     hubertf  8918: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87      wiz      8919:     no effect except the logging of a message. The script overriding
1.110     hubertf  8920:     <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87      wiz      8921:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110     hubertf  8922:     <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75      rillig   8923: </div>
                   8924: <div class="sect2" lang="en">
                   8925: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8926: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.81      rillig   8927: <p>All packages that install manual pages should install them
1.87      wiz      8928:     into the same directory, so that there is one common place to look
                   8929:     for them. In pkgsrc, this place is
                   8930:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   8931:     should be used in packages. The default for
                   8932:     <code class="varname">PKGMANDIR</code> is
                   8933:     &#8220;<span class="quote"><code class="filename">man</code></span>&#8221;. Another often-used value
                   8934:     is &#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;.</p>
1.75      rillig   8935: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   8936: <h3 class="title">Note</h3>
1.87      wiz      8937: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   8938:     is far from complete.</p>
1.75      rillig   8939: </div>
1.81      rillig   8940: <p>The <code class="filename">PLIST</code> files can just use
1.87      wiz      8941:     <code class="filename">man/</code> as the top level directory for the man
                   8942:     page file entries, and the pkgsrc framework will convert as
                   8943:     needed. In all other places, the correct
                   8944:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   8945: <p>Packages that are
                   8946:     configured with <code class="varname">GNU_CONFIGURE</code> set as
                   8947:     &#8220;<span class="quote">yes</span>&#8221;, by default will use the
                   8948:     <code class="filename">./configure</code>
                   8949:     --mandir switch to set where the man pages should be installed.
                   8950:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   8951:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   8952: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   8953:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
                   8954:     to &#8220;<span class="quote">no</span>&#8221;.
                   8955:     Or if the <code class="filename">./configure</code> script uses
                   8956:     a non-standard use of --mandir, you can set
                   8957:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.110     hubertf  8958: <p>See <a class="xref" href="#manpage-compression" title="13.5. Man page compression">Section 13.5, &#8220;Man page compression&#8221;</a> for
1.87      wiz      8959:     information on installation of compressed manual pages.</p>
1.75      rillig   8960: </div>
                   8961: <div class="sect2" lang="en">
                   8962: <div class="titlepage"><div><div><h3 class="title">
1.107     rillig   8963: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.87      wiz      8964: <p>If a package installs <code class="filename">.schemas</code> or
1.107     rillig   8965:     <code class="filename">.entries</code> files, used by GConf,
1.87      wiz      8966:     you need to take some extra steps to make sure they get registered
                   8967:     in the database:</p>
1.75      rillig   8968: <div class="orderedlist"><ol type="1">
1.107     rillig   8969: <li><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.87      wiz      8970:        instead of its <code class="filename">buildlink3.mk</code> file.  This
1.107     rillig   8971:        takes care of rebuilding the GConf database at installation and
1.87      wiz      8972:        deinstallation time, and tells the package where to install
1.107     rillig   8973:        GConf data files using some standard configure arguments.  It
1.87      wiz      8974:        also disallows any access to the database directly from the
                   8975:        package.</p></li>
1.75      rillig   8976: <li><p>Ensure that the package installs its
1.87      wiz      8977:        <code class="filename">.schemas</code> files under
                   8978:        <code class="filename">${PREFIX}/share/gconf/schemas</code>.  If they get
                   8979:        installed under <code class="filename">${PREFIX}/etc</code>, you will
                   8980:        need to manually patch the package.</p></li>
1.75      rillig   8981: <li><p>Check the PLIST and remove any entries under the etc/gconf
1.87      wiz      8982:        directory, as they will be handled automatically.  See
1.110     hubertf  8983:        <a class="xref" href="#faq.conf" title="9.13. How do I change the location of configuration files?">Section 9.13, &#8220;How do I change the location of configuration files?&#8221;</a> for more information.</p></li>
1.107     rillig   8984: <li><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.87      wiz      8985:        your <code class="filename">Makefile</code> with a list of all
                   8986:        <code class="filename">.schemas</code> files installed by the package, if
                   8987:        any.  Names must not contain any directories in them.</p></li>
1.107     rillig   8988: <li><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.87      wiz      8989:        your <code class="filename">Makefile</code> with a
                   8990:        list of all <code class="filename">.entries</code> files installed by the
                   8991:        package, if any. Names must not contain any directories in
                   8992:        them.</p></li>
1.75      rillig   8993: </ol></div>
                   8994: </div>
                   8995: <div class="sect2" lang="en">
                   8996: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8997: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper data files</h3></div></div></div>
1.87      wiz      8998: <p>If a package installs <code class="filename">.omf</code> files, used by
                   8999:     scrollkeeper, you need to take some extra steps to make sure they
                   9000:     get registered in the database:</p>
1.75      rillig   9001: <div class="orderedlist"><ol type="1">
                   9002: <li><p>Include
1.116   ! rillig   9003:        <code class="filename">../../textproc/scrollkeeper/omf.mk</code>
1.87      wiz      9004:        instead of its <code class="filename">buildlink3.mk</code> file.  This
                   9005:        takes care of rebuilding the scrollkeeper database at
                   9006:        installation and deinstallation time, and disallows any access
                   9007:        to it directly from the package.</p></li>
1.75      rillig   9008: <li><p>Check the PLIST and remove any entries under the
1.87      wiz      9009:        <code class="filename">libdata/scrollkeeper</code> directory, as they
                   9010:        will be handled automatically.</p></li>
1.76      rillig   9011: <li><p>Remove the <code class="filename">share/omf</code> directory from
1.87      wiz      9012:        the PLIST.  It will be handled by scrollkeeper.</p></li>
1.75      rillig   9013: </ol></div>
                   9014: </div>
                   9015: <div class="sect2" lang="en">
                   9016: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9017: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75      rillig   9018: <p>If a package installs font files, you will need to rebuild
1.87      wiz      9019:     the fonts database in the directory where they get installed at
                   9020:     installation and deinstallation time.  This can be automatically
                   9021:     done by using the pkginstall framework.</p>
1.75      rillig   9022: <p>You can list the directories where fonts are installed in the
1.87      wiz      9023:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   9024:     variables, where <em class="replaceable"><code>type</code></em> can be one of
                   9025:     &#8220;<span class="quote">ttf</span>&#8221;, &#8220;<span class="quote">type1</span>&#8221; or &#8220;<span class="quote">x11</span>&#8221;.
                   9026:     Also make sure that the database file
                   9027:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75      rillig   9028: <p>Note that you should not create new directories for fonts;
1.87      wiz      9029:     instead use the standard ones to avoid that the user needs to
                   9030:     manually configure his X server to find them.</p>
1.75      rillig   9031: </div>
                   9032: <div class="sect2" lang="en">
                   9033: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9034: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75      rillig   9035: <p>If a package installs GTK2 immodules or loaders, you need to
1.87      wiz      9036:     take some extra steps to get them registered in the GTK2 database
                   9037:     properly:</p>
1.75      rillig   9038: <div class="orderedlist"><ol type="1">
                   9039: <li><p>Include
1.87      wiz      9040:       <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
                   9041:       <code class="filename">buildlink3.mk</code> file.  This takes care of
                   9042:       rebuilding the database at installation and deinstallation time.</p></li>
                   9043: <li><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
                   9044:       your package installs GTK2 immodules.</p></li>
                   9045: <li><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
                   9046:       GTK2 loaders.</p></li>
1.75      rillig   9047: <li>
1.87      wiz      9048: <p>Patch the package to not touch any of the GTK2
                   9049:       databases directly.  These are:</p>
1.75      rillig   9050: <div class="itemizedlist"><ul type="disc">
1.76      rillig   9051: <li><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
                   9052: <li><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75      rillig   9053: </ul></div>
                   9054: </li>
1.87      wiz      9055: <li><p>Check the <code class="filename">PLIST</code> and remove
                   9056:       any entries under the <code class="filename">libdata/gtk-2.0</code>
                   9057:       directory, as they will be handled automatically.</p></li>
1.75      rillig   9058: </ol></div>
                   9059: </div>
                   9060: <div class="sect2" lang="en">
                   9061: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9062: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75      rillig   9063: <p>If a package installs SGML or XML data files that need to be
1.87      wiz      9064:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   9065:     etc.), you need to take some extra steps:</p>
1.75      rillig   9066: <div class="orderedlist"><ol type="1">
                   9067: <li><p>Include
1.87      wiz      9068:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   9069:        your <code class="filename">Makefile</code>, which takes care of
                   9070:        registering those files in system-wide catalogs at
                   9071:        installation and deinstallation time.</p></li>
1.75      rillig   9072: <li><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87      wiz      9073:        any SGML catalogs installed by the package.</p></li>
1.75      rillig   9074: <li><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87      wiz      9075:        any XML catalogs installed by the package.</p></li>
1.75      rillig   9076: <li><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87      wiz      9077:        to be added to the SGML catalog.  These come in groups of
                   9078:        three strings; see xmlcatmgr(1) for more information
                   9079:        (specifically, arguments recognized by the 'add' action).
                   9080:        Note that you will normally not use this variable.</p></li>
1.75      rillig   9081: <li><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87      wiz      9082:        to be added to the XML catalog.  These come in groups of three
                   9083:        strings; see xmlcatmgr(1) for more information (specifically,
                   9084:        arguments recognized by the 'add' action).  Note that you will
                   9085:        normally not use this variable.</p></li>
1.75      rillig   9086: </ol></div>
                   9087: </div>
                   9088: <div class="sect2" lang="en">
                   9089: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9090: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75      rillig   9091: <p>If a package provides extensions to the MIME database by
1.87      wiz      9092:     installing <code class="filename">.xml</code> files inside
                   9093:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   9094:     need to take some extra steps to ensure that the database is kept
                   9095:     consistent with respect to these new files:</p>
1.75      rillig   9096: <div class="orderedlist"><ol type="1">
                   9097: <li><p>Include
1.87      wiz      9098:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   9099:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   9100:        this same directory, which is reserved for inclusion from
                   9101:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   9102:        care of rebuilding the MIME database at installation and
                   9103:        deinstallation time, and disallows any access to it directly
                   9104:        from the package.</p></li>
1.75      rillig   9105: <li><p>Check the PLIST and remove any entries under the
1.87      wiz      9106:        <code class="filename">share/mime</code> directory,
                   9107:        <span class="emphasis"><em>except</em></span> for files saved under
                   9108:        <code class="filename">share/mime/packages</code>.  The former are
                   9109:        handled automatically by
                   9110:        the update-mime-database program, but the latter are
                   9111:        package-dependent and must be removed by the package that
                   9112:        installed them in the first place.</p></li>
1.76      rillig   9113: <li><p>Remove any <code class="filename">share/mime/*</code> directories
1.87      wiz      9114:        from the PLIST.  They will be handled by the shared-mime-info
                   9115:        package.</p></li>
1.75      rillig   9116: </ol></div>
                   9117: </div>
                   9118: <div class="sect2" lang="en">
                   9119: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9120: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.93      rillig   9121: <p>If a package uses intltool during its build, add
                   9122:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87      wiz      9123:     which forces it to use the intltool package provided by pkgsrc,
                   9124:     instead of the one bundled with the distribution file.</p>
1.75      rillig   9125: <p>This tracks intltool's build-time dependencies and uses the
1.87      wiz      9126:     latest available version; this way, the package benefits of any
                   9127:     bug fixes that may have appeared since it was released.</p>
1.75      rillig   9128: </div>
                   9129: <div class="sect2" lang="en">
                   9130: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9131: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.75      rillig   9132: <p>If a package contains a rc.d script, it won't be copied into
1.87      wiz      9133:     the startup directory by default, but you can enable it, by adding
                   9134:     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110     hubertf  9135:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87      wiz      9136:     into <code class="filename">/etc/rc.d</code> when a package is installed, and
                   9137:     it will automatically remove the scripts when the package is
                   9138:     deinstalled.</p>
1.75      rillig   9139: </div>
                   9140: <div class="sect2" lang="en">
                   9141: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9142: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.75      rillig   9143: <p>If a package installs TeX packages into the texmf tree,
1.87      wiz      9144:     the <code class="filename">ls-R</code> database of the tree needs to be
                   9145:     updated.</p>
1.75      rillig   9146: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   9147: <h3 class="title">Note</h3>
                   9148: <p>Except the main TeX packages such as teTeX-texmf,
1.87      wiz      9149:     packages should install files
                   9150:     into <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
                   9151:     not <code class="varname">PKG_TEXMFPREFIX</code>.</p>
1.75      rillig   9152: </div>
                   9153: <div class="orderedlist"><ol type="1">
                   9154: <li><p>Include
1.87      wiz      9155:       <code class="filename">../../print/teTeX/module.mk</code> instead
                   9156:       of <code class="filename">../../mk/tex.buildlink3.mk</code>.  This
                   9157:       takes care of rebuilding the <code class="filename">ls-R</code>
                   9158:       database at installation and deinstallation time.</p></li>
1.75      rillig   9159: <li>
                   9160: <p>If your package installs files into a texmf
1.87      wiz      9161:       tree other than the one
                   9162:       at <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
                   9163:       set <code class="varname">TEXMFDIRS</code> to the list of all texmf
                   9164:       trees that need database update.</p>
1.75      rillig   9165: <p>If your package also installs font map files that need
1.110     hubertf  9166:       to be registered using <span class="command"><strong>updmap</strong></span>,
1.87      wiz      9167:       set <code class="varname">TEX_FONTMAPS</code> to the list of all
1.110     hubertf  9168:       such font map files.  Then <span class="command"><strong>updmap</strong></span> will
1.87      wiz      9169:       be run automatically at installation/deinstallation to
                   9170:       enable/disable font map files for TeX output
                   9171:       drivers.</p>
1.75      rillig   9172: </li>
1.76      rillig   9173: <li><p>Make sure that none of <code class="filename">ls-R</code>
1.87      wiz      9174:       databases are included in <code class="filename">PLIST</code>, as
                   9175:       they will be removed only by the teTeX-bin package.</p></li>
1.75      rillig   9176: </ol></div>
                   9177: </div>
1.85      jmmv     9178: <div class="sect2" lang="en">
                   9179: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9180: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.87      wiz      9181:     emulation</h3></div></div></div>
                   9182: <p>There are some packages that provide libraries and
                   9183:     executables for running binaries from a one operating system
                   9184:     on a different one (if the latter supports it).  One example
                   9185:     is running Linux binaries on NetBSD.</p>
1.91      rillig   9186: <p>The <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>
1.87      wiz      9187:     helps in extracting and packaging Linux rpm packages.</p>
                   9188: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110     hubertf  9189:     avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87      wiz      9190:     if all libraries for each installed executable can be found by
                   9191:     the dynamic linker.  Since the standard dynamic linker is run,
                   9192:     this fails for emulation packages, because the libraries used
                   9193:     by the emulation are not in the standard directories.</p>
                   9194: </div>
                   9195: <div class="sect2" lang="en">
                   9196: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9197: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.85      jmmv     9198: <p>If a package installs images under the
1.87      wiz      9199:     <code class="filename">share/icons/hicolor</code> and/or updates the
                   9200:     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
                   9201:     database, you need to take some extra steps to make sure that the
                   9202:     shared theme directory is handled appropriately and that the cache
                   9203:     database is rebuilt:</p>
1.85      jmmv     9204: <div class="orderedlist"><ol type="1">
                   9205: <li><p>Include
1.87      wiz      9206:        <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
                   9207: <li><p>Check the <code class="filename">PLIST</code> and remove the
                   9208:        entry that refers to the theme cache.</p></li>
1.85      jmmv     9209: <li><p>Ensure that the PLIST does not remove the shared icon
                   9210:          directories from the <code class="filename">share/icons/hicolor</code>
                   9211:          hierarchy because they will be handled automatically.</p></li>
                   9212: </ol></div>
                   9213: <p>The best way to verify that the PLIST is correct with
                   9214:       respect to the last two points is to regenerate it using
1.110     hubertf  9215:       <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.85      jmmv     9216: </div>
                   9217: <div class="sect2" lang="en">
                   9218: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9219: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.85      jmmv     9220: <p>If a package installs <code class="filename">.desktop</code> files
                   9221:       under <code class="filename">share/applications</code> and these include
                   9222:       MIME information, you need to take extra steps to ensure that they
                   9223:       are registered into the MIME database:</p>
                   9224: <div class="orderedlist"><ol type="1">
                   9225: <li><p>Include
                   9226:          <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
                   9227: <li><p>Check the PLIST and remove the entry that refers to the
                   9228:          <code class="filename">share/applications/mimeinfo.cache</code> file.
                   9229:          It will be handled automatically.</p></li>
                   9230: </ol></div>
                   9231: <p>The best way to verify that the PLIST is correct with
1.110     hubertf  9232:       respect to the last point is to regenerate it using <span class="command"><strong>make
1.85      jmmv     9233:       print-PLIST</strong></span>.</p>
1.75      rillig   9234: </div>
                   9235: </div>
1.87      wiz      9236: <div class="sect1" lang="en">
                   9237: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9238: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.87      wiz      9239: <p>In some cases one does not have the time to solve a problem
                   9240:   immediately.  There are currently two ways to declare that one knows
                   9241:   that a package has problems.</p>
                   9242: <div class="itemizedlist"><ul type="disc">
                   9243: <li><p>The first way is to plainly mark it as broken.  For
                   9244:     this, one just sets the variable <code class="varname">BROKEN</code> to the
                   9245:     reason why the package is broken (similar to the
                   9246:     <code class="varname">RESTRICTED</code> variable).  A user trying to build
                   9247:     the package will immediately be shown this message, and the build
                   9248:     will not be even tried.</p></li>
                   9249: <li><p>After each pkgsrc freeze period (a time when the
                   9250:     tree is stabilized and a new pkgsrc branch is cut), the packages
                   9251:     that were not building in the official branch build on the latest
                   9252:     NetBSD release will be marked as broken on that branch.  This is
                   9253:     done by setting the <code class="varname">BROKEN_IN</code> variable to the
                   9254:     branch name (or appending the branch name to it).  If a user tries
                   9255:     to build such a package and the build fails, the user gets a
                   9256:     message that says that the package was broken on the respective
                   9257:     branch(es).</p></li>
                   9258: </ul></div>
                   9259: <p>Both types of packages are removed from pkgsrc in irregular
                   9260:   intervals.</p>
                   9261: </div>
1.75      rillig   9262: </div>
                   9263: <div class="chapter" lang="en">
                   9264: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9265: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.88      wiz      9266: <p>To check out all the gotchas when building a package, here are
                   9267:   the steps that I do in order to get a package working.  Please note
                   9268:   this is basically the same as what was explained in the previous
                   9269:   sections, only with some debugging aids.</p>
1.75      rillig   9270: <div class="itemizedlist"><ul type="disc">
1.110     hubertf  9271: <li><p>Be sure to set <code class="varname">PKG_DEVELOPER=yes</code> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></li>
1.75      rillig   9272: <li>
1.91      rillig   9273: <p>Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>,
1.88      wiz      9274:       create a directory for a new package, change into it, then run
1.110     hubertf  9275:       <span class="command"><strong>url2pkg</strong></span>:</p>
1.75      rillig   9276: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>mkdir /usr/pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>examplepkg</code></em></code></strong>
                   9277: <code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>examplepkg</code></em></code></strong>
                   9278: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
                   9279: </li>
1.76      rillig   9280: <li><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
                   9281: <li><p>Fill in the <code class="filename">DESCR</code> file</p></li>
1.110     hubertf  9282: <li><p>Run <span class="command"><strong>make configure</strong></span></p></li>
1.75      rillig   9283: <li><p>Add any dependencies glimpsed from documentation and the
1.88      wiz      9284:       configure step to the package's
                   9285:       <code class="filename">Makefile</code>.</p></li>
1.75      rillig   9286: <li>
                   9287: <p>Make the package compile, doing multiple rounds of</p>
                   9288: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   9289: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   9290: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
                   9291: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
                   9292: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
                   9293: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
                   9294: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88      wiz      9295: <p>Doing this step as non-root user will ensure that no files
                   9296:       are modified that shouldn't be, especially during the build
1.110     hubertf  9297:       phase.  <span class="command"><strong>mkpatches</strong></span>,
                   9298:       <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.91      rillig   9299:       from the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>
1.88      wiz      9300:       package.</p>
1.75      rillig   9301: </li>
1.88      wiz      9302: <li><p>Look at the <code class="filename">Makefile</code>, fix if
1.116   ! rillig   9303:       necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, &#8220;Makefile&#8221;</a>.</p></li>
1.75      rillig   9304: <li>
1.76      rillig   9305: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75      rillig   9306: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9307: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST &gt;PLIST</code></strong>
                   9308: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
                   9309: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9310: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88      wiz      9311: <p>You usually need to be <code class="username">root</code> to do
                   9312:       this.  Look if there are any files left:</p>
1.75      rillig   9313: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9314: <p>If this reveals any files that are missing in
1.88      wiz      9315:       <code class="filename">PLIST</code>, add them.</p>
1.75      rillig   9316: </li>
                   9317: <li>
1.88      wiz      9318: <p>Now that the <code class="filename">PLIST</code> is OK, install the
                   9319:       package again and make a binary package:</p>
1.75      rillig   9320: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
                   9321: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
                   9322: </li>
                   9323: <li>
                   9324: <p>Delete the installed package:</p>
1.88      wiz      9325: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
1.75      rillig   9326: </li>
                   9327: <li>
1.110     hubertf  9328: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.88      wiz      9329:       command, which shouldn't find anything now:</p>
1.75      rillig   9330: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9331: </li>
                   9332: <li>
                   9333: <p>Reinstall the binary package:</p>
1.93      rillig   9334: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
1.75      rillig   9335: </li>
1.88      wiz      9336: <li><p>Play with it.  Make sure everything works.</p></li>
1.75      rillig   9337: <li>
1.110     hubertf  9338: <p>Run <span class="command"><strong>pkglint</strong></span> from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>, and fix the problems it
1.88      wiz      9339:       reports:</p>
1.75      rillig   9340: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
                   9341: </li>
1.110     hubertf  9342: <li><p>Submit (or commit, if you have cvs access); see <a class="xref" href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a>.</p></li>
1.75      rillig   9343: </ul></div>
                   9344: </div>
                   9345: <div class="chapter" lang="en">
                   9346: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9347: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.75      rillig   9348: <div class="toc">
                   9349: <p><b>Table of Contents</b></p>
                   9350: <dl>
1.106     rillig   9351: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   9352: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   9353: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
                   9354: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
                   9355: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
                   9356: <dt><span class="sect1"><a href="#moving-package">21.6. Moving a package in pkgsrc</a></span></dt>
1.75      rillig   9357: </dl>
                   9358: </div>
                   9359: <div class="sect1" lang="en">
                   9360: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9361: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.75      rillig   9362: <p>Our policy is that we accept binaries only from pkgsrc
                   9363:        developers to guarantee that the packages don't contain any
                   9364:        trojan horses etc. This is not to annoy anyone but rather to
                   9365:        protect our users! You're still free to put up your home-made
                   9366:        binary packages and tell the world where to get them. NetBSD
                   9367:        developers doing bulk builds and wanting to upload them please
1.110     hubertf  9368:        see <a class="xref" href="#bulk-upload" title="7.3.8. Uploading results of a bulk build">Section 7.3.8, &#8220;Uploading results of a bulk build&#8221;</a>.</p>
1.75      rillig   9369: </div>
                   9370: <div class="sect1" lang="en">
                   9371: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9372: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75      rillig   9373: <p>First, check that your package is complete, compiles and
1.110     hubertf  9374:        runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
                   9375:        document. Next, generate an uuencoded gzipped <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.82      rillig   9376:        archive that contains all files that make up the package.
1.87      wiz      9377:        Finally, send this package to the pkgsrc bug tracking system,
1.110     hubertf  9378:        either with the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.87      wiz      9379:        that, go to the web page
1.110     hubertf  9380:        <a class="ulink" href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.87      wiz      9381:        which contains some instructions and a link to a form, where you
                   9382:        can submit packages.</p>
                   9383: <p>In the form of the problem report, the category should be
                   9384:        &#8220;<span class="quote">pkg</span>&#8221;, the synopsis should include the package name
                   9385:        and version number, and the description field should contain a
                   9386:        short description of your package (contents of the COMMENT
                   9387:        variable or DESCR file are OK). The uuencoded package data should
                   9388:        go into the &#8220;<span class="quote">fix</span>&#8221; field.</p>
1.75      rillig   9389: <p>If you want to submit several packages, please send a
                   9390:        separate PR for each one, it's easier for us to track things
                   9391:        that way.</p>
                   9392: <p>Alternatively, you can also import new packages into
                   9393:        pkgsrc-wip (&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;); see the
1.110     hubertf  9394:        homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
1.75      rillig   9395:        for details.</p>
                   9396: </div>
                   9397: <div class="sect1" lang="en">
                   9398: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9399: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75      rillig   9400: <p>Please note all package additions, updates, moves, and
1.93      rillig   9401:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75      rillig   9402:        important to keep this file up to date and conforming to the
                   9403:        existing format, because it will be used by scripts to
1.110     hubertf  9404:        automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75      rillig   9405:        sites. Additionally, check the
1.76      rillig   9406:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75      rillig   9407:        for the package you updated or removed, in case it was mentioned
                   9408:        there.</p>
                   9409: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   9410:        bumped, the change should appear in
1.93      rillig   9411:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75      rillig   9412:        related or otherwise relevant. Mass bumps that result from a
                   9413:        dependency being updated should not be mentioned. In all other
                   9414:        cases it's the developer's decision.</p>
                   9415: <p>There is a make target that helps in creating proper
1.110     hubertf  9416:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span class="command"><strong>make
1.75      rillig   9417:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   9418:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93      rillig   9419:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75      rillig   9420:   file is up-to-date (to avoid having to resolve conflicts later-on)
1.110     hubertf  9421:   and then to <span class="command"><strong>cd</strong></span> to the package directory.  For
                   9422:   package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75      rillig   9423:   For new packages, or package moves or removals, set the
                   9424:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   9425:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110     hubertf  9426:   in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.75      rillig   9427:   not the same as your NetBSD login name. Don't forget to commit
1.93      rillig   9428:   the changes to <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>!</p>
1.75      rillig   9429: </div>
                   9430: <div class="sect1" lang="en">
                   9431: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9432: <a name="committing-importing"></a>21.4. Committing: Importing a package into CVS</h2></div></div></div>
1.87      wiz      9433: <p>This section is only of interest for pkgsrc developers with write
1.75      rillig   9434:   access to the pkgsrc repository. Please remember that cvs
                   9435:   imports files relative to the current working directory, and that
                   9436:   the pathname that you
1.110     hubertf  9437:   give the <span class="command"><strong>cvs import</strong></span> command is so that it knows where
1.75      rillig   9438:   to place the files in the repository.  Newly created packages should be
                   9439:   imported with a vendor tag of &#8220;<span class="quote">TNF</span>&#8221; and a release tag of
1.87      wiz      9440:   &#8220;<span class="quote">pkgsrc-base</span>&#8221;, e.g:</p>
1.75      rillig   9441: <pre class="programlisting">
1.100     rillig   9442: <code class="prompt">$</code> cd .../pkgsrc/category/pkgname
                   9443: <code class="prompt">$</code> cvs import pkgsrc/category/pkgname TNF pkgsrc-base
1.75      rillig   9444: </pre>
1.87      wiz      9445: <p>Remember to move the directory from which you imported out of
1.75      rillig   9446:   the way, or cvs will complain the next time you &#8220;<span class="quote">cvs
                   9447:   update</span>&#8221; your source tree.  Also don't forget to add the new
1.87      wiz      9448:   package to the category's <code class="filename">Makefile</code>.</p>
                   9449: <p>The commit message of the initial import should include part of the
1.76      rillig   9450:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87      wiz      9451:   what the package is/does.</p>
                   9452: <p>For new packages, &#8220;<span class="quote">cvs import</span>&#8221; is preferred to &#8220;<span class="quote">cvs
1.75      rillig   9453:   add</span>&#8221; because the former gets everything with a single command,
1.87      wiz      9454:   and provides a consistent tag.</p>
1.75      rillig   9455: </div>
                   9456: <div class="sect1" lang="en">
                   9457: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9458: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.87      wiz      9459: <p>Please always put a concise, appropriate and relevant summary of the
1.75      rillig   9460:   changes between old and new versions into the commit log when updating
1.87      wiz      9461:   a package. There are various reasons for this:</p>
1.75      rillig   9462: <div class="itemizedlist"><ul type="disc">
1.87      wiz      9463: <li><p>A URL is volatile, and can change over time. It may go away completely
                   9464:   or its information may be overwritten by newer information.</p></li>
                   9465: <li><p>Having the change information between old and new versions in our CVS
                   9466:   repository is very useful for people who use either cvs or anoncvs.</p></li>
                   9467: <li><p>Having the change information between old and new versions in our CVS
1.75      rillig   9468:   repository is very useful for people who read the pkgsrc-changes mailing
                   9469:   list, so that they can make tactical decisions about when to upgrade
1.87      wiz      9470:   the package.</p></li>
1.75      rillig   9471: </ul></div>
1.87      wiz      9472: <p>Please also recognize that, just because a new version of a package
1.75      rillig   9473:   has been released, it should not automatically be upgraded in the CVS
                   9474:   repository.  We prefer to be conservative in the packages that are
                   9475:   included in pkgsrc - development or beta packages are not really the
                   9476:   best thing for most places in which pkgsrc is used. Please use your
                   9477:   judgement about what should go into pkgsrc, and bear in mind that
1.87      wiz      9478:   stability is to be preferred above new and possibly untested features.</p>
1.75      rillig   9479: </div>
                   9480: <div class="sect1" lang="en">
                   9481: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9482: <a name="moving-package"></a>21.6. Moving a package in pkgsrc</h2></div></div></div>
1.75      rillig   9483: <div class="orderedlist"><ol type="1">
                   9484: <li><p>Make a copy of the directory somewhere else.</p></li>
                   9485: <li>
                   9486: <p>Remove all CVS dirs.</p>
1.87      wiz      9487: <p>Alternatively to the first two steps you can also do:</p>
1.75      rillig   9488: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs -d user@cvs.NetBSD.org:/cvsroot export -D today pkgsrc/category/package</code></strong></pre>
1.87      wiz      9489: <p>and use that for further work.</p>
1.75      rillig   9490: </li>
                   9491: <li><p>Fix <code class="varname">CATEGORIES</code> and any
                   9492: <code class="varname">DEPENDS</code> paths that just did &#8220;<span class="quote">../package</span>&#8221;
                   9493: instead of &#8220;<span class="quote">../../category/package</span>&#8221;.</p></li>
1.110     hubertf  9494: <li><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75      rillig   9495: place.</p></li>
                   9496: <li>
                   9497: <p>Check if any package depends on it:
                   9498: </p>
                   9499: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   9500: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   9501: </li>
                   9502: <li><p>Fix paths in packages from step 5 to point to new location.</p></li>
1.110     hubertf  9503: <li><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
1.76      rillig   9504: <li><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   9505: <li><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
1.75      rillig   9506: <li>
                   9507: <p>Commit the changed and removed files:</p>
                   9508: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
1.87      wiz      9509: <p>(and any packages from step 5, of course).</p>
1.75      rillig   9510: </li>
                   9511: </ol></div>
                   9512: </div>
                   9513: </div>
                   9514: <div class="chapter" lang="en">
                   9515: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9516: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   9517: <p>This section contains the answers to questions that may
                   9518:        arise when you are writing a package. If you don't find your
                   9519:        question answered here, first have a look in the other chapters,
                   9520:        and if you still don't have the answer, ask on the
                   9521:        <code class="literal">pkgsrc-users</code> mailing list.</p>
                   9522: <div class="qandaset">
                   9523: <dl>
1.106     rillig   9524: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.75      rillig   9525:        MAKEFLAGS, .MAKEFLAGS and
                   9526:        MAKE_FLAGS?</a>
                   9527: </dt>
1.106     rillig   9528: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.75      rillig   9529:        MAKE, GMAKE and
                   9530:        MAKE_PROGRAM?</a>
                   9531: </dt>
1.106     rillig   9532: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.75      rillig   9533:        CC, PKG_CC and
                   9534:        PKGSRC_COMPILER?</a>
                   9535: </dt>
1.106     rillig   9536: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.75      rillig   9537:        BUILDLINK_LDFLAGS,
                   9538:        BUILDLINK_LDADD and
                   9539:        BUILDLINK_LIBS?</a>
                   9540: </dt>
1.106     rillig   9541: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75      rillig   9542:        VARNAME=BUILDLINK_PREFIX.foo
                   9543:        say it's empty?</a>
                   9544: </dt>
1.106     rillig   9545: <dt>22.6. <a href="#devfaq.master_sites">What does
1.78      rillig   9546:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   9547:        don't understand the := inside
                   9548:        it.</a>
                   9549: </dt>
1.106     rillig   9550: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78      rillig   9551:        developers?</a>
                   9552: </dt>
1.106     rillig   9553: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80      rillig   9554:        documentation?</a>
                   9555: </dt>
1.106     rillig   9556: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill.  What shall I
1.92      rillig   9557: do?</a>
                   9558: </dt>
1.75      rillig   9559: </dl>
                   9560: <table border="0" summary="Q and A Set">
                   9561: <col align="left" width="1%">
                   9562: <tbody>
                   9563: <tr class="question">
                   9564: <td align="left" valign="top">
1.116   ! rillig   9565: <a name="devfaq.makeflags"></a><a name="id369298"></a><p><b>22.1.</b></p>
1.75      rillig   9566: </td>
                   9567: <td align="left" valign="top"><p>What is the difference between
                   9568:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   9569:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   9570: </tr>
                   9571: <tr class="answer">
1.91      rillig   9572: <td align="left" valign="top"></td>
1.75      rillig   9573: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.110     hubertf  9574:        to the pkgsrc-internal invocations of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.75      rillig   9575:        <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
                   9576:        the <code class="varname">MAKE_PROGRAM</code> when building the
                   9577:        package. [FIXME: What is .MAKEFLAGS for?]</p></td>
                   9578: </tr>
                   9579: <tr class="question">
                   9580: <td align="left" valign="top">
1.116   ! rillig   9581: <a name="devfaq.make"></a><a name="id369338"></a><p><b>22.2.</b></p>
1.75      rillig   9582: </td>
                   9583: <td align="left" valign="top"><p>What is the difference between
                   9584:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   9585:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   9586: </tr>
                   9587: <tr class="answer">
1.91      rillig   9588: <td align="left" valign="top"></td>
1.75      rillig   9589: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.110     hubertf  9590:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.75      rillig   9591:        infrastructure. <code class="varname">GMAKE</code> is the path to GNU
                   9592:        Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
                   9593:        use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
                   9594:        Make program that is used for building the
                   9595:        package.</p></td>
                   9596: </tr>
                   9597: <tr class="question">
                   9598: <td align="left" valign="top">
1.116   ! rillig   9599: <a name="devfaq.cc"></a><a name="id369382"></a><p><b>22.3.</b></p>
1.75      rillig   9600: </td>
                   9601: <td align="left" valign="top"><p>What is the difference between
                   9602:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   9603:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   9604: </tr>
                   9605: <tr class="answer">
1.91      rillig   9606: <td align="left" valign="top"></td>
1.75      rillig   9607: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
                   9608:        compiler, which can be configured by the pkgsrc user.
                   9609:        <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
                   9610:        <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
                   9611:        path to a compiler, but the type of compiler that should be
1.76      rillig   9612:        used. See <code class="filename">mk/compiler.mk</code> for more
1.75      rillig   9613:        information about the latter variable.</p></td>
                   9614: </tr>
                   9615: <tr class="question">
                   9616: <td align="left" valign="top">
1.116   ! rillig   9617: <a name="devfaq.bl3flags"></a><a name="id369424"></a><p><b>22.4.</b></p>
1.75      rillig   9618: </td>
                   9619: <td align="left" valign="top"><p>What is the difference between
                   9620:        <code class="varname">BUILDLINK_LDFLAGS</code>,
                   9621:        <code class="varname">BUILDLINK_LDADD</code> and
                   9622:        <code class="varname">BUILDLINK_LIBS</code>?</p></td>
                   9623: </tr>
                   9624: <tr class="answer">
1.91      rillig   9625: <td align="left" valign="top"></td>
1.75      rillig   9626: <td align="left" valign="top"><p>[FIXME]</p></td>
                   9627: </tr>
                   9628: <tr class="question">
                   9629: <td align="left" valign="top">
1.116   ! rillig   9630: <a name="devfaq.bl3prefix"></a><a name="id369447"></a><p><b>22.5.</b></p>
1.75      rillig   9631: </td>
1.110     hubertf  9632: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75      rillig   9633:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   9634:        say it's empty?</p></td>
                   9635: </tr>
                   9636: <tr class="answer">
1.91      rillig   9637: <td align="left" valign="top"></td>
1.75      rillig   9638: <td align="left" valign="top"><p>For optimization reasons, some variables are only
                   9639:        available in the &#8220;<span class="quote">wrapper</span>&#8221; phase and later. To
                   9640:        &#8220;<span class="quote">simulate</span>&#8221; the wrapper phase, append
1.110     hubertf  9641:        <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75      rillig   9642:        command.</p></td>
                   9643: </tr>
1.78      rillig   9644: <tr class="question">
                   9645: <td align="left" valign="top">
1.116   ! rillig   9646: <a name="devfaq.master_sites"></a><a name="id369481"></a><p><b>22.6.</b></p>
1.78      rillig   9647: </td>
                   9648: <td align="left" valign="top"><p>What does
                   9649:        <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   9650:        don't understand the <code class="literal">:=</code> inside
                   9651:        it.</p></td>
                   9652: </tr>
                   9653: <tr class="answer">
1.91      rillig   9654: <td align="left" valign="top"></td>
1.78      rillig   9655: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
                   9656:        assignment operator, like you might expect at first sight.
                   9657:        Instead, it is a degenerate form of
                   9658:        <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.110     hubertf  9659:        which is documented in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which you
1.78      rillig   9660:        may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
                   9661:        case of <code class="varname">MASTER_SITE_*</code>,
                   9662:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   9663:        <em class="replaceable"><code>new_string</code></em> is
                   9664:        <code class="literal">package/</code>. That's where the
                   9665:        <code class="literal">:</code> and the <code class="literal">=</code> fall
                   9666:        together.</p></td>
                   9667: </tr>
                   9668: <tr class="question">
                   9669: <td align="left" valign="top">
1.116   ! rillig   9670: <a name="devfaq.mailinglists"></a><a name="id369566"></a><p><b>22.7.</b></p>
1.78      rillig   9671: </td>
                   9672: <td align="left" valign="top"><p>Which mailing lists are there for package
                   9673:        developers?</p></td>
                   9674: </tr>
                   9675: <tr class="answer">
1.91      rillig   9676: <td align="left" valign="top"></td>
1.78      rillig   9677: <td align="left" valign="top"><div class="variablelist"><dl>
1.110     hubertf  9678: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
1.78      rillig   9679: <dd><p>This is a list for technical discussions related
                   9680:        to pkgsrc development, e.g. soliciting feedback for changes to
                   9681:        pkgsrc infrastructure, proposed new features, questions related
                   9682:        to porting pkgsrc to a new platform, advice for maintaining a
                   9683:        package, patches that affect many packages, help requests moved
                   9684:        from pkgsrc-users when an infrastructure bug is found,
                   9685:        etc.</p></dd>
1.110     hubertf  9686: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
1.78      rillig   9687: <dd><p>All bug reports in category "pkg" sent with
1.110     hubertf  9688:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.78      rillig   9689:        directly; use one of the other mailing
                   9690:        lists.</p></dd>
                   9691: </dl></div></td>
                   9692: </tr>
1.80      rillig   9693: <tr class="question">
                   9694: <td align="left" valign="top">
1.116   ! rillig   9695: <a name="devfaq.documentation"></a><a name="id369609"></a><p><b>22.8.</b></p>
1.80      rillig   9696: </td>
                   9697: <td align="left" valign="top"><p>Where is the pkgsrc
                   9698:        documentation?</p></td>
                   9699: </tr>
                   9700: <tr class="answer">
1.91      rillig   9701: <td align="left" valign="top"></td>
1.80      rillig   9702: <td align="left" valign="top">
                   9703: <p>There are many places where you can find
                   9704:        documentation about pkgsrc:</p>
                   9705: <div class="itemizedlist"><ul type="disc">
                   9706: <li><p>The pkgsrc guide (this document) is a collection
                   9707:        of chapters that explain large parts of pkgsrc, but some
                   9708:        chapters tend to be outdated. Which ones they are is hard to
                   9709:        say.</p></li>
1.110     hubertf  9710: <li><p>On the mailing list archives (see <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>), you can find discussions
1.80      rillig   9711:        about certain features, announcements of new parts of the pkgsrc
                   9712:        infrastructure and sometimes even announcements that a certain
                   9713:        feature has been marked as obsolete. The benefit here is that
                   9714:        each message has a date appended to it.</p></li>
                   9715: <li><p>Many of the files in the
                   9716:        <code class="filename">mk/</code> directory start with a comment that
                   9717:        describes the purpose of the file and how it can be used by the
1.92      rillig   9718:        pkgsrc user and package authors. An easy way to find this
1.110     hubertf  9719:        documentation is to run <span class="command"><strong>bmake
1.92      rillig   9720:        help</strong></span>.</p></li>
1.80      rillig   9721: <li><p>The CVS log messages are a rich source of
                   9722:        information, but they tend to be highly abbreviated, especially
                   9723:        for actions that occur often. Some contain a detailed
                   9724:        description of what has changed, but they are geared towards the
                   9725:        other pkgsrc developers, not towards an average pkgsrc user.
                   9726:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   9727:        don't know what has been before, these messages may not be worth
                   9728:        too much to you.</p></li>
                   9729: <li><p>Some parts of pkgsrc are only &#8220;<span class="quote">implicitly
                   9730:        documented</span>&#8221;, that is the documentation exists only in the
                   9731:        mind of the developer who wrote the code. To get this
1.110     hubertf  9732:        information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80      rillig   9733:        to see who has written it and ask on the
                   9734:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   9735:        find your questions later (see above). To be sure that the
                   9736:        developer in charge reads the mail, you may CC him or
                   9737:        her.</p></li>
                   9738: </ul></div>
                   9739: </td>
                   9740: </tr>
1.92      rillig   9741: <tr class="question">
                   9742: <td align="left" valign="top">
1.116   ! rillig   9743: <a name="devfaq.too-much-time"></a><a name="id369686"></a><p><b>22.9.</b></p>
1.92      rillig   9744: </td>
                   9745: <td align="left" valign="top"><p>I have a little time to kill.  What shall I
                   9746: do?</p></td>
                   9747: </tr>
                   9748: <tr class="answer">
                   9749: <td align="left" valign="top"></td>
                   9750: <td align="left" valign="top">
1.93      rillig   9751: <p>This is not really an FAQ yet, but here's the answer
1.92      rillig   9752: anyway.</p>
                   9753: <div class="itemizedlist"><ul type="disc">
1.110     hubertf  9754: <li><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.92      rillig   9755:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a> package).  It
                   9756:     will tell you about newer versions of installed packages that are
                   9757:     available, but not yet updated in pkgsrc.</p></li>
                   9758: <li><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.114     jmcneill 9759:     &mdash; it contains a list of suggested new packages and a list of
1.92      rillig   9760:     cleanups and enhancements for pkgsrc that would be nice to
                   9761:     have.</p></li>
                   9762: <li><p>Review packages for which review was requested on
1.110     hubertf  9763:     the <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
1.92      rillig   9764:     mailing list.</p></li>
                   9765: </ul></div>
                   9766: </td>
                   9767: </tr>
1.75      rillig   9768: </tbody>
                   9769: </table>
                   9770: </div>
                   9771: </div>
1.85      jmmv     9772: <div class="chapter" lang="en">
                   9773: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9774: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.85      jmmv     9775: <div class="toc">
                   9776: <p><b>Table of Contents</b></p>
                   9777: <dl>
1.106     rillig   9778: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   9779: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   9780: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   9781: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85      jmmv     9782: </dl>
                   9783: </div>
1.110     hubertf  9784: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.85      jmmv     9785: site</a>:</p>
                   9786: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   9787:   environment, an intuitive and attractive desktop for users, and the
                   9788:   GNOME development platform, an extensive framework for building
                   9789:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   9790: <p>pkgsrc provides a seamless way to automatically build and install
                   9791: a complete GNOME environment <span class="emphasis"><em>under many different
                   9792: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   9793: the most advanced build and packaging systems for GNOME due to its
                   9794: included technologies buildlink3, the wrappers and tools framework and
                   9795: automatic configuration file management.  Lots of efforts are put into
                   9796: achieving a completely clean deinstallation of installed software
                   9797: components.</p>
1.110     hubertf  9798: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.85      jmmv     9799: the above also means that great efforts are put into making GNOME work
1.110     hubertf  9800: under this operating system.  Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.85      jmmv     9801: pkgsrc as its preferred packaging system, contributing lots of
                   9802: portability fixes to make GNOME build and install under it.</p>
                   9803: <p>This chapter is aimed at pkgsrc developers and other people
                   9804: interested in helping our GNOME porting and packaging efforts.  It
                   9805: provides instructions on how to manage the existing packages and some
                   9806: important information regarding their internals.</p>
                   9807: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   9808: <h3 class="title">We need your help!</h3>
                   9809: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
                   9810:   and GNOME and are willing to learn new exciting stuff, please jump
1.110     hubertf  9811:   straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.85      jmmv     9812:   work</a> list!  There is still a long way to go to get a
                   9813:   fully-functional GNOME desktop under NetBSD and we need your help to
                   9814:   achieve it!</p>
                   9815: </div>
                   9816: <div class="sect1" lang="en">
                   9817: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9818: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.85      jmmv     9819: <p>pkgsrc includes three GNOME-related meta packages:</p>
                   9820: <div class="itemizedlist"><ul type="disc">
1.91      rillig   9821: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/README.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>: Provides
1.85      jmmv     9822:     the core GNOME desktop environment.  It only includes the necessary
                   9823:     bits to get it to boot correctly, although it may lack important
                   9824:     functionality for daily operation.  The idea behind this package is
                   9825:     to let end users build their own configurations on top of this one,
                   9826:     first installing this meta package to achieve a functional setup and
                   9827:     then adding individual applications.</p></li>
1.91      rillig   9828: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a>: Provides a
1.85      jmmv     9829:     complete installation of the GNOME platform and desktop as defined
                   9830:     by the GNOME project; this is based on the components distributed in
                   9831:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   9832:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   9833:     official FTP server.  Developer-only tools found in those
                   9834:     directories are not installed unless required by some other
                   9835:     component to work properly.  Similarly, packages from the bindings
                   9836:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   9837:     in unless required as a dependency for an end-user component.  This
1.91      rillig   9838:     package "extends" <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/README.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>.</p></li>
                   9839: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/README.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a>:
1.85      jmmv     9840:     Installs all the tools required to build a GNOME component when
                   9841:     fetched from the CVS repository.  These are required to let the
1.110     hubertf  9842:     <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.85      jmmv     9843: </ul></div>
                   9844: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   9845: sorted in a way that eases updates: a package may depend on other
                   9846: packages listed before it but not on any listed after it.  It is very
                   9847: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   9848: change it to alphabetical sorting!</em></span></p>
                   9849: </div>
                   9850: <div class="sect1" lang="en">
                   9851: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9852: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.85      jmmv     9853: <p>Almost all GNOME applications are written in C and use a common
                   9854: set of tools as their build system.  Things get different with the new
                   9855: bindings to other languages (such as Python), but the following will
                   9856: give you a general idea on the minimum required tools:</p>
                   9857: <div class="itemizedlist"><ul type="disc">
                   9858: <li>
                   9859: <p>Almost all GNOME applications use the GNU Autotools as their
                   9860:     build system.  As a general rule you will need to tell this to your
                   9861:     package:</p>
1.100     rillig   9862: <pre class="programlisting">
                   9863: GNU_CONFIGURE=yes
1.85      jmmv     9864: USE_LIBTOOL=yes
1.100     rillig   9865: USE_TOOLS+=gmake
                   9866: </pre>
1.85      jmmv     9867: </li>
                   9868: <li>
                   9869: <p>If the package uses pkg-config to detect dependencies, add this
                   9870:     tool to the list of required utilities:</p>
                   9871: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.91      rillig   9872: <p>Also use <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/verifypc/README.html" target="_top"><code class="filename">pkgtools/verifypc</code></a> at
1.85      jmmv     9873:     the end of the build process to ensure that you did not miss to
                   9874:     specify any dependency in your package and that the version
                   9875:     requirements are all correct.</p>
                   9876: </li>
1.93      rillig   9877: <li><p>If the package uses intltool, be sure to add
                   9878:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85      jmmv     9879:     to handle dependencies and to force the package to use the latest
                   9880:     available version.</p></li>
                   9881: <li>
                   9882: <p>If the package uses gtk-doc (a documentation generation
                   9883:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   9884:     tool is rather big and the distfile should come with pregenerated
                   9885:     documentation anyway; if it does not, it is a bug that you ought to
                   9886:     report.  For such packages you should disable gtk-doc (unless it is
1.89      rillig   9887:     the default):</p>
                   9888: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
                   9889: <p>The default location of installed HTML files
                   9890:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   9891:     and should not be changed unless the package insists on installing
                   9892:     them somewhere else.  Otherwise programs as
1.110     hubertf  9893:     <span class="command"><strong>devhelp</strong></span> will not be able to open them.  You can
1.89      rillig   9894:     do that with an entry similar to:</p>
                   9895: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
1.85      jmmv     9896: </li>
                   9897: </ul></div>
                   9898: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   9899: files under the installation prefix to maintain databases.  In this
                   9900: context, shared means that those exact same directories and files are
                   9901: used among several different packages, leading to conflicts in the
                   9902: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   9903: handle the most common cases, so you have to forget about using
                   9904: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   9905: omitting shared files from them.  If you find yourself doing those,
                   9906: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   9907: <p>The following table lists the common situations that result in
                   9908: using shared directories or files.  For each of them, the appropriate
                   9909: solution is given.  After applying the solution be sure to
                   9910: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.110     hubertf  9911: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.85      jmmv     9912: <div class="table">
1.106     rillig   9913: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.91      rillig   9914: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
1.85      jmmv     9915: <colgroup>
                   9916: <col>
                   9917: <col>
                   9918: </colgroup>
                   9919: <thead><tr>
                   9920: <th>If the package...</th>
                   9921: <th>Then...</th>
                   9922: </tr></thead>
                   9923: <tbody>
                   9924: <tr>
                   9925: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.110     hubertf  9926: <td>See <a class="xref" href="#scrollkeeper-data-files" title="19.6.10. Packages installing scrollkeeper data files">Section 19.6.10, &#8220;Packages installing scrollkeeper data files&#8221;</a>.</td>
1.85      jmmv     9927: </tr>
                   9928: <tr>
                   9929: <td>Installs icons under the
                   9930:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   9931:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.110     hubertf  9932: <td>See <a class="xref" href="#hicolor-theme" title="19.6.19. Packages installing hicolor theme icons">Section 19.6.19, &#8220;Packages installing hicolor theme icons&#8221;</a>.</td>
1.85      jmmv     9933: </tr>
                   9934: <tr>
                   9935: <td>Installs files under
                   9936:         <code class="filename">share/mime/packages</code>.</td>
1.110     hubertf  9937: <td>See <a class="xref" href="#mime-database" title="19.6.14. Packages installing extensions to the MIME database">Section 19.6.14, &#8220;Packages installing extensions to the MIME database&#8221;</a>.</td>
1.85      jmmv     9938: </tr>
                   9939: <tr>
                   9940: <td>Installs <code class="filename">.desktop</code> files under
                   9941:         <code class="filename">share/applications</code> and these include MIME
                   9942:         information.</td>
1.110     hubertf  9943: <td>See <a class="xref" href="#desktop-files" title="19.6.20. Packages installing desktop files">Section 19.6.20, &#8220;Packages installing desktop files&#8221;</a>.</td>
1.85      jmmv     9944: </tr>
                   9945: </tbody>
1.91      rillig   9946: </table></div>
1.85      jmmv     9947: </div>
1.91      rillig   9948: <br class="table-break">
1.85      jmmv     9949: </div>
                   9950: <div class="sect1" lang="en">
                   9951: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9952: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.85      jmmv     9953: <p>When seeing GNOME as a whole, there are two kinds of
                   9954: updates:</p>
                   9955: <div class="variablelist"><dl>
                   9956: <dt><span class="term">Major update</span></dt>
                   9957: <dd>
                   9958: <p>Given that there is still a very long way for GNOME 3 (if it
                   9959:       ever appears), we consider a major update one that goes from a
                   9960:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   9961:       where <code class="literal">Y</code> is even and greater than
                   9962:       <code class="literal">X</code>.  These are hard to achieve because they
                   9963:       introduce lots of changes in the components' code and almost all
                   9964:       GNOME distfiles are updated to newer versions.  Some of them can
                   9965:       even break API and ABI compatibility with the previous major
                   9966:       version series.  As a result, the update needs to be done all at
                   9967:       once to minimize breakage.</p>
                   9968: <p>A major update typically consists of around 80 package
                   9969:       updates and the addition of some new ones.</p>
                   9970: </dd>
                   9971: <dt><span class="term">Minor update</span></dt>
                   9972: <dd>
                   9973: <p>We consider a minor update one that goes from a
                   9974:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   9975:       one where <code class="literal">Y</code> is greater than
                   9976:       <code class="literal">X</code>.  These are easy to achieve because they do
                   9977:       not update all GNOME components, can be done in an incremental way
                   9978:       and do not break API nor ABI compatibility.</p>
                   9979: <p>A minor update typically consists of around 50 package
                   9980:       updates, although the numbers here may vary a lot.</p>
                   9981: </dd>
                   9982: </dl></div>
                   9983: <p>In order to update the GNOME components in pkgsrc to a new stable
                   9984: release (either major or minor), the following steps should be
                   9985: followed:</p>
                   9986: <div class="orderedlist"><ol type="1">
                   9987: <li>
                   9988: <p>Get a list of all the tarballs that form the new release by
                   9989:     using the following commands.  These will leave the full list of the
                   9990:     components's distfiles into the <code class="filename">list.txt</code>
                   9991:     file:</p>
1.88      wiz      9992: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85      jmmv     9993:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   9994:     awk '{ print $9 }' &gt;list.txt</code></strong>
1.88      wiz      9995: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85      jmmv     9996:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   9997:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
                   9998: </li>
                   9999: <li><p>Open each meta package's <code class="filename">Makefile</code> and
                   10000:     bump their version to the release you are updating them to.  The
                   10001:     three meta packages should be always consistent with versioning.
                   10002:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   10003:     in them.</p></li>
                   10004: <li>
                   10005: <p>For each meta package, update all its
                   10006:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   10007:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   10008:     newer version (even if found in the FTP) because the meta packages
                   10009:     are supposed to list the exact versions that form a specific GNOME
                   10010:     release.  Exceptions are permitted here if a newer version solves a
                   10011:     serious issue in the overall desktop experience; these typically
                   10012:     come in the form of a revision bump in pkgsrc, not in newer versions
                   10013:     from the developers.</p>
                   10014: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   10015:     should be updated to the latest version available (if found in
                   10016:     pkgsrc).  This is the case, for example, of the dependencies on the
1.91      rillig   10017:     GNU Autotools in the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/README.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a> meta package.</p>
1.85      jmmv     10018: </li>
                   10019: <li>
                   10020: <p>Generate a patch from the modified meta packages and extract the
                   10021:     list of "new" lines.  This will provide you an outline on what
                   10022:     packages need to be updated in pkgsrc and in what order:</p>
1.93      rillig   10023: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs diff -u gnome-devel gnome-base gnome | grep '^+D' &gt;todo.txt</code></strong></pre>
1.85      jmmv     10024: </li>
                   10025: <li><p>For major desktop updates it is recommended to zap all your
                   10026:     installed packages and start over from scratch at this point.</p></li>
                   10027: <li><p>Now comes the longest step by far: iterate over the contents
                   10028:     of <code class="filename">todo.txt</code> and update the packages listed in
                   10029:     it in order.  For major desktop updates none of these should be
1.93      rillig   10030:     committed until the entire set is completed because there are chances
1.85      jmmv     10031:     of breaking not-yet-updated packages.</p></li>
                   10032: <li><p>Once the packages are up to date and working, commit them to
                   10033:     the tree one by one with appropriate log messages.  At the end,
                   10034:     commit the three meta package updates and all the corresponding
                   10035:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
                   10036:     <a href="http://cvsweb.NetBSD.org/bsdweb.cgi/pkgsrc/doc/TODO?rev=HEAD&amp;content-type=text/x-cvsweb-markup" target="_top"><code class="filename">pkgsrc/doc/TODO</code></a> files.</p></li>
                   10037: </ol></div>
                   10038: </div>
                   10039: <div class="sect1" lang="en">
                   10040: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10041: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.85      jmmv     10042: <p>GNOME is a very big component in pkgsrc which approaches 100
                   10043: packages.  Please, it is very important that you always, always,
                   10044: <span class="strong"><strong>always</strong></span> feed back any portability
1.110     hubertf  10045: fixes you do to a GNOME package to the mainstream developers (see <a class="xref" href="#components.patches.feedback" title="11.3.5. Feedback to the author">Section 11.3.5, &#8220;Feedback to the author&#8221;</a>).  This is the only way to get
1.85      jmmv     10046: their attention on portability issues and to ensure that future versions
                   10047: can be built out-of-the box on NetBSD.  The less custom patches in
                   10048: pkgsrc, the easier further updates are.  Those developers in charge of
                   10049: issuing major GNOME updates will be grateful if you do that.</p>
1.110     hubertf  10050: <p>The most common places to report bugs are the <a class="ulink" href="http://bugzilla.gnome.org/" target="_top">GNOME's Bugzilla</a> and the <a class="ulink" href="http://bugzilla.freedesktop.org/" target="_top">freedesktop.org's
1.85      jmmv     10051: Bugzilla</a>.  Not all components use these to track bugs, but most
                   10052: of them do.  Do not be short on your reports: always provide detailed
                   10053: explanations of the current failure, how it can be improved to achieve
                   10054: maximum portability and, if at all possible, provide a patch against CVS
                   10055: head.  The more verbose you are, the higher chances of your patch being
                   10056: accepted.</p>
                   10057: <p>Also, please avoid using preprocessor magic to fix portability
                   10058: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   10059: GNOME to their operating system, the official GNOME sources are now
                   10060: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   10061: and similar macros.  This hurts portability.  Please see our patching
1.110     hubertf  10062: guidelines (<a class="xref" href="#components.patches.guidelines" title="11.3.4. Patching guidelines">Section 11.3.4, &#8220;Patching guidelines&#8221;</a>) for more
1.85      jmmv     10063: details.</p>
                   10064: </div>
                   10065: </div>
1.75      rillig   10066: </div>
                   10067: <div class="part" lang="en">
                   10068: <div class="titlepage"><div><div><h1 class="title">
                   10069: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
                   10070: <div class="partintro" lang="en">
                   10071: <div></div>
                   10072: <p>This part of the guide deals with everything
                   10073:        from the infrastructure that is behind the interfaces described
                   10074:        in the developer's guide. A casual package maintainer should not
                   10075:        need anything from this part.</p>
                   10076: <div class="toc">
                   10077: <p><b>Table of Contents</b></p>
                   10078: <dl>
1.106     rillig   10079: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig   10080: <dd><dl>
1.106     rillig   10081: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   10082: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   10083: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.75      rillig   10084: <dd><dl>
1.106     rillig   10085: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   10086: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.75      rillig   10087: </dl></dd>
1.106     rillig   10088: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   10089: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10090: <dd><dl>
1.106     rillig   10091: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   10092: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.81      rillig   10093: </dl></dd>
1.106     rillig   10094: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.81      rillig   10095: <dd><dl>
1.116   ! rillig   10096: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in bsd.prefs.mk</a></span></dt>
        !          10097: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in bsd.pkg.mk</a></span></dt>
1.75      rillig   10098: </dl></dd>
                   10099: </dl></dd>
1.106     rillig   10100: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75      rillig   10101: <dd><dl>
1.106     rillig   10102: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                   10103: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                   10104: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75      rillig   10105: <dd><dl>
1.106     rillig   10106: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                   10107: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75      rillig   10108: </dl></dd>
                   10109: </dl></dd>
1.106     rillig   10110: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75      rillig   10111: <dd><dl>
1.106     rillig   10112: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                   10113: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75      rillig   10114: </dl></dd>
                   10115: </dl>
                   10116: </div>
                   10117: </div>
                   10118: <div class="chapter" lang="en">
                   10119: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   10120: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75      rillig   10121: <div class="toc">
                   10122: <p><b>Table of Contents</b></p>
                   10123: <dl>
1.106     rillig   10124: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   10125: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   10126: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81      rillig   10127: <dd><dl>
1.106     rillig   10128: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   10129: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81      rillig   10130: </dl></dd>
1.106     rillig   10131: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   10132: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10133: <dd><dl>
1.106     rillig   10134: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   10135: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75      rillig   10136: </dl></dd>
1.106     rillig   10137: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75      rillig   10138: <dd><dl>
1.116   ! rillig   10139: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in bsd.prefs.mk</a></span></dt>
        !          10140: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in bsd.pkg.mk</a></span></dt>
1.75      rillig   10141: </dl></dd>
                   10142: </dl>
                   10143: </div>
                   10144: <p>The pkgsrc infrastructure consists of many small Makefile
                   10145:        fragments. Each such fragment needs a properly specified
                   10146:        interface. This chapter explains how such an interface looks
                   10147:        like.</p>
                   10148: <div class="sect1" lang="en">
                   10149: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10150: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.81      rillig   10151: <p>Whenever a variable is defined in the pkgsrc
                   10152:        infrastructure, the location and the way of definition provide
                   10153:        much information about the intended use of that variable.
                   10154:        Additionally, more documentation may be found in a header
                   10155:        comment or in this pkgsrc guide.</p>
                   10156: <p>A special file is
                   10157:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   10158:        variables that are intended to be user-defined. They are either
                   10159:        defined using the <code class="literal">?=</code> operator or they are
                   10160:        left undefined because defining them to anything would
                   10161:        effectively mean &#8220;<span class="quote">yes</span>&#8221;. All these variables may be
                   10162:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   10163:        file.</p>
                   10164: <p>Outside this file, the following conventions apply:
                   10165:        Variables that are defined using the <code class="literal">?=</code>
                   10166:        operator may be overridden by a package.</p>
                   10167: <p>Variables that are defined using the <code class="literal">=</code>
                   10168:        operator may be used read-only at run-time.</p>
                   10169: <p>Variables whose name starts with an underscore must not be
                   10170:        accessed outside the pkgsrc infrastructure at all. They may
                   10171:        change without further notice.</p>
                   10172: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   10173: <h3 class="title">Note</h3>
                   10174: <p>These conventions are currently not applied
                   10175:        consistently to the complete pkgsrc
                   10176:        infrastructure.</p>
                   10177: </div>
                   10178: </div>
                   10179: <div class="sect1" lang="en">
                   10180: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10181: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.81      rillig   10182: <p>All variables that contain lists of things should default
                   10183:        to being empty. Two examples that do not follow this rule are
                   10184:        <code class="varname">USE_LANGUAGES</code> and
                   10185:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   10186:        modified using the <code class="literal">+=</code> operator in package
                   10187:        <code class="filename">Makefile</code>s (or other files included by
                   10188:        them), since there is no guarantee whether the variable is
                   10189:        already set or not, and what its value is. In the case of
                   10190:        <code class="varname">DISTFILES</code>, the packages &#8220;<span class="quote">know</span>&#8221;
                   10191:        the default value and just define it as in the following
                   10192:        example.</p>
                   10193: <pre class="programlisting">
1.100     rillig   10194: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81      rillig   10195: </pre>
                   10196: <p>Because of the selection of this default value, the same
                   10197:        value appears in many package Makefiles. Similarly for
                   10198:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
                   10199:        value (&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;) is so short that it
                   10200:        doesn't stand out. Nevertheless it is mentioned in many
                   10201:        files.</p>
                   10202: </div>
                   10203: <div class="sect1" lang="en">
                   10204: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10205: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.75      rillig   10206: <div class="sect2" lang="en">
                   10207: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10208: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.75      rillig   10209: <p>Variable evaluation takes place either at load time or at
                   10210:        runtime, depending on the context in which they occur. The
                   10211:        contexts where variables are evaluated at load time are:</p>
                   10212: <div class="itemizedlist"><ul type="disc">
                   10213: <li><p>The right hand side of the <code class="literal">:=</code>
                   10214:        and <code class="literal">!=</code> operators,</p></li>
                   10215: <li><p>Make directives like <code class="literal">.if</code> or
                   10216:        <code class="literal">.for</code>,</p></li>
                   10217: <li><p>Dependency lines.</p></li>
                   10218: </ul></div>
                   10219: <p>A special exception are references to the iteration
                   10220:        variables of <code class="literal">.for</code> loops, which are expanded
                   10221:        inline, no matter in which context they appear.</p>
                   10222: <p>As the values of variables may change during load time,
                   10223:        care must be taken not to evaluate them by accident. Typical
                   10224:        examples for variables that should not be evaluated at load time
                   10225:        are <code class="varname">DEPENDS</code> and
                   10226:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   10227:        clear, here is an example:</p>
                   10228: <pre class="programlisting">
1.100     rillig   10229: CONFIGURE_ARGS=         # none
                   10230: CFLAGS=                 -O
                   10231: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
1.1       grant    10232: 
1.100     rillig   10233: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
1.1       grant    10234: 
1.100     rillig   10235: CFLAGS+=                -Wall
1.75      rillig   10236:        </pre>
                   10237: <p>This code shows how the use of the <code class="literal">:=</code>
                   10238:        operator can quickly lead to unexpected results. The first
                   10239:        paragraph is fairly common code. The second paragraph evaluates
                   10240:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   10241:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   10242:        <code class="literal">-Wall</code> is appended to the
                   10243:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   10244:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   10245:        paragraphs from above typically occur in completely unrelated
                   10246:        files.</p>
                   10247: </div>
                   10248: <div class="sect2" lang="en">
                   10249: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10250: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.75      rillig   10251: <p>After all the files have been loaded, the values of the
                   10252:        variables cannot be changed anymore. Variables that are used in
                   10253:        the shell commands are expanded at this point.</p>
                   10254: </div>
                   10255: </div>
                   10256: <div class="sect1" lang="en">
                   10257: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10258: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.78      rillig   10259: <p>There are many ways in which the definition and use of a
                   10260:        variable can be restricted in order to detect bugs and
                   10261:        violations of the (mostly unwritten) policies. See the
                   10262:        <code class="literal">pkglint</code> developer's documentation for further
                   10263:        details.</p>
                   10264: </div>
                   10265: <div class="sect1" lang="en">
                   10266: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10267: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76      rillig   10268: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75      rillig   10269:        of the following classes. Cases where a file falls into more
                   10270:        than one class should be avoided as it often leads to subtle
                   10271:        bugs.</p>
                   10272: <div class="sect2" lang="en">
                   10273: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10274: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.75      rillig   10275: <p>In a traditional imperative programming language some of
1.76      rillig   10276:        the <code class="filename">.mk</code> files could be described as
1.114     jmcneill 10277:        procedures. They take some input parameters and&mdash;after
                   10278:        inclusion&mdash;provide a result in output parameters. Since all
1.76      rillig   10279:        variables in <code class="filename">Makefile</code>s have global scope
1.75      rillig   10280:        care must be taken not to use parameter names that have already
                   10281:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   10282:        bad choice for a parameter name.</p>
                   10283: <p>Procedures are completely evaluated at preprocessing time.
                   10284:        That is, when calling a procedure all input parameters must be
                   10285:        completely resolvable. For example,
                   10286:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   10287:        parameter since it is very likely that further text will be
                   10288:        added after calling the procedure, which would effectively apply
                   10289:        the procedure to only a part of the variable. Also, references
                   10290:        to other variables wit will be modified after calling the
                   10291:        procedure.</p>
                   10292: <p>A procedure can declare its output parameters either as
                   10293:        suitable for use in preprocessing directives or as only
                   10294:        available at runtime. The latter alternative is for variables
                   10295:        that contain references to other runtime variables.</p>
                   10296: <p>Procedures shall be written such that it is possible to
                   10297:        call the procedure more than once. That is, the file must not
                   10298:        contain multiple-inclusion guards.</p>
                   10299: <p>Examples for procedures are
1.76      rillig   10300:        <code class="filename">mk/bsd.options.mk</code> and
                   10301:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75      rillig   10302:        that the parameters are evaluated at load time, they should be
                   10303:        assigned using the <code class="literal">:=</code> operator, which should
                   10304:        be used only for this purpose.</p>
                   10305: </div>
                   10306: <div class="sect2" lang="en">
                   10307: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10308: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75      rillig   10309: <p>Action files take some input parameters and may define
                   10310:        runtime variables. They shall not define loadtime variables.
                   10311:        There are action files that are included implicitly by the
                   10312:        pkgsrc infrastructure, while other must be included
                   10313:        explicitly.</p>
                   10314: <p>An example for action files is
1.76      rillig   10315:        <code class="filename">mk/subst.mk</code>.</p>
1.75      rillig   10316: </div>
                   10317: </div>
1.81      rillig   10318: <div class="sect1" lang="en">
                   10319: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10320: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.81      rillig   10321: <p>Package <code class="filename">Makefile</code>s usually consist of
                   10322:        a set of variable definitions, and include the file
                   10323:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   10324:        Before that, they may also include various other
                   10325:        <code class="filename">*.mk</code> files if they need to query the
                   10326:        availability of certain features like the type of compiler or
                   10327:        the X11 implementation. Due to the heavy use of preprocessor
                   10328:        directives like <code class="literal">.if</code> and
                   10329:        <code class="literal">.for</code>, the order in which the files are loaded
                   10330:        matters.</p>
                   10331: <p>This section describes at which point the various files
                   10332:        are loaded and gives reasons for that order.</p>
                   10333: <div class="sect2" lang="en">
                   10334: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10335: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93      rillig   10336: </h3></div></div></div>
                   10337: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81      rillig   10338:        is to define some essential variables like
                   10339:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   10340:        <code class="varname">MACHINE_ARCH</code>.</p>
                   10341: <p>Then, the user settings are loaded from the file specified
1.110     hubertf  10342:        in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.104     rillig   10343:        After that, those variables
1.81      rillig   10344:        that have not been overridden by the user are loaded from
                   10345:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   10346: <p>After the user settings, the system settings and platform
                   10347:        settings are loaded, which may override the user
                   10348:        settings.</p>
                   10349: <p>Then, the tool definitions are loaded. The tool wrappers
                   10350:        are not yet in effect. This only happens when building a
                   10351:        package, so the proper variables must be used instead of the
                   10352:        direct tool names.</p>
                   10353: <p>As the last steps, some essential variables from the
                   10354:        wrapper and the package system flavor are loaded, as well as the
                   10355:        variables that have been cached in earlier phases of a package
                   10356:        build.</p>
                   10357: </div>
                   10358: <div class="sect2" lang="en">
                   10359: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10360: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93      rillig   10361: </h3></div></div></div>
1.81      rillig   10362: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   10363: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   10364:        loaded, which fill default values for those variables that have
1.93      rillig   10365:        not been defined by the package. These variables may later
1.81      rillig   10366:        be used even in unrelated files.</p>
                   10367: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   10368:        provides the target <code class="literal">error-check</code> that is added
                   10369:        as a special dependency to all other targets that use
                   10370:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   10371:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   10372: <p>Then, the package-specific hacks from
                   10373:        <code class="filename">hacks.mk</code> are included.</p>
                   10374: <p>Then, various other files follow. Most of them don't have
                   10375:        any dependencies on what they need to have included before or
                   10376:        after them, though some do.</p>
                   10377: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   10378:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   10379:        restricts the use of these variables to all the files that have
                   10380:        been included before. Appearances in later files will be
                   10381:        silently ignored.</p>
                   10382: <p>Then, the files for the main targets are included, in the
                   10383:        order of later execution, though the actual order should not
                   10384:        matter.</p>
                   10385: <p>At last, some more files are included that don't set any
                   10386:        interesting variables but rather just define make targets to be
                   10387:        executed.</p>
                   10388: </div>
                   10389: </div>
1.75      rillig   10390: </div>
                   10391: <div class="chapter" lang="en">
                   10392: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   10393: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.75      rillig   10394: <div class="toc">
                   10395: <p><b>Table of Contents</b></p>
                   10396: <dl>
1.106     rillig   10397: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                   10398: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                   10399: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75      rillig   10400: <dd><dl>
1.106     rillig   10401: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                   10402: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75      rillig   10403: </dl></dd>
                   10404: </dl>
                   10405: </div>
                   10406: <p>The pkgsrc infrastructure consists of a large codebase,
                   10407:        and there are many corners where every little bit of a file is
                   10408:        well thought out, making pkgsrc likely to fail as soon as
                   10409:        anything is changed near those parts. To prevent most changes
                   10410:        from breaking anything, a suite of regression tests should go
                   10411:        along with every important part of the pkgsrc infrastructure.
                   10412:        This chapter describes how regression tests work in pkgsrc and
                   10413:        how you can add new tests.</p>
                   10414: <div class="sect1" lang="en">
                   10415: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10416: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.75      rillig   10417: <p></p>
                   10418: </div>
                   10419: <div class="sect1" lang="en">
                   10420: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10421: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.91      rillig   10422: <p>You first need to install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_regress/README.html" target="_top"><code class="filename">pkgtools/pkg_regress</code></a> package, which
1.110     hubertf  10423:        provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75      rillig   10424:        can simply run that command, which will run all tests in the
1.76      rillig   10425:        <code class="filename">regress</code> category.</p>
1.75      rillig   10426: </div>
                   10427: <div class="sect1" lang="en">
                   10428: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10429: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.76      rillig   10430: <p>Every directory in the <code class="filename">regress</code>
                   10431:        category that contains a file called <code class="filename">spec</code>
1.75      rillig   10432:        is considered a regression test. This file is a shell program
1.110     hubertf  10433:        that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75      rillig   10434:        The following functions can be overridden to suit your
                   10435:        needs.</p>
                   10436: <div class="sect2" lang="en">
                   10437: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10438: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.75      rillig   10439: <p>These functions do not take any parameters. They are all
                   10440:        called in &#8220;<span class="quote">set -e</span>&#8221; mode, so you should be careful
                   10441:        to check the exitcodes of any commands you run in the
                   10442:        test.</p>
                   10443: <div class="variablelist"><dl>
                   10444: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
                   10445: <dd><p>This function prepares the environment for the
                   10446:        test. By default it does nothing.</p></dd>
                   10447: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
                   10448: <dd><p>This function runs the actual test. By default,
                   10449:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   10450:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   10451:        error messages into the file
                   10452:        <code class="varname">TEST_OUTFILE</code>.</p></dd>
                   10453: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
                   10454: <dd><p>This function is run after the test and is
                   10455:        typically used to compare the actual output from the one that is
                   10456:        expected. It can make use of the various helper functions from
                   10457:        the next section.</p></dd>
                   10458: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
                   10459: <dd><p>This function cleans everything up after the
                   10460:        test has been run. By default it does nothing.</p></dd>
                   10461: </dl></div>
                   10462: </div>
                   10463: <div class="sect2" lang="en">
                   10464: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10465: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.75      rillig   10466: <div class="variablelist"><dl>
                   10467: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
                   10468: <dd><p>This function compares the exitcode of the
1.110     hubertf  10469:        <span class="command"><strong>do_test()</strong></span> function with its first parameter.
1.75      rillig   10470:        If they differ, the test will fail.</p></dd>
                   10471: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
                   10472: <dd><p>This function checks for each of its parameters
1.110     hubertf  10473:        if the output from <span class="command"><strong>do_test()</strong></span> matches the
1.75      rillig   10474:        extended regular expression. If it does not, the test will
                   10475:        fail.</p></dd>
                   10476: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
                   10477: <dd><p>This function checks for each of its parameters
1.110     hubertf  10478:        if the output from <span class="command"><strong>do_test()</strong></span> does
1.75      rillig   10479:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   10480:        If any of the regular expressions matches, the test will
                   10481:        fail.</p></dd>
                   10482: </dl></div>
                   10483: </div>
                   10484: </div>
                   10485: </div>
                   10486: <div class="chapter" lang="en">
                   10487: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   10488: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.75      rillig   10489: <div class="toc">
                   10490: <p><b>Table of Contents</b></p>
                   10491: <dl>
1.106     rillig   10492: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                   10493: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75      rillig   10494: </dl>
                   10495: </div>
                   10496: <p>The pkgsrc system has already been ported to many
                   10497:        operating systems, hardware architectures and compilers. This
                   10498:        chapter explains the necessary steps to make pkgsrc even more
                   10499:        portable.</p>
                   10500: <div class="sect1" lang="en">
                   10501: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10502: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75      rillig   10503: <p>To port pkgsrc to a new operating system (called
                   10504:        <code class="literal">MyOS</code> in this example), you need to touch the
                   10505:        following files:</p>
                   10506: <div class="variablelist"><dl>
1.93      rillig   10507: <dt><span class="term"><code class="filename">pkgtools/bootstrap-mk-files/files/mods/<em class="replaceable"><code>MyOS</code></em>.sys.mk</code></span></dt>
1.75      rillig   10508: <dd><p>This file contains some basic definitions, for
                   10509:        example the name of the C
                   10510:        compiler.</p></dd>
1.76      rillig   10511: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75      rillig   10512: <dd><p>Insert code that defines the variables
                   10513:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
                   10514:        <code class="varname">LOWER_OS_VERSION</code>,
                   10515:        <code class="varname">LOWER_VENDOR</code>,
                   10516:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   10517:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   10518:        appear in this file.</p></dd>
1.93      rillig   10519: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10520: <dd><p>This file contains the platform-specific
                   10521:        definitions that are used by pkgsrc. Start by copying one of the
                   10522:        other files and edit it to your
                   10523:        needs.</p></dd>
1.93      rillig   10524: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
1.75      rillig   10525: <dd><p>This file contains a list of directories,
                   10526:        together with their permission bits and ownership. These
                   10527:        directories will be created automatically with every package
1.98      wiz      10528:        that explicitly sets <code class="varname">USE_MTREE</code>. This feature will
                   10529:        be removed.</p></dd>
1.93      rillig   10530: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
1.75      rillig   10531: <dd><p>Just copy one of the pre-existing x11.dist files
                   10532:        to your
1.76      rillig   10533:        <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
                   10534: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
1.75      rillig   10535: <dd><p>On some operating systems, the tools that are
                   10536:        provided with the base system are not good enough for pkgsrc.
1.110     hubertf  10537:        For example, there are many versions of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that have a
1.75      rillig   10538:        narrow limit on the line length they can process. Therefore
                   10539:        pkgsrc brings its own tools, which can be enabled
                   10540:        here.</p></dd>
1.93      rillig   10541: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10542: <dd><p>This file defines the paths to all the tools
                   10543:        that are needed by one or the other package in pkgsrc, as well
                   10544:        as by pkgsrc itself. Find out where these tools are on your
                   10545:        platform and add them.</p></dd>
                   10546: </dl></div>
                   10547: <p>Now, you should be able to build some basic packages, like
1.91      rillig   10548:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/perl5/README.html" target="_top"><code class="filename">lang/perl5</code></a>, <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/README.html" target="_top"><code class="filename">shells/bash</code></a>.</p>
1.75      rillig   10549: </div>
                   10550: <div class="sect1" lang="en">
                   10551: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10552: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.75      rillig   10553: <p>TODO</p>
                   10554: </div>
                   10555: </div>
                   10556: </div>
                   10557: <div class="appendix" lang="en">
                   10558: <div class="titlepage"><div><div><h2 class="title">
                   10559: <a name="examples"></a>Appendix A. A simple example package: bison</h2></div></div></div>
                   10560: <div class="toc">
                   10561: <p><b>Table of Contents</b></p>
                   10562: <dl>
                   10563: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   10564: <dd><dl>
                   10565: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   10566: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   10567: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.116   ! rillig   10568: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75      rillig   10569: </dl></dd>
                   10570: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   10571: </dl>
                   10572: </div>
                   10573: <p>We checked to find a piece of software that wasn't in the packages
                   10574:     collection, and picked GNU bison. Quite why someone would want to have
1.110     hubertf  10575:     <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75      rillig   10576:     present in the tree is beyond us, but it's useful for the purposes of
                   10577:     this exercise.</p>
                   10578: <div class="sect1" lang="en">
                   10579: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10580: <a name="example-files"></a>A.1. files</h2></div></div></div>
                   10581: <div class="sect2" lang="en">
                   10582: <div class="titlepage"><div><div><h3 class="title">
                   10583: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
                   10584: <pre class="programlisting">
1.100     rillig   10585: # $NetBSD$
                   10586: #
1.1       grant    10587: 
1.100     rillig   10588: DISTNAME=       bison-1.25
                   10589: CATEGORIES=     devel
                   10590: MASTER_SITES=   ${MASTER_SITE_GNU}
1.1       grant    10591: 
1.100     rillig   10592: MAINTAINER=     thorpej@NetBSD.org
                   10593: HOMEPAGE=       http://www.gnu.org/software/bison/bison.html
                   10594: COMMENT=        GNU yacc clone
1.1       grant    10595: 
1.100     rillig   10596: GNU_CONFIGURE=  yes
                   10597: INFO_FILES=     bison.info
1.1       grant    10598: 
1.100     rillig   10599: .include "../../mk/bsd.pkg.mk"
1.1       grant    10600: </pre>
1.75      rillig   10601: </div>
                   10602: <div class="sect2" lang="en">
                   10603: <div class="titlepage"><div><div><h3 class="title">
                   10604: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
                   10605: <pre class="programlisting">
1.100     rillig   10606: GNU version of yacc.  Can make re-entrant parsers, and numerous other
1.110     hubertf  10607: improvements.  Why you would want this when Berkeley <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?yacc+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.100     rillig   10608: of the NetBSD source tree is beyond me.
1.1       grant    10609: </pre>
1.75      rillig   10610: </div>
                   10611: <div class="sect2" lang="en">
                   10612: <div class="titlepage"><div><div><h3 class="title">
                   10613: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
                   10614: <pre class="programlisting">
1.100     rillig   10615: @comment $NetBSD$
                   10616: bin/bison
                   10617: man/man1/bison.1.gz
                   10618: share/bison.simple
                   10619: share/bison.hairy
1.1       grant    10620: </pre>
1.75      rillig   10621: </div>
                   10622: <div class="sect2" lang="en">
                   10623: <div class="titlepage"><div><div><h3 class="title">
1.110     hubertf  10624: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.93      rillig   10625: </h3></div></div></div>
1.75      rillig   10626: <p>The NetBSD package system comes with
1.91      rillig   10627:         <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.75      rillig   10628:        which helps to check the contents of these
                   10629:        files. After installation it is quite easy to use, just change to the
                   10630:        directory of the package you wish to examine and execute
1.110     hubertf  10631:        <span class="command"><strong>pkglint</strong></span>:</p>
1.75      rillig   10632: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
                   10633: looks fine.</pre>
                   10634: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.110     hubertf  10635:        more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.75      rillig   10636:        -Wall</strong></span> for a very thorough check.</p>
                   10637: </div>
                   10638: </div>
                   10639: <div class="sect1" lang="en">
                   10640: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10641: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
                   10642: <p>Create the directory where the package lives,
                   10643:       plus any auxiliary directories:</p>
                   10644: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   10645: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   10646: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   10647: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76      rillig   10648: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.110     hubertf  10649:       <code class="filename">PLIST</code> (see <a class="xref" href="#components" title="Chapter 11. Package components - files, directories and contents">Chapter 11, <i>Package components - files, directories and contents</i></a>)
1.75      rillig   10650:       then continue with fetching the distfile:</p>
                   10651: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1       grant    10652: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   10653: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   10654: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10655: ftp: Error retrieving file: 500 Internal error
                   10656: 
                   10657: &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   10658: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10659: ftp: Error retrieving file: 500 Internal error
                   10660: 
                   10661: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   10662: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75      rillig   10663: Successfully retrieved file.</pre>
                   10664: <p>Generate the checksum of the distfile into
1.76      rillig   10665:       <code class="filename">distinfo</code>:</p>
1.88      wiz      10666: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75      rillig   10667: <p>Now compile:</p>
                   10668: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10669: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10670: ===&gt;  Extracting for bison-1.25
                   10671: ===&gt;  Patching for bison-1.25
                   10672: ===&gt;   Ignoring empty patch directory
                   10673: ===&gt;  Configuring for bison-1.25
                   10674: creating cache ./config.cache
                   10675: checking for gcc... cc
                   10676: checking whether we are using GNU C... yes
                   10677: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   10678: checking how to run the C preprocessor... cc -E
                   10679: checking for minix/config.h... no
                   10680: checking for POSIXized ISC... no
                   10681: checking whether cross-compiling... no
                   10682: checking for ANSI C header files... yes
                   10683: checking for string.h... yes
                   10684: checking for stdlib.h... yes
                   10685: checking for memory.h... yes
                   10686: checking for working const... yes
                   10687: checking for working alloca.h... no
                   10688: checking for alloca... yes
                   10689: checking for strerror... yes
                   10690: updating cache ./config.cache
                   10691: creating ./config.status
                   10692: creating Makefile
                   10693: ===&gt;  Building for bison-1.25
                   10694: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g LR0.c
                   10695: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g allocate.c
                   10696: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g closure.c
                   10697: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g conflicts.c
                   10698: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g derives.c
1.68      rillig   10699: cc -c -DXPFILE=\"/usr/pkg/share/bison.simple\"  -DXPFILE1=\"/usr/pkg/share/bison.hairy\" -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1  -g  ./files.c
1.1       grant    10700: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g getargs.c
                   10701: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g gram.c
                   10702: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g lalr.c
                   10703: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g lex.c
                   10704: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g main.c
                   10705: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g nullable.c
                   10706: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g output.c
                   10707: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g print.c
                   10708: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g reader.c
                   10709: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g reduce.c
                   10710: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g symtab.c
                   10711: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g warshall.c
                   10712: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g version.c
                   10713: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g getopt.c
                   10714: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g getopt1.c
                   10715: cc  -g -o bison LR0.o allocate.o closure.o conflicts.o derives.o files.o         getargs.o gram.o lalr.o lex.o                                   main.o nullable.o output.o print.o reader.o reduce.o symtab.o   warshall.o version.o getopt.o getopt1.o
                   10716: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   10717: rm -f bison.s1
1.75      rillig   10718: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   10719: <p>Everything seems OK, so install the files:</p>
                   10720: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10721: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10722: ===&gt;  Installing for bison-1.25
                   10723: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   10724: rm -f /usr/pkg/bin/bison
                   10725: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   10726: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   10727: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   10728: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   10729: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   10730: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   10731: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75      rillig   10732: ===&gt;  Registering installation for bison-1.25</pre>
                   10733: <p>You can now use bison, and also - if you decide so - remove it with
1.110     hubertf  10734:       <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75      rillig   10735:       binary package, do this now:</p>
                   10736: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10737: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10738: ===&gt;  Building package for bison-1.25
                   10739: Creating package bison-1.25.tgz
                   10740: Registering depends:.
1.75      rillig   10741: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   10742: <p>Now that you don't need the source and object files
                   10743:       any more, clean up:</p>
                   10744: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   10745: ===&gt;  Cleaning for bison-1.25</pre>
                   10746: </div>
                   10747: </div>
                   10748: <div class="appendix" lang="en">
                   10749: <div class="titlepage"><div><div><h2 class="title">
                   10750: <a name="logs"></a>Appendix B. Build logs</h2></div></div></div>
                   10751: <div class="toc">
                   10752: <p><b>Table of Contents</b></p>
                   10753: <dl>
                   10754: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                   10755: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                   10756: </dl>
                   10757: </div>
                   10758: <div class="sect1" lang="en">
                   10759: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10760: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
                   10761: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10762: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10763: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   10764: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   10765: =&gt; [172219 bytes]
                   10766: Connected to ftp.plig.net.
                   10767: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   10768: 331 Guest login ok, send your complete e-mail address as password.
                   10769: 230-You are user #5 of 500 simultaneous users allowed.
                   10770: 230-
1.68      rillig   10771: 230-  ___ _             _ _
                   10772: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
1.1       grant    10773: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   10774: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   10775: 230-         |_|   |_|     |___|         |___|
                   10776: 230-
                   10777: 230-** Welcome to ftp.plig.org **
                   10778: 230-
                   10779: 230-Please note that all transfers from this FTP site are logged. If you
                   10780: 230-do not like this, please disconnect now.
                   10781: 230-
                   10782: 230-This arhive is available via
                   10783: 230-
                   10784: 230-HTTP:  http://ftp.plig.org/
                   10785: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   10786: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   10787: 230-
                   10788: 230-Please email comments, bug reports and requests for packages to be
1.68      rillig   10789: 230-mirrored to ftp-admin@plig.org.
1.1       grant    10790: 230-
                   10791: 230-
                   10792: 230 Logged in anonymously.
                   10793: Remote system type is UNIX.
                   10794: Using binary mode to transfer files.
                   10795: 200 Type okay.
                   10796: 250 "/pub" is new cwd.
                   10797: 250-"/pub/figlet" is new cwd.
                   10798: 250-
                   10799: 250-Welcome to the figlet archive at ftp.figlet.org
1.68      rillig   10800: 250-
1.75      rillig   10801: 250-   ftp://ftp.figlet.org/pub/figlet/
1.1       grant    10802: 250-
                   10803: 250-The official FIGlet web page is:
1.75      rillig   10804: 250-   http://www.figlet.org/
1.1       grant    10805: 250-
                   10806: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   10807: 250-contribute a font or something else, you can email us.
1.68      rillig   10808: 250
1.1       grant    10809: 250 "/pub/figlet/program" is new cwd.
                   10810: 250 "/pub/figlet/program/unix" is new cwd.
                   10811: local: figlet221.tar.gz remote: figlet221.tar.gz
                   10812: 502 Unimplemented command.
                   10813: 227 Entering Passive Mode (195,40,6,41,246,104)
                   10814: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   10815: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   10816: 226 Transfer completed.
                   10817: 172219 bytes received in 00:02 (75.99 KB/s)
                   10818: 221 Goodbye.
                   10819: =&gt; Checksum OK for figlet221.tar.gz.
                   10820: ===&gt; Extracting for figlet-2.2.1nb2
                   10821: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   10822: ===&gt; Patching for figlet-2.2.1nb2
                   10823: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   10824: ===&gt; Overriding tools for figlet-2.2.1nb2
                   10825: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   10826: ===&gt; Configuring for figlet-2.2.1nb2
                   10827: ===&gt; Building for figlet-2.2.1nb2
                   10828: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   10829: chmod a+x figlet
                   10830: gcc -O2 -o chkfont chkfont.c
                   10831: =&gt; Unwrapping files-to-be-installed.
1.14      xtraeme  10832: <code class="prompt">#</code>
1.75      rillig   10833: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10834: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10835: ===&gt; Installing for figlet-2.2.1nb2
                   10836: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   10837: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   10838: mkdir -p /usr/pkg/share/figlet
                   10839: cp figlet /usr/pkg/bin
                   10840: cp chkfont /usr/pkg/bin
                   10841: chmod 555 figlist showfigfonts
                   10842: cp figlist /usr/pkg/bin
                   10843: cp showfigfonts /usr/pkg/bin
                   10844: cp fonts/*.flf /usr/pkg/share/figlet
                   10845: cp fonts/*.flc /usr/pkg/share/figlet
                   10846: cp figlet.6 /usr/pkg/man/man6
                   10847: ===&gt; Registering installation for figlet-2.2.1nb2
1.75      rillig   10848: <code class="prompt">#</code></pre>
                   10849: </div>
                   10850: <div class="sect1" lang="en">
                   10851: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10852: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
                   10853: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10854: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10855: ===&gt; Packaging figlet-2.2.1nb2
                   10856: ===&gt; Building binary package for figlet-2.2.1nb2
                   10857: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   10858: Using SrcDir value of /usr/pkg
1.68      rillig   10859: Registering depends:.
1.75      rillig   10860: <code class="prompt">#</code></pre>
                   10861: </div>
                   10862: </div>
                   10863: <div class="appendix" lang="en">
                   10864: <div class="titlepage"><div><div><h2 class="title">
1.76      rillig   10865: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h2></div></div></div>
                   10866: <div class="toc">
                   10867: <p><b>Table of Contents</b></p>
                   10868: <dl>
1.116   ! rillig   10869: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. bootstrap-pkgsrc: Bootstrap kits</a></span></dt>
        !          10870: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. distfiles: The distributed source files</a></span></dt>
        !          10871: <dt><span class="sect1"><a href="#ftp-iso">C.3. iso: Currently empty</a></span></dt>
        !          10872: <dt><span class="sect1"><a href="#ftp-misc">C.4. misc: Miscellaneous things</a></span></dt>
        !          10873: <dt><span class="sect1"><a href="#ftp-packages">C.5. packages: Binary packages</a></span></dt>
        !          10874: <dt><span class="sect1"><a href="#ftp-reports">C.6. reports: Bulk build reports</a></span></dt>
        !          10875: <dt><span class="sect1"><a href="#ftp-source">C.7. current,
        !          10876: pkgsrc-200xQy:
1.76      rillig   10877: source packages</a></span></dt>
                   10878: </dl>
                   10879: </div>
                   10880: <p>As in other big projects, the directory layout of pkgsrc
                   10881:        is quite complex for newbies. This chapter explains where you
                   10882:        find things on the FTP server. The base directory on
1.110     hubertf  10883:        <code class="filename">ftp.NetBSD.org</code> is <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top"><code class="filename">/pub/pkgsrc/</code></a>.
1.89      rillig   10884:        On other servers it may be different, but inside this directory,
                   10885:        everything should look the same, no matter on which server you
                   10886:        are. This directory contains some subdirectories, which are
                   10887:        explained below.</p>
1.76      rillig   10888: <div class="sect1" lang="en">
                   10889: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10890: <a name="ftp-bootstrap"></a>C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</h2></div></div></div>
1.109     rillig   10891: <p>This directory used to contain binary packages of the
                   10892:        package management tools for various platforms. For those
                   10893:        package collections that need them, they are now stored near the
1.110     hubertf  10894:        binary packages, so you should look <a class="link" href="#ftp-packages" title="C.5. packages: Binary packages">in the <code class="filename">packages</code>
1.109     rillig   10895:        directory</a>.</p>
1.76      rillig   10896: </div>
                   10897: <div class="sect1" lang="en">
                   10898: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10899: <a name="ftp-distfiles"></a>C.2. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
                   10900: <p>The directory <code class="filename">distfiles</code> contains lots
                   10901:        of archive files from all pkgsrc packages, which are mirrored
                   10902:        here. The subdirectories are called after their package names
                   10903:        and are used when the distributed files have names that don't
                   10904:        explicitly contain a version number or are otherwise too generic
                   10905:        (for example <code class="filename">release.tar.gz</code>).</p>
                   10906: </div>
                   10907: <div class="sect1" lang="en">
                   10908: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10909: <a name="ftp-iso"></a>C.3. <code class="filename">iso</code>: Currently empty</h2></div></div></div>
                   10910: <p>This directory is currently not in use.</p>
                   10911: </div>
                   10912: <div class="sect1" lang="en">
                   10913: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10914: <a name="ftp-misc"></a>C.4. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
                   10915: <p>This directory contains things that individual pkgsrc
                   10916:        developers find worth publishing.</p>
                   10917: </div>
                   10918: <div class="sect1" lang="en">
                   10919: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.102     rillig   10920: <a name="ftp-packages"></a>C.5. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
                   10921: <p>This directory contains binary packages for the various
                   10922:        platforms that are supported by pkgsrc.
                   10923:        Each subdirectory is of the form <em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>OSVERSION_TAG</code></em>. The meaning of these variables is:</p>
                   10924: <div class="itemizedlist"><ul type="disc">
1.108     rillig   10925: <li><p><code class="varname">OPSYS</code> is the name of the
1.109     rillig   10926:        operating system for which the packages have been built. The
1.110     hubertf  10927:        name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.109     rillig   10928:        command, so it may differ from the one you are used to
                   10929:        hear.</p></li>
1.108     rillig   10930: <li><p><code class="varname">ARCH</code> is the hardware
                   10931:        architecture of the platform for which the packages have been
1.110     hubertf  10932:        built. It also includes the <code class="varname">ABI</code> (Application
                   10933:        Binary Interface) for platforms that have several of
                   10934:        them.</p></li>
1.108     rillig   10935: <li><p><code class="varname">OSVERSION</code> is the version of
                   10936:        the operating system. For version numbers that change often (for
                   10937:        example NetBSD-current), the often-changing part should be
                   10938:        replaced with an <code class="literal">x</code>, for example
                   10939:        <code class="literal">4.99.x</code>.</p></li>
                   10940: <li><p><code class="varname">TAG</code> is either
                   10941:        <code class="literal">200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   10942:        for a stable branch, or <code class="literal">head</code> for packages
                   10943:        built from the HEAD branch. The latter should only be used when
                   10944:        the packages are updated on a regular basis. Otherwise the date
                   10945:        from checking out pkgsrc should be appended, for example
                   10946:        <code class="literal">head_20071015</code>.</p></li>
1.102     rillig   10947: </ul></div>
                   10948: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
                   10949:        can quickly click through the directories on the
                   10950:        server and find the best binary packages for their machines. Since they
                   10951:        usually know the operating system and the hardware architecture, OPSYS
                   10952:        and ARCH are placed first. After these choices, they can select the
                   10953:        best combination of OSVERSION and TAG together, since it is usually the
                   10954:        case that packages stay compatible between different version of the
                   10955:        operating system.</p>
                   10956: <p>In each of these directories, there is a
                   10957:        whole binary packages collection for a specific platform. It has a directory called
1.76      rillig   10958:        <code class="filename">All</code> which contains all binary packages.
                   10959:        Besides that, there are various category directories that
                   10960:        contain symbolic links to the real binary packages.</p>
                   10961: </div>
                   10962: <div class="sect1" lang="en">
                   10963: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108     rillig   10964: <a name="ftp-reports"></a>C.6. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
                   10965: <p>Here are the reports from bulk builds, for those who want
                   10966:        to fix packages that didn't build on some of the platforms. The
1.116   ! rillig   10967:        structure of subdirectories should look like the one in <a class="xref" href="#ftp-packages" title="C.5. packages: Binary packages">Section C.5, &#8220;packages: Binary packages&#8221;</a>.</p>
1.108     rillig   10968: </div>
                   10969: <div class="sect1" lang="en">
                   10970: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10971: <a name="ftp-source"></a>C.7. <code class="filename">current</code>,
1.93      rillig   10972: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   10973: source packages</h2></div></div></div>
                   10974: <p>These directories contain the &#8220;<span class="quote">real</span>&#8221; pkgsrc,
                   10975:        that is the files that define how to create binary packages from
                   10976:        source archives.</p>
                   10977: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89      rillig   10978:        snapshot of the CVS repository, which is updated regularly. The
                   10979:        file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
                   10980:        directory, ready to be downloaded as a whole.</p>
1.76      rillig   10981: <p>In the directories for the quarterly branches, there is an
                   10982:        additional file called
                   10983:        <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
                   10984:        which contains the state of pkgsrc when it was branched.</p>
                   10985: </div>
1.75      rillig   10986: </div>
                   10987: <div class="appendix" lang="en">
                   10988: <div class="titlepage"><div><div><h2 class="title">
                   10989: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h2></div></div></div>
                   10990: <div class="toc">
                   10991: <p><b>Table of Contents</b></p>
                   10992: <dl>
1.79      rillig   10993: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75      rillig   10994: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                   10995: </dl>
                   10996: </div>
1.79      rillig   10997: <p>This section contains information on editing the pkgsrc
                   10998:        guide itself.</p>
1.75      rillig   10999: <div class="sect1" lang="en">
                   11000: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79      rillig   11001: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
                   11002: <p>The pkgsrc guide's source code is stored in
                   11003:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   11004:        are created from it:</p>
                   11005: <div class="itemizedlist"><ul type="disc">
                   11006: <li><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   11007: <li><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.110     hubertf  11008: <li><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/" target="_top">http://www.NetBSD.org/docs/pkgsrc/</a></p></li>
                   11009: <li><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf</a>:
1.79      rillig   11010:        The PDF version of the pkgsrc guide.</p></li>
1.110     hubertf  11011: <li><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps</a>:
1.79      rillig   11012:        PostScript version of the pkgsrc guide.</p></li>
1.75      rillig   11013: </ul></div>
                   11014: </div>
                   11015: <div class="sect1" lang="en">
                   11016: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11017: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79      rillig   11018: <p>The procedure to edit the pkgsrc guide is:</p>
                   11019: <div class="procedure"><ol type="1">
                   11020: <li><p>Make sure you have the packages needed to
1.83      wiz      11021:        regenerate the pkgsrc guide (and other XML-based NetBSD
1.91      rillig   11022:        documentation) installed. These are <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/netbsd-doc/README.html" target="_top"><code class="filename">meta-pkgs/netbsd-doc</code></a> for creating the
                   11023:        ASCII and HTML versions, and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/netbsd-doc-print/README.html" target="_top"><code class="filename">meta-pkgs/netbsd-doc-print</code></a> for the
1.79      rillig   11024:        PostScript and PDF versions. You will need both packages
                   11025:        installed, to make sure documentation is consistent across all
                   11026:        formats.</p></li>
1.110     hubertf  11027: <li><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79      rillig   11028:        right directory. All further steps will take place
                   11029:        here.</p></li>
                   11030: <li><p>Edit the XML file(s) in
                   11031:        <code class="filename">files/</code>.</p></li>
1.110     hubertf  11032: <li><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79      rillig   11033:        guide for valid XML and to build the final output files. If you
                   11034:        get any errors at this stage, you can just edit the files, as
                   11035:        there are only symbolic links in the working directory, pointing
                   11036:        to the files in <code class="filename">files/</code>.</p></li>
1.110     hubertf  11037: <li><p><span class="command"><strong>(cd files &amp;&amp; cvs
1.79      rillig   11038:        commit)</strong></span></p></li>
1.110     hubertf  11039: <li><p>Run <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span> to
1.79      rillig   11040:        regenerate the output files with the proper RCS
                   11041:        Ids.</p></li>
1.91      rillig   11042: <li>
1.110     hubertf  11043: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91      rillig   11044:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                   11045:        <code class="filename">htdocs</code>.</p>
                   11046: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   11047: <h3 class="title">Note</h3>
                   11048: <p>If you have added, removed or renamed some chapters,
1.110     hubertf  11049:        you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
                   11050:        <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91      rillig   11051:        directory.</p>
                   11052: </div>
                   11053: </li>
1.79      rillig   11054: </ol></div>
1.75      rillig   11055: </div>
                   11056: </div>
                   11057: </div></body>
1.1       grant    11058: </html>

CVSweb <webmaster@jp.NetBSD.org>