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

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>
                      6: <link rel="stylesheet" href="/NetBSD.css" type="text/css">
                      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>
                     21: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>&gt;</code></p></div></div>
                     22: </div>
                     23: <div class="author">
                     24: <h3 class="author">
                     25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
                     26: </h3>
                     27: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>&gt;</code></p></div></div>
                     28: </div>
                     29: <h3 class="corpauthor">
                     30:         The pkgsrc Developers
                     31:       </h3>
                     32: </div></div>
                     33: <div><p class="copyright">Copyright © 1994-2006 The NetBSD Foundation, Inc</p></div>
1.92      rillig     34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.24 2006/11/11 05:39:09 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.78      rillig    116: <dt><span class="sect1"><a href="#conf.compiler">5.3. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       117: <dd><dl>
1.89      rillig    118: <dt><span class="sect2"><a href="#selecting-the-compiler">5.3.1. Selecting the compiler</a></span></dt>
                    119: <dt><span class="sect2"><a href="#conf.cflags">5.3.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    120: <dt><span class="sect2"><a href="#conf.ldflags">5.3.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz       121: </dl></dd>
1.78      rillig    122: <dt><span class="sect1"><a href="#developer-advanced-settings">5.4. Developer/advanced settings</a></span></dt>
                    123: <dt><span class="sect1"><a href="#selecting-build-options">5.5. Selecting Build Options</a></span></dt>
1.75      rillig    124: </dl></dd>
                    125: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    126: <dd><dl>
                    127: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    128: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
                    129: <dt><span class="sect1"><a href="#bulkbuild">6.3. Doing a bulk build of all packages</a></span></dt>
                    130: <dd><dl>
                    131: <dt><span class="sect2"><a href="#binary.configuration">6.3.1. Configuration</a></span></dt>
                    132: <dt><span class="sect2"><a href="#other-environmental-considerations">6.3.2. Other environmental considerations</a></span></dt>
                    133: <dt><span class="sect2"><a href="#operation">6.3.3. Operation</a></span></dt>
                    134: <dt><span class="sect2"><a href="#what-it-does">6.3.4. What it does</a></span></dt>
                    135: <dt><span class="sect2"><a href="#disk-space-requirements">6.3.5. Disk space requirements</a></span></dt>
                    136: <dt><span class="sect2"><a href="#setting-up-a-sandbox">6.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                    137: <dt><span class="sect2"><a href="#building-a-partial-set">6.3.7. Building a partial set of packages</a></span></dt>
                    138: <dt><span class="sect2"><a href="#bulk-upload">6.3.8. Uploading results of a bulk build</a></span></dt>
                    139: </dl></dd>
                    140: <dt><span class="sect1"><a href="#creating-cdroms">6.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                    141: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">6.4.1. Example of cdpack</a></span></dt></dl></dd>
                    142: </dl></dd>
1.90      rillig    143: <dt><span class="chapter"><a href="#files">7. Directory layout of the installed files</a></span></dt>
1.75      rillig    144: <dd><dl>
1.91      rillig    145: <dt><span class="sect1"><a href="#files.localbase">7.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
1.90      rillig    146: <dt><span class="sect1"><a href="#files.varbase">7.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
                    147: </dl></dd>
                    148: <dt><span class="chapter"><a href="#faq">8. Frequently Asked Questions</a></span></dt>
                    149: <dd><dl>
                    150: <dt><span class="sect1"><a href="#mailing-list-pointers">8.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    151: <dt><span class="sect1"><a href="#pkgviews-docs">8.2. Where's the pkgviews documentation?</a></span></dt>
                    152: <dt><span class="sect1"><a href="#faq-pkgtools">8.3. Utilities for package management (pkgtools)</a></span></dt>
                    153: <dt><span class="sect1"><a href="#non-root-pkgsrc">8.4. How to use pkgsrc as non-root</a></span></dt>
                    154: <dt><span class="sect1"><a href="#resume-transfers">8.5. How to resume transfers when fetching distfiles?</a></span></dt>
                    155: <dt><span class="sect1"><a href="#XFree86-from-pkgsrc">8.6. How can I install/use XFree86 from pkgsrc?</a></span></dt>
                    156: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">8.7. How can I install/use X.org from pkgsrc?</a></span></dt>
                    157: <dt><span class="sect1"><a href="#fetch-behind-firewall">8.8. How to fetch files from behind a firewall</a></span></dt>
                    158: <dt><span class="sect1"><a href="#passive-ftp">8.9. How do I tell <span><strong class="command">make fetch</strong></span> to do passive FTP?</a></span></dt>
                    159: <dt><span class="sect1"><a href="#fetching-all-distfiles">8.10. How to fetch all distfiles at once</a></span></dt>
                    160: <dt><span class="sect1"><a href="#tmac.andoc-missing">8.11. What does &#8220;<span class="quote">Don't know how to make
1.75      rillig    161: /usr/share/tmac/tmac.andoc</span>&#8221; mean?</a></span></dt>
1.90      rillig    162: <dt><span class="sect1"><a href="#bsd.own.mk-missing">8.12. What does &#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221; mean?</a></span></dt>
                    163: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">8.13. Using 'sudo' with pkgsrc</a></span></dt>
                    164: <dt><span class="sect1"><a href="#faq.conf">8.14. How do I change the location of configuration files?</a></span></dt>
                    165: <dt><span class="sect1"><a href="#audit-packages">8.15. Automated security checks</a></span></dt>
                    166: <dt><span class="sect1"><a href="#ufaq-cflags">8.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    167: <dt><span class="sect1"><a href="#ufaq-fail">8.17. A package does not build.  What shall I do?</a></span></dt>
                    168: <dt><span class="sect1"><a href="#faq.rcs-conflicts">8.18. What does &#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221; mean?</a></span></dt>
1.75      rillig    169: </dl></dd>
                    170: </dl></dd>
                    171: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
                    172: <dd><dl>
1.90      rillig    173: <dt><span class="chapter"><a href="#creating">9. Creating a new pkgsrc package from scratch</a></span></dt>
1.91      rillig    174: <dd><dl>
                    175: <dt><span class="sect1"><a href="#creating.common">9.1. Common types of packages</a></span></dt>
                    176: <dd><dl>
                    177: <dt><span class="sect2"><a href="#creating.perl-module">9.1.1. Perl modules</a></span></dt>
                    178: <dt><span class="sect2"><a href="#creating.kde-app">9.1.2. KDE applications</a></span></dt>
                    179: </dl></dd>
                    180: <dt><span class="sect1"><a href="#creating.examples">9.2. Examples</a></span></dt>
                    181: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">9.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
                    182: </dl></dd>
1.90      rillig    183: <dt><span class="chapter"><a href="#components">10. Package components - files, directories and contents</a></span></dt>
1.75      rillig    184: <dd><dl>
1.90      rillig    185: <dt><span class="sect1"><a href="#components.Makefile">10.1. <code class="filename">Makefile</code></a></span></dt>
                    186: <dt><span class="sect1"><a href="#components.distinfo">10.2. <code class="filename">distinfo</code></a></span></dt>
                    187: <dt><span class="sect1"><a href="#components.patches">10.3. patches/*</a></span></dt>
                    188: <dd><dl>
1.93      rillig    189: <dt><span class="sect2"><a href="#components.patch.structure">10.3.1. Structure of a single patch file</a></span></dt>
                    190: <dt><span class="sect2"><a href="#components.patches.caveats">10.3.2. Creating patch files</a></span></dt>
                    191: <dt><span class="sect2"><a href="#components.patches.sources">10.3.3. Sources where the patch files come from</a></span></dt>
                    192: <dt><span class="sect2"><a href="#components.patches.guidelines">10.3.4. Patching guidelines</a></span></dt>
                    193: <dt><span class="sect2"><a href="#components.patches.feedback">10.3.5. Feedback to the author</a></span></dt>
1.90      rillig    194: </dl></dd>
                    195: <dt><span class="sect1"><a href="#other-mandatory-files">10.4. Other mandatory files</a></span></dt>
                    196: <dt><span class="sect1"><a href="#components.optional">10.5. Optional files</a></span></dt>
                    197: <dd><dl>
                    198: <dt><span class="sect2"><a href="#components.optional.bin">10.5.1. Files affecting the binary package</a></span></dt>
                    199: <dt><span class="sect2"><a href="#components.optional.build">10.5.2. Files affecting the build process</a></span></dt>
                    200: <dt><span class="sect2"><a href="#components.optional.none">10.5.3. Files affecting nothing at all</a></span></dt>
                    201: </dl></dd>
                    202: <dt><span class="sect1"><a href="#work-dir">10.6. <code class="filename">work*</code></a></span></dt>
                    203: <dt><span class="sect1"><a href="#files-dir">10.7. <code class="filename">files/*</code></a></span></dt>
                    204: </dl></dd>
                    205: <dt><span class="chapter"><a href="#makefile">11. Programming in <code class="filename">Makefile</code>s</a></span></dt>
                    206: <dd><dl>
1.97    ! rillig    207: <dt><span class="sect1"><a href="#makefile.style">11.1. Caveats</a></span></dt>
        !           208: <dt><span class="sect1"><a href="#makefile.variables">11.2. <code class="filename">Makefile</code> variables</a></span></dt>
        !           209: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">11.2.1. Naming conventions</a></span></dt></dl></dd>
        !           210: <dt><span class="sect1"><a href="#makefile.code">11.3. Code snippets</a></span></dt>
        !           211: <dd><dl>
        !           212: <dt><span class="sect2"><a href="#adding-to-list">11.3.1. Adding things to a list</a></span></dt>
        !           213: <dt><span class="sect2"><a href="#converting-internal-to-external">11.3.2. Converting an internal list into an external list</a></span></dt>
        !           214: <dt><span class="sect2"><a href="#passing-variable-to-shell">11.3.3. Passing variables to a shell command</a></span></dt>
        !           215: <dt><span class="sect2"><a href="#quoting-guideline">11.3.4. Quoting guideline</a></span></dt>
        !           216: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">11.3.5. Workaround for a bug in BSD Make</a></span></dt>
1.90      rillig    217: </dl></dd>
                    218: </dl></dd>
                    219: <dt><span class="chapter"><a href="#plist">12. PLIST issues</a></span></dt>
                    220: <dd><dl>
                    221: <dt><span class="sect1"><a href="#rcs-id">12.1. RCS ID</a></span></dt>
                    222: <dt><span class="sect1"><a href="#automatic-plist-generation">12.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                    223: <dt><span class="sect1"><a href="#print-PLIST">12.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span></a></span></dt>
                    224: <dt><span class="sect1"><a href="#plist.misc">12.4. Variable substitution in PLIST</a></span></dt>
                    225: <dt><span class="sect1"><a href="#manpage-compression">12.5. Man page compression</a></span></dt>
                    226: <dt><span class="sect1"><a href="#using-PLIST_SRC">12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                    227: <dt><span class="sect1"><a href="#platform-specific-plist">12.7. Platform-specific and differing PLISTs</a></span></dt>
                    228: <dt><span class="sect1"><a href="#faq.common-dirs">12.8. Sharing directories between packages</a></span></dt>
                    229: </dl></dd>
                    230: <dt><span class="chapter"><a href="#buildlink">13. Buildlink methodology</a></span></dt>
                    231: <dd><dl>
                    232: <dt><span class="sect1"><a href="#converting-to-buildlink3">13.1. Converting packages to use buildlink3</a></span></dt>
                    233: <dt><span class="sect1"><a href="#creating-buildlink3.mk">13.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
                    234: <dd><dl>
                    235: <dt><span class="sect2"><a href="#anatomy-of-bl3">13.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                    236: <dt><span class="sect2"><a href="#updating-buildlink-depends">13.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</a></span></dt>
                    237: </dl></dd>
                    238: <dt><span class="sect1"><a href="#writing-builtin.mk">13.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
                    239: <dd><dl>
                    240: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">13.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
                    241: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">13.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                    242: </dl></dd>
                    243: </dl></dd>
                    244: <dt><span class="chapter"><a href="#pkginstall">14. The pkginstall framework</a></span></dt>
                    245: <dd><dl>
                    246: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">14.1. Files and directories outside the installation prefix</a></span></dt>
                    247: <dd><dl>
                    248: <dt><span class="sect2"><a href="#dirs-outside-prefix">14.1.1. Directory manipulation</a></span></dt>
                    249: <dt><span class="sect2"><a href="#files-outside-prefix">14.1.2. File manipulation</a></span></dt>
                    250: </dl></dd>
                    251: <dt><span class="sect1"><a href="#conf-files">14.2. Configuration files</a></span></dt>
                    252: <dd><dl>
                    253: <dt><span class="sect2"><a href="#conf-files-sysconfdir">14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                    254: <dt><span class="sect2"><a href="#conf-files-configure">14.2.2. Telling the software where configuration files are</a></span></dt>
                    255: <dt><span class="sect2"><a href="#conf-files-patching">14.2.3. Patching installations</a></span></dt>
                    256: <dt><span class="sect2"><a href="#conf-files-disable">14.2.4. Disabling handling of configuration files</a></span></dt>
                    257: </dl></dd>
                    258: <dt><span class="sect1"><a href="#rcd-scripts">14.3. System startup scripts</a></span></dt>
                    259: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">14.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
                    260: <dt><span class="sect1"><a href="#users-and-groups">14.4. System users and groups</a></span></dt>
                    261: <dt><span class="sect1"><a href="#shells">14.5. System shells</a></span></dt>
                    262: <dd><dl><dt><span class="sect2"><a href="#shells-disable">14.5.1. Disabling shell registration</a></span></dt></dl></dd>
                    263: <dt><span class="sect1"><a href="#fonts">14.6. Fonts</a></span></dt>
                    264: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">14.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
                    265: </dl></dd>
                    266: <dt><span class="chapter"><a href="#options">15. Options handling</a></span></dt>
                    267: <dd><dl>
                    268: <dt><span class="sect1"><a href="#global-default-options">15.1. Global default options</a></span></dt>
                    269: <dt><span class="sect1"><a href="#converting-to-options">15.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
                    270: <dt><span class="sect1"><a href="#option-names">15.3. Option Names</a></span></dt>
                    271: </dl></dd>
                    272: <dt><span class="chapter"><a href="#build">16. The build process</a></span></dt>
                    273: <dd><dl>
                    274: <dt><span class="sect1"><a href="#build.intro">16.1. Introduction</a></span></dt>
                    275: <dt><span class="sect1"><a href="#build.prefix">16.2. Program location</a></span></dt>
                    276: <dt><span class="sect1"><a href="#build.builddirs">16.3. Directories used during the build process</a></span></dt>
                    277: <dt><span class="sect1"><a href="#build.running">16.4. Running a phase</a></span></dt>
                    278: <dt><span class="sect1"><a href="#build.fetch">16.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                    279: <dd><dl>
                    280: <dt><span class="sect2"><a href="#build.fetch.what">16.5.1. What to fetch and where to get it from</a></span></dt>
                    281: <dt><span class="sect2"><a href="#build.fetch.how">16.5.2. How are the files fetched?</a></span></dt>
                    282: </dl></dd>
                    283: <dt><span class="sect1"><a href="#build.checksum">16.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                    284: <dt><span class="sect1"><a href="#build.extract">16.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                    285: <dt><span class="sect1"><a href="#build.patch">16.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                    286: <dt><span class="sect1"><a href="#build.tools">16.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                    287: <dt><span class="sect1"><a href="#build.wrapper">16.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                    288: <dt><span class="sect1"><a href="#build.configure">16.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    289: <dt><span class="sect1"><a href="#build.build">16.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    290: <dt><span class="sect1"><a href="#build.test">16.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                    291: <dt><span class="sect1"><a href="#build.install">16.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    292: <dt><span class="sect1"><a href="#build.package">16.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                    293: <dt><span class="sect1"><a href="#build.clean">16.16. Cleaning up</a></span></dt>
                    294: <dt><span class="sect1"><a href="#build.helpful-targets">16.17. Other helpful targets</a></span></dt>
                    295: </dl></dd>
                    296: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
                    297: <dd><dl>
                    298: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                    299: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                    300: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.97    ! rillig    301: <dt><span class="sect1"><a href="#tools.questions">17.4. Questions regarding the tools</a></span></dt>
1.90      rillig    302: </dl></dd>
                    303: <dt><span class="chapter"><a href="#fixes">18. Making your package work</a></span></dt>
                    304: <dd><dl>
                    305: <dt><span class="sect1"><a href="#general-operation">18.1. General operation</a></span></dt>
                    306: <dd><dl>
                    307: <dt><span class="sect2"><a href="#portability-of-packages">18.1.1. Portability of packages</a></span></dt>
                    308: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">18.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
                    309: <dt><span class="sect2"><a href="#user-interaction">18.1.3. User interaction</a></span></dt>
                    310: <dt><span class="sect2"><a href="#handling-licenses">18.1.4. Handling licenses</a></span></dt>
                    311: <dt><span class="sect2"><a href="#restricted-packages">18.1.5. Restricted packages</a></span></dt>
                    312: <dt><span class="sect2"><a href="#dependencies">18.1.6. Handling dependencies</a></span></dt>
                    313: <dt><span class="sect2"><a href="#conflicts">18.1.7. Handling conflicts with other packages</a></span></dt>
                    314: <dt><span class="sect2"><a href="#not-building-packages">18.1.8. Packages that cannot or should not be built</a></span></dt>
                    315: <dt><span class="sect2"><a href="#undeletable-packages">18.1.9. Packages which should not be deleted, once installed</a></span></dt>
                    316: <dt><span class="sect2"><a href="#security-handling">18.1.10. Handling packages with security problems</a></span></dt>
                    317: <dt><span class="sect2"><a href="#bumping-pkgrevision">18.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                    318: <dt><span class="sect2"><a href="#fixes.subst">18.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                    319: </dl></dd>
                    320: <dt><span class="sect1"><a href="#fixes.fetch">18.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                    321: <dd><dl>
                    322: <dt><span class="sect2"><a href="#no-plain-download">18.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                    323: <dt><span class="sect2"><a href="#modified-distfiles-same-name">18.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
                    324: </dl></dd>
                    325: <dt><span class="sect1"><a href="#fixes.configure">18.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    326: <dd><dl>
                    327: <dt><span class="sect2"><a href="#fixes.libtool">18.3.1. Shared libraries - libtool</a></span></dt>
                    328: <dt><span class="sect2"><a href="#using-libtool">18.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                    329: <dt><span class="sect2"><a href="#autoconf-automake">18.3.3. GNU Autoconf/Automake</a></span></dt>
                    330: </dl></dd>
                    331: <dt><span class="sect1"><a href="#programming-languages">18.4. Programming languages</a></span></dt>
                    332: <dd><dl>
                    333: <dt><span class="sect2"><a href="#basic-programming-languages">18.4.1. C, C++, and Fortran</a></span></dt>
                    334: <dt><span class="sect2"><a href="#java-programming-language">18.4.2. Java</a></span></dt>
                    335: <dt><span class="sect2"><a href="#perl-scripts">18.4.3. Packages containing perl scripts</a></span></dt>
                    336: <dt><span class="sect2"><a href="#other-programming-languages">18.4.4. Other programming languages</a></span></dt>
                    337: </dl></dd>
                    338: <dt><span class="sect1"><a href="#fixes.build">18.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    339: <dd><dl>
                    340: <dt><span class="sect2"><a href="#fixes.build.cpp">18.5.1. Compiling C and C++ code conditionally</a></span></dt>
                    341: <dt><span class="sect2"><a href="#compiler-bugs">18.5.2. How to handle compiler bugs</a></span></dt>
                    342: <dt><span class="sect2"><a href="#undefined-reference">18.5.3. Undefined reference to &#8220;<span class="quote">...</span>&#8221;</a></span></dt>
                    343: <dt><span class="sect2"><a href="#out-of-memory">18.5.4. Running out of memory</a></span></dt>
                    344: </dl></dd>
                    345: <dt><span class="sect1"><a href="#fixes.install">18.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    346: <dd><dl>
                    347: <dt><span class="sect2"><a href="#install-scripts">18.6.1. Creating needed directories</a></span></dt>
                    348: <dt><span class="sect2"><a href="#where-to-install-documentation">18.6.2. Where to install documentation</a></span></dt>
                    349: <dt><span class="sect2"><a href="#installing-score-files">18.6.3. Installing score files</a></span></dt>
                    350: <dt><span class="sect2"><a href="#hardcoded-paths">18.6.4. Packages with hardcoded paths to other interpreters</a></span></dt>
                    351: <dt><span class="sect2"><a href="#perl-modules">18.6.5. Packages installing perl modules</a></span></dt>
                    352: <dt><span class="sect2"><a href="#faq.info-files">18.6.6. Packages installing info files</a></span></dt>
                    353: <dt><span class="sect2"><a href="#manpages">18.6.7. Packages installing man pages</a></span></dt>
                    354: <dt><span class="sect2"><a href="#gconf2-data-files">18.6.8. Packages installing GConf2 data files</a></span></dt>
                    355: <dt><span class="sect2"><a href="#scrollkeeper-data-files">18.6.9. Packages installing scrollkeeper data files</a></span></dt>
                    356: <dt><span class="sect2"><a href="#x11-fonts">18.6.10. Packages installing X11 fonts</a></span></dt>
                    357: <dt><span class="sect2"><a href="#gtk2-modules">18.6.11. Packages installing GTK2 modules</a></span></dt>
                    358: <dt><span class="sect2"><a href="#sgml-xml-data">18.6.12. Packages installing SGML or XML data</a></span></dt>
                    359: <dt><span class="sect2"><a href="#mime-database">18.6.13. Packages installing extensions to the MIME database</a></span></dt>
                    360: <dt><span class="sect2"><a href="#intltool">18.6.14. Packages using intltool</a></span></dt>
                    361: <dt><span class="sect2"><a href="#startup-scripts">18.6.15. Packages installing startup scripts</a></span></dt>
                    362: <dt><span class="sect2"><a href="#tex-packages">18.6.16. Packages installing TeX modules</a></span></dt>
                    363: <dt><span class="sect2"><a href="#emulation-packages">18.6.17. Packages supporting running binaries in
1.87      wiz       364:     emulation</a></span></dt>
1.90      rillig    365: <dt><span class="sect2"><a href="#hicolor-theme">18.6.18. Packages installing hicolor theme icons</a></span></dt>
                    366: <dt><span class="sect2"><a href="#desktop-files">18.6.19. Packages installing desktop files</a></span></dt>
1.77      rillig    367: </dl></dd>
1.90      rillig    368: <dt><span class="sect1"><a href="#punting">18.7. Marking packages as having problems</a></span></dt>
1.77      rillig    369: </dl></dd>
1.90      rillig    370: <dt><span class="chapter"><a href="#debug">19. Debugging</a></span></dt>
                    371: <dt><span class="chapter"><a href="#submit">20. Submitting and Committing</a></span></dt>
1.77      rillig    372: <dd><dl>
1.90      rillig    373: <dt><span class="sect1"><a href="#submitting-binary-packages">20.1. Submitting binary packages</a></span></dt>
                    374: <dt><span class="sect1"><a href="#submitting-your-package">20.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                    375: <dt><span class="sect1"><a href="#general-notes-for-changes">20.3. General notes when adding, updating, or removing packages</a></span></dt>
                    376: <dt><span class="sect1"><a href="#committing-importing">20.4. Committing: Importing a package into CVS</a></span></dt>
                    377: <dt><span class="sect1"><a href="#updating-package">20.5. Updating a package to a newer version</a></span></dt>
                    378: <dt><span class="sect1"><a href="#moving-package">20.6. Moving a package in pkgsrc</a></span></dt>
                    379: </dl></dd>
                    380: <dt><span class="chapter"><a href="#devfaq">21. Frequently Asked Questions</a></span></dt>
                    381: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
                    382: <dd><dl>
                    383: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                    384: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                    385: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                    386: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
1.85      jmmv      387: </dl></dd>
1.75      rillig    388: </dl></dd>
                    389: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
                    390: <dd><dl>
1.90      rillig    391: <dt><span class="chapter"><a href="#infr.design">23. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig    392: <dd><dl>
1.90      rillig    393: <dt><span class="sect1"><a href="#infr.vardef">23.1. The meaning of variable definitions</a></span></dt>
                    394: <dt><span class="sect1"><a href="#infr.vardef.problems">23.2. Avoiding problems before they arise</a></span></dt>
                    395: <dt><span class="sect1"><a href="#infr.var">23.3. Variable evaluation</a></span></dt>
1.81      rillig    396: <dd><dl>
1.90      rillig    397: <dt><span class="sect2"><a href="#infr.var.load">23.3.1. At load time</a></span></dt>
                    398: <dt><span class="sect2"><a href="#infr.var.run">23.3.2. At runtime</a></span></dt>
1.81      rillig    399: </dl></dd>
1.90      rillig    400: <dt><span class="sect1"><a href="#infr.varspec">23.4. How can variables be specified?</a></span></dt>
                    401: <dt><span class="sect1"><a href="#infr.design.intf">23.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig    402: <dd><dl>
1.90      rillig    403: <dt><span class="sect2"><a href="#infr.design.intf.proc">23.5.1. Procedures with parameters</a></span></dt>
                    404: <dt><span class="sect2"><a href="#infr.design.intf.action">23.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75      rillig    405: </dl></dd>
1.90      rillig    406: <dt><span class="sect1"><a href="#infr.order">23.6. The order in which files are loaded</a></span></dt>
1.75      rillig    407: <dd><dl>
1.90      rillig    408: <dt><span class="sect2"><a href="#infr.order.prefs">23.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
                    409: <dt><span class="sect2"><a href="#infr.order.pkg">23.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75      rillig    410: </dl></dd>
                    411: </dl></dd>
1.90      rillig    412: <dt><span class="chapter"><a href="#regression">24. Regression tests</a></span></dt>
1.75      rillig    413: <dd><dl>
1.90      rillig    414: <dt><span class="sect1"><a href="#regression.descr">24.1. The regression tests framework</a></span></dt>
                    415: <dt><span class="sect1"><a href="#regression.run">24.2. Running the regression tests</a></span></dt>
                    416: <dt><span class="sect1"><a href="#regression.new">24.3. Adding a new regression test</a></span></dt>
1.75      rillig    417: <dd><dl>
1.90      rillig    418: <dt><span class="sect2"><a href="#regression.fun.override">24.3.1. Overridable functions</a></span></dt>
                    419: <dt><span class="sect2"><a href="#regression.fun.helper">24.3.2. Helper functions</a></span></dt>
1.75      rillig    420: </dl></dd>
                    421: </dl></dd>
1.90      rillig    422: <dt><span class="chapter"><a href="#porting">25. Porting pkgsrc</a></span></dt>
1.75      rillig    423: <dd><dl>
1.90      rillig    424: <dt><span class="sect1"><a href="#porting.opsys">25.1. Porting pkgsrc to a new operating system</a></span></dt>
                    425: <dt><span class="sect1"><a href="#porting.compiler">25.2. Adding support for a new compiler</a></span></dt>
1.75      rillig    426: </dl></dd>
                    427: </dl></dd>
                    428: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
                    429: <dd><dl>
                    430: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                    431: <dd><dl>
                    432: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                    433: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                    434: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
                    435: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span><strong class="command">pkglint</strong></span></a></span></dt>
                    436: </dl></dd>
                    437: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                    438: </dl></dd>
                    439: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
                    440: <dd><dl>
                    441: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                    442: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                    443: </dl></dd>
1.76      rillig    444: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
                    445: <dd><dl>
                    446: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</a></span></dt>
                    447: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                    448: <dt><span class="sect1"><a href="#ftp-iso">C.3. <code class="filename">iso</code>: Currently empty</a></span></dt>
                    449: <dt><span class="sect1"><a href="#ftp-misc">C.4. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                    450: <dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages*</code>: Binary packages</a></span></dt>
                    451: <dt><span class="sect1"><a href="#ftp-source">C.6. <code class="filename">current</code>,
1.93      rillig    452: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig    453: source packages</a></span></dt>
                    454: </dl></dd>
1.75      rillig    455: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
                    456: <dd><dl>
1.79      rillig    457: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75      rillig    458: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                    459: </dl></dd>
                    460: </dl>
                    461: </div>
1.82      rillig    462: <div class="list-of-tables">
                    463: <p><b>List of Tables</b></p>
                    464: <dl>
                    465: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
                    466: </dt>
                    467: <dt>3.1. <a href="#binary-kits">Binary kits and available packages</a>
                    468: </dt>
1.90      rillig    469: <dt>10.1. <a href="#patch-examples">Patching examples</a>
1.85      jmmv      470: </dt>
1.90      rillig    471: <dt>22.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85      jmmv      472: </dt>
1.82      rillig    473: </dl>
                    474: </div>
1.75      rillig    475: <div class="chapter" lang="en">
                    476: <div class="titlepage"><div><div><h2 class="title">
                    477: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h2></div></div></div>
                    478: <div class="toc">
                    479: <p><b>Table of Contents</b></p>
                    480: <dl>
                    481: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig    482: <dd><dl>
                    483: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                    484: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                    485: </dl></dd>
1.75      rillig    486: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                    487: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88      wiz       488: <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    489: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                    490: </dl>
                    491: </div>
                    492: <div class="sect1" lang="en">
                    493: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    494: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82      rillig    495: <p>There is a lot of software freely available for Unix-based
                    496: systems, which is usually available in form of the source code. Before
                    497: such software can be used, it needs to be configured to the local
                    498: system, compiled and installed, and this is exactly what The NetBSD
                    499: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
                    500: to handle binary packages, so that not every user has to build the
                    501: packages for himself, which is a time-costly task.</p>
1.75      rillig    502: <p>pkgsrc currently contains several thousand packages,
                    503:       including:</p>
                    504: <div class="itemizedlist"><ul type="disc">
1.91      rillig    505: <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    506:          web server</p></li>
1.91      rillig    507: <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    508:          web browser</p></li>
1.91      rillig    509: <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    510:          Desktop Environment</p></li>
1.91      rillig    511: <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    512:          Desktop Environment</p></li>
                    513: </ul></div>
                    514: <p>...just to name a few.</p>
                    515: <p>pkgsrc has built-in support for handling varying dependencies,
                    516:       such as pthreads and X11, and extended features such as IPv6 support on
                    517:       a range of platforms.</p>
1.82      rillig    518: <div class="sect2" lang="en">
                    519: <div class="titlepage"><div><div><h3 class="title">
                    520: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
                    521: <p>
                    522: pkgsrc provides the following key features:
                    523: </p>
                    524: <div class="itemizedlist"><ul type="disc">
                    525: <li><p>Easy building of software from source as well as the creation
                    526:   and installation of binary packages. The source and latest
                    527:   patches are retrieved from a master or mirror download site, checksum
                    528:   verified, then built on your system. Support for binary-only
                    529:   distributions is available for both native platforms and NetBSD
                    530:   emulated platforms.</p></li>
                    531: <li><p>All packages are installed in a consistent directory tree,
                    532:   including binaries, libraries, man pages and other
                    533:   documentation.</p></li>
                    534: <li><p>Package dependencies, including when performing package updates,
                    535:   are handled automatically. The configuration files of various
                    536:   packages are handled automatically during updates, so local changes
                    537:   are preserved.</p></li>
                    538: <li><p>Like NetBSD, pkgsrc is designed with portability in mind and
                    539:   consists of highly portable code. This allows the greatest speed of
                    540:   development when porting to new a platform. This portability also
                    541:   ensures that pkgsrc is <span class="emphasis"><em>consistent across all
                    542:   platforms</em></span>.</p></li>
                    543: <li><p>The installation prefix, acceptable software licenses,
                    544:   international encryption requirements and build-time options for a
                    545:   large number of packages are all set in a simple, central
                    546:   configuration file.</p></li>
                    547: <li><p>The entire source (not including the distribution files) is
                    548:   freely available under a BSD license, so you may extend and adapt
                    549:   pkgsrc to your needs. Support for local packages and patches is
                    550:   available right out of the box, so you can configure it specifically
                    551:   for your environment.</p></li>
                    552: </ul></div>
1.91      rillig    553: <p>The following principles are basic to pkgsrc:</p>
                    554: <div class="itemizedlist"><ul type="disc">
                    555: <li><p>&#8220;<span class="quote">It should only work if it's right.</span>&#8221;
                    556: &mdash; That means, if a package contains bugs, it's better to find
                    557: them and to complain about them rather than to just install the package
                    558: and hope that it works. There are numerous checks in pkgsrc that try to
                    559: 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
                    560: of shell scripts), and post-installation checks (installed files,
                    561: references to shared libraries, script interpreters).</p></li>
                    562: <li><p>&#8220;<span class="quote">If it works, it should work everywhere</span>&#8221;
                    563: &mdash; Like NetBSD has been ported to many hardware architectures,
                    564: pkgsrc has been ported to many operating systems. Care is taken that
                    565: packages behave the same on all platforms.</p></li>
                    566: </ul></div>
1.82      rillig    567: </div>
                    568: <div class="sect2" lang="en">
                    569: <div class="titlepage"><div><div><h3 class="title">
                    570: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
                    571: <p>pkgsrc consists of both a source distribution and a binary
                    572: distribution for these operating systems. After retrieving the required
                    573: source or binaries, you can be up and running with pkgsrc in just
                    574: minutes!</p>
1.75      rillig    575: <p>pkgsrc was derived from FreeBSD's ports system, and
                    576:       initially developed for NetBSD only. Since then, pkgsrc has
                    577:       grown a lot, and now supports the following platforms:</p>
1.82      rillig    578: <div class="table">
                    579: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.91      rillig    580: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
1.82      rillig    581: <colgroup>
                    582: <col>
                    583: <col>
                    584: </colgroup>
                    585: <thead><tr>
                    586: <th>Platform</th>
                    587: <th>Date Support Added</th>
                    588: </tr></thead>
                    589: <tbody>
                    590: <tr>
                    591: <td><a href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
                    592: <td align="center">Aug 1997</td>
                    593: </tr>
                    594: <tr>
                    595: <td><a href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
                    596: <td align="center">Mar 1999</td>
                    597: </tr>
                    598: <tr>
                    599: <td><a href="http://www.kernel.org/" target="_top">Linux</a></td>
                    600: <td align="center">Jun 1999</td>
                    601: </tr>
                    602: <tr>
                    603: <td>
                    604:           <a href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
                    605:           (<a href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
                    606:         </td>
                    607: <td align="center">Oct 2001</td>
                    608: </tr>
                    609: <tr>
                    610: <td><a href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
                    611: <td align="center">Nov 2002</td>
                    612: </tr>
                    613: <tr>
                    614: <td><a href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
                    615: <td align="center">Nov 2002</td>
                    616: </tr>
                    617: <tr>
                    618: <td><a href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
                    619: <td align="center">Dec 2002</td>
                    620: </tr>
                    621: <tr>
                    622: <td>BSD/OS</td>
                    623: <td align="center">Dec 2003</td>
                    624: </tr>
                    625: <tr>
                    626: <td><a href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
                    627: <td align="center">Dec 2003</td>
                    628: </tr>
                    629: <tr>
                    630: <td>
                    631:           <a href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
                    632:           (Microsoft Windows Services for Unix)
                    633:         </td>
                    634: <td align="center">Mar 2004</td>
                    635: </tr>
                    636: <tr>
                    637: <td><a href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
                    638: <td align="center">Oct 2004</td>
                    639: </tr>
                    640: <tr>
                    641: <td><a href="http://www.tru64.org/" target="_top">OSF/1</a></td>
                    642: <td align="center">Nov 2004</td>
                    643: </tr>
                    644: </tbody>
1.91      rillig    645: </table></div>
1.82      rillig    646: </div>
1.91      rillig    647: <br class="table-break">
1.82      rillig    648: </div>
1.75      rillig    649: </div>
                    650: <div class="sect1" lang="en">
                    651: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    652: <a name="overview"></a>1.2. Overview</h2></div></div></div>
                    653: <p>This document is divided into three parts. The first,
                    654:        <a href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
                    655:        describes how one can use one of the packages in the Package
                    656:        Collection, either by installing a precompiled binary package,
1.93      rillig    657:        or by building one's own copy using the NetBSD package system.
1.75      rillig    658:        The second part, <a href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
                    659:        package so it can be easily built by other NetBSD users without
                    660:        knowing about the package's building details. The third part,
                    661:        <a href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
                    662:        is intended for those who want to understand how pkgsrc is
                    663:        implemented.</p>
                    664: <p>This document is available in various formats:
                    665:        <span class="simplelist"><a href="index.html" target="_top">HTML</a>, <a href="pkgsrc.pdf" target="_top">PDF</a>, <a href="pkgsrc.ps" target="_top">PS</a>, <a href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
                    666: </div>
                    667: <div class="sect1" lang="en">
                    668: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    669: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
                    670: <p>There has been a lot of talk about &#8220;<span class="quote">ports</span>&#8221;,
                    671:       &#8220;<span class="quote">packages</span>&#8221;, etc. so far. Here is a description of all the
                    672:       terminology used within this document.</p>
                    673: <div class="variablelist"><dl>
                    674: <dt><span class="term">Package</span></dt>
                    675: <dd><p>A set of files and building instructions
                    676:            that describe what's necessary
                    677:            to build a certain piece of software using
                    678:             pkgsrc. Packages are traditionally stored under
1.76      rillig    679:            <code class="filename">/usr/pkgsrc</code>.</p></dd>
1.75      rillig    680: <dt><span class="term">The NetBSD package system</span></dt>
1.87      wiz       681: <dd><p>This is the former name of &#8220;<span class="quote">pkgsrc</span>&#8221;.  It
                    682:          is part of the NetBSD operating system and can be bootstrapped
                    683:          to run on non-NetBSD operating systems as well.  It handles
                    684:          building (compiling), installing, and removing of
                    685:          packages.</p></dd>
1.75      rillig    686: <dt><span class="term">Distfile</span></dt>
                    687: <dd><p>This term describes the file or files that are
                    688:            provided by the author of the piece of software to
                    689:            distribute his work. All the changes necessary to build on
                    690:            NetBSD are reflected in the corresponding package. Usually
                    691:            the distfile is in the form of a compressed tar-archive,
                    692:            but other types are possible, too. Distfiles are usually
                    693:            stored below
1.76      rillig    694:            <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75      rillig    695: <dt><span class="term">Port</span></dt>
                    696: <dd><p>This is the term used by FreeBSD and OpenBSD people
                    697:            for what we call a package.
                    698:            In NetBSD terminology, &#8220;<span class="quote">port</span>&#8221; refers to a different
                    699:            architecture.</p></dd>
                    700: <dt><span class="term">Precompiled/binary package</span></dt>
                    701: <dd>
                    702: <p>A set of binaries built with pkgsrc from a distfile
1.76      rillig    703:            and stuffed together in a single <code class="filename">.tgz</code>
1.75      rillig    704:            file so it can be installed on machines of the same
                    705:            machine architecture without the need to
                    706:            recompile. Packages are usually generated in
1.76      rillig    707:            <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.75      rillig    708:            an archive on <a href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/" target="_top">ftp.NetBSD.org</a>.</p>
                    709: <p>Sometimes, this is referred to by the term &#8220;<span class="quote">package</span>&#8221; too,
                    710:            especially in the context of precompiled packages.</p>
                    711: </dd>
                    712: <dt><span class="term">Program</span></dt>
1.88      wiz       713: <dd><p>The piece of software to be installed which will be
                    714:          constructed from all the files in the distfile by the
                    715:          actions defined in the corresponding package.</p></dd>
1.75      rillig    716: </dl></div>
                    717: <div class="sect2" lang="en">
                    718: <div class="titlepage"><div><div><h3 class="title">
1.88      wiz       719: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.75      rillig    720: <div class="variablelist"><dl>
                    721: <dt><span class="term">pkgsrc users</span></dt>
                    722: <dd>
                    723: <p>The
                    724:        pkgsrc users are people who use the packages provided by pkgsrc.
                    725:        Typically they are system administrators. The people using the
                    726:        software that is inside the packages (maybe called &#8220;<span class="quote">end
                    727:        users</span>&#8221;) are not covered by the pkgsrc guide.</p>
                    728: <p>There are two kinds of pkgsrc users: Some only want to
                    729:        install pre-built binary packages. Others build the pkgsrc
                    730:        packages from source, either for installing them directly or for
                    731:        building binary packages themselves. For pkgsrc users <a 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
                    732:        documentation.</p>
                    733: </dd>
                    734: <dt><span class="term">package maintainers</span></dt>
                    735: <dd><p>A
                    736:        package maintainer creates packages as described in <a href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, &#8220;The pkgsrc developer's guide&#8221;</a>.</p></dd>
                    737: <dt><span class="term">infrastructure developers</span></dt>
                    738: <dd><p>These people are involved in all those files
1.76      rillig    739:        that live in the <code class="filename">mk/</code> directory and below.
1.75      rillig    740:        Only these people should need to read through <a href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, &#8220;The pkgsrc infrastructure internals&#8221;</a>, though others might be curious,
                    741:        too.</p></dd>
                    742: </dl></div>
                    743: </div>
                    744: </div>
                    745: <div class="sect1" lang="en">
                    746: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    747: <a name="typography"></a>1.4. Typography</h2></div></div></div>
                    748: <p>When giving examples for commands, shell prompts are used to
                    749:       show if the command should/can be issued as root, or if
                    750:       &#8220;<span class="quote">normal</span>&#8221; user privileges are sufficient. We use a
                    751:       <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
                    752:       shell prompt, assuming they use the C-shell or tcsh.</p>
                    753: </div>
                    754: </div>
                    755: <div class="part" lang="en">
                    756: <div class="titlepage"><div><div><h1 class="title">
                    757: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
                    758: <div class="toc">
                    759: <p><b>Table of Contents</b></p>
                    760: <dl>
                    761: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
                    762: <dd><dl>
                    763: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    764: <dd><dl>
                    765: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
                    766: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
1.97    ! rillig    767: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75      rillig    768: </dl></dd>
                    769: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    770: <dd><dl>
                    771: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    772: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    773: </dl></dd>
                    774: </dl></dd>
                    775: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
                    776: <dd><dl>
1.82      rillig    777: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                    778: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                    779: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                    780: <dd><dl>
                    781: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
                    782: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
                    783: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
                    784: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
                    785: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
                    786: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
                    787: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75      rillig    788: </dl></dd>
                    789: </dl></dd>
                    790: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                    791: <dd><dl>
                    792: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                    793: <dd><dl>
                    794: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                    795: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig    796: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                    797: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                    798: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    799: <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>
                    800: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                    801: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75      rillig    802: </dl></dd>
                    803: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                    804: <dd><dl>
                    805: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                    806: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                    807: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                    808: </dl></dd>
                    809: </dl></dd>
                    810: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    811: <dd><dl>
                    812: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    813: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.78      rillig    814: <dt><span class="sect1"><a href="#conf.compiler">5.3. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       815: <dd><dl>
1.89      rillig    816: <dt><span class="sect2"><a href="#selecting-the-compiler">5.3.1. Selecting the compiler</a></span></dt>
                    817: <dt><span class="sect2"><a href="#conf.cflags">5.3.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    818: <dt><span class="sect2"><a href="#conf.ldflags">5.3.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz       819: </dl></dd>
1.78      rillig    820: <dt><span class="sect1"><a href="#developer-advanced-settings">5.4. Developer/advanced settings</a></span></dt>
                    821: <dt><span class="sect1"><a href="#selecting-build-options">5.5. Selecting Build Options</a></span></dt>
1.75      rillig    822: </dl></dd>
                    823: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    824: <dd><dl>
                    825: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    826: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
                    827: <dt><span class="sect1"><a href="#bulkbuild">6.3. Doing a bulk build of all packages</a></span></dt>
                    828: <dd><dl>
                    829: <dt><span class="sect2"><a href="#binary.configuration">6.3.1. Configuration</a></span></dt>
                    830: <dt><span class="sect2"><a href="#other-environmental-considerations">6.3.2. Other environmental considerations</a></span></dt>
                    831: <dt><span class="sect2"><a href="#operation">6.3.3. Operation</a></span></dt>
                    832: <dt><span class="sect2"><a href="#what-it-does">6.3.4. What it does</a></span></dt>
                    833: <dt><span class="sect2"><a href="#disk-space-requirements">6.3.5. Disk space requirements</a></span></dt>
                    834: <dt><span class="sect2"><a href="#setting-up-a-sandbox">6.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                    835: <dt><span class="sect2"><a href="#building-a-partial-set">6.3.7. Building a partial set of packages</a></span></dt>
                    836: <dt><span class="sect2"><a href="#bulk-upload">6.3.8. Uploading results of a bulk build</a></span></dt>
                    837: </dl></dd>
                    838: <dt><span class="sect1"><a href="#creating-cdroms">6.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                    839: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">6.4.1. Example of cdpack</a></span></dt></dl></dd>
                    840: </dl></dd>
1.90      rillig    841: <dt><span class="chapter"><a href="#files">7. Directory layout of the installed files</a></span></dt>
                    842: <dd><dl>
1.91      rillig    843: <dt><span class="sect1"><a href="#files.localbase">7.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
1.90      rillig    844: <dt><span class="sect1"><a href="#files.varbase">7.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
                    845: </dl></dd>
                    846: <dt><span class="chapter"><a href="#faq">8. Frequently Asked Questions</a></span></dt>
1.75      rillig    847: <dd><dl>
1.90      rillig    848: <dt><span class="sect1"><a href="#mailing-list-pointers">8.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    849: <dt><span class="sect1"><a href="#pkgviews-docs">8.2. Where's the pkgviews documentation?</a></span></dt>
                    850: <dt><span class="sect1"><a href="#faq-pkgtools">8.3. Utilities for package management (pkgtools)</a></span></dt>
                    851: <dt><span class="sect1"><a href="#non-root-pkgsrc">8.4. How to use pkgsrc as non-root</a></span></dt>
                    852: <dt><span class="sect1"><a href="#resume-transfers">8.5. How to resume transfers when fetching distfiles?</a></span></dt>
                    853: <dt><span class="sect1"><a href="#XFree86-from-pkgsrc">8.6. How can I install/use XFree86 from pkgsrc?</a></span></dt>
                    854: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">8.7. How can I install/use X.org from pkgsrc?</a></span></dt>
                    855: <dt><span class="sect1"><a href="#fetch-behind-firewall">8.8. How to fetch files from behind a firewall</a></span></dt>
                    856: <dt><span class="sect1"><a href="#passive-ftp">8.9. How do I tell <span><strong class="command">make fetch</strong></span> to do passive FTP?</a></span></dt>
                    857: <dt><span class="sect1"><a href="#fetching-all-distfiles">8.10. How to fetch all distfiles at once</a></span></dt>
                    858: <dt><span class="sect1"><a href="#tmac.andoc-missing">8.11. What does &#8220;<span class="quote">Don't know how to make
1.75      rillig    859: /usr/share/tmac/tmac.andoc</span>&#8221; mean?</a></span></dt>
1.90      rillig    860: <dt><span class="sect1"><a href="#bsd.own.mk-missing">8.12. What does &#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221; mean?</a></span></dt>
                    861: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">8.13. Using 'sudo' with pkgsrc</a></span></dt>
                    862: <dt><span class="sect1"><a href="#faq.conf">8.14. How do I change the location of configuration files?</a></span></dt>
                    863: <dt><span class="sect1"><a href="#audit-packages">8.15. Automated security checks</a></span></dt>
                    864: <dt><span class="sect1"><a href="#ufaq-cflags">8.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    865: <dt><span class="sect1"><a href="#ufaq-fail">8.17. A package does not build.  What shall I do?</a></span></dt>
                    866: <dt><span class="sect1"><a href="#faq.rcs-conflicts">8.18. What does &#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221; mean?</a></span></dt>
1.75      rillig    867: </dl></dd>
                    868: </dl>
                    869: </div>
                    870: <div class="chapter" lang="en">
                    871: <div class="titlepage"><div><div><h2 class="title">
                    872: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
                    873: <div class="toc">
                    874: <p><b>Table of Contents</b></p>
                    875: <dl>
                    876: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    877: <dd><dl>
                    878: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
                    879: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
1.97    ! rillig    880: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75      rillig    881: </dl></dd>
                    882: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    883: <dd><dl>
                    884: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    885: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    886: </dl></dd>
                    887: </dl>
                    888: </div>
1.91      rillig    889: <p>Before you download and extract the files, you need to decide
                    890: where you want to extract them. When using pkgsrc as root user, pkgsrc
                    891: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
                    892: free to install the sources and binary packages wherever you want in
                    893: your filesystem, provided that the pathname does not contain white-space
                    894: or other characters that are interpreted specially by the shell and some
                    895: other programs. A safe bet is to use only letters, digits, underscores
                    896: and dashes.</p>
1.75      rillig    897: <div class="sect1" lang="en">
                    898: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    899: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
                    900: <p>Before you download any pkgsrc files, you should decide
                    901:        whether you want the <span class="emphasis"><em>current</em></span> branch or the
                    902:        <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
                    903:        quarterly basis from the current branch and only gets modified
                    904:        for security updates. The names of the stable branches are built
                    905:        from the year and the quarter, for example
1.96      rillig    906:        <code class="literal">2006Q4</code>.</p>
1.75      rillig    907: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
                    908:        want to download pkgsrc. You can get it as a tar file, via SUP,
                    909:        or via CVS. All three ways are described here.</p>
                    910: <div class="sect2" lang="en">
                    911: <div class="titlepage"><div><div><h3 class="title">
                    912: <a name="getting-via-tar"></a>2.1.1. As tar file</h3></div></div></div>
                    913: <p>The primary download location for all pkgsrc files is
                    914:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>. There are a
                    915:        number of subdirectories for different purposes, which are
1.76      rillig    916:        described in detail in <a 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    917: <p>The tar file for the current branch is in the directory
1.76      rillig    918:        <code class="filename">current</code> and is called <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.75      rillig    919:        It is autogenerated daily.</p>
1.96      rillig    920: <p>The tar file for the stable branch 2006Q4 is in the
                    921:        directory <code class="filename">pkgsrc-2006Q4</code> and is also called <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2006Q4/pkgsrc-2006Q4.tar.gz" target="_top"><code class="filename">pkgsrc-2006Q4.tar.gz</code></a>.</p>
1.75      rillig    922: <p>After downloading the tar file, change to the directory
                    923:        where you want to have pkgsrc. This is usually
1.91      rillig    924:        <code class="filename">/usr</code>. Then, run <span><strong class="command">gzcat
                    925:        pkgsrc.tar.gz | tar xf -</strong></span> to extract the files.</p>
1.75      rillig    926: </div>
                    927: <div class="sect2" lang="en">
                    928: <div class="titlepage"><div><div><h3 class="title">
                    929: <a name="getting-via-sup"></a>2.1.2. Via SUP</h3></div></div></div>
                    930: <p>As an alternative to the tar file, you can get pkgsrc via
                    931:        the Software Update Protocol, SUP. To do so, make sure your
                    932:        supfile has a line
1.1       grant     933: 
1.75      rillig    934: </p>
                    935: <pre class="programlisting">
1.51      rillig    936:     release=pkgsrc
1.1       grant     937: </pre>
1.75      rillig    938: <p>
1.1       grant     939: 
1.75      rillig    940:        in it, see the examples in
1.76      rillig    941:        <code class="filename">/usr/share/examples/supfiles</code>, and that the
                    942:        <code class="filename">/usr/pkgsrc</code> directory exists. Then, simply
1.75      rillig    943:        run <span><strong class="command">sup -v
                    944:        <em class="replaceable"><code>/path/to/your/supfile</code></em></strong></span>.</p>
                    945: </div>
                    946: <div class="sect2" lang="en">
                    947: <div class="titlepage"><div><div><h3 class="title">
1.97    ! rillig    948: <a name="getting-via-cvs"></a>2.1.3. Via anonymous CVS</h3></div></div></div>
1.75      rillig    949: <p>To get pkgsrc via CVS, make sure you have <a href="http://netbsd.gw.com/cgi-bin/man-cgi?cvs+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">cvs</span>(1)</span></a>
                    950:        installed. To do an initial (full) checkout of pkgsrc, you first
                    951:        have to set some environment variables. For the C-Shell,
                    952:        type:</p>
                    953: <pre class="screen">
                    954:     <code class="prompt">%</code> <strong class="userinput"><code>setenv CVSROOT anoncvs@anoncvs.NetBSD.org:/cvsroot</code></strong>
                    955:     <code class="prompt">%</code> <strong class="userinput"><code>setenv CVS_RSH ssh</code></strong>
                    956: </pre>
                    957: <p>Or, the same for the bourne shell:</p>
                    958: <pre class="screen">
                    959:     <code class="prompt">$</code> <strong class="userinput"><code>CVSROOT="anoncvs@anoncvs.NetBSD.org:/cvsroot"</code></strong>
                    960:     <code class="prompt">$</code> <strong class="userinput"><code>CVS_RSH="ssh"</code></strong>
                    961:     <code class="prompt">$</code> <strong class="userinput"><code>export CVSROOT CVS_RSH</code></strong>
                    962: </pre>
                    963: <p>Then, you change to the directory where you want to have
                    964:        your copy of pkgsrc. In most cases this is
1.76      rillig    965:        <code class="filename">/usr</code>. In that directory you run the
1.75      rillig    966:        checkout command, which is <span><strong class="command">cvs -q checkout -P
                    967:        pkgsrc</strong></span> for the current branch and <span><strong class="command">cvs -q
1.96      rillig    968:        checkout -rpkgsrc-2006Q4 -P pkgsrc</strong></span> for the stable
1.75      rillig    969:        branch. This command will create a directory called
1.76      rillig    970:        <code class="filename">pkgsrc</code> with all the pkgsrc files in
1.75      rillig    971:        it.</p>
                    972: </div>
                    973: </div>
                    974: <div class="sect1" lang="en">
                    975: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    976: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
                    977: <p>The preferred way to keep pkgsrc up-to-date is via CVS
                    978:        (which also works if you have first installed it via a tar
                    979:        file). It saves bandwidth and hard disk activity, compared to
                    980:        downloading the tar file again.</p>
                    981: <div class="sect2" lang="en">
                    982: <div class="titlepage"><div><div><h3 class="title">
                    983: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
                    984: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
                    985: <h3 class="title">Warning</h3>
1.77      rillig    986: <p>When updating from a tar file, you first need to
                    987:        completely remove the old pkgsrc directory. Otherwise those
                    988:        files that have been removed from pkgsrc in the mean time will
                    989:        not be removed on your local disk, resulting in inconsistencies.
                    990:        When removing the old files, any changes that you have done to
                    991:        the pkgsrc files will be lost after updating. Therefore updating
                    992:        via CVS is strongly recommended.</p>
1.75      rillig    993: </div>
1.82      rillig    994: <p>Note that by default the distfiles and the binary packages
                    995:        are saved in the pkgsrc tree, so don't forget to rescue them
                    996:        before updating. You can also configure pkgsrc to use other than
                    997:        the default directories by setting the
                    998:        <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
                    999:        variables. See <a href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1.75      rillig   1000: <p>To update pkgsrc from a tar file, download the tar file as
                   1001:        explained above. Then, make sure that you have not made any
                   1002:        changes to the files in the pkgsrc directory. Remove the pkgsrc
                   1003:        directory and extract the new tar file. Done.</p>
                   1004: </div>
                   1005: <div class="sect2" lang="en">
                   1006: <div class="titlepage"><div><div><h3 class="title">
                   1007: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
                   1008: <p>To update pkgsrc via CVS, make sure the environment
                   1009:        variable <code class="varname">CVS_RSH</code> is set as above. Then,
                   1010:        change to the pkgsrc directory and run <span><strong class="command">cvs -q update
1.77      rillig   1011:        -dP</strong></span>.</p>
1.75      rillig   1012: <div class="sect3" lang="en">
                   1013: <div class="titlepage"><div><div><h4 class="title">
                   1014: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
                   1015: <p>When updating pkgsrc, the CVS program keeps track of the
                   1016:        branch you selected. But if you, for whatever reason, want to
                   1017:        switch from the stable branch to the current one, you can do it
                   1018:        by adding the option &#8220;<span class="quote">-A</span>&#8221; after the
                   1019:        &#8220;<span class="quote">update</span>&#8221; keyword. To switch from the current branch
                   1020:        back to the stable branch, add the
1.96      rillig   1021:        &#8220;<span class="quote">-rpkgsrc-2006Q4</span>&#8221; option.</p>
1.75      rillig   1022: </div>
                   1023: <div class="sect3" lang="en">
                   1024: <div class="titlepage"><div><div><h4 class="title">
                   1025: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
                   1026: <p>When you update pkgsrc, the CVS program will only touch
                   1027:        those files that are registered in the CVS repository. That
                   1028:        means that any packages that you created on your own will stay
                   1029:        unmodified. If you change files that are managed by CVS, later
                   1030:        updates will try to merge your changes with those that have been
                   1031:        done by others. See the CVS manual, chapter
                   1032:        &#8220;<span class="quote">update</span>&#8221; for details.</p>
                   1033: </div>
                   1034: </div>
                   1035: </div>
                   1036: </div>
                   1037: <div class="chapter" lang="en">
                   1038: <div class="titlepage"><div><div><h2 class="title">
                   1039: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
                   1040: <div class="toc">
                   1041: <p><b>Table of Contents</b></p>
                   1042: <dl>
1.82      rillig   1043: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                   1044: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                   1045: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                   1046: <dd><dl>
                   1047: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
                   1048: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
                   1049: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
                   1050: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
                   1051: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
                   1052: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
                   1053: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75      rillig   1054: </dl></dd>
                   1055: </dl>
                   1056: </div>
                   1057: <div class="sect1" lang="en">
                   1058: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82      rillig   1059: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
                   1060: <p>
                   1061: We provide a bootstrap kit in both source and binary form for other
                   1062: platforms than NetBSD, consisting of the pkg administration tools and other
                   1063: tools required to use pkgsrc and build packages.
                   1064: </p>
                   1065: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1066: <h3 class="title">Note</h3>
                   1067: <p>
                   1068: Older binary snapshots are available in the
                   1069: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/archive/" target="_top">bootstrap-pkgsrc/archive</a>
                   1070: directory on ftp.NetBSD.org.</p>
                   1071: </div>
                   1072: <div class="table">
                   1073: <a name="binary-kits"></a><p class="title"><b>Table 3.1. Binary kits and available packages</b></p>
1.91      rillig   1074: <div class="table-contents"><table summary="Binary kits and available packages" border="1">
1.82      rillig   1075: <colgroup>
                   1076: <col>
                   1077: <col>
                   1078: <col>
                   1079: <col>
                   1080: </colgroup>
                   1081: <thead><tr>
                   1082: <th>Platform</th>
                   1083: <th>Latest snapshot</th>
                   1084: <th>Binary kit</th>
                   1085: <th>Binary packages</th>
                   1086: </tr></thead>
                   1087: <tbody>
                   1088: <tr>
                   1089: <td class="osname">Darwin 5.5/powerpc (Mac OS X 10.1.5)</td>
                   1090: <td class="date">20021209</td>
                   1091: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Darwin-5.5-powerpc-20021209.tar.gz" target="_top">binary kit</a></td>
                   1092: <td class="binary-pkgs-url"> </td>
                   1093: </tr>
                   1094: <tr>
                   1095: <td class="osname">Darwin 6.6/powerpc (Mac OS X 10.2.6)</td>
                   1096: <td class="date">20030623</td>
                   1097: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Darwin-6.6-powerpc-20030623.tar.gz" target="_top">binary kit</a></td>
                   1098: <td class="binary-pkgs-url"> </td>
                   1099: </tr>
                   1100: <tr>
                   1101: <td class="osname">Darwin 7.6/powerpc (Mac OS X 10.3.6)</td>
                   1102: <td class="date">20041219</td>
                   1103: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Darwin-7.6.0-powerpc-20041219.tar.gz" target="_top">binary kit</a></td>
                   1104: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/Darwin-7.6/" target="_top">binary packages</a></td>
                   1105: </tr>
                   1106: <tr>
                   1107: <td class="osname">Darwin 7.8/powerpc (Mac OS X 10.3.8)</td>
                   1108: <td class="date">20050320</td>
                   1109: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Darwin-7.8.0-powerpc-20050320.tar.gz" target="_top">binary kit</a></td>
                   1110: <td class="binary-pkgs-url"> </td>
                   1111: </tr>
                   1112: <tr>
                   1113: <td class="osname">Darwin 8.1/powerpc (Mac OS X 10.4.1)</td>
                   1114: <td class="date">20050625</td>
                   1115: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Darwin-8.1.0-powerpc-20050625.tar.gz" target="_top">binary kit</a></td>
                   1116: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/Darwin-8.1/powerpc/current/" target="_top">binary packages</a></td>
                   1117: </tr>
                   1118: <tr>
                   1119: <td class="osname">Debian GNU Linux/i386</td>
                   1120: <td class="date">20031023</td>
                   1121: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Linux-2.4.22-debian-i386-20031023.tar.gz" target="_top">binary kit</a></td>
                   1122: <td class="binary-pkgs-url"> </td>
                   1123: </tr>
                   1124: <tr>
                   1125: <td class="osname">Fedora Core 2 Linux/i386</td>
                   1126: <td class="date">20050618</td>
                   1127: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Linux-2.6.10-i386-fc2-20050618.tar.gz" target="_top">binary kit</a></td>
                   1128: <td class="binary-pkgs-url"> </td>
                   1129: </tr>
                   1130: <tr>
                   1131: <td class="osname">Fedora Core 4 Linux/i386</td>
                   1132: <td class="date">20060105</td>
                   1133: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Linux-2.6.11-i386-fc4-20060105.tar.gz" target="_top">binary kit</a></td>
                   1134: <td class="binary-pkgs-url"> </td>
                   1135: </tr>
                   1136: <tr>
                   1137: <td class="osname">FreeBSD 3.5/i386</td>
                   1138: <td class="date">20030411</td>
                   1139: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-3.5-STABLE-i386-20030411.tar.gz" target="_top">binary kit</a></td>
                   1140: <td class="binary-pkgs-url"> </td>
                   1141: </tr>
                   1142: <tr>
                   1143: <td class="osname">FreeBSD 4.7/i386</td>
                   1144: <td class="date">20021211</td>
                   1145: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-4.7-RELEASE-i386-20021211.tar.gz" target="_top">binary kit</a></td>
                   1146: <td class="binary-pkgs-url"> </td>
                   1147: </tr>
                   1148: <tr>
                   1149: <td class="osname">FreeBSD 5.0/i386</td>
                   1150: <td class="date">20030411</td>
                   1151: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-5.0-RELEASE-i386-20030411.tar.gz" target="_top">binary kit</a></td>
                   1152: <td class="binary-pkgs-url"> </td>
                   1153: </tr>
                   1154: <tr>
                   1155: <td class="osname">FreeBSD 5.1/i386</td>
                   1156: <td class="date">20030630</td>
                   1157: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-5.1-RELEASE-i386-20030630.tar.gz" target="_top">binary kit</a></td>
                   1158: <td class="binary-pkgs-url"> </td>
                   1159: </tr>
                   1160: <tr>
                   1161: <td class="osname">FreeBSD 5.2.1/i386</td>
                   1162: <td class="date">20040227</td>
                   1163: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-5.2.1-RELEASE-i386-20040227.tar.gz" target="_top">binary kit</a></td>
                   1164: <td class="binary-pkgs-url"> </td>
                   1165: </tr>
                   1166: <tr>
                   1167: <td class="osname">FreeBSD 5.3/i386</td>
                   1168: <td class="date">20050119</td>
                   1169: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-5.3-RELEASE-i386-20050119.tar" target="_top">binary kit</a></td>
                   1170: <td class="binary-pkgs-url"> </td>
                   1171: </tr>
                   1172: <tr>
                   1173: <td class="osname">Interix 3.5</td>
1.93      rillig   1174: <td class="date">20061106</td>
                   1175: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Interix-3.5-i386-20061106.tar.gz" target="_top">binary kit</a></td>
                   1176: <td class="binary-pkgs-url"> </td>
1.82      rillig   1177: </tr>
                   1178: <tr>
                   1179: <td class="osname">IRIX 6.5 n32-bit ABI</td>
                   1180: <td class="date">20040911</td>
                   1181: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-IRIX-6.5-mips-20040911.tar.gz" target="_top">binary kit</a></td>
                   1182: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/IRIX-6.5/n32/" target="_top">binary packages</a></td>
                   1183: </tr>
                   1184: <tr>
                   1185: <td class="osname">IRIX 6.5 64-bit ABI</td>
                   1186: <td class="date">20040912</td>
                   1187: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-IRIX64-6.5-mips-20040912.tar.gz" target="_top">binary kit</a></td>
                   1188: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/IRIX-6.5/64/" target="_top">binary packages</a></td>
                   1189: </tr>
                   1190: <tr>
                   1191: <td class="osname">OpenBSD 3.2/i386</td>
                   1192: <td class="date">20030420</td>
                   1193: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-OpenBSD-3.2-i386-20030420.tar.gz" target="_top">binary kit</a></td>
                   1194: <td class="binary-pkgs-url"> </td>
                   1195: </tr>
                   1196: <tr>
                   1197: <td class="osname">OpenBSD 3.3/i386</td>
                   1198: <td class="date">20030503</td>
                   1199: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-OpenBSD-3.3-i386-20030503.tar.gz" target="_top">binary kit</a></td>
                   1200: <td class="binary-pkgs-url"> </td>
                   1201: </tr>
                   1202: <tr>
                   1203: <td class="osname">OpenBSD 3.5/i386</td>
1.93      rillig   1204: <td class="date">20040703</td>
1.82      rillig   1205: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-OpenBSD-3.5-i386-20040703.tar.gz" target="_top">binary kit</a></td>
                   1206: <td class="binary-pkgs-url"> </td>
                   1207: </tr>
                   1208: <tr>
                   1209: <td class="osname">Slackware Linux 8.1/i386</td>
                   1210: <td class="date">20030417</td>
                   1211: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Linux-2.4.18-slackware-20030417.tar.gz" target="_top">binary kit</a></td>
                   1212: <td class="binary-pkgs-url"> </td>
                   1213: </tr>
                   1214: <tr>
                   1215: <td class="osname">Slackware Linux 9/i386</td>
1.93      rillig   1216: <td class="date">20040703</td>
1.82      rillig   1217: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Linux-2.4.22-i386-slackware9-20040703.tar.gz" target="_top">binary kit</a></td>
                   1218: <td class="binary-pkgs-url"> </td>
                   1219: </tr>
                   1220: <tr>
                   1221: <td class="osname">Solaris 8/sparc</td>
                   1222: <td class="date">20050220</td>
                   1223: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-SunOS-5.8-sparc-20050220.tar.gz" target="_top">binary kit</a></td>
                   1224: <td class="binary-pkgs-url"> </td>
                   1225: </tr>
                   1226: <tr>
                   1227: <td class="osname">Solaris 8/i386</td>
                   1228: <td class="date">20050220</td>
                   1229: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-SunOS-5.8-i386-20050220.tar.gz" target="_top">binary kit</a></td>
                   1230: <td class="binary-pkgs-url"> </td>
                   1231: </tr>
                   1232: <tr>
                   1233: <td class="osname">Solaris 9/sparc</td>
1.93      rillig   1234: <td class="date">20060713</td>
                   1235: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-SunOS-5.9-sparc-pkgsrc-2006Q2.tar.gz" target="_top">binary kit</a></td>
                   1236: <td class="binary-pkgs-url"> </td>
1.82      rillig   1237: </tr>
                   1238: <tr>
                   1239: <td class="osname">Solaris 9/i386</td>
                   1240: <td class="date">20030411</td>
                   1241: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-SunOS-5.9-i386-20030411.tar.gz" target="_top">binary kit</a></td>
                   1242: <td class="binary-pkgs-url"> </td>
                   1243: </tr>
                   1244: </tbody>
1.91      rillig   1245: </table></div>
1.82      rillig   1246: </div>
1.91      rillig   1247: <br class="table-break"><p>
1.82      rillig   1248: Simply download the binary kit for your platform, and extract it into
                   1249: <code class="filename">/</code> e.g.
                   1250: </p>
                   1251: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   1252: <code class="prompt">#</code> <strong class="userinput"><code>gzip -c -d /tmp/bootstrap-pkgsrc-SunOS-5.9-sparc-20031023.tar.gz \
                   1253:   | tar -xpf -</code></strong></pre>
                   1254: <p>
                   1255: Of course, as with any binary distributions, you should verify the
                   1256: checksum against the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/SUM" target="_top">SUM</a>
                   1257: or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/CKSUM" target="_top">CKSUM</a>
                   1258: file and inspect the contents before extracting it.
                   1259: </p>
                   1260: </div>
                   1261: <div class="sect1" lang="en">
                   1262: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1263: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
                   1264: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75      rillig   1265: <pre class="screen">
                   1266: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc</code></strong>
                   1267: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87      wiz      1268: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
                   1269:     </pre>
1.75      rillig   1270: <p>See <a 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      1271:     pkgsrc before bootstrapping. The given
                   1272:     <span><strong class="command">bootstrap</strong></span> command will use the defaults of
                   1273:     <code class="filename">/usr/pkg</code> for the
                   1274:     <span class="emphasis"><em>prefix</em></span> where programs will be installed in,
                   1275:     and <code class="filename">/var/db/pkg</code> for the package database
                   1276:     directory where pkgsrc will do its internal bookkeeping.
                   1277:     However, these can also be set using command-line
                   1278:     arguments.</p>
1.75      rillig   1279: <p>Binary packages for the pkgsrc tools and an initial set of packages is
1.87      wiz      1280:     available for supported platforms. An up-to-date list of these can be
                   1281:     found on <a href="http://www.pkgsrc.org/" target="_top">www.pkgsrc.org</a>.
                   1282:     Note that this only works for privileged builds that install
                   1283:     into <code class="filename">/usr/pkg</code>.</p>
1.75      rillig   1284: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1285: <h3 class="title">Note</h3>
                   1286: <p>The bootstrap installs a <span><strong class="command">bmake</strong></span> tool.
1.87      wiz      1287:       Use this <span><strong class="command">bmake</strong></span> when building via pkgsrc.
                   1288:       For examples in this guide, use <span><strong class="command">bmake</strong></span>
                   1289:       instead of &#8220;<span class="quote">make</span>&#8221;.</p>
1.75      rillig   1290: </div>
                   1291: </div>
                   1292: <div class="sect1" lang="en">
                   1293: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82      rillig   1294: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1.75      rillig   1295: <p>Here are some platform-specific notes you should be aware of.</p>
                   1296: <div class="sect2" lang="en">
                   1297: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1298: <a name="darwin"></a>3.3.1. Darwin (Mac OS X)</h3></div></div></div>
1.85      jmmv     1299: <p>Darwin 5.x and up are supported. There are two methods of using
1.82      rillig   1300:        pkgsrc on Mac OS X, by using a <a href="#platform.osx-image" title="3.3.1.1. Using a disk image">disk
1.89      rillig   1301:          image</a>, or a <a href="#platform.osx-part" title="3.3.1.2. Using a UFS or HFSX partition">UFS or HFSX
1.75      rillig   1302:          partition</a>.</p>
                   1303: <p>Before you start, you will need to download and install the Mac OS X Developer
1.87      wiz      1304:       Tools from Apple's Developer Connection.  See <a href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
                   1305:       for details.  Also, make sure you install X11 for Mac OS X and the X11 SDK
                   1306:       from <a href="http://www.apple.com/macosx/x11/download/" target="_top">http://www.apple.com/macosx/x11/download/</a>
                   1307:       if you intend to build packages that use the X11 Window System.</p>
1.89      rillig   1308: <p>If you already have a UFS or HFSX partition, or have a spare partition
                   1309:       that you can format as UFS or HFSX, it is recommended to use that instead of
1.87      wiz      1310:       the disk image. It'll be somewhat faster and will mount automatically
                   1311:       at boot time, where you must manually mount a disk image.</p>
1.75      rillig   1312: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1313: <h3 class="title">Note</h3>
1.85      jmmv     1314: <p>You cannot use an ordinary HFS+ file system for pkgsrc, because pkgsrc currently
1.89      rillig   1315:          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   1316: </div>
                   1317: <div class="sect3" lang="en">
                   1318: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1319: <a name="platform.osx-image"></a>3.3.1.1. Using a disk image</h4></div></div></div>
1.75      rillig   1320: <p>Create the disk image:</p>
                   1321: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.95      tron     1322: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage create ~/Documents/NetBSD 1024</code></strong> # megabytes - season to taste
1.85      jmmv     1323: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage mount ~/Documents/NetBSD</code></strong>
1.75      rillig   1324: <code class="prompt">#</code> <strong class="userinput"><code>sudo chown `id -u`:`id -g` /Volumes/NetBSD</code></strong></pre>
1.85      jmmv     1325: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1326: <h3 class="title">Note</h3>
1.89      rillig   1327: <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 journalling.</p>
1.85      jmmv     1328: </div>
1.89      rillig   1329: <p>Allow suid:</p>
                   1330: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sudo mount -u -o suid /Volumes/NetBSD</code></strong></pre>
1.75      rillig   1331: </div>
                   1332: <div class="sect3" lang="en">
                   1333: <div class="titlepage"><div><div><h4 class="title">
1.89      rillig   1334: <a name="platform.osx-part"></a>3.3.1.2. Using a UFS or HFSX partition</h4></div></div></div>
1.76      rillig   1335: <p>By default, <code class="filename">/usr</code> will be on your root file
1.87      wiz      1336:        system, normally HFS+. It is possible to use the default
                   1337:        <span class="emphasis"><em>prefix</em></span> of <code class="filename">/usr/pkg</code>
                   1338:        by symlinking <code class="filename">/usr/pkg</code> to a directory on a UFS
1.89      rillig   1339:        or HFSX file system. Obviously, another symlink is required if you want to
1.87      wiz      1340:        place the package database directory outside the
                   1341:        <span class="emphasis"><em>prefix</em></span>. e.g.</p>
1.75      rillig   1342: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --pkgdbdir /usr/pkg/pkgdb</code></strong></pre>
                   1343: <p>If you created your partitions at the time of installing Mac OS X
1.89      rillig   1344:        and formatted the target partition as UFS or HFSX, it should automatically
1.87      wiz      1345:        mount on <code class="filename">/Volumes/&lt;volume name&gt;</code> when the
1.89      rillig   1346:        machine boots. If you are (re)formatting a partition as UFS or HFSX, you need
1.87      wiz      1347:        to ensure that the partition map correctly reflects
1.89      rillig   1348:        &#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   1349: <p>The problem is that none of the disk tools will let you touch a
1.87      wiz      1350:        disk that is booted from. You can unmount the partition, but even if
                   1351:        you newfs it, the partition type will be incorrect and the
                   1352:        automounter won't mount it. It can be mounted manually, but it won't
                   1353:        appear in Finder.</p>
1.75      rillig   1354: <p>You'll need to boot off of the OS X Installation (User) CD.  When
1.87      wiz      1355:        the Installation program starts, go up to the menu and select Disk
                   1356:        Utility.  Now, you will be able to select the partition you want
1.89      rillig   1357:        to be UFS or HFSX, and Format it Apple UFS or HFSX. Quit the Disk Utility, quit the
                   1358:        installer which will reboot your machine. The new UFS or HFSX file system
1.87      wiz      1359:        will appear in Finder.</p>
1.75      rillig   1360: <p>Be aware that the permissions on the new file system will be writable
1.87      wiz      1361:        by root only.</p>
1.75      rillig   1362: <p>This note is as of 10.2 (Jaguar) and applies to earlier versions.
1.87      wiz      1363:        Hopefully Apple will fix Disk Utility in 10.3 (Panther).</p>
1.75      rillig   1364: </div>
                   1365: </div>
                   1366: <div class="sect2" lang="en">
                   1367: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1368: <a name="freebsd"></a>3.3.2. FreeBSD</h3></div></div></div>
1.87      wiz      1369: <p>FreeBSD 4.7 and 5.0 have been tested and are supported,
                   1370:       other versions may work.</p>
1.75      rillig   1371: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87      wiz      1372:       with the FreeBSD userland tools. There are several steps:</p>
1.75      rillig   1373: <div class="orderedlist"><ol type="1">
                   1374: <li><p>FreeBSD stores its ports pkg database in
1.87      wiz      1375:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1376:          recommended that you choose a different location (e.g.
                   1377:          <code class="filename">/usr/pkgdb</code>) by
                   1378:          using the --pkgdbdir option to the bootstrap script.</p></li>
1.75      rillig   1379: <li>
                   1380: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1.87      wiz      1381:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1382: <pre class="screen">
                   1383: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75      rillig   1384: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1385: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1386: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87      wiz      1387: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1388:          </pre>
1.75      rillig   1389: </li>
1.76      rillig   1390: <li><p>An example <code class="filename">/etc/mk.conf</code> file will be placed in
1.87      wiz      1391:          <code class="filename">/etc/mk.conf.example</code> file
                   1392:          when you use the bootstrap script.</p></li>
1.75      rillig   1393: </ol></div>
                   1394: </div>
                   1395: <div class="sect2" lang="en">
                   1396: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1397: <a name="interix"></a>3.3.3. Interix</h3></div></div></div>
1.75      rillig   1398: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1.87      wiz      1399:       providing a Unix-like environment with a tighter kernel integration than
                   1400:       available with Cygwin.  It is part of the Windows Services for Unix
                   1401:       package, available for free for any licensed copy of Windows 2000, XP
                   1402:       (not including XP Home), or 2003.  SFU can be downloaded from <a href="http://www.microsoft.com/windows/sfu/" target="_top">http://www.microsoft.com/windows/sfu/</a>.</p>
1.93      rillig   1403: <p>Services for Unix 3.5 has been tested.  3.0 or 3.1 may work, but
                   1404:       are not officially supported.  (The main difference in 3.0/3.1 is lack
                   1405:       of pthreads, but other parts of libc may also be lacking.)</p>
                   1406: <p>Services for Unix Applications (aka SUA) is an integrated component
                   1407:       of Windows Server 2003 R2 and Windows Vista.  As of this writing, SUA's
1.95      tron     1408:       Interix 5.x subsystem has not yet been tested with pkgsrc.</p>
1.75      rillig   1409: <div class="sect3" lang="en">
                   1410: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1411: <a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
1.75      rillig   1412: <p>At an absolute minimum, the following packages must be installed from
1.87      wiz      1413:        the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.75      rillig   1414: <div class="itemizedlist"><ul type="disc">
                   1415: <li><p>Utilities -&gt; Base Utilities</p></li>
                   1416: <li><p>Interix GNU Components -&gt; (all)</p></li>
                   1417: <li><p>Remote Connectivity</p></li>
                   1418: <li><p>Interix SDK</p></li>
                   1419: </ul></div>
                   1420: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1.87      wiz      1421:        "UNIX Perl".  That is Perl 5.6 without shared module support, installed to
                   1422:        /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
                   1423:        pkgsrc (or from a binary package).</p>
1.75      rillig   1424: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1.87      wiz      1425:        not need to be installed, but Remote Connectivity itself should be
                   1426:        installed in order to have a working inetd.</p>
1.75      rillig   1427: <p>During installation you may be asked whether to enable setuid
1.87      wiz      1428:        behavior for Interix programs, and whether to make pathnames default to
                   1429:        case-sensitive.  Setuid should be enabled, and case-sensitivity MUST be
                   1430:        enabled.  (Without case-sensitivity, a large number of packages including
                   1431:        perl will not build.)</p>
1.75      rillig   1432: <p>NOTE:  Newer Windows service packs change the way binary execution
1.87      wiz      1433:        works (via the Data Execution Prevention feature).  In order to use
                   1434:        pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
                   1435:        POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
                   1436:        must be installed.  Hotfixes are available from Microsoft through a
                   1437:        support contract; however, a NetBSD developer has made most Interix
                   1438:        hotfixes available for personal use from <a href="http://www.duh.org/interix/hotfixes.php" target="_top">http://www.duh.org/interix/hotfixes.php</a>.</p>
1.93      rillig   1439: <p>In addition to the hotfix noted above, it may be necessary to
                   1440:        disable Data Execution Prevention entirely to make Interix functional.
                   1441:        This may happen only with certain types of CPUs; the cause is not fully
                   1442:        understood at this time.  If gcc or other applications still segfault
                   1443:        repeatedly after installing one of the hotfixes note above, the
                   1444:        following option can be added to the appropriate "boot.ini" line on the
                   1445:        Windows boot drive:  /NoExecute=AlwaysOff
                   1446:        (WARNING, this will disable DEP completely, which may be a security
                   1447:        risk if applications are often run as a user in the Administrators
                   1448:        group!)</p>
1.75      rillig   1449: </div>
                   1450: <div class="sect3" lang="en">
                   1451: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1452: <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   1453: <p>If SFU is already installed and you wish to alter these settings to work
1.87      wiz      1454:        with pkgsrc, note the following things.</p>
1.75      rillig   1455: <div class="itemizedlist"><ul type="disc">
                   1456: <li><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.87      wiz      1457:            Windows Services for UNIX, then click Change.  In the installer, choose
                   1458:            Add or Remove, then uncheck Utilities-&gt;UNIX Perl.</p></li>
1.75      rillig   1459: <li>
                   1460: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1.87      wiz      1461:            change the following registry key:</p>
1.75      rillig   1462: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
                   1463: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
                   1464: </li>
                   1465: <li>
                   1466: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1.87      wiz      1467:            following registry key:</p>
1.75      rillig   1468: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
                   1469: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
                   1470: </li>
                   1471: </ul></div>
                   1472: </div>
                   1473: <div class="sect3" lang="en">
                   1474: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1475: <a name="platform.interix-notes"></a>3.3.3.3. Important notes for using pkgsrc</h4></div></div></div>
1.75      rillig   1476: <p>The package manager (either the pkgsrc "su" user, or the user
1.87      wiz      1477:        running "pkg_add") must be a member of the local Administrators
                   1478:        group.  Such a user must also be used to run the bootstrap.  This is
                   1479:        slightly relaxed from the normal pkgsrc requirement of "root".</p>
1.75      rillig   1480: <p>The package manager should use a umask of 002.  "make install" will
1.87      wiz      1481:        automatically complain if this is not the case.  This ensures that
                   1482:        directories written in /var/db/pkg are Administrators-group writeable.</p>
1.75      rillig   1483: <p>The popular Interix binary packages from http://www.interopsystems.com/
1.87      wiz      1484:        use an older version of pkgsrc's pkg_* tools.  Ideally, these should
                   1485:        NOT be used in conjunction with pkgsrc.  If you choose to use them at
                   1486:        the same time as the pkgsrc packages, ensure that you use the proper
                   1487:        pkg_* tools for each type of binary package.</p>
1.75      rillig   1488: <p>The TERM setting used for DOS-type console windows (including those
1.87      wiz      1489:        invoked by the csh and ksh startup shortcuts) is "interix".  Most systems
                   1490:        don't have a termcap/terminfo entry for it, but the following .termcap
                   1491:        entry provides adequate emulation in most cases:</p>
1.75      rillig   1492: <pre class="programlisting">
1.87      wiz      1493:          interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
                   1494:        </pre>
1.75      rillig   1495: </div>
                   1496: <div class="sect3" lang="en">
                   1497: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1498: <a name="platform.interix-limits"></a>3.3.3.4. Limitations of the Interix platform</h4></div></div></div>
1.75      rillig   1499: <p>Though Interix suffices as a familiar and flexible substitute
1.87      wiz      1500:        for a full Unix-like platform, it has some drawbacks that should
                   1501:        be noted for those desiring to make the most of Interix.</p>
1.75      rillig   1502: <div class="itemizedlist"><ul type="disc">
                   1503: <li>
                   1504: <p><span class="strong"><strong>X11:</strong></span></p>
                   1505: <p>Interix comes with the standard set of X11R6 client libraries,
1.87      wiz      1506:          and can run X11 based applications, but it does
                   1507:          <span class="emphasis"><em>not</em></span> come with an X server.  Some options are
                   1508:          <a href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
                   1509:          <a href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
                   1510:          (available in a trimmed version for Interix from Interop Systems as the
                   1511:          <a href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
                   1512:          and the free X11 server included with
                   1513:          <a href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.75      rillig   1514: </li>
                   1515: <li>
                   1516: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
                   1517: <p>Because Interix runs in a completely different NT subsystem from
1.87      wiz      1518:          Win32 applications, it does not currently support various X11
                   1519:          protocol extensions for acceleration (such as MIT-SHM or DGA).
                   1520:          Most interactive applications to a local X server will run
                   1521:          reasonably fast, but full motion video and other graphics
                   1522:          intensive applications may require a faster-than-expected CPU.</p>
1.75      rillig   1523: </li>
                   1524: <li>
                   1525: <p><span class="strong"><strong>Audio:</strong></span></p>
                   1526: <p>Interix has no native support for audio output.  For audio
1.87      wiz      1527:          support, pkgsrc uses the <span><strong class="command">esound</strong></span> client/server
                   1528:          audio system on Interix.  Unlike on most platforms, the
1.91      rillig   1529:          <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.87      wiz      1530:          <span class="emphasis"><em>not</em></span> contain the <span><strong class="command">esd</strong></span>
                   1531:          server component.  To output audio via an Interix host, the
1.91      rillig   1532:          <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      1533:          must also be installed.</p>
1.75      rillig   1534: </li>
                   1535: <li>
                   1536: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
                   1537: <p>Direct device access is not currently supported in Interix, so it
1.87      wiz      1538:          is not currently possible to access CD/DVD drives, USB devices,
                   1539:          or SCSI devices through non-filesystem means.  Among other things,
                   1540:          this makes it impossible to use Interix directly for CD/DVD
                   1541:          burning.</p>
1.75      rillig   1542: </li>
                   1543: <li>
                   1544: <p><span class="strong"><strong>Tape drives:</strong></span></p>
                   1545: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1.87      wiz      1546:          drives are also not directly accessible in Interix.  However,
                   1547:          support is in work to make tape drive access possible by using
                   1548:          Cygwin as a bridge (similarly to audio bridged via Cygwin's
                   1549:          esound server).</p>
1.75      rillig   1550: </li>
                   1551: </ul></div>
                   1552: </div>
                   1553: <div class="sect3" lang="en">
                   1554: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1555: <a name="platform.interix-knownissues"></a>3.3.3.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.75      rillig   1556: <p>It is not necessary, in general, to have a "root" user on the
1.87      wiz      1557:        Windows system; any member of the local Administrators group will
                   1558:        suffice.  However, some packages currently assume that the user
                   1559:        named "root" is the privileged user.  To accommodate these, you
                   1560:        may create such a user; make sure it is in the local group
                   1561:        Administrators (or your language equivalent).</p>
                   1562: <p><span><strong class="command">pkg_add</strong></span> creates directories of mode
                   1563:        0755, not 0775, in <code class="filename">$PKG_DBDIR</code>.  For the
                   1564:        time being, install packages as the local Administrator (or
                   1565:        your language equivalent), or run the following command after
                   1566:        installing a package to work around the issue:</p>
1.75      rillig   1567: <pre class="screen">
1.87      wiz      1568: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
                   1569:        </pre>
1.75      rillig   1570: </div>
                   1571: </div>
                   1572: <div class="sect2" lang="en">
                   1573: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1574: <a name="irix"></a>3.3.4. IRIX</h3></div></div></div>
1.75      rillig   1575: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1.87      wiz      1576:       compiler (cc/c89).  Please set the <code class="varname">CC</code> environment variable
                   1577:       according to your preference.  If you do not have a license for the MIPSpro
                   1578:       compiler suite, you can download a gcc tardist file from <a href="http://freeware.sgi.com/" target="_top">http://freeware.sgi.com/</a>.</p>
1.75      rillig   1579: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.87      wiz      1580:       version of IRIX providing support for <a 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 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>,
                   1581:       etc.</p>
1.86      schwarz  1582: <p>At this point in time, pkgsrc only supports one ABI at a time.  That is, you cannot
1.75      rillig   1583:        switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI.  If
                   1584:        you start out using "abi=n32", that's what all your packages will be built
                   1585:        with.</p>
                   1586: <p>Therefore, please make sure that you have no conflicting
1.87      wiz      1587:       <code class="varname">CFLAGS</code> in your environment or the
                   1588:       <code class="filename">/etc/mk.conf</code>.  Particularly, make sure that you do not
                   1589:       try to link n32 object files with lib64 or vice versa.  Check your
                   1590:       <code class="filename">/etc/compiler.defaults</code>!</p>
1.75      rillig   1591: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1.87      wiz      1592:       please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
                   1593:       as it appears that IRIX linker occasionally runs into issues when trying to
                   1594:       link over a network-mounted file system.</p>
1.75      rillig   1595: <p>The bootstrapping process should set all the right options for programs such
1.87      wiz      1596:       as imake(1), but you may want to set some options depending on your local
                   1597:       setup.  Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
                   1598:       course, your compiler's man pages for details.</p>
1.75      rillig   1599: <p>If you are using SGI's MIPSPro compiler, please set
1.1       grant    1600: 
1.87      wiz      1601:       </p>
1.75      rillig   1602: <pre class="programlisting">
1.87      wiz      1603:        PKGSRC_COMPILER=        mipspro
                   1604:       </pre>
1.75      rillig   1605: <p>
1.1       grant    1606: 
1.87      wiz      1607:       in <code class="filename">/etc/mk.conf</code>.  Otherwise, pkgsrc will assume you
                   1608:       are using gcc and may end up passing invalid flags to the compiler.  Note that
                   1609:       bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
                   1610:       default.</p>
1.75      rillig   1611: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1.93      rillig   1612:       but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1.87      wiz      1613:       to <span class="emphasis"><em>not</em></span> include the location of gcc (often
                   1614:       <code class="filename">/usr/freeware/bin</code>), and (important) pass the
                   1615:       '--preserve-path' flag.</p>
1.75      rillig   1616: </div>
                   1617: <div class="sect2" lang="en">
                   1618: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1619: <a name="linux"></a>3.3.5. Linux</h3></div></div></div>
1.87      wiz      1620: <p>Some versions of Linux (for example Debian GNU/Linux) need
                   1621:       either libtermcap or libcurses (libncurses).  Installing the
                   1622:       distributions libncurses-dev package (or equivalent) should fix
                   1623:       the problem.</p>
                   1624: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
                   1625:       (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
                   1626:       i386 have been tested.</p>
1.75      rillig   1627: <p>To bootstrap using icc, assuming the default icc installation
1.87      wiz      1628:       directory:</p>
1.75      rillig   1629: <pre class="programlisting">
1.87      wiz      1630:        env CC=/opt/intel_cc_80/bin/icc LDFLAGS=-static-libcxa \
                   1631:        ac_cv___attribute__=yes ./bootstrap
                   1632:       </pre>
1.75      rillig   1633: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1634: <h3 class="title">Note</h3>
                   1635: <p>icc 8.1 needs the `-i-static' argument instead of -static-libcxa.</p>
                   1636: </div>
                   1637: <p>icc supports __attribute__, but the GNU configure test uses a nested
1.87      wiz      1638:       function, which icc does not support. #undef'ing __attribute__ has the
                   1639:       unfortunate side-effect of breaking many of the Linux header files, which
                   1640:       cannot be compiled properly without __attribute__. The test must be
                   1641:       overridden so that __attribute__ is assumed supported by the
                   1642:       compiler.</p>
1.75      rillig   1643: <p>After bootstrapping, you should set <code class="varname">PKGSRC_COMPILER</code>
1.87      wiz      1644:       in <code class="filename">/etc/mk.conf</code>:</p>
1.75      rillig   1645: <pre class="programlisting">
1.87      wiz      1646:        PKGSRC_COMPILER=        icc
                   1647:       </pre>
1.75      rillig   1648: <p>The default installation directory for icc is
1.87      wiz      1649:       <code class="filename">/opt/intel_cc_80</code>, which
                   1650:       is also the pkgsrc default. If you have installed it into a different
                   1651:       directory, set <code class="varname">ICCBASE</code> in
                   1652:       <code class="filename">/etc/mk.conf</code>:</p>
1.75      rillig   1653: <pre class="programlisting">
1.87      wiz      1654:        ICCBASE=                /opt/icc
                   1655:       </pre>
1.75      rillig   1656: <p>pkgsrc uses the static linking method of the runtime libraries
1.87      wiz      1657:       provided by icc, so binaries can be run on other systems which do not
                   1658:       have the shared libraries installed.</p>
                   1659: <p>Libtool, however, extracts a list of libraries from the
                   1660:       <a 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
                   1661:       records it, throwing away the -Bstatic and -Bdynamic options
                   1662:       interspersed between the libraries.  This means that
                   1663:       libtool-linked C++ shared libraries will have a runtime
                   1664:       dependency on the icc libraries until this is fixed in
                   1665:       libtool.</p>
1.75      rillig   1666: </div>
                   1667: <div class="sect2" lang="en">
                   1668: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1669: <a name="openbsd"></a>3.3.6. OpenBSD</h3></div></div></div>
1.75      rillig   1670: <p>OpenBSD 3.0 and 3.2 are tested and supported.</p>
                   1671: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87      wiz      1672:       with the OpenBSD userland tools. There are several steps:</p>
1.75      rillig   1673: <div class="orderedlist"><ol type="1">
                   1674: <li><p>OpenBSD stores its ports pkg database in
1.87      wiz      1675:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1676:          recommended that you choose a different location (e.g.
                   1677:          <code class="filename">/usr/pkgdb</code>) by
                   1678:          using the --pkgdbdir option to the bootstrap script.</p></li>
1.75      rillig   1679: <li>
                   1680: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1.87      wiz      1681:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1682: <pre class="screen">
                   1683: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75      rillig   1684: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1685: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1686: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87      wiz      1687: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1688:          </pre>
1.75      rillig   1689: </li>
                   1690: <li>
1.76      rillig   1691: <p>An example <code class="filename">/etc/mk.conf</code> file will be placed in
1.87      wiz      1692:          <code class="filename">/etc/mk.conf.example</code> file
                   1693:          when you use the bootstrap script. OpenBSD's make program uses
                   1694:          <code class="filename">/etc/mk.conf</code>
                   1695:          as well. You can work around this by enclosing all the pkgsrc-specific parts
                   1696:          of the file with:</p>
                   1697: <pre class="programlisting">
                   1698:            .ifdef BSD_PKG_MK
                   1699:            # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
                   1700:            .else
                   1701:            # OpenBSD stuff
                   1702:            .endif
                   1703:          </pre>
1.75      rillig   1704: </li>
                   1705: </ol></div>
                   1706: </div>
                   1707: <div class="sect2" lang="en">
                   1708: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1709: <a name="solaris"></a>3.3.7. Solaris</h3></div></div></div>
1.75      rillig   1710: <p>Solaris 2.6 through 9 are supported on both x86 and sparc.
1.87      wiz      1711:       You will need a working C compiler. Both gcc 2.95.3 and
                   1712:       Sun WorkShop 5 have been tested.</p>
1.75      rillig   1713: <p>The following packages are required on Solaris 8 for the bootstrap
1.87      wiz      1714:       process and to build packages.</p>
1.75      rillig   1715: <div class="itemizedlist"><ul type="disc">
                   1716: <li><p>SUNWsprot</p></li>
                   1717: <li><p>SUNWarc</p></li>
                   1718: <li><p>SUNWbtool</p></li>
                   1719: <li><p>SUNWtoo</p></li>
                   1720: <li><p>SUNWlibm</p></li>
                   1721: </ul></div>
1.78      rillig   1722: <p>Please note that the use of GNU binutils on Solaris is
1.87      wiz      1723:       <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1.75      rillig   1724: <p>Whichever compiler you use, please ensure the compiler tools and
1.87      wiz      1725:       your $prefix are in your <code class="varname">PATH</code>. This includes
                   1726:       <code class="filename">/usr/ccs/{bin,lib}</code>
                   1727:       and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.75      rillig   1728: <div class="sect3" lang="en">
                   1729: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1730: <a name="solaris-gcc-note"></a>3.3.7.1. If you are using gcc</h4></div></div></div>
1.75      rillig   1731: <p>It makes life much simpler if you only use the same gcc consistently
1.87      wiz      1732:        for building all packages.</p>
1.75      rillig   1733: <p>It is recommended that an external gcc be used only for bootstrapping,
1.87      wiz      1734:        then either build gcc from
1.91      rillig   1735:        <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      1736:        package, then remove gcc used during bootstrapping.</p>
1.93      rillig   1737: <p>Binary packages of gcc can be found through <a href="http://www.sunfreeware.com/" target="_top">http://www.sunfreeware.com/</a>.</p>
1.75      rillig   1738: </div>
                   1739: <div class="sect3" lang="en">
                   1740: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1741: <a name="solaris-sun-workshop-note"></a>3.3.7.2. If you are using Sun WorkShop</h4></div></div></div>
1.75      rillig   1742: <p>You will need at least the following packages installed (from WorkShop
1.87      wiz      1743:        5.0)</p>
1.75      rillig   1744: <div class="itemizedlist"><ul type="disc">
                   1745: <li><p>SPROcc
1.87      wiz      1746:          - Sun WorkShop Compiler C 5.0</p></li>
1.75      rillig   1747: <li><p>SPROcpl
1.87      wiz      1748:          - Sun WorkShop Compiler C++ 5.0</p></li>
1.75      rillig   1749: <li><p>SPROild
1.87      wiz      1750:          - Sun WorkShop Incremental Linker</p></li>
1.75      rillig   1751: <li><p>SPROlang
1.87      wiz      1752:          - Sun WorkShop Compilers common components</p></li>
1.75      rillig   1753: </ul></div>
1.96      rillig   1754: <p>You should set the following variables in your
                   1755:        <code class="filename">mk.conf</code> file:</p>
                   1756: <pre class="programlisting">
                   1757:     CC=     cc
                   1758:     CXX=    CC
                   1759:     CPP=    cc -E
                   1760:     CXXCPP= CC -E
                   1761: </pre>
                   1762: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1763: <h3 class="title">Note</h3>
                   1764: <p>The <code class="varname">CPP</code> setting might break some
                   1765:        packages that use the C preprocessor for processing things other
                   1766:        than C source code.</p>
                   1767: </div>
1.75      rillig   1768: </div>
                   1769: <div class="sect3" lang="en">
                   1770: <div class="titlepage"><div><div><h4 class="title">
1.93      rillig   1771: <a name="solaris-sunpro-64"></a>3.3.7.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.96      rillig   1772: <p>To build 64-bit packages, you just need to have the
                   1773:        following lines in your <code class="filename">mk.conf</code>
1.75      rillig   1774:        file:</p>
                   1775: <pre class="programlisting">
1.96      rillig   1776:     PKGSRC_COMPILER=        sunpro
                   1777:     ABI=                    64
                   1778: </pre>
                   1779: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1780: <h3 class="title">Note</h3>
                   1781: <p>This setting has been tested for the SPARC
                   1782:        architecture. Intel and AMD machines need some more
                   1783:        work.</p>
                   1784: </div>
1.75      rillig   1785: </div>
                   1786: <div class="sect3" lang="en">
                   1787: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1788: <a name="plat.sunos.problems"></a>3.3.7.4. Common problems</h4></div></div></div>
1.75      rillig   1789: <p>Sometimes, when using <span><strong class="command">libtool</strong></span>,
1.87      wiz      1790:       <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
                   1791:       The workaround is to use another shell for the configure
1.91      rillig   1792:       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.87      wiz      1793:       to your <code class="filename">mk.conf</code>:</p>
                   1794: <pre class="programlisting">
                   1795:        CONFIG_SHELL=   ${LOCALBASE}/bin/bash
                   1796:        WRAPPER_SHELL=  ${LOCALBASE}/bin/bash
                   1797:       </pre>
1.91      rillig   1798: <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   1799: </div>
                   1800: </div>
                   1801: </div>
                   1802: </div>
                   1803: <div class="chapter" lang="en">
                   1804: <div class="titlepage"><div><div><h2 class="title">
                   1805: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
                   1806: <div class="toc">
                   1807: <p><b>Table of Contents</b></p>
                   1808: <dl>
                   1809: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                   1810: <dd><dl>
                   1811: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                   1812: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig   1813: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                   1814: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                   1815: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                   1816: <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>
                   1817: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                   1818: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75      rillig   1819: </dl></dd>
                   1820: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                   1821: <dd><dl>
                   1822: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                   1823: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                   1824: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                   1825: </dl></dd>
                   1826: </dl>
                   1827: </div>
                   1828: <p>Basically, there are two ways of using pkgsrc. The first
1.88      wiz      1829: is to only install the package tools and to use binary packages
                   1830: that someone else has prepared. This is the &#8220;<span class="quote">pkg</span>&#8221;
                   1831: in pkgsrc. The second way is to install the &#8220;<span class="quote">src</span>&#8221;
                   1832: of pkgsrc, too. Then you are able to build your own packages,
                   1833: and you can still use binary packages from someone else.</p>
1.75      rillig   1834: <div class="sect1" lang="en">
                   1835: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1836: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
                   1837: <p>To use binary packages, you need some tools to manage
1.88      wiz      1838:   them. On NetBSD, these tools are already installed. On all other
                   1839:   operating systems, you need to install them first. For the
                   1840:   following platforms, prebuilt versions of the package tools
                   1841:   are available and can simply be downloaded and unpacked in the
                   1842:   <code class="filename">/</code> directory:</p>
1.75      rillig   1843: <div class="informaltable">
                   1844: <a name="binary-bootstrap-kits"></a><table border="1">
                   1845: <colgroup>
                   1846: <col>
                   1847: <col>
                   1848: </colgroup>
                   1849: <thead><tr>
                   1850: <th>Platform</th>
                   1851: <th>URL</th>
                   1852: </tr></thead>
                   1853: <tbody>
                   1854: <tr>
                   1855: <td>Solaris 9</td>
1.76      rillig   1856: <td><code class="filename">ftp://ftp0.mh.bbc.co.uk/pub/pkgsrc/packages/bootstrap-pkgsrc/</code></td>
1.75      rillig   1857: </tr>
                   1858: <tr>
                   1859: <td>Solaris 10</td>
1.76      rillig   1860: <td><code class="filename">http://public.enst.fr/pkgsrc/packages/bootstrap-pkgsrc/</code></td>
1.75      rillig   1861: </tr>
                   1862: </tbody>
                   1863: </table>
                   1864: </div>
1.82      rillig   1865: <p>These pre-built package tools use
1.88      wiz      1866:   <code class="filename">/usr/pkg</code> for the base directory, and
                   1867:   <code class="filename">/var/db/pkg</code> for the database of installed
                   1868:   packages. If you cannot use these directories for whatever
                   1869:   reasons (maybe because you're not root), you have to build the
                   1870:   package tools yourself, which is explained in <a href="#bootstrapping-pkgsrc" title="3.2. Bootstrapping pkgsrc">Section 3.2, &#8220;Bootstrapping pkgsrc&#8221;</a>.</p>
1.75      rillig   1871: <div class="sect2" lang="en">
                   1872: <div class="titlepage"><div><div><h3 class="title">
                   1873: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
                   1874: <p>To install binary packages, you first need to know from
1.88      wiz      1875:     where to get them. You can get them on CD-ROMs, DVDs, or via FTP
                   1876:     or HTTP.</p>
1.81      rillig   1877: <p>The binary packages can be found at the following
1.88      wiz      1878:     locations.</p>
1.75      rillig   1879: <div class="informaltable">
                   1880: <a name="binary-packages"></a><table border="1">
                   1881: <colgroup>
                   1882: <col>
                   1883: <col>
                   1884: </colgroup>
                   1885: <thead><tr>
                   1886: <th>Platform</th>
                   1887: <th>URL</th>
                   1888: </tr></thead>
                   1889: <tbody>
                   1890: <tr>
1.81      rillig   1891: <td>NetBSD</td>
                   1892: <td><code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/</code></td>
                   1893: </tr>
                   1894: <tr>
1.75      rillig   1895: <td>Solaris 9</td>
1.76      rillig   1896: <td><code class="filename">ftp://ftp0.mh.bbc.co.uk/pub/pkgsrc/packages/</code></td>
1.75      rillig   1897: </tr>
                   1898: <tr>
                   1899: <td>Solaris 10</td>
1.76      rillig   1900: <td><code class="filename">http://public.enst.fr/pkgsrc/packages/</code></td>
1.75      rillig   1901: </tr>
                   1902: </tbody>
                   1903: </table>
                   1904: </div>
1.81      rillig   1905: <p>Most of these directories contain binary packages for
1.88      wiz      1906:     multiple platforms. Select the appropriate subdirectories,
                   1907:     according to your machine architecture and operating system,
                   1908:     until you find a directory called <code class="filename">All</code>. This
                   1909:     directory contains all the binary packages. Further, there are
                   1910:     subdirectories for categories that contain symbolic links that
                   1911:     point to the actual binary package in
                   1912:     <code class="filename">../All</code>. This directory layout is used for
                   1913:     all package repositories, no matter if they are accessed via
                   1914:     HTTP, FTP, NFS, CD-ROM, or the local filesystem.</p>
1.75      rillig   1915: </div>
                   1916: <div class="sect2" lang="en">
                   1917: <div class="titlepage"><div><div><h3 class="title">
                   1918: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.87      wiz      1919: <p>If you have the files on a CD-ROM or downloaded them to
1.88      wiz      1920:     your hard disk, you can install them with the following command
                   1921:     (be sure to <span><strong class="command">su</strong></span> to root first):</p>
1.75      rillig   1922: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add /path/to/package.tgz</code></strong></pre>
1.87      wiz      1923: <p>If you have FTP access and you don't want to download the
1.88      wiz      1924:     packages via FTP prior to installation, you can do this
                   1925:     automatically by giving <span><strong class="command">pkg_add</strong></span> an FTP URL:</p>
1.82      rillig   1926: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add ftp://ftp.NetBSD.org/pub/NetBSD/packages/&lt;OSVERSION&gt;/&lt;ARCH&gt;/All/package</code></strong></pre>
1.75      rillig   1927: <p>Note that any prerequisite packages needed to run the
1.88      wiz      1928:     package in question will be installed, too, assuming they are
                   1929:     present where you install from.</p>
1.75      rillig   1930: <p>To save some typing, you can set the
1.88      wiz      1931:     <code class="varname">PKG_PATH</code> environment variable to a semicolon-separated
                   1932:     list of paths (including remote URLs); trailing slashes are not allowed.
                   1933:     </p>
1.76      rillig   1934: <p>Additionally to the <code class="filename">All</code> directory
1.88      wiz      1935:     there exists a <code class="filename">vulnerable</code> directory to
                   1936:     which binary packages with known vulnerabilities are
                   1937:     moved, since removing them could cause missing dependencies. To
                   1938:     use these packages, add the <code class="filename">vulnerable</code>
                   1939:     directory to your <code class="varname">PKG_PATH</code>. However, you should run
1.91      rillig   1940:     <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> regularly,
1.88      wiz      1941:     especially after installing new packages, and verify that the
                   1942:     vulnerabilities are acceptable for your configuration. An example
                   1943:     <code class="varname">PKG_PATH</code> would be:
                   1944:     <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/&lt;OSVERSION&gt;/&lt;ARCH&gt;/All;ftp://ftp.NetBSD.org/pub/NetBSD/packages/&lt;OSVERSION&gt;/&lt;ARCH&gt;/vulnerable</code>
                   1945:     Please note that semicolon (';') is a shell meta-character, so
                   1946:     you'll probably have to quote it.</p>
1.75      rillig   1947: <p>After you've installed packages, be sure to have
1.88      wiz      1948:     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
                   1949:     <code class="varname">PATH</code> so you can actually start the just
                   1950:     installed program.</p>
1.75      rillig   1951: </div>
                   1952: <div class="sect2" lang="en">
                   1953: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1954: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
                   1955: <p>To deinstall a package, it does not matter whether it was
1.88      wiz      1956:     installed from source code or from a binary package. The
                   1957:     <span><strong class="command">pkg_delete</strong></span> command does not know it anyway.
                   1958:     To delete a package, you can just run <span><strong class="command">pkg_delete
                   1959:     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
                   1960:     name can be given with or without version number. Wildcards can
                   1961:     also be used to deinstall a set of packages, for example
                   1962:     <code class="literal">*emacs*</code>. Be sure to include them in quotes,
                   1963:     so that the shell does not expand them before
                   1964:     <code class="literal">pkg_delete</code> sees them.</p>
1.82      rillig   1965: <p>The <code class="option">-r</code> option is very powerful: it
1.88      wiz      1966:     removes all the packages that require the package in question
                   1967:     and then removes the package itself. For example:
1.82      rillig   1968: 
1.88      wiz      1969:     </p>
1.82      rillig   1970: <pre class="screen">
1.88      wiz      1971: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
                   1972:     </pre>
1.82      rillig   1973: <p>
                   1974: 
1.88      wiz      1975:     will remove jpeg and all the packages that used it; this allows
                   1976:     upgrading the jpeg package.</p>
1.82      rillig   1977: </div>
                   1978: <div class="sect2" lang="en">
                   1979: <div class="titlepage"><div><div><h3 class="title">
                   1980: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
                   1981: <p>The <span><strong class="command">pkg_info</strong></span> shows information about
1.88      wiz      1982:     installed packages or binary package files.</p>
1.82      rillig   1983: </div>
                   1984: <div class="sect2" lang="en">
                   1985: <div class="titlepage"><div><div><h3 class="title">
                   1986: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
                   1987: <p>
1.88      wiz      1988:       The NetBSD Security-Officer and Packages Groups maintain a list of
                   1989:       known security vulnerabilities to packages which are (or have been)
                   1990:       included in pkgsrc.  The list is available from the NetBSD
                   1991:       FTP site at <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
                   1992:     </p>
1.82      rillig   1993: <p>
1.93      rillig   1994:       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      1995:       this list can be downloaded
                   1996:       automatically, and a security audit of all packages installed on a system
                   1997:       can take place.
                   1998:     </p>
1.82      rillig   1999: <p>
1.93      rillig   2000:       There are two components to
1.91      rillig   2001:       <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      2002:       component, &#8220;<span class="quote">download-vulnerability-list</span>&#8221;, is for downloading
                   2003:       the list of vulnerabilities from the NetBSD FTP site.  The second
                   2004:       component, &#8220;<span class="quote">audit-packages</span>&#8221;, checks to see if any of your
                   2005:       installed packages are vulnerable.  If a package is vulnerable, you
                   2006:       will see output similar to the following:
                   2007:     </p>
1.82      rillig   2008: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88      wiz      2009:     http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82      rillig   2010: <p>
1.91      rillig   2011:       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.88      wiz      2012:       <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
                   2013:       file daily, and include a package audit in the daily security script.
                   2014:       Details on this are located in the <a 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   2015:       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      2016:     </p>
1.82      rillig   2017: </div>
                   2018: <div class="sect2" lang="en">
                   2019: <div class="titlepage"><div><div><h3 class="title">
                   2020: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
                   2021: <p>
1.93      rillig   2022:       Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a> and run
1.88      wiz      2023:       <span><strong class="command">lintpkgsrc</strong></span> with the &#8220;<span class="quote">-i</span>&#8221;
                   2024:       argument to check if your packages are up-to-date, e.g.
                   2025:     </p>
                   2026: <pre class="screen">
                   2027: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82      rillig   2028: ...
1.88      wiz      2029: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   2030:     </pre>
1.82      rillig   2031: <p>You can then use <span><strong class="command">make update</strong></span> to update the
1.88      wiz      2032:     package on your system and rebuild any dependencies.
                   2033:     </p>
1.82      rillig   2034: </div>
                   2035: <div class="sect2" lang="en">
                   2036: <div class="titlepage"><div><div><h3 class="title">
                   2037: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
                   2038: <p>The <span><strong class="command">pkg_admin</strong></span> executes various
1.88      wiz      2039:     administrative functions on the package system.</p>
1.82      rillig   2040: </div>
                   2041: <div class="sect2" lang="en">
                   2042: <div class="titlepage"><div><div><h3 class="title">
                   2043: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1.75      rillig   2044: <p>Please pay very careful attention to the warnings
1.88      wiz      2045:     expressed in the <a 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
                   2046:     inherent dangers of installing binary packages which you did
                   2047:     not create yourself, and the security holes that can be
                   2048:     introduced onto your system by indiscriminate adding of such
                   2049:     files.</p>
1.75      rillig   2050: <p>The same warning of course applies to every package you
1.88      wiz      2051:     install from source when you haven't completely read and
                   2052:     understood the source code of the package, the compiler that
                   2053:     is used to build the package and all the other tools that are
                   2054:     involved.</p>
1.75      rillig   2055: </div>
                   2056: </div>
                   2057: <div class="sect1" lang="en">
                   2058: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2059: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88      wiz      2060: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
                   2061:   directory now contains a set of packages, organized into
                   2062:   categories. You can browse the online index of packages, or run
                   2063:   <span><strong class="command">make readme</strong></span> from the <code class="filename">pkgsrc</code>
                   2064:   directory to build local <code class="filename">README.html</code> files for
1.91      rillig   2065:   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      2066: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
                   2067:   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
                   2068:   should do so by setting <code class="varname">LOCALBASE</code> in
                   2069:   <code class="filename">mk.conf</code>. You should not try to use multiple
                   2070:   different <code class="varname">LOCALBASE</code> definitions on the same
                   2071:   system (inside a chroot is an exception). </p>
                   2072: <p>The rest of this chapter assumes that the package is already
                   2073:   in pkgsrc. If it is not, see <a href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, &#8220;The pkgsrc developer's guide&#8221;</a> for
                   2074:   instructions how to create your own packages.</p>
1.75      rillig   2075: <div class="sect2" lang="en">
                   2076: <div class="titlepage"><div><div><h3 class="title">
                   2077: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82      rillig   2078: <p>To build packages from source, you need a working C
1.88      wiz      2079:     compiler. On NetBSD, you need to install the
                   2080:     &#8220;<span class="quote">comp</span>&#8221; and the &#8220;<span class="quote">text</span>&#8221; distribution
                   2081:     sets. If you want to build X11-related packages, the
                   2082:     &#8220;<span class="quote">xbase</span>&#8221; and &#8220;<span class="quote">xcomp</span>&#8221; distribution
                   2083:     sets are required, too.</p>
1.75      rillig   2084: </div>
                   2085: <div class="sect2" lang="en">
                   2086: <div class="titlepage"><div><div><h3 class="title">
                   2087: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
                   2088: <p>The first step for building a package is downloading the
1.88      wiz      2089:     distfiles (i.e. the unmodified source). If they have not yet been
                   2090:     downloaded, pkgsrc will fetch them automatically.</p>
                   2091: <p>If you have all files that you need in the
                   2092:     <code class="filename">distfiles</code> directory,
                   2093:     you don't need to connect. If the distfiles are on CD-ROM, you can
                   2094:     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
                   2095:     </p>
1.82      rillig   2096: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
                   2097: <p>
1.88      wiz      2098:     to your <code class="filename">mk.conf</code>.</p>
1.91      rillig   2099: <p>By default a list of distribution sites will be randomly
                   2100:     intermixed to prevent huge load on servers which holding popular
                   2101:     packages (for example, SourceForge.net mirrors). Thus, every
                   2102:     time when you need to fetch yet another distfile all the mirrors
                   2103:     will be tried in new (random) order. You can turn this feature
                   2104:     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
                   2105:     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88      wiz      2106: <p>You can overwrite some of the major distribution sites to
                   2107:     fit to sites that are close to your own.  By setting one or two
                   2108:     variables you can modify the order in which the master sites are
                   2109:     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
                   2110:     delimited list of domain suffixes.
                   2111:     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
                   2112:     contains a whitespace delimited list of regular expressions.  It
                   2113:     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
                   2114:     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
                   2115:     some examples.  This may save some of your bandwidth and
                   2116:     time.</p>
1.75      rillig   2117: <p>You can change these settings either in your shell's environment, or,
1.88      wiz      2118:     if you want to keep the settings, by editing the
                   2119:     <code class="filename">/etc/mk.conf</code> file,
                   2120:     and adding the definitions there.</p>
1.82      rillig   2121: <p>
1.88      wiz      2122:       If a package depends on many other packages (such as
1.93      rillig   2123:       <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      2124:       alternate between periods of
                   2125:       downloading source, and compiling. To ensure you have all the source
                   2126:       downloaded initially you can run the command:
                   2127:       </p>
1.82      rillig   2128: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
                   2129: <p>
1.88      wiz      2130:       which will output and run a set of shell commands to fetch the
                   2131:       necessary files into the <code class="filename">distfiles</code> directory.  You can
                   2132:       also choose to download the files manually.
                   2133:     </p>
1.75      rillig   2134: </div>
                   2135: <div class="sect2" lang="en">
                   2136: <div class="titlepage"><div><div><h3 class="title">
                   2137: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82      rillig   2138: <p>
1.88      wiz      2139:       Once the software has downloaded, any patches will be applied, then it
                   2140:       will be compiled for you. This may take some time depending on your
                   2141:       computer, and how many other packages the software depends on and their
                   2142:       compile time.
                   2143:     </p>
1.75      rillig   2144: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2145: <h3 class="title">Note</h3>
                   2146: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.88      wiz      2147:     use the pkgsrc <span><strong class="command">bmake</strong></span> command instead of
                   2148:     &#8220;<span class="quote">make</span>&#8221; in the examples in this guide.</p>
1.75      rillig   2149: </div>
1.87      wiz      2150: <p>For example, type</p>
1.88      wiz      2151: <pre class="screen">
                   2152: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2153: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   2154:     </pre>
1.75      rillig   2155: <p>at the shell prompt to build the various components of the
1.88      wiz      2156:     package.</p>
1.82      rillig   2157: <p>The next stage is to actually install the newly compiled
1.88      wiz      2158:     program onto your system. Do this by entering:
1.82      rillig   2159: 
1.88      wiz      2160:     </p>
1.82      rillig   2161: <pre class="screen">
1.88      wiz      2162: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
                   2163:     </pre>
1.82      rillig   2164: <p>
                   2165: 
1.88      wiz      2166:     while you are still in the directory for whatever package you
                   2167:     are installing.</p>
1.82      rillig   2168: <p>Installing the package on your system may require you to
1.88      wiz      2169:     be root.  However, pkgsrc has a
                   2170:     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
                   2171:     to only become root for the actual installation step.</p>
1.82      rillig   2172: <p>That's it, the software should now be installed and setup for use.
1.88      wiz      2173:     You can now enter:
1.82      rillig   2174: 
1.88      wiz      2175:     </p>
1.82      rillig   2176: <pre class="screen">
1.88      wiz      2177: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
                   2178:     </pre>
1.82      rillig   2179: <p>
                   2180: 
1.88      wiz      2181:     to remove the compiled files in the work directory, as you shouldn't need
                   2182:     them any more. If other packages were also added to your system
                   2183:     (dependencies) to allow your program to compile, you can tidy these up
                   2184:     also with the command:</p>
1.82      rillig   2185: <pre class="screen">
1.88      wiz      2186: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
                   2187:     </pre>
1.75      rillig   2188: <p>Taking the figlet utility as an example, we can install it on our
1.88      wiz      2189:     system by building as shown in <a href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
                   2190: <p>The program is installed under the default root of the
                   2191:     packages tree - <code class="filename">/usr/pkg</code>. Should this not
                   2192:     conform to your tastes, set the <code class="varname">LOCALBASE</code>
                   2193:     variable in your environment, and it will use that value as the
                   2194:     root of your packages tree. So, to use
                   2195:     <code class="filename">/usr/local</code>, set
                   2196:     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
                   2197:     Please note that you should use a directory which is dedicated to
                   2198:     packages and not shared with other programs (i.e., do not try and
                   2199:     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
                   2200:     to add any of your own files or directories (such as
                   2201:     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
                   2202:     <code class="filename">pkgsrc/</code>) below the
                   2203:     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
                   2204:     conflicts between programs and other files installed by the
                   2205:     package system and whatever else may have been installed
                   2206:     there.</p>
                   2207: <p>Some packages look in <code class="filename">/etc/mk.conf</code> to
                   2208:     alter some configuration options at build time.  Have a look at
                   2209:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
                   2210:     of what will be set there by default.  Environment variables such
                   2211:     as <code class="varname">LOCALBASE</code> can be set in
                   2212:     <code class="filename">/etc/mk.conf</code> to save having to remember to
                   2213:     set them each time you want to use pkgsrc.</p>
                   2214: <p>Occasionally, people want to &#8220;<span class="quote">look under the
                   2215:     covers</span>&#8221; to see what is going on when a package is building
                   2216:     or being installed. This may be for debugging purposes, or out of
                   2217:     simple curiosity. A number of utility values have been added to
                   2218:     help with this.</p>
1.75      rillig   2219: <div class="orderedlist"><ol type="1">
                   2220: <li>
1.88      wiz      2221: <p>If you invoke the <a 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
                   2222:        <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
                   2223:        information will be displayed. For example,</p>
1.75      rillig   2224: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88      wiz      2225: <p>will show all the commands that are invoked, up to and
                   2226:        including the &#8220;<span class="quote">patch</span>&#8221; stage.</p>
1.75      rillig   2227: </li>
                   2228: <li>
1.88      wiz      2229: <p>If you want to know the value of a certain <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
                   2230:        definition, then the <code class="varname">VARNAME</code> definition
                   2231:        should be used, in conjunction with the show-var
                   2232:        target. e.g. to show the expansion of the <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
                   2233:        variable <code class="varname">LOCALBASE</code>:</p>
                   2234: <pre class="screen">
                   2235: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75      rillig   2236: /usr/pkg
                   2237: <code class="prompt">%</code>
1.88      wiz      2238:        </pre>
1.75      rillig   2239: </li>
                   2240: </ol></div>
                   2241: <p>If you want to install a binary package that you've either
1.88      wiz      2242:     created yourself (see next section), that you put into
                   2243:     pkgsrc/packages manually or that is located on a remote FTP
                   2244:     server, you can use the "bin-install" target. This target will
                   2245:     install a binary package - if available - via <a 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>,
                   2246:     else do a <span><strong class="command">make package</strong></span>.  The list of remote FTP
                   2247:     sites searched is kept in the variable
                   2248:     <code class="varname">BINPKG_SITES</code>, which defaults to
                   2249:     ftp.NetBSD.org. Any flags that should be added to <a 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>
                   2250:     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
                   2251:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
                   2252:     details.</p>
                   2253: <p>A final word of warning: If you set up a system that has a
                   2254:     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
                   2255:     set that before any packages are installed, as you cannot use
                   2256:     several directories for the same purpose. Doing so will result in
                   2257:     pkgsrc not being able to properly detect your installed packages,
                   2258:     and fail miserably. Note also that precompiled binary packages are
                   2259:     usually built with the default <code class="varname">LOCALBASE</code> of
                   2260:     <code class="filename">/usr/pkg</code>, and that you should
                   2261:     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
                   2262:     <code class="varname">LOCALBASE</code>.</p>
1.75      rillig   2263: </div>
                   2264: </div>
                   2265: </div>
                   2266: <div class="chapter" lang="en">
                   2267: <div class="titlepage"><div><div><h2 class="title">
                   2268: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
                   2269: <div class="toc">
                   2270: <p><b>Table of Contents</b></p>
                   2271: <dl>
                   2272: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                   2273: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.78      rillig   2274: <dt><span class="sect1"><a href="#conf.compiler">5.3. Selecting and configuring the compiler</a></span></dt>
1.88      wiz      2275: <dd><dl>
1.89      rillig   2276: <dt><span class="sect2"><a href="#selecting-the-compiler">5.3.1. Selecting the compiler</a></span></dt>
                   2277: <dt><span class="sect2"><a href="#conf.cflags">5.3.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                   2278: <dt><span class="sect2"><a href="#conf.ldflags">5.3.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz      2279: </dl></dd>
1.78      rillig   2280: <dt><span class="sect1"><a href="#developer-advanced-settings">5.4. Developer/advanced settings</a></span></dt>
                   2281: <dt><span class="sect1"><a href="#selecting-build-options">5.5. Selecting Build Options</a></span></dt>
1.75      rillig   2282: </dl>
                   2283: </div>
1.89      rillig   2284: <p>The whole pkgsrc system is configured in a single file, usually
                   2285: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
                   2286: that file depends on the installation. On NetBSD, when you use
                   2287: <a 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
                   2288: <code class="filename">/etc/</code>. In all other cases the default location is
                   2289: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
                   2290: bootstrap program to install the binary packages.</p>
                   2291: <p>During the bootstrap, an example configuration file is created. To
                   2292: use that, you have to create the directory
                   2293: <code class="filename">${PREFIX}/etc</code> and copy the example file
                   2294: there.</p>
                   2295: <p>The format of the configuration file is that of the usual
                   2296: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
                   2297: is done by setting variables in this file. Note that you can define all
                   2298: kinds of variables, and no special error checking (for example for
                   2299: spelling mistakes) takes place, so you have to try it out to see if it
                   2300: works.</p>
1.75      rillig   2301: <div class="sect1" lang="en">
                   2302: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2303: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
                   2304: <p>In this section, you can find some variables that apply to all
1.89      rillig   2305:     pkgsrc packages. A complete list of the variables that can be
                   2306:     configured by the user is available in
                   2307:     <code class="filename">mk/defaults/mk.conf</code>, together with some
                   2308:     comments that describe each variable's intent.</p>
1.75      rillig   2309: <div class="itemizedlist"><ul type="disc">
                   2310: <li><p><code class="varname">LOCALBASE</code>: Where
                   2311:            packages will be installed. The default is
1.76      rillig   2312:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75      rillig   2313:            with different <code class="varname">LOCALBASE</code>s!</p></li>
                   2314: <li><p><code class="varname">CROSSBASE</code>: Where
                   2315:            &#8220;<span class="quote">cross</span>&#8221; category packages will be
                   2316:            installed. The default is
1.76      rillig   2317:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.75      rillig   2318: <li><p><code class="varname">X11BASE</code>: Where
                   2319:            X11 is installed on the system. The default is
1.76      rillig   2320:            <code class="filename">/usr/X11R6</code>.</p></li>
1.75      rillig   2321: <li><p><code class="varname">DISTDIR</code>: Where to store the
                   2322:            downloaded copies of the original source distributions used
                   2323:            for building pkgsrc packages. The default is
1.76      rillig   2324:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.97    ! rillig   2325: <li><p><code class="varname">PKG_DBDIR</code>: Where the
        !          2326:            database about installed packages is stored.  The default is
        !          2327:            <code class="filename">/var/db/pkg</code>.</p></li>
1.75      rillig   2328: <li><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
                   2329:            If set, override the packages'
                   2330:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
                   2331: <li><p><code class="varname">MASTER_SITE_BACKUP</code>:
                   2332:            Backup location(s) for distribution files and patch files
                   2333:            if not found locally or in
1.76      rillig   2334:            <code class="filename">${MASTER_SITES}</code> or
                   2335:            <code class="filename">${PATCH_SITES}</code> respectively.
1.75      rillig   2336:            The defaults are
1.76      rillig   2337:            <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}/</code>
1.75      rillig   2338:            and
1.76      rillig   2339:            <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.75      rillig   2340: <li><p><code class="varname">BINPKG_SITES</code>:
1.93      rillig   2341:            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
                   2342:            <em class="replaceable"><code>arch</code></em> are replaced with OS
                   2343:            release (&#8220;<span class="quote">2.0</span>&#8221;, etc.) and architecture
                   2344:            (&#8220;<span class="quote">mipsel</span>&#8221;, etc.).</p></li>
1.82      rillig   2345: <li><p><code class="varname">ACCEPTABLE_LICENSES</code>:
                   2346:            List of acceptable licenses. Whenever you try to build a package
                   2347:            whose license is not in this list, you will get an error message
                   2348:            that includes instructions on how to change this variable.</p></li>
1.75      rillig   2349: </ul></div>
                   2350: </div>
                   2351: <div class="sect1" lang="en">
                   2352: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2353: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
                   2354: <p>XXX
                   2355:       </p>
                   2356: <div class="itemizedlist"><ul type="disc">
                   2357: <li><p><code class="varname">PACKAGES</code>: The top level
                   2358:            directory for the binary packages. The default is
1.76      rillig   2359:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.75      rillig   2360: <li><p><code class="varname">WRKOBJDIR</code>:
                   2361:            The top level directory where, if defined, the separate
                   2362:            working directories will get created, and symbolically
1.76      rillig   2363:            linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75      rillig   2364:            This is useful for building packages on several
1.76      rillig   2365:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                   2366:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75      rillig   2367:            is local to every architecture. (It should be noted that
                   2368:            <code class="varname">PKGSRCDIR</code> should not be set by the user
1.89      rillig   2369:            &mdash; it is an internal definition which refers to the
1.75      rillig   2370:            root of the pkgsrc tree. It is possible to have many
                   2371:            pkgsrc tree instances.)</p></li>
                   2372: <li><p><code class="varname">LOCALPATCHES</code>:
                   2373:            Directory for local patches that aren't part of pkgsrc.
1.90      rillig   2374:            See <a href="#components.patches" title="10.3. patches/*">Section 10.3, &#8220;patches/*&#8221;</a> for more
1.93      rillig   2375:            information.</p></li>
1.75      rillig   2376: <li><p><code class="varname">PKGMAKECONF</code>: Location of
1.76      rillig   2377:            the <code class="filename">mk.conf</code> file used by a package's
1.75      rillig   2378:            BSD-style Makefile. If this is not set,
                   2379:            <code class="varname">MAKECONF</code> is set to
1.76      rillig   2380:            <code class="filename">/dev/null</code> to avoid picking up
                   2381:            settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.82      rillig   2382: <li><p><code class="varname">DEPENDS_TARGET</code>:
                   2383:            By default, dependencies are only installed, and no binary
                   2384:            package is created for them. You can set this variable to
                   2385:            <code class="literal">package</code> to automatically create binary
                   2386:            packages after installing dependencies.</p></li>
1.75      rillig   2387: </ul></div>
                   2388: </div>
                   2389: <div class="sect1" lang="en">
                   2390: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.78      rillig   2391: <a name="conf.compiler"></a>5.3. Selecting and configuring the compiler</h2></div></div></div>
                   2392: <div class="sect2" lang="en">
                   2393: <div class="titlepage"><div><div><h3 class="title">
1.89      rillig   2394: <a name="selecting-the-compiler"></a>5.3.1. Selecting the compiler</h3></div></div></div>
                   2395: <p>By default, pkgsrc will use GCC to build packages.  This may be
                   2396:     overridden by setting the following variables in /etc/mk.conf:</p>
                   2397: <div class="variablelist"><dl>
                   2398: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
                   2399: <dd>
                   2400: <p>This is a list of values specifying the chain of
                   2401:          compilers to invoke when building packages.  Valid values
                   2402:          are:</p>
                   2403: <div class="itemizedlist"><ul type="disc">
                   2404: <li><p><code class="varname">distcc</code>:
                   2405:            distributed C/C++ (chainable)</p></li>
                   2406: <li><p><code class="varname">ccache</code>:
                   2407:            compiler cache (chainable)</p></li>
                   2408: <li><p><code class="varname">gcc</code>:
                   2409:            GNU C/C++ Compiler</p></li>
                   2410: <li><p><code class="varname">mipspro</code>:
                   2411:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
                   2412: <li><p><code class="varname">mipspro</code>:
                   2413:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
                   2414: <li><p><code class="varname">sunpro</code>:
                   2415:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
                   2416: </ul></div>
                   2417: <p>The default is
                   2418:          &#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;.  You can use
                   2419:          <code class="varname">ccache</code> and/or
                   2420:          <code class="varname">distcc</code> with an appropriate
                   2421:          <code class="varname">PKGSRC_COMPILER</code> setting,
                   2422:          e.g. &#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;.  This
1.94      dmcmahil 2423:          variable should always be terminated with a value for
                   2424:          a real compiler.  Note that only one real compiler
                   2425:          should be listed (e.g. &#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;
                   2426:          is not allowed).</p>
1.89      rillig   2427: </dd>
                   2428: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
                   2429: <dd><p>This specifies the minimum version of GCC to use
                   2430:          when building packages.  If the system GCC doesn't
                   2431:          satisfy this requirement, then pkgsrc will build and
                   2432:          install one of the GCC packages to use instead.</p></dd>
                   2433: </dl></div>
                   2434: </div>
                   2435: <div class="sect2" lang="en">
                   2436: <div class="titlepage"><div><div><h3 class="title">
                   2437: <a name="conf.cflags"></a>5.3.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.78      rillig   2438: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
                   2439:        please make sure to use the <code class="literal">+=</code> operator
                   2440:        instead of the <code class="literal">=</code> operator:</p>
                   2441: <pre class="programlisting">
                   2442:     CFLAGS+=        -your -flags
                   2443: </pre>
                   2444: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
                   2445:        &#8220;<span class="quote">+</span>&#8221;) may lead to problems with packages that need
                   2446:        to add their own flags.  Also, you may want to take a look at
1.91      rillig   2447:        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   2448:        you're interested in optimization for the current CPU.</p>
                   2449: </div>
1.88      wiz      2450: <div class="sect2" lang="en">
                   2451: <div class="titlepage"><div><div><h3 class="title">
1.89      rillig   2452: <a name="conf.ldflags"></a>5.3.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.88      wiz      2453: <p>If you want to pass flags to the linker, both in the configure
                   2454: step and the build step, you can do this in two ways.  Either set
                   2455: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
                   2456: between the two is that <code class="varname">LIBS</code> will be appended to
                   2457: the command line, while <code class="varname">LDFLAGS</code> come earlier.
                   2458: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
                   2459: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
                   2460: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
                   2461: <code class="varname">CFLAGS</code>, if you do not wish to override these
                   2462: settings, use the <code class="literal">+=</code> operator:</p>
                   2463: <pre class="programlisting">
                   2464:     LDFLAGS+=        -your -linkerflags
                   2465: </pre>
                   2466: </div>
1.78      rillig   2467: </div>
                   2468: <div class="sect1" lang="en">
                   2469: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2470: <a name="developer-advanced-settings"></a>5.4. Developer/advanced settings</h2></div></div></div>
1.75      rillig   2471: <p>XXX
                   2472:       </p>
                   2473: <div class="itemizedlist"><ul type="disc">
                   2474: <li>
                   2475: <p><code class="varname">PKG_DEVELOPER</code>:
                   2476:            Run some sanity checks that package developers want:
                   2477:            </p>
                   2478: <div class="itemizedlist"><ul type="circle">
1.88      wiz      2479: <li><p>make sure patches apply with zero
                   2480:              fuzz</p></li>
                   2481: <li><p>run check-shlibs to see that all
                   2482:              binaries will find their shared libs.</p></li>
1.75      rillig   2483: </ul></div>
                   2484: <p>
1.87      wiz      2485:        </p>
1.75      rillig   2486: </li>
1.88      wiz      2487: <li><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
                   2488:        of debugging output which is displayed whilst making and
                   2489:        installing the package.  The default value for this is 0,
                   2490:        which will not display the commands as they are executed
                   2491:        (normal, default, quiet operation); the value 1 will display
                   2492:        all shell commands before their invocation, and the value 2
                   2493:        will display both the shell commands before their invocation,
                   2494:        and their actual execution progress with <span><strong class="command">set
                   2495:        -x</strong></span> will be displayed.</p></li>
1.75      rillig   2496: </ul></div>
                   2497: <p>
                   2498:     </p>
                   2499: </div>
                   2500: <div class="sect1" lang="en">
                   2501: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.78      rillig   2502: <a name="selecting-build-options"></a>5.5. Selecting Build Options</h2></div></div></div>
1.88      wiz      2503: <p>Some packages have build time options, usually to select
                   2504:     between different dependencies, enable optional support for big
                   2505:     dependencies or enable experimental features.</p>
1.75      rillig   2506: <p>To see which options, if any, a package supports, and which
1.88      wiz      2507:     options are mutually exclusive, run <span><strong class="command">make
                   2508:     show-options</strong></span>, for example:</p>
1.75      rillig   2509: <pre class="programlisting">
                   2510:     The following options are supported by this package:
                   2511:         ssl      Enable SSL support.
                   2512:     Exactly one of the following gecko options is required:
                   2513:         firefox  Use firefox as gecko rendering engine.
                   2514:         mozilla  Use mozilla as gecko rendering engine.
                   2515:     At most one of the following database options may be selected:
                   2516:         mysql    Enable support for MySQL database.
                   2517:         pgsql    Enable support for PostgreSQL database.
1.1       grant    2518: 
1.75      rillig   2519:     These options are enabled by default: firefox
                   2520:     These options are currently enabled: mozilla ssl
1.1       grant    2521: </pre>
1.75      rillig   2522: <p>The following variables can be defined in
1.88      wiz      2523:     <code class="filename">/etc/mk.conf</code> to select which options to
                   2524:     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
                   2525:     which can be used to select or disable options for all packages
                   2526:     that support them, and
                   2527:     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
                   2528:     which can be used to select or disable options specifically for
                   2529:     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
                   2530:     these variables are selected, options preceded by &#8220;<span class="quote">-</span>&#8221;
                   2531:     are disabled. A few examples:</p>
1.75      rillig   2532: <pre class="screen">
                   2533: <code class="prompt">$</code> <span><strong class="command">grep "PKG.*OPTION" /etc/mk.conf</strong></span>
                   2534: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   2535: PKG_OPTIONS.kdebase=    debug -sasl
                   2536: PKG_OPTIONS.apache=     suexec </pre>
1.88      wiz      2537: <p>The following settings are consulted in the order given, and
                   2538:     the last setting that selects or disables an option is
                   2539:     used:</p>
1.75      rillig   2540: <div class="orderedlist"><ol type="1">
                   2541: <li><p>the default options as suggested by the package
1.88      wiz      2542:       maintainer</p></li>
1.75      rillig   2543: <li><p>the options implied by the settings of legacy
1.88      wiz      2544:       variables (see below)</p></li>
1.75      rillig   2545: <li><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
                   2546: <li><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
                   2547: </ol></div>
                   2548: <p>For groups of mutually exclusive options, the last option
1.88      wiz      2549:     selected is used, all others are automatically disabled.  If an
                   2550:     option of the group is explicitly disabled, the previously
                   2551:     selected option, if any, is used.  It is an error if no option
                   2552:     from a required group of options is selected, and building the
                   2553:     package will fail.</p>
                   2554: <p>Before the options framework was introduced, build options
                   2555:     were selected by setting a variable (often named
                   2556:     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
                   2557:     <code class="filename">/etc/mk.conf</code> for each option.  To ease
                   2558:     transition to the options framework for the user, these legacy
                   2559:     variables are converted to the appropriate options setting
                   2560:     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
                   2561:     automatically.  A warning is issued to prompt the user to update
                   2562:     <code class="filename">/etc/mk.conf</code> to use the options framework
                   2563:     directly.  Support for the legacy variables will be removed
                   2564:     eventually.</p>
1.75      rillig   2565: </div>
                   2566: </div>
                   2567: <div class="chapter" lang="en">
                   2568: <div class="titlepage"><div><div><h2 class="title">
                   2569: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
                   2570: <div class="toc">
                   2571: <p><b>Table of Contents</b></p>
                   2572: <dl>
                   2573: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                   2574: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
                   2575: <dt><span class="sect1"><a href="#bulkbuild">6.3. Doing a bulk build of all packages</a></span></dt>
                   2576: <dd><dl>
                   2577: <dt><span class="sect2"><a href="#binary.configuration">6.3.1. Configuration</a></span></dt>
                   2578: <dt><span class="sect2"><a href="#other-environmental-considerations">6.3.2. Other environmental considerations</a></span></dt>
                   2579: <dt><span class="sect2"><a href="#operation">6.3.3. Operation</a></span></dt>
                   2580: <dt><span class="sect2"><a href="#what-it-does">6.3.4. What it does</a></span></dt>
                   2581: <dt><span class="sect2"><a href="#disk-space-requirements">6.3.5. Disk space requirements</a></span></dt>
                   2582: <dt><span class="sect2"><a href="#setting-up-a-sandbox">6.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                   2583: <dt><span class="sect2"><a href="#building-a-partial-set">6.3.7. Building a partial set of packages</a></span></dt>
                   2584: <dt><span class="sect2"><a href="#bulk-upload">6.3.8. Uploading results of a bulk build</a></span></dt>
                   2585: </dl></dd>
                   2586: <dt><span class="sect1"><a href="#creating-cdroms">6.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                   2587: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">6.4.1. Example of cdpack</a></span></dt></dl></dd>
                   2588: </dl>
                   2589: </div>
                   2590: <div class="sect1" lang="en">
                   2591: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2592: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87      wiz      2593: <p>Once you have built and installed a package, you can create
                   2594:     a <span class="emphasis"><em>binary package</em></span> which can be installed on
                   2595:     another system with <a 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
                   2596:     the same package on a group of hosts and wasting CPU time. It also
                   2597:     provides a simple means for others to install your package, should
                   2598:     you distribute it.</p>
                   2599: <p>To create a binary package, change into the appropriate
                   2600:     directory in pkgsrc, and run <span><strong class="command">make
                   2601:     package</strong></span>:</p>
                   2602: <pre class="screen">
                   2603: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2604: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   2605:     </pre>
                   2606: <p>This will build and install your package (if not already done),
                   2607:     and then build a binary package from what was installed. You can
                   2608:     then use the <span><strong class="command">pkg_*</strong></span> tools to manipulate
                   2609:     it. Binary packages are created by default in
                   2610:     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
                   2611:     gzipped tar file. See <a href="#logs.package" title="B.2. Packaging figlet">Section B.2, &#8220;Packaging figlet&#8221;</a> for a
1.91      rillig   2612:     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.90      rillig   2613: <p>See <a href="#submit" title="Chapter 20. Submitting and Committing">Chapter 20, <i>Submitting and Committing</i></a> for information on how to submit
1.87      wiz      2614:     such a binary package.</p>
1.75      rillig   2615: </div>
                   2616: <div class="sect1" lang="en">
                   2617: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2618: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.90      rillig   2619: <p>See <a href="#build.helpful-targets" title="16.17. Other helpful targets">Section 16.17, &#8220;Other helpful targets&#8221;</a>.</p>
1.75      rillig   2620: </div>
                   2621: <div class="sect1" lang="en">
                   2622: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2623: <a name="bulkbuild"></a>6.3. Doing a bulk build of all packages</h2></div></div></div>
                   2624: <p>If you want to get a full set of precompiled binary
1.87      wiz      2625:     packages, this section describes how to get them. Beware that
                   2626:     the bulk build will remove all currently installed packages from
                   2627:     your system!</p>
1.75      rillig   2628: <p>Having an FTP server configured either on the
1.87      wiz      2629:     machine doing the bulk builds or on a nearby NFS server can help
                   2630:     to make the packages available to other machines that can then
                   2631:     save time by installing only the binary packages. See <a href="http://netbsd.gw.com/cgi-bin/man-cgi?ftpd+8+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ftpd</span>(8)</span></a> for
                   2632:     more information. If you use a remote NFS server's storage, be
                   2633:     sure to not actually compile on NFS storage, as this slows
                   2634:     things down a lot.</p>
1.75      rillig   2635: <div class="sect2" lang="en">
                   2636: <div class="titlepage"><div><div><h3 class="title">
                   2637: <a name="binary.configuration"></a>6.3.1. Configuration</h3></div></div></div>
                   2638: <div class="sect3" lang="en">
                   2639: <div class="titlepage"><div><div><h4 class="title">
1.93      rillig   2640: <a name="binary.bulk.build.conf"></a>6.3.1.1. <code class="filename">build.conf</code>
                   2641: </h4></div></div></div>
1.76      rillig   2642: <p>The <code class="filename">build.conf</code> file is the main
1.87      wiz      2643:        configuration file for bulk builds. You can configure how your
                   2644:        copy of pkgsrc is kept up to date, how the distfiles are
                   2645:        downloaded, how the packages are built and how the report is
                   2646:        generated. You can find an annotated example file in
                   2647:        <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
                   2648:        it, copy <code class="filename">build.conf-example</code> to
                   2649:        <code class="filename">build.conf</code> and edit it, following the
                   2650:        comments in that file.</p>
1.75      rillig   2651: </div>
                   2652: <div class="sect3" lang="en">
                   2653: <div class="titlepage"><div><div><h4 class="title">
                   2654: <a name="binary.mk.conf"></a>6.3.1.2. /etc/mk.conf</h4></div></div></div>
                   2655: <p>You may want to set variables in
1.87      wiz      2656:        <code class="filename">/etc/mk.conf</code>.
                   2657:        Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
                   2658:        details of the default settings. You will want to ensure that
                   2659:        <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
                   2660:        As used in this example, <code class="varname">_ACCEPTABLE=yes</code>
                   2661:        accepts <span class="emphasis"><em>all</em></span> licenses.</p>
                   2662: <pre class="programlisting">
                   2663:          PACKAGES?=      ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
                   2664:          WRKOBJDIR?=     /usr/tmp/pkgsrc   # build here instead of in pkgsrc
                   2665:          BSDSRCDIR=      /usr/src
                   2666:          BSDXSRCDIR=     /usr/xsrc         # for x11/xservers
                   2667:          OBJHOSTNAME?=   yes               # use work.`hostname`
                   2668:          FAILOVER_FETCH= yes               # insist on the correct checksum
                   2669:          PKG_DEVELOPER?= yes
                   2670:          _ACCEPTABLE=    yes
                   2671:        </pre>
1.75      rillig   2672: <p>Some options that are especially useful for bulk builds
                   2673:        can be found at the top lines of the file
1.76      rillig   2674:        <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
1.75      rillig   2675:        options of these are briefly described here.</p>
                   2676: <div class="itemizedlist"><ul type="disc">
                   2677: <li><p>If you are on a slow machine, you may want to
1.87      wiz      2678:          set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
                   2679:          &#8220;<span class="quote">no</span>&#8221;.</p></li>
1.75      rillig   2680: <li><p>If you are doing bulk builds from a read-only
1.87      wiz      2681:          copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
                   2682:          to the directory where all log files are created. Otherwise the
                   2683:          log files are created in the pkgsrc directory.</p></li>
1.75      rillig   2684: <li><p>Another important variable is
1.87      wiz      2685:          <code class="varname">BULK_PREREQ</code>, which is a list of packages that
                   2686:          should be always available while building other
                   2687:          packages.</p></li>
1.75      rillig   2688: </ul></div>
                   2689: <p>Some other options are scattered in the pkgsrc
                   2690:        infrastructure:</p>
                   2691: <div class="itemizedlist"><ul type="disc">
                   2692: <li><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
1.87      wiz      2693:          should be set to <code class="literal">yes</code>. The purpose of the bulk
                   2694:          builds is creating binary packages, no matter if they are
                   2695:          vulnerable or not. When uploading the packages to a public
                   2696:          server, the vulnerable packages will be put into a directory of
                   2697:          their own. Leaving this variable unset would prevent the bulk
                   2698:          build system from even trying to build them, so possible
                   2699:          building errors would not show up.</p></li>
1.75      rillig   2700: <li><p><code class="varname">CHECK_FILES</code>
1.93      rillig   2701:          (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
1.87      wiz      2702:          &#8220;<span class="quote">yes</span>&#8221; to check that the installed set of files
                   2703:          matches the <code class="filename">PLIST</code>.</p></li>
1.75      rillig   2704: <li><p><code class="varname">CHECK_INTERPRETER</code>
1.93      rillig   2705:          (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
1.87      wiz      2706:          &#8220;<span class="quote">yes</span>&#8221; to check that the installed
                   2707:          &#8220;<span class="quote">#!</span>&#8221;-scripts will find their
                   2708:          interpreter.</p></li>
1.91      rillig   2709: <li><p><code class="varname">PKGSRC_RUN_TEST</code> can be
                   2710:          set to &#8220;<span class="quote"><code class="literal">yes</code></span>&#8221; to run each
                   2711:          package's self-test before installing it. Note that some
                   2712:          packages make heavy use of &#8220;<span class="quote">good</span>&#8221; random
                   2713:          numbers, so you need to assure that the machine on which you
                   2714:          are doing the bulk builds is not completely idle. Otherwise
                   2715:          some test programs will seem to hang, while they are just
                   2716:          waiting for new random data to be
                   2717:          available.</p></li>
1.75      rillig   2718: </ul></div>
                   2719: </div>
                   2720: <div class="sect3" lang="en">
                   2721: <div class="titlepage"><div><div><h4 class="title">
1.93      rillig   2722: <a name="pre-build.local"></a>6.3.1.3. <code class="filename">pre-build.local</code>
                   2723: </h4></div></div></div>
1.75      rillig   2724: <p>It is possible to configure the bulk build to perform
1.87      wiz      2725:        certain site-specific tasks at the end of the pre-build
                   2726:        stage.  If the file
                   2727:        <code class="filename">pre-build.local</code> exists in
                   2728:        <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
                   2729:        (as a <a 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
                   2730:        stage.  An example use of
                   2731:        <code class="filename">pre-build.local</code> is to have the line:</p>
1.75      rillig   2732: <pre class="screen">echo "I do not have enough disk space to build this pig." \
1.87      wiz      2733:        &gt; misc/openoffice/$BROKENF</pre>
1.75      rillig   2734: <p>to prevent the system from trying to build a particular package
1.87      wiz      2735:        which requires nearly 3 GB of disk space.</p>
1.75      rillig   2736: </div>
                   2737: </div>
                   2738: <div class="sect2" lang="en">
                   2739: <div class="titlepage"><div><div><h3 class="title">
                   2740: <a name="other-environmental-considerations"></a>6.3.2. Other environmental considerations</h3></div></div></div>
1.76      rillig   2741: <p>As <code class="filename">/usr/pkg</code> will be completely
1.87      wiz      2742:       deleted at the start of bulk builds, make sure your login
                   2743:       shell is placed somewhere else. Either drop it into
                   2744:       <code class="filename">/usr/local/bin</code> (and adjust your login
                   2745:       shell in the passwd file), or (re-)install it via
                   2746:       <a 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
                   2747:       you can login after a reboot (remember that your current
                   2748:       process won't die if the package is removed, you just can't
                   2749:       start any new instances of the shell any more).  Also, if you
                   2750:       use NetBSD earlier than 1.5, or you still want to use the pkgsrc
                   2751:       version of ssh for some reason, be sure to install ssh before
                   2752:       starting it from <code class="filename">rc.local</code>:</p>
                   2753: <pre class="programlisting">
                   2754:        ( cd /usr/pkgsrc/security/ssh ; make bulk-install )
                   2755:        if [ -f /usr/pkg/etc/rc.d/sshd ]; then
                   2756:        /usr/pkg/etc/rc.d/sshd
                   2757:        fi
                   2758:       </pre>
1.75      rillig   2759: <p>Not doing so will result in you being not able to log in
1.87      wiz      2760:       via ssh after the bulk build is finished or if the machine
                   2761:       gets rebooted or crashes. You have been warned! :)</p>
1.75      rillig   2762: </div>
                   2763: <div class="sect2" lang="en">
                   2764: <div class="titlepage"><div><div><h3 class="title">
                   2765: <a name="operation"></a>6.3.3. Operation</h3></div></div></div>
                   2766: <p>Make sure you don't need any of the packages still
1.87      wiz      2767:       installed.</p>
1.75      rillig   2768: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2769: <h3 class="title">Warning</h3>
                   2770: <p>During the bulk build, <span class="emphasis"><em>all packages will be
1.87      wiz      2771:        removed!</em></span></p>
1.75      rillig   2772: </div>
                   2773: <p>Be sure to remove all other things that might
1.87      wiz      2774:       interfere with builds, like some libs installed in
                   2775:       <code class="filename">/usr/local</code>, etc. then become root and type:</p>
                   2776: <pre class="screen">
                   2777: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   2778: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
                   2779:       </pre>
1.75      rillig   2780: <p>If for some reason your last build didn't complete (power
1.87      wiz      2781:       failure, system panic, ...), you can continue it by
                   2782:       running:</p>
1.75      rillig   2783: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
1.87      wiz      2784: <p>At the end of the bulk build, you will get a summary via mail,
                   2785:       and find build logs in the directory specified by
                   2786:       <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
                   2787:       file.</p>
1.75      rillig   2788: </div>
                   2789: <div class="sect2" lang="en">
                   2790: <div class="titlepage"><div><div><h3 class="title">
                   2791: <a name="what-it-does"></a>6.3.4. What it does</h3></div></div></div>
                   2792: <p>The bulk builds consist of three steps:</p>
                   2793: <div class="variablelist"><dl>
                   2794: <dt><span class="term">1. pre-build</span></dt>
1.87      wiz      2795: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
                   2796:            cleans out any broken distfiles, and removes all
                   2797:            packages installed.</p></dd>
1.75      rillig   2798: <dt><span class="term">2. the bulk build</span></dt>
1.87      wiz      2799: <dd><p>This is basically &#8220;<span class="quote">make bulk-package</span>&#8221; with
                   2800:            an optimised order in which packages will be
                   2801:            built. Packages that don't require other packages will
                   2802:            be built first, and packages with many dependencies will
                   2803:            be built later.</p></dd>
1.75      rillig   2804: <dt><span class="term">3. post-build</span></dt>
1.87      wiz      2805: <dd><p>Generates a report that's placed in the directory
                   2806:            specified in the <code class="filename">build.conf</code> file
                   2807:            named <code class="filename">broken.html</code>, a short version
                   2808:            of that report will also be mailed to the build's
                   2809:            admin.</p></dd>
1.75      rillig   2810: </dl></div>
1.87      wiz      2811: <p>During the build, a list of broken packages will be compiled
                   2812:       in <code class="filename">/usr/pkgsrc/.broken</code> (or
                   2813:       <code class="filename">.../.broken.${MACHINE}</code> if
                   2814:       <code class="varname">OBJMACHINE</code> is set), individual build logs
                   2815:       of broken builds can be found in the package's
                   2816:       directory. These files are used by the bulk-targets to mark
                   2817:       broken builds to not waste time trying to rebuild them, and
                   2818:       they can be used to debug these broken package builds
                   2819:       later.</p>
1.75      rillig   2820: </div>
                   2821: <div class="sect2" lang="en">
                   2822: <div class="titlepage"><div><div><h3 class="title">
                   2823: <a name="disk-space-requirements"></a>6.3.5. Disk space requirements</h3></div></div></div>
                   2824: <p>Currently, roughly the following requirements are valid for
1.87      wiz      2825:       NetBSD 2.0/i386:</p>
1.75      rillig   2826: <div class="itemizedlist"><ul type="disc">
1.87      wiz      2827: <li><p>10 GB - distfiles (NFS ok)</p></li>
                   2828: <li><p>8 GB - full set of all binaries (NFS ok)</p></li>
                   2829: <li><p>5 GB - temp space for compiling (local disk recommended)</p></li>
                   2830: </ul></div>
                   2831: <p>Note that all pkgs will be de-installed as soon as they are
                   2832:       turned into a binary package, and that sources are removed,
                   2833:       so there is no excessively huge demand to disk
                   2834:       space. Afterwards, if the package is needed again, it will
                   2835:       be installed via <a 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
                   2836:       there are no cycles wasted by recompiling.</p>
1.75      rillig   2837: </div>
                   2838: <div class="sect2" lang="en">
                   2839: <div class="titlepage"><div><div><h3 class="title">
                   2840: <a name="setting-up-a-sandbox"></a>6.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.87      wiz      2841: <p>If you don't want all the packages nuked from a machine
                   2842:       (rendering it useless for anything but pkg compiling), there
                   2843:       is the possibility of doing the package bulk build inside a
                   2844:       chroot environment.</p>
                   2845: <p>The first step is to set up a chroot sandbox,
                   2846:       e.g. <code class="filename">/usr/sandbox</code>.  This can be done by
                   2847:       using null mounts, or manually.</p>
                   2848: <p>There is a shell script called
                   2849:       <code class="filename">pkgsrc/mk/bulk/mksandbox</code> which will set
                   2850:       up the sandbox environment using null mounts. It will also
                   2851:       create a script called <code class="filename">sandbox</code> in the
                   2852:       root of the sandbox environment, which will allow the null
                   2853:       mounts to be activated using the <span><strong class="command">sandbox
                   2854:       mount</strong></span> command and deactivated using the
                   2855:       <span><strong class="command">sandbox umount</strong></span> command.</p>
                   2856: <p>To set up a sandbox environment by hand, after extracting all
                   2857:       the sets from a NetBSD installation or doing a <span><strong class="command">make
                   2858:       distribution DESTDIR=/usr/sandbox</strong></span> in
                   2859:       <code class="filename">/usr/src/etc</code>, be sure the following items
                   2860:       are present and properly configured:</p>
1.75      rillig   2861: <div class="procedure"><ol type="1">
                   2862: <li>
                   2863: <p>Kernel</p>
                   2864: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
                   2865: </li>
                   2866: <li>
1.76      rillig   2867: <p><code class="filename">/dev/*</code></p>
1.75      rillig   2868: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
                   2869: </li>
                   2870: <li>
1.91      rillig   2871: <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   2872: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
                   2873: </li>
                   2874: <li>
                   2875: <p>Working(!) mail config (hostname, sendmail.cf):</p>
                   2876: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
                   2877: </li>
                   2878: <li>
1.91      rillig   2879: <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   2880: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
                   2881: </li>
                   2882: <li>
1.76      rillig   2883: <p><code class="filename">/usr/src</code> (system sources,
1.91      rillig   2884:          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   2885: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
1.87      wiz      2886:          <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
1.75      rillig   2887: </li>
                   2888: <li>
1.76      rillig   2889: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
1.75      rillig   2890: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
                   2891: </li>
                   2892: <li>
1.76      rillig   2893: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
1.75      rillig   2894: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
                   2895: </li>
                   2896: <li>
                   2897: <p>Checkout pkgsrc via cvs into
1.87      wiz      2898:          <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
                   2899: <pre class="screen">
                   2900: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
                   2901: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
                   2902:          </pre>
1.75      rillig   2903: <p>Do not mount/link this to the copy of your pkgsrc tree
1.87      wiz      2904:          you do development in, as this will likely cause problems!</p>
1.75      rillig   2905: </li>
                   2906: <li><p>Make
1.87      wiz      2907:          <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
                   2908:          <code class="filename">.../distfiles</code> point somewhere
                   2909:          appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.76      rillig   2910: <li><p>Edit <code class="filename">/etc/mk.conf</code>, see <a href="#binary.mk.conf" title="6.3.1.2. /etc/mk.conf">Section 6.3.1.2, &#8220;/etc/mk.conf&#8221;</a>.</p></li>
                   2911: <li><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
1.75      rillig   2912: </ol></div>
                   2913: <p>When the chroot sandbox is set up, you can start
1.87      wiz      2914:       the build with the following steps:</p>
                   2915: <pre class="screen">
                   2916: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
                   2917: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
                   2918:       </pre>
                   2919: <p>This will just jump inside the sandbox and start building.  At
                   2920:        the end of the build, mail will be sent with the results of
                   2921:        the build. Created binary pkgs will be in
                   2922:        <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
                   2923:       (wherever that points/mounts to/from).</p>
1.75      rillig   2924: </div>
                   2925: <div class="sect2" lang="en">
                   2926: <div class="titlepage"><div><div><h3 class="title">
                   2927: <a name="building-a-partial-set"></a>6.3.7. Building a partial set of packages</h3></div></div></div>
1.87      wiz      2928: <p>In addition to building a complete set of all packages in
                   2929:       pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
                   2930:       may be used to build a subset of the packages contained in
                   2931:       pkgsrc.  By setting <code class="varname">SPECIFIC_PKGS</code>
                   2932:       in <code class="filename">/etc/mk.conf</code>, the variables</p>
1.75      rillig   2933: <div class="itemizedlist"><ul type="disc">
                   2934: <li><p>SITE_SPECIFIC_PKGS</p></li>
                   2935: <li><p>HOST_SPECIFIC_PKGS</p></li>
                   2936: <li><p>GROUP_SPECIFIC_PKGS</p></li>
                   2937: <li><p>USER_SPECIFIC_PKGS</p></li>
                   2938: </ul></div>
1.87      wiz      2939: <p>will define the set of packages which should be built.
                   2940:       The bulk build code will also include any packages which are
                   2941:       needed as dependencies for the explicitly listed packages.</p>
                   2942: <p>One use of this is to do a bulk build with
                   2943:       <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
                   2944:       periodically to have a complete set of the binary packages
                   2945:       needed for your site available without the overhead of
                   2946:       building extra packages that are not needed.</p>
1.75      rillig   2947: </div>
                   2948: <div class="sect2" lang="en">
                   2949: <div class="titlepage"><div><div><h3 class="title">
                   2950: <a name="bulk-upload"></a>6.3.8. Uploading results of a bulk build</h3></div></div></div>
1.87      wiz      2951: <p>This section describes how pkgsrc developers can upload binary
                   2952:       pkgs built by bulk builds to ftp.NetBSD.org.</p>
                   2953: <p>If you would like to automatically create checksum files for the
                   2954:       binary packages you intend to upload, remember to set
                   2955:       <code class="varname">MKSUMS=yes</code> in your
                   2956:       <code class="filename">mk/bulk/build.conf</code>.</p>
                   2957: <p>If you would like to PGP sign the checksum files (highly
                   2958:       recommended!), remember to set
                   2959:       <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
                   2960:       <code class="filename">mk/bulk/build.conf</code>.  This will prompt you for
                   2961:       your GPG password to sign the files before uploading everything.</p>
                   2962: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
                   2963:       set properly in your <code class="filename">mk/bulk/build.conf</code>
                   2964:       file, i.e. adjust it to something like one of the following:</p>
1.93      rillig   2965: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload </pre>
                   2966: <p>Please use appropriate values for "packages-200xQy",
1.87      wiz      2967:       "NetBSD-a.b.c" and "arch" here. If your login on ftp.NetBSD.org
                   2968:       is different from your local login, write your login directly
                   2969:       into the variable, e.g. my local account is "feyrer", but for my
                   2970:       login "hubertf", I use:</p>
1.93      rillig   2971: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload</pre>
1.87      wiz      2972: <p>A separate <code class="filename">upload</code> directory is used
                   2973:       here to allow "closing" the directory during upload. To do
                   2974:       so, run the following command on ftp.NetBSD.org next:</p>
1.93      rillig   2975: <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      2976: <p>Please note that <code class="filename">/pub/NetBSD/packages</code> is
                   2977:       only appropriate for packages for the NetBSD operating
                   2978:       system. Binary packages for other operating systems should go
                   2979:       into <code class="filename">/pub/pkgsrc</code>.</p>
                   2980: <p>Before uploading the binary pkgs, ssh authentication needs
                   2981:       to be set up. This example shows how to set up temporary keys
                   2982:       for the root account <span class="emphasis"><em>inside the sandbox</em></span>
                   2983:       (assuming that no keys should be present there usually):</p>
                   2984: <pre class="screen">
                   2985: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
1.75      rillig   2986: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
                   2987: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t dsa</code></strong>
1.87      wiz      2988: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-dsa.pub</code></strong>
                   2989:       </pre>
                   2990: <p>Now take the output of <code class="filename">id-dsa.pub</code> and
                   2991:       append it to your <code class="filename">~/.ssh/authorized_keys</code>
                   2992:       file on ftp.NetBSD.org. You can remove the key after the
                   2993:       upload is done!</p>
                   2994: <p>Next, test if your ssh connection really works:</p>
1.75      rillig   2995: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
1.87      wiz      2996: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
                   2997: <p>Now after all this works, you can exit the sandbox and start
                   2998:       the upload:</p>
                   2999: <pre class="screen">
                   3000: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
1.75      rillig   3001: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
1.87      wiz      3002: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
                   3003:       </pre>
                   3004: <p>The upload process may take quite some time. Use <a 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
                   3005:       <a 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
                   3006:       upload. The upload script will take care of not uploading
                   3007:       restricted packages and putting vulnerable packages into the
                   3008:       <code class="filename">vulnerable</code> subdirectory.</p>
                   3009: <p>After the upload has ended, first thing is to revoke ssh access:</p>
1.75      rillig   3010: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
1.87      wiz      3011:       Gdd:x! </pre>
                   3012: <p>Use whatever is needed to remove the key you've entered
                   3013:       before! Last, move the uploaded packages out of the
                   3014:       <code class="filename">upload</code> directory to have them accessible
                   3015:       to everyone:</p>
                   3016: <pre class="screen">
1.93      rillig   3017: nbftp% <strong class="userinput"><code>cd /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch</code></strong>
1.75      rillig   3018: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
                   3019: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
1.87      wiz      3020: nbftp% <strong class="userinput"><code>chmod 755 .</code></strong>
                   3021:       </pre>
1.75      rillig   3022: </div>
                   3023: </div>
                   3024: <div class="sect1" lang="en">
                   3025: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3026: <a name="creating-cdroms"></a>6.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87      wiz      3027: <p>After your pkgsrc bulk-build has completed, you may wish to
                   3028:     create a CD-ROM set of the resulting binary packages to assist
                   3029:     in installing packages on other machines.  The
1.91      rillig   3030:     <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      3031:     a simple tool for creating the ISO 9660 images.
                   3032:     <span><strong class="command">cdpack</strong></span> arranges the packages on the CD-ROMs in a
                   3033:     way that keeps all the dependencies for a given package on the same
                   3034:     CD as that package.</p>
1.75      rillig   3035: <div class="sect2" lang="en">
                   3036: <div class="titlepage"><div><div><h3 class="title">
                   3037: <a name="cdpack-example"></a>6.4.1. Example of cdpack</h3></div></div></div>
1.87      wiz      3038: <p>Complete documentation for cdpack is found in the cdpack(1)
                   3039:       man page. The following short example assumes that the binary
                   3040:       packages are left in
                   3041:       <code class="filename">/usr/pkgsrc/packages/All</code> and that
                   3042:       sufficient disk space exists in <code class="filename">/u2</code> to
                   3043:       hold the ISO 9660 images.</p>
                   3044: <pre class="screen">
                   3045: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75      rillig   3046: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87      wiz      3047: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
                   3048:       </pre>
                   3049: <p>If you wish to include a common set of files
                   3050:       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
                   3051:       etc.) on each CD in the collection, then you need to create a
                   3052:       directory which contains these files. e.g.</p>
                   3053: <pre class="screen">
                   3054: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75      rillig   3055: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
                   3056: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
                   3057: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
                   3058: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
                   3059: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
1.87      wiz      3060: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
                   3061:       </pre>
1.75      rillig   3062: <p>Now create the images:</p>
                   3063: <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   3064: <p>Each image will contain <code class="filename">README</code>,
1.87      wiz      3065:       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
                   3066:       in their root directories.</p>
1.75      rillig   3067: </div>
                   3068: </div>
                   3069: </div>
                   3070: <div class="chapter" lang="en">
                   3071: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   3072: <a name="files"></a>Chapter 7. Directory layout of the installed files</h2></div></div></div>
                   3073: <div class="toc">
                   3074: <p><b>Table of Contents</b></p>
                   3075: <dl>
1.91      rillig   3076: <dt><span class="sect1"><a href="#files.localbase">7.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
1.90      rillig   3077: <dt><span class="sect1"><a href="#files.varbase">7.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
                   3078: </dl>
                   3079: </div>
                   3080: <p>The files that are installed by pkgsrc are organized in a way that
                   3081: is similar to what you find in the <code class="filename">/usr</code> directory
                   3082: of the base system. But some details are different. This is because
                   3083: pkgsrc initially came from FreeBSD and had adopted its file system
                   3084: hierarchy. Later it was largely influenced by NetBSD. But no matter
                   3085: which operating system you are using pkgsrc with, you can expect the
                   3086: same layout for pkgsrc.</p>
1.91      rillig   3087: <p>There are mainly four root directories for pkgsrc, which are all
                   3088: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
                   3089: When pkgsrc has been installed as root, the default locations
                   3090: are:</p>
                   3091: <pre class="programlisting">
                   3092:     LOCALBASE=              /usr/pkg
                   3093:     PKG_SYSCONFBASE=        /usr/pkg/etc
                   3094:     VARBASE=                /var
1.93      rillig   3095:     PKG_DBDIR=              /var/db/pkg
1.91      rillig   3096: </pre>
                   3097: <p>In unprivileged mode (when pkgsrc has been installed as any other
                   3098: user), the default locations are:</p>
                   3099: <pre class="programlisting">
                   3100:     LOCALBASE=              ${HOME}/pkg
                   3101:     PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   3102:     VARBASE=                ${HOME}/pkg/var
1.93      rillig   3103:     PKG_DBDIR=              ${HOME}/pkg/var/db/pkg
1.91      rillig   3104: </pre>
                   3105: <p>What these four directories are for, and what they look like is
                   3106: explained below.</p>
1.90      rillig   3107: <div class="itemizedlist"><ul type="disc">
                   3108: <li><p><code class="varname">LOCALBASE</code> corresponds to the
                   3109: <code class="filename">/usr</code> directory in the base system. It is the
                   3110: &#8220;<span class="quote">main</span>&#8221; directory where the files are installed and contains
                   3111: the well-known subdirectories like <code class="filename">bin</code>,
                   3112: <code class="filename">include</code>, <code class="filename">lib</code>,
                   3113: <code class="filename">share</code> and
                   3114: <code class="filename">sbin</code>.</p></li>
                   3115: <li><p><code class="varname">VARBASE</code> corresponds to
                   3116: <code class="filename">/var</code> in the base system. Some programs (especially
                   3117: games, network daemons) need write access to it during normal
                   3118: operation.</p></li>
                   3119: <li><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
                   3120: <code class="filename">/etc</code> in the base system. It contains configuration
                   3121: files of the packages, as well as pkgsrc's <code class="filename">mk.conf</code>
                   3122: itself.</p></li>
                   3123: </ul></div>
                   3124: <div class="sect1" lang="en">
                   3125: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   3126: <a name="files.localbase"></a>7.1. File system layout in <code class="literal">${LOCALBASE}</code>
                   3127: </h2></div></div></div>
1.90      rillig   3128: <p>The following directories exist in a typical pkgsrc installation
1.91      rillig   3129: in <code class="filename">${LOCALBASE}</code>.</p>
1.90      rillig   3130: <div class="variablelist"><dl>
                   3131: <dt><span class="term"><code class="filename">bin</code></span></dt>
                   3132: <dd><p>Contains executable programs that are intended to be
                   3133: directly used by the end user.</p></dd>
                   3134: <dt><span class="term"><code class="filename">emul</code></span></dt>
                   3135: <dd><p>Contains files for the emulation layers of various other
                   3136: operating systems, especially for
                   3137: NetBSD.</p></dd>
                   3138: <dt><span class="term"><code class="filename">etc</code> (the usual location of
                   3139: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
                   3140: <dd><p>Contains
                   3141: the configuration files.</p></dd>
                   3142: <dt><span class="term"><code class="filename">include</code></span></dt>
                   3143: <dd><p>Contains headers for the C and C++ programming
                   3144: languages.</p></dd>
                   3145: <dt><span class="term"><code class="filename">info</code></span></dt>
                   3146: <dd><p>Contains GNU info files of various
                   3147: packages.</p></dd>
                   3148: <dt><span class="term"><code class="filename">lib</code></span></dt>
                   3149: <dd><p>Contains shared and static
                   3150: libraries.</p></dd>
                   3151: <dt><span class="term"><code class="filename">libdata</code></span></dt>
                   3152: <dd><p>Contains data files that don't change after
                   3153: installation. Other data files belong into
                   3154: <code class="filename">${VARBASE}</code>.</p></dd>
                   3155: <dt><span class="term"><code class="filename">libexec</code></span></dt>
                   3156: <dd><p>Contains programs that are not intended to be used by
                   3157: end users, such as helper programs or network
                   3158: daemons.</p></dd>
                   3159: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
                   3160: <dd><p>Contains programs that are intended to be executed as
                   3161: CGI scripts by a web server.</p></dd>
                   3162: <dt><span class="term"><code class="filename">man</code> (the usual value of
                   3163: <code class="filename">${PKGMANDIR}</code>)</span></dt>
                   3164: <dd><p>Contains brief
                   3165: documentation in form of manual pages.</p></dd>
                   3166: <dt><span class="term"><code class="filename">sbin</code></span></dt>
                   3167: <dd><p>Contains programs that are intended to be used only by
                   3168: the super-user.</p></dd>
                   3169: <dt><span class="term"><code class="filename">share</code></span></dt>
                   3170: <dd><p>Contains platform-independent data files that don't
                   3171: change after installation.</p></dd>
                   3172: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
                   3173: <dd><p>Contains documentation files provided by the
                   3174: packages.</p></dd>
                   3175: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
                   3176: <dd><p>Contains example files provided by the packages. Among
                   3177: others, the original configuration files are saved here and copied to
                   3178: <code class="filename">${PKG_SYSCONFDIR}</code> during
                   3179: installation.</p></dd>
                   3180: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
                   3181: <dd><p>Contains the original files for rc.d
                   3182: scripts.</p></dd>
                   3183: <dt><span class="term"><code class="filename">var</code> (the usual location of
                   3184: <code class="filename">${VARBASE}</code>)</span></dt>
                   3185: <dd><p>Contains files
                   3186: that may be modified after
                   3187: installation.</p></dd>
                   3188: </dl></div>
                   3189: </div>
                   3190: <div class="sect1" lang="en">
                   3191: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   3192: <a name="files.varbase"></a>7.2. File system layout in <code class="literal">${VARBASE}</code>
                   3193: </h2></div></div></div>
1.90      rillig   3194: <div class="variablelist"><dl>
                   3195: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
                   3196: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
                   3197: <dd><p>Contains
                   3198: information about the currently installed
                   3199: packages.</p></dd>
                   3200: <dt><span class="term"><code class="filename">games</code></span></dt>
                   3201: <dd><p>Contains highscore
                   3202: files.</p></dd>
                   3203: <dt><span class="term"><code class="filename">log</code></span></dt>
                   3204: <dd><p>Contains log files.</p></dd>
                   3205: <dt><span class="term"><code class="filename">run</code></span></dt>
                   3206: <dd><p>Contains informational files about daemons that are
                   3207: currently running.</p></dd>
                   3208: </dl></div>
                   3209: </div>
                   3210: </div>
                   3211: <div class="chapter" lang="en">
                   3212: <div class="titlepage"><div><div><h2 class="title">
                   3213: <a name="faq"></a>Chapter 8. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   3214: <div class="toc">
                   3215: <p><b>Table of Contents</b></p>
                   3216: <dl>
1.90      rillig   3217: <dt><span class="sect1"><a href="#mailing-list-pointers">8.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                   3218: <dt><span class="sect1"><a href="#pkgviews-docs">8.2. Where's the pkgviews documentation?</a></span></dt>
                   3219: <dt><span class="sect1"><a href="#faq-pkgtools">8.3. Utilities for package management (pkgtools)</a></span></dt>
                   3220: <dt><span class="sect1"><a href="#non-root-pkgsrc">8.4. How to use pkgsrc as non-root</a></span></dt>
                   3221: <dt><span class="sect1"><a href="#resume-transfers">8.5. How to resume transfers when fetching distfiles?</a></span></dt>
                   3222: <dt><span class="sect1"><a href="#XFree86-from-pkgsrc">8.6. How can I install/use XFree86 from pkgsrc?</a></span></dt>
                   3223: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">8.7. How can I install/use X.org from pkgsrc?</a></span></dt>
                   3224: <dt><span class="sect1"><a href="#fetch-behind-firewall">8.8. How to fetch files from behind a firewall</a></span></dt>
                   3225: <dt><span class="sect1"><a href="#passive-ftp">8.9. How do I tell <span><strong class="command">make fetch</strong></span> to do passive FTP?</a></span></dt>
                   3226: <dt><span class="sect1"><a href="#fetching-all-distfiles">8.10. How to fetch all distfiles at once</a></span></dt>
                   3227: <dt><span class="sect1"><a href="#tmac.andoc-missing">8.11. What does &#8220;<span class="quote">Don't know how to make
1.75      rillig   3228: /usr/share/tmac/tmac.andoc</span>&#8221; mean?</a></span></dt>
1.90      rillig   3229: <dt><span class="sect1"><a href="#bsd.own.mk-missing">8.12. What does &#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221; mean?</a></span></dt>
                   3230: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">8.13. Using 'sudo' with pkgsrc</a></span></dt>
                   3231: <dt><span class="sect1"><a href="#faq.conf">8.14. How do I change the location of configuration files?</a></span></dt>
                   3232: <dt><span class="sect1"><a href="#audit-packages">8.15. Automated security checks</a></span></dt>
                   3233: <dt><span class="sect1"><a href="#ufaq-cflags">8.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                   3234: <dt><span class="sect1"><a href="#ufaq-fail">8.17. A package does not build.  What shall I do?</a></span></dt>
                   3235: <dt><span class="sect1"><a href="#faq.rcs-conflicts">8.18. What does &#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221; mean?</a></span></dt>
1.75      rillig   3236: </dl>
                   3237: </div>
                   3238: <p>This section contains hints, tips &amp; tricks on special things in
                   3239: pkgsrc that we didn't find a better place for in the previous chapters, and
                   3240: it contains items for both pkgsrc users and developers.</p>
                   3241: <div class="sect1" lang="en">
                   3242: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3243: <a name="mailing-list-pointers"></a>8.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75      rillig   3244: <p>The following mailing lists may be of interest to pkgsrc users:</p>
                   3245: <div class="itemizedlist"><ul type="disc">
1.78      rillig   3246: <li><p><a href="http://www.NetBSD.org/MailingLists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
                   3247:          This is a general purpose list for most issues regarding
                   3248:          pkgsrc, regardless of platform, e.g. soliciting user help
                   3249:          for pkgsrc configuration, unexpected build failures, using
                   3250:          particular packages, upgrading pkgsrc installations,
                   3251:          questions regarding the pkgsrc release branches, etc.  General announcements or
                   3252:          proposals for changes that impact the pkgsrc user community,
                   3253:          e.g. major infrastructure changes, new features, package
                   3254:          removals, etc., may also be posted.</p></li>
1.75      rillig   3255: <li><p><a href="http://www.NetBSD.org/MailingLists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
                   3256:          A list where the results of pkgsrc bulk builds are sent and
                   3257:          discussed.</p></li>
                   3258: <li><p><a href="http://www.NetBSD.org/MailingLists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
                   3259:          This list is for those who are interested in getting a
                   3260:          commit message for every change committed to pkgsrc. It is
                   3261:          also available in digest form, meaning one daily message
                   3262:          containing all commit messages for changes to the package
                   3263:          source tree in that 24 hour period.</p></li>
                   3264: </ul></div>
                   3265: <p>To subscribe, do:</p>
                   3266: <pre class="programlisting">
                   3267:     <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
                   3268: </pre>
                   3269: <p>Archives for all these mailing lists are available from
                   3270: <a href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
                   3271: </div>
                   3272: <div class="sect1" lang="en">
                   3273: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3274: <a name="pkgviews-docs"></a>8.2. Where's the pkgviews documentation?</h2></div></div></div>
1.75      rillig   3275: <p>Pkgviews is tightly integrated with buildlink.  You can find a
                   3276: pkgviews User's guide in
1.76      rillig   3277: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
1.75      rillig   3278: </div>
                   3279: <div class="sect1" lang="en">
                   3280: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3281: <a name="faq-pkgtools"></a>8.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.80      rillig   3282: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75      rillig   3283: a number of useful utilities for both users and developers of pkgsrc.  This
                   3284: section attempts only to make the reader aware of the utilities and when
                   3285: they might be useful, and not to duplicate the documentation that comes
                   3286: with each package.</p>
                   3287: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.91      rillig   3288: <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   3289:       Symlinks for use by buildlink.</p></li></ul></div>
                   3290: <p>OS tool augmentation (automatically installed when needed):</p>
                   3291: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3292: <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   3293:       Calculates various kinds of checksums (including SHA1).</p></li>
1.91      rillig   3294: <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   3295:       Compatibility library for pkgsrc tools.</p></li>
1.91      rillig   3296: <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      3297:       non-BSD systems due to lack of native mtree.</p></li>
1.91      rillig   3298: <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   3299:       Up-to-date replacement for
1.76      rillig   3300:       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75      rillig   3301:       systems where pkg_install is not present.</p></li>
                   3302: </ul></div>
                   3303: <p>Utilities used by pkgsrc (not automatically installed):</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/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
1.75      rillig   3306:       Create a binary package from an
                   3307:       already-installed package.  Used by <span><strong class="command">make replace</strong></span> to
                   3308:       save the old package.</p></li>
1.91      rillig   3309: <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   3310:       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
                   3311:       from multiple locations. It currently supports the following
                   3312:       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.91      rillig   3313: <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   3314:       packages someplace else (enabled by default).</p></li>
1.91      rillig   3315: <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   3316:       best compiler flags to optimise code for your current CPU and
                   3317:       compiler.</p></li>
                   3318: </ul></div>
                   3319: <p>Utilities for keeping track of installed packages, being up to date,
                   3320: etc:</p>
                   3321: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3322: <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   3323:       packages whose installed versions do not match the latest pkgsrc
                   3324:       entries.</p></li>
1.91      rillig   3325: <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   3326:       dependency graphs of packages, to aid in choosing a strategy for
                   3327:       updating.</p></li>
1.91      rillig   3328: <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
                   3329:       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>
                   3330: <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.75      rillig   3331:       pkglint(1) program checks a pkgsrc entry for errors, lintpkgsrc(1)
                   3332:       does various checks on the complete pkgsrc system.</p></li>
1.91      rillig   3333: <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   3334:       packages you have installed.</p></li>
                   3335: </ul></div>
                   3336: <p>Utilities for people maintaining or creating individual packages:</p>
                   3337: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3338: <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   3339:       making and maintaining patches for a package (includes pkgdiff,
                   3340:       pkgvi, mkpatches, etc.).</p></li>
1.91      rillig   3341: <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>,
                   3342:       <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   3343:       converting to pkgsrc.</p></li>
1.91      rillig   3344: <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   3345:       pkgsrc to a Solaris package.</p></li>
                   3346: </ul></div>
                   3347: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
                   3348: utilities)</p>
                   3349: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3350: <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   3351:       packages in a chrooted area.</p></li>
1.91      rillig   3352: <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   3353:       kernel version for chrooted cross builds.</p></li>
                   3354: </ul></div>
                   3355: </div>
                   3356: <div class="sect1" lang="en">
                   3357: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3358: <a name="non-root-pkgsrc"></a>8.4. How to use pkgsrc as non-root</h2></div></div></div>
1.75      rillig   3359: <p>If you want to use pkgsrc as non-root user, you can set some
                   3360: variables to make pkgsrc work under these conditions.  At the very least,
                   3361: you need to set <code class="varname">UNPRIVILEGED</code> to &#8220;<span class="quote">yes</span>&#8221;; this
                   3362: will turn on unprivileged mode and set multiple related variables to allow
                   3363: installation of packages as non-root.</p>
                   3364: <p>In case the defaults are not enough, you may want to tune some other
                   3365: variables used.  For example, if the automatic user/group detection leads
                   3366: to incorrect values (or not the ones you would like to use), you can change
                   3367: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
                   3368: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
                   3369: <p>As regards bootstrapping, please note that the
                   3370: <span><strong class="command">bootstrap</strong></span> script will ease non-root configuration when
                   3371: given the &#8220;<span class="quote">--ignore-user-check</span>&#8221; flag, as it will choose and
1.76      rillig   3372: use multiple default directories under <code class="filename">~/pkg</code> as the
1.93      rillig   3373: installation targets.  These directories can be overridden by the
1.75      rillig   3374: &#8220;<span class="quote">--prefix</span>&#8221; flag provided by the script, as well as some others
                   3375: that allow finer tuning of the tree layout.</p>
                   3376: </div>
                   3377: <div class="sect1" lang="en">
                   3378: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3379: <a name="resume-transfers"></a>8.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75      rillig   3380: <p>By default, resuming transfers in pkgsrc is disabled, but you can
                   3381: enable this feature by adding the option
                   3382: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.76      rillig   3383: <code class="filename">/etc/mk.conf</code>.  If, during a fetch step, an incomplete
1.75      rillig   3384: distfile is found, pkgsrc will try to resume it.</p>
                   3385: <p>You can also
                   3386: use a different program than the default <a 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
                   3387: <code class="varname">FETCH_CMD</code> variable.  Don't forget to set
                   3388: <code class="varname">FETCH_RESUME_ARGS</code> and
                   3389: <code class="varname">FETCH_OUTPUT_ARGS</code> if you are not using default
                   3390: values.</p>
                   3391: <p>For example, if you want to use
1.76      rillig   3392: <code class="filename">wget</code> to resume downloads, you'll have to use something
1.75      rillig   3393: like:</p>
                   3394: <pre class="programlisting">
                   3395:     FETCH_CMD=             wget
                   3396:     FETCH_BEFORE_ARGS=     --passive-ftp
                   3397:     FETCH_RESUME_ARGS=     -c
                   3398:     FETCH_OUTPUT_ARGS=     -O
1.1       grant    3399: </pre>
1.75      rillig   3400: </div>
                   3401: <div class="sect1" lang="en">
                   3402: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3403: <a name="XFree86-from-pkgsrc"></a>8.6. How can I install/use XFree86 from pkgsrc?</h2></div></div></div>
1.75      rillig   3404: <p>If you want to use XFree86 from pkgsrc instead of your system's own
1.76      rillig   3405: X11 (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>,
1.75      rillig   3406: ...), you will have to add the following line into
1.76      rillig   3407: <code class="filename">/etc/mk.conf</code>:</p>
1.75      rillig   3408: <pre class="programlisting">
                   3409:     X11_TYPE=XFree86
1.1       grant    3410: </pre>
1.75      rillig   3411: </div>
                   3412: <div class="sect1" lang="en">
                   3413: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3414: <a name="x.org-from-pkgsrc"></a>8.7. How can I install/use X.org from pkgsrc?</h2></div></div></div>
1.75      rillig   3415: <p>If you want to use X.org from pkgsrc instead of your system's own X11
1.76      rillig   3416: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75      rillig   3417: you will have to add the following line into
1.76      rillig   3418: <code class="filename">/etc/mk.conf</code>:</p>
1.75      rillig   3419: <pre class="programlisting">
                   3420:     X11_TYPE=xorg
1.1       grant    3421: </pre>
1.75      rillig   3422: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   3423: <h3 class="title">Note</h3>
                   3424: <p>The DragonFly operating system defaults to using
1.87      wiz      3425: this X.org X11 implementation from pkgsrc.</p>
1.75      rillig   3426: </div>
                   3427: </div>
                   3428: <div class="sect1" lang="en">
                   3429: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3430: <a name="fetch-behind-firewall"></a>8.8. How to fetch files from behind a firewall</h2></div></div></div>
1.75      rillig   3431: <p>If you are sitting behind a firewall which does not allow direct
                   3432: connections to Internet hosts (i.e. non-NAT), you may specify the
                   3433: relevant proxy hosts.  This is done using an environment variable in the
                   3434: form of a URL, e.g. in Amdahl, the machine
                   3435: &#8220;<span class="quote">orpheus.amdahl.com</span>&#8221; is one of the firewalls, and it uses
                   3436: port 80 as the proxy port number.  So the proxy environment variables
                   3437: are:</p>
                   3438: <pre class="programlisting">
                   3439:     ftp_proxy=ftp://orpheus.amdahl.com:80/
                   3440:     http_proxy=http://orpheus.amdahl.com:80/
1.1       grant    3441: </pre>
1.75      rillig   3442: </div>
                   3443: <div class="sect1" lang="en">
                   3444: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3445: <a name="passive-ftp"></a>8.9. How do I tell <span><strong class="command">make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.75      rillig   3446: <p>This depends on which utility is used to retrieve distfiles.  From
1.76      rillig   3447: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75      rillig   3448: the first available command from the following list:</p>
                   3449: <div class="itemizedlist"><ul type="disc">
1.76      rillig   3450: <li><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
                   3451: <li><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75      rillig   3452: </ul></div>
                   3453: <p>On a default NetBSD installation, this will be
1.76      rillig   3454: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75      rillig   3455: connections first, and falls back to active connections if the server
                   3456: refuses to do passive.  For the other tools, add the following to your
1.76      rillig   3457: <code class="filename">/etc/mk.conf</code> file:
1.75      rillig   3458: <code class="varname">PASSIVE_FETCH=1</code>.</p>
                   3459: <p>Having that option present will prevent
1.76      rillig   3460: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75      rillig   3461: transfers.</p>
                   3462: </div>
                   3463: <div class="sect1" lang="en">
                   3464: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3465: <a name="fetching-all-distfiles"></a>8.10. How to fetch all distfiles at once</h2></div></div></div>
1.88      wiz      3466: <p>You would like to download all the distfiles in a single batch
                   3467: from work or university, where you can't run a <span><strong class="command">make
                   3468: fetch</strong></span>.  There is an archive of distfiles on <a href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/" target="_top">ftp.NetBSD.org</a>,
1.75      rillig   3469: but downloading the entire directory may not be appropriate.</p>
                   3470: <p>The answer here is to do a <span><strong class="command">make fetch-list</strong></span> in
1.76      rillig   3471: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75      rillig   3472: resulting list to your machine at work/school and use it there.  If you
                   3473: don't have a NetBSD-compatible <a 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
                   3474: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
                   3475: URL:</p>
                   3476: <p>At home:</p>
                   3477: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   3478: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
                   3479: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
                   3480: <p>At work:</p>
                   3481: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76      rillig   3482: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75      rillig   3483: home.</p>
                   3484: <p>If you have a machine running NetBSD, and you want to get
1.88      wiz      3485: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
                   3486: machine architecture), you can do so by using the above-mentioned
                   3487: <span><strong class="command">make fetch-list</strong></span> approach, or fetch the distfiles
                   3488: directly by running:</p>
1.75      rillig   3489: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
                   3490: <p>If you even decide to ignore
                   3491: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
                   3492: by running:</p>
                   3493: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
                   3494: </div>
                   3495: <div class="sect1" lang="en">
                   3496: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3497: <a name="tmac.andoc-missing"></a>8.11. What does &#8220;<span class="quote">Don't know how to make
1.75      rillig   3498: /usr/share/tmac/tmac.andoc</span>&#8221; mean?</h2></div></div></div>
1.91      rillig   3499: <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   3500: package, you get the error from make that it doesn't know how to make
1.76      rillig   3501: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.75      rillig   3502: you don't have installed the &#8220;<span class="quote">text</span>&#8221; set (nroff, ...) from
                   3503: the NetBSD base distribution on your machine.  It is recommended to do
                   3504: that to format man pages.</p>
1.91      rillig   3505: <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   3506: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.76      rillig   3507: environment or in <code class="filename">/etc/mk.conf</code>.</p>
1.75      rillig   3508: </div>
                   3509: <div class="sect1" lang="en">
                   3510: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3511: <a name="bsd.own.mk-missing"></a>8.12. What does &#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221; mean?</h2></div></div></div>
1.87      wiz      3512: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75      rillig   3513: when you installed your NetBSD machine.  Please get and install it, by
1.76      rillig   3514: extracting it in <code class="filename">/</code>:</p>
1.75      rillig   3515: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   3516: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76      rillig   3517: <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
1.75      rillig   3518: the one that corresponds to your release (determine via <span><strong class="command">uname
                   3519: -r</strong></span>).</p>
                   3520: </div>
                   3521: <div class="sect1" lang="en">
                   3522: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3523: <a name="using-sudo-with-pkgsrc"></a>8.13. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75      rillig   3524: <p>When installing packages as non-root user and using the just-in-time
                   3525: <a 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
                   3526: password for each required package installed.  To avoid this, the sudo
                   3527: package can be used, which does password caching over a limited time.  To
                   3528: use it, install sudo (either as binary package or from
1.91      rillig   3529: <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 following
1.76      rillig   3530: into your <code class="filename">/etc/mk.conf</code>:</p>
1.75      rillig   3531: <pre class="programlisting">
                   3532:     .if exists(${LOCALBASE}/bin/sudo)
                   3533:     SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
                   3534:     .endif
1.1       grant    3535: </pre>
1.75      rillig   3536: </div>
                   3537: <div class="sect1" lang="en">
                   3538: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3539: <a name="faq.conf"></a>8.14. How do I change the location of configuration files?</h2></div></div></div>
1.75      rillig   3540: <p>As the system administrator, you can choose where configuration files
                   3541: are installed.  The default settings make all these files go into
1.76      rillig   3542: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75      rillig   3543: be suboptimal depending on your expectations (e.g., a read-only,
                   3544: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
                   3545: configuration of the provided packages).</p>
                   3546: <p>In order to change the defaults, you can modify the
                   3547: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.76      rillig   3548: <code class="filename">/etc/mk.conf</code>) to point to your preferred configuration
                   3549: directory; some common examples include <code class="filename">/etc</code> or
                   3550: <code class="filename">/etc/pkg</code>.</p>
1.75      rillig   3551: <p>Furthermore, you can change this value on a per-package basis by
                   3552: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
                   3553: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
                   3554: package you would like to modify, that is, the contents of
                   3555: <code class="varname">PKGBASE</code>.</p>
                   3556: <p>Note that after changing these settings, you must rebuild and
                   3557: reinstall any affected packages.</p>
                   3558: </div>
                   3559: <div class="sect1" lang="en">
                   3560: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3561: <a name="audit-packages"></a>8.15. Automated security checks</h2></div></div></div>
1.75      rillig   3562: <p>Please be aware that there can often be bugs in third-party software,
                   3563: and some of these bugs can leave a machine vulnerable to exploitation by
                   3564: attackers.  In an effort to lessen the exposure, the NetBSD packages team
                   3565: maintains a database of known-exploits to packages which have at one time
                   3566: been included in pkgsrc.  The database can be downloaded automatically, and
                   3567: a security audit of all packages installed on a system can take place.  To
1.91      rillig   3568: do this, install the <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> package.  It has two
1.75      rillig   3569: components:</p>
                   3570: <div class="orderedlist"><ol type="1">
                   3571: <li>
                   3572: <p><span><strong class="command">download-vulnerability-list</strong></span>, an easy way to
                   3573:     download a list of the security vulnerabilities information.  This list
                   3574:     is kept up to date by the NetBSD security officer and the NetBSD
                   3575:     packages team, and is distributed from the NetBSD ftp server:</p>
                   3576: <p><a 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>
                   3577: </li>
                   3578: <li><p><span><strong class="command">audit-packages</strong></span>, an easy way to audit the
                   3579:     current machine, checking each vulnerability which is known.  If a
                   3580:     vulnerable package is installed, it will be shown by output to stdout,
                   3581:     including a description of the type of vulnerability, and a URL
                   3582:     containing more information.</p></li>
                   3583: </ol></div>
1.91      rillig   3584: <p>Use of the <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.75      rillig   3585: package is strongly recommended!  After
                   3586: &#8220;<span class="quote">audit-packages</span>&#8221; is installed, please read
                   3587: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
                   3588: audit-packages</code></strong>.</p>
1.87      wiz      3589: <p>If this package is installed, pkgsrc builds will use it to
                   3590: perform a security check before building any package.  See <a 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
                   3591: check.</p>
1.75      rillig   3592: </div>
                   3593: <div class="sect1" lang="en">
                   3594: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3595: <a name="ufaq-cflags"></a>8.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.75      rillig   3596: <p>When you add your own preferences to the
                   3597:        <code class="varname">CFLAGS</code> variable in your
1.76      rillig   3598:        <code class="filename">mk.conf</code>, these flags are passed in
                   3599:        environment variables to the <code class="filename">./configure</code>
1.75      rillig   3600:        scripts and to <a 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
                   3601:        <code class="varname">CFLAGS</code> from the environment variable by
1.76      rillig   3602:        overriding them in the <code class="filename">Makefile</code>s of their
1.75      rillig   3603:        package.</p>
                   3604: <p>Currently there is no solution to this problem. If you
                   3605:        really need the package to use your <code class="varname">CFLAGS</code>
                   3606:        you should run <span><strong class="command">make patch</strong></span> in the package
1.76      rillig   3607:        directory and then inspect any <code class="filename">Makefile</code> and
                   3608:        <code class="filename">Makefile.in</code> for whether they define
1.75      rillig   3609:        <code class="varname">CFLAGS</code> explicitly. Usually you can remove
                   3610:        these lines. But be aware that some &#8220;<span class="quote">smart</span>&#8221;
                   3611:        programmers write so bad code that it only works for the
                   3612:        specific combination of <code class="varname">CFLAGS</code> they have
                   3613:        chosen.</p>
                   3614: </div>
1.80      rillig   3615: <div class="sect1" lang="en">
                   3616: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3617: <a name="ufaq-fail"></a>8.17. A package does not build.  What shall I do?</h2></div></div></div>
1.80      rillig   3618: <div class="procedure"><ol type="1">
                   3619: <li><p>Make sure that your copy of pkgsrc is consistent. A
                   3620:        case that occurs often is that people only update pkgsrc in
                   3621:        parts, because of performance reasons. Since pkgsrc is one large
                   3622:        system, not a collection of many small systems, there are
                   3623:        sometimes changes that only work when the whole pkgsrc tree is
                   3624:        updated.</p></li>
                   3625: <li><p>Make sure that you don't have any CVS conflicts.
                   3626:        Search for &#8220;<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>&#8221; or
                   3627:        &#8220;<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>&#8221; in all your pkgsrc
                   3628:        files.</p></li>
                   3629: <li><p>Make sure that you don't have old copies of the packages
                   3630:        extracted. Run <span><strong class="command">make clean clean-depends</strong></span> to
                   3631:        verify this.</p></li>
                   3632: <li><p>If the problem still exists, write a mail to the
                   3633:        <code class="literal">pkgsrc-users</code> mailing list.</p></li>
                   3634: </ol></div>
                   3635: </div>
1.88      wiz      3636: <div class="sect1" lang="en">
                   3637: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3638: <a name="faq.rcs-conflicts"></a>8.18. 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   3639: <p>You have modified a file from pkgsrc, and someone else has
                   3640: modified that same file afterwards in the CVS repository. Both changes
                   3641: are in the same region of the file, so when you updated pkgsrc, the
                   3642: <code class="literal">cvs</code> command marked the conflicting changes in the
                   3643: file. Because of these markers, the file is no longer a valid
                   3644: <code class="filename">Makefile</code>.</p>
                   3645: <p>Have a look at that file, and if you don't need your local changes
                   3646: anymore, you can remove that file and run <span><strong class="command">cvs -q update
                   3647: -dP</strong></span> in that directory to download the current version.</p>
                   3648: </div>
1.75      rillig   3649: </div>
                   3650: </div>
                   3651: <div class="part" lang="en">
                   3652: <div class="titlepage"><div><div><h1 class="title">
                   3653: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.77      rillig   3654: <div class="partintro" lang="en">
                   3655: <div></div>
                   3656: <p>This part of the book deals with creating and
                   3657:        modifying packages. It starts with a &#8220;<span class="quote">HOWTO</span>&#8221;-like
                   3658:        guide on creating a new package. The remaining chapters are more
                   3659:        like a reference manual for pkgsrc.</p>
1.75      rillig   3660: <div class="toc">
                   3661: <p><b>Table of Contents</b></p>
                   3662: <dl>
1.90      rillig   3663: <dt><span class="chapter"><a href="#creating">9. Creating a new pkgsrc package from scratch</a></span></dt>
1.91      rillig   3664: <dd><dl>
                   3665: <dt><span class="sect1"><a href="#creating.common">9.1. Common types of packages</a></span></dt>
                   3666: <dd><dl>
                   3667: <dt><span class="sect2"><a href="#creating.perl-module">9.1.1. Perl modules</a></span></dt>
                   3668: <dt><span class="sect2"><a href="#creating.kde-app">9.1.2. KDE applications</a></span></dt>
                   3669: </dl></dd>
                   3670: <dt><span class="sect1"><a href="#creating.examples">9.2. Examples</a></span></dt>
                   3671: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">9.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
                   3672: </dl></dd>
1.90      rillig   3673: <dt><span class="chapter"><a href="#components">10. Package components - files, directories and contents</a></span></dt>
1.75      rillig   3674: <dd><dl>
1.90      rillig   3675: <dt><span class="sect1"><a href="#components.Makefile">10.1. <code class="filename">Makefile</code></a></span></dt>
                   3676: <dt><span class="sect1"><a href="#components.distinfo">10.2. <code class="filename">distinfo</code></a></span></dt>
                   3677: <dt><span class="sect1"><a href="#components.patches">10.3. patches/*</a></span></dt>
                   3678: <dd><dl>
1.93      rillig   3679: <dt><span class="sect2"><a href="#components.patch.structure">10.3.1. Structure of a single patch file</a></span></dt>
                   3680: <dt><span class="sect2"><a href="#components.patches.caveats">10.3.2. Creating patch files</a></span></dt>
                   3681: <dt><span class="sect2"><a href="#components.patches.sources">10.3.3. Sources where the patch files come from</a></span></dt>
                   3682: <dt><span class="sect2"><a href="#components.patches.guidelines">10.3.4. Patching guidelines</a></span></dt>
                   3683: <dt><span class="sect2"><a href="#components.patches.feedback">10.3.5. Feedback to the author</a></span></dt>
1.90      rillig   3684: </dl></dd>
                   3685: <dt><span class="sect1"><a href="#other-mandatory-files">10.4. Other mandatory files</a></span></dt>
                   3686: <dt><span class="sect1"><a href="#components.optional">10.5. Optional files</a></span></dt>
                   3687: <dd><dl>
                   3688: <dt><span class="sect2"><a href="#components.optional.bin">10.5.1. Files affecting the binary package</a></span></dt>
                   3689: <dt><span class="sect2"><a href="#components.optional.build">10.5.2. Files affecting the build process</a></span></dt>
                   3690: <dt><span class="sect2"><a href="#components.optional.none">10.5.3. Files affecting nothing at all</a></span></dt>
                   3691: </dl></dd>
                   3692: <dt><span class="sect1"><a href="#work-dir">10.6. <code class="filename">work*</code></a></span></dt>
                   3693: <dt><span class="sect1"><a href="#files-dir">10.7. <code class="filename">files/*</code></a></span></dt>
                   3694: </dl></dd>
                   3695: <dt><span class="chapter"><a href="#makefile">11. Programming in <code class="filename">Makefile</code>s</a></span></dt>
                   3696: <dd><dl>
1.97    ! rillig   3697: <dt><span class="sect1"><a href="#makefile.style">11.1. Caveats</a></span></dt>
        !          3698: <dt><span class="sect1"><a href="#makefile.variables">11.2. <code class="filename">Makefile</code> variables</a></span></dt>
        !          3699: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">11.2.1. Naming conventions</a></span></dt></dl></dd>
        !          3700: <dt><span class="sect1"><a href="#makefile.code">11.3. Code snippets</a></span></dt>
        !          3701: <dd><dl>
        !          3702: <dt><span class="sect2"><a href="#adding-to-list">11.3.1. Adding things to a list</a></span></dt>
        !          3703: <dt><span class="sect2"><a href="#converting-internal-to-external">11.3.2. Converting an internal list into an external list</a></span></dt>
        !          3704: <dt><span class="sect2"><a href="#passing-variable-to-shell">11.3.3. Passing variables to a shell command</a></span></dt>
        !          3705: <dt><span class="sect2"><a href="#quoting-guideline">11.3.4. Quoting guideline</a></span></dt>
        !          3706: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">11.3.5. Workaround for a bug in BSD Make</a></span></dt>
1.90      rillig   3707: </dl></dd>
                   3708: </dl></dd>
                   3709: <dt><span class="chapter"><a href="#plist">12. PLIST issues</a></span></dt>
                   3710: <dd><dl>
                   3711: <dt><span class="sect1"><a href="#rcs-id">12.1. RCS ID</a></span></dt>
                   3712: <dt><span class="sect1"><a href="#automatic-plist-generation">12.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   3713: <dt><span class="sect1"><a href="#print-PLIST">12.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span></a></span></dt>
                   3714: <dt><span class="sect1"><a href="#plist.misc">12.4. Variable substitution in PLIST</a></span></dt>
                   3715: <dt><span class="sect1"><a href="#manpage-compression">12.5. Man page compression</a></span></dt>
                   3716: <dt><span class="sect1"><a href="#using-PLIST_SRC">12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   3717: <dt><span class="sect1"><a href="#platform-specific-plist">12.7. Platform-specific and differing PLISTs</a></span></dt>
                   3718: <dt><span class="sect1"><a href="#faq.common-dirs">12.8. Sharing directories between packages</a></span></dt>
                   3719: </dl></dd>
                   3720: <dt><span class="chapter"><a href="#buildlink">13. Buildlink methodology</a></span></dt>
                   3721: <dd><dl>
                   3722: <dt><span class="sect1"><a href="#converting-to-buildlink3">13.1. Converting packages to use buildlink3</a></span></dt>
                   3723: <dt><span class="sect1"><a href="#creating-buildlink3.mk">13.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
                   3724: <dd><dl>
                   3725: <dt><span class="sect2"><a href="#anatomy-of-bl3">13.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   3726: <dt><span class="sect2"><a href="#updating-buildlink-depends">13.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</a></span></dt>
                   3727: </dl></dd>
                   3728: <dt><span class="sect1"><a href="#writing-builtin.mk">13.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
                   3729: <dd><dl>
                   3730: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">13.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
                   3731: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">13.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                   3732: </dl></dd>
                   3733: </dl></dd>
                   3734: <dt><span class="chapter"><a href="#pkginstall">14. The pkginstall framework</a></span></dt>
                   3735: <dd><dl>
                   3736: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">14.1. Files and directories outside the installation prefix</a></span></dt>
                   3737: <dd><dl>
                   3738: <dt><span class="sect2"><a href="#dirs-outside-prefix">14.1.1. Directory manipulation</a></span></dt>
                   3739: <dt><span class="sect2"><a href="#files-outside-prefix">14.1.2. File manipulation</a></span></dt>
                   3740: </dl></dd>
                   3741: <dt><span class="sect1"><a href="#conf-files">14.2. Configuration files</a></span></dt>
                   3742: <dd><dl>
                   3743: <dt><span class="sect2"><a href="#conf-files-sysconfdir">14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   3744: <dt><span class="sect2"><a href="#conf-files-configure">14.2.2. Telling the software where configuration files are</a></span></dt>
                   3745: <dt><span class="sect2"><a href="#conf-files-patching">14.2.3. Patching installations</a></span></dt>
                   3746: <dt><span class="sect2"><a href="#conf-files-disable">14.2.4. Disabling handling of configuration files</a></span></dt>
                   3747: </dl></dd>
                   3748: <dt><span class="sect1"><a href="#rcd-scripts">14.3. System startup scripts</a></span></dt>
                   3749: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">14.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
                   3750: <dt><span class="sect1"><a href="#users-and-groups">14.4. System users and groups</a></span></dt>
                   3751: <dt><span class="sect1"><a href="#shells">14.5. System shells</a></span></dt>
                   3752: <dd><dl><dt><span class="sect2"><a href="#shells-disable">14.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   3753: <dt><span class="sect1"><a href="#fonts">14.6. Fonts</a></span></dt>
                   3754: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">14.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
                   3755: </dl></dd>
                   3756: <dt><span class="chapter"><a href="#options">15. Options handling</a></span></dt>
                   3757: <dd><dl>
                   3758: <dt><span class="sect1"><a href="#global-default-options">15.1. Global default options</a></span></dt>
                   3759: <dt><span class="sect1"><a href="#converting-to-options">15.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
                   3760: <dt><span class="sect1"><a href="#option-names">15.3. Option Names</a></span></dt>
                   3761: </dl></dd>
                   3762: <dt><span class="chapter"><a href="#build">16. The build process</a></span></dt>
                   3763: <dd><dl>
                   3764: <dt><span class="sect1"><a href="#build.intro">16.1. Introduction</a></span></dt>
                   3765: <dt><span class="sect1"><a href="#build.prefix">16.2. Program location</a></span></dt>
                   3766: <dt><span class="sect1"><a href="#build.builddirs">16.3. Directories used during the build process</a></span></dt>
                   3767: <dt><span class="sect1"><a href="#build.running">16.4. Running a phase</a></span></dt>
                   3768: <dt><span class="sect1"><a href="#build.fetch">16.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   3769: <dd><dl>
                   3770: <dt><span class="sect2"><a href="#build.fetch.what">16.5.1. What to fetch and where to get it from</a></span></dt>
                   3771: <dt><span class="sect2"><a href="#build.fetch.how">16.5.2. How are the files fetched?</a></span></dt>
                   3772: </dl></dd>
                   3773: <dt><span class="sect1"><a href="#build.checksum">16.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   3774: <dt><span class="sect1"><a href="#build.extract">16.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   3775: <dt><span class="sect1"><a href="#build.patch">16.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   3776: <dt><span class="sect1"><a href="#build.tools">16.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   3777: <dt><span class="sect1"><a href="#build.wrapper">16.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   3778: <dt><span class="sect1"><a href="#build.configure">16.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   3779: <dt><span class="sect1"><a href="#build.build">16.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   3780: <dt><span class="sect1"><a href="#build.test">16.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   3781: <dt><span class="sect1"><a href="#build.install">16.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   3782: <dt><span class="sect1"><a href="#build.package">16.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   3783: <dt><span class="sect1"><a href="#build.clean">16.16. Cleaning up</a></span></dt>
                   3784: <dt><span class="sect1"><a href="#build.helpful-targets">16.17. Other helpful targets</a></span></dt>
                   3785: </dl></dd>
                   3786: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
                   3787: <dd><dl>
                   3788: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                   3789: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                   3790: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.97    ! rillig   3791: <dt><span class="sect1"><a href="#tools.questions">17.4. Questions regarding the tools</a></span></dt>
1.90      rillig   3792: </dl></dd>
                   3793: <dt><span class="chapter"><a href="#fixes">18. Making your package work</a></span></dt>
                   3794: <dd><dl>
                   3795: <dt><span class="sect1"><a href="#general-operation">18.1. General operation</a></span></dt>
                   3796: <dd><dl>
                   3797: <dt><span class="sect2"><a href="#portability-of-packages">18.1.1. Portability of packages</a></span></dt>
                   3798: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">18.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
                   3799: <dt><span class="sect2"><a href="#user-interaction">18.1.3. User interaction</a></span></dt>
                   3800: <dt><span class="sect2"><a href="#handling-licenses">18.1.4. Handling licenses</a></span></dt>
                   3801: <dt><span class="sect2"><a href="#restricted-packages">18.1.5. Restricted packages</a></span></dt>
                   3802: <dt><span class="sect2"><a href="#dependencies">18.1.6. Handling dependencies</a></span></dt>
                   3803: <dt><span class="sect2"><a href="#conflicts">18.1.7. Handling conflicts with other packages</a></span></dt>
                   3804: <dt><span class="sect2"><a href="#not-building-packages">18.1.8. Packages that cannot or should not be built</a></span></dt>
                   3805: <dt><span class="sect2"><a href="#undeletable-packages">18.1.9. Packages which should not be deleted, once installed</a></span></dt>
                   3806: <dt><span class="sect2"><a href="#security-handling">18.1.10. Handling packages with security problems</a></span></dt>
                   3807: <dt><span class="sect2"><a href="#bumping-pkgrevision">18.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   3808: <dt><span class="sect2"><a href="#fixes.subst">18.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   3809: </dl></dd>
                   3810: <dt><span class="sect1"><a href="#fixes.fetch">18.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   3811: <dd><dl>
                   3812: <dt><span class="sect2"><a href="#no-plain-download">18.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   3813: <dt><span class="sect2"><a href="#modified-distfiles-same-name">18.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
                   3814: </dl></dd>
                   3815: <dt><span class="sect1"><a href="#fixes.configure">18.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   3816: <dd><dl>
                   3817: <dt><span class="sect2"><a href="#fixes.libtool">18.3.1. Shared libraries - libtool</a></span></dt>
                   3818: <dt><span class="sect2"><a href="#using-libtool">18.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   3819: <dt><span class="sect2"><a href="#autoconf-automake">18.3.3. GNU Autoconf/Automake</a></span></dt>
                   3820: </dl></dd>
                   3821: <dt><span class="sect1"><a href="#programming-languages">18.4. Programming languages</a></span></dt>
                   3822: <dd><dl>
                   3823: <dt><span class="sect2"><a href="#basic-programming-languages">18.4.1. C, C++, and Fortran</a></span></dt>
                   3824: <dt><span class="sect2"><a href="#java-programming-language">18.4.2. Java</a></span></dt>
                   3825: <dt><span class="sect2"><a href="#perl-scripts">18.4.3. Packages containing perl scripts</a></span></dt>
                   3826: <dt><span class="sect2"><a href="#other-programming-languages">18.4.4. Other programming languages</a></span></dt>
                   3827: </dl></dd>
                   3828: <dt><span class="sect1"><a href="#fixes.build">18.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   3829: <dd><dl>
                   3830: <dt><span class="sect2"><a href="#fixes.build.cpp">18.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   3831: <dt><span class="sect2"><a href="#compiler-bugs">18.5.2. How to handle compiler bugs</a></span></dt>
                   3832: <dt><span class="sect2"><a href="#undefined-reference">18.5.3. Undefined reference to &#8220;<span class="quote">...</span>&#8221;</a></span></dt>
                   3833: <dt><span class="sect2"><a href="#out-of-memory">18.5.4. Running out of memory</a></span></dt>
                   3834: </dl></dd>
                   3835: <dt><span class="sect1"><a href="#fixes.install">18.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   3836: <dd><dl>
                   3837: <dt><span class="sect2"><a href="#install-scripts">18.6.1. Creating needed directories</a></span></dt>
                   3838: <dt><span class="sect2"><a href="#where-to-install-documentation">18.6.2. Where to install documentation</a></span></dt>
                   3839: <dt><span class="sect2"><a href="#installing-score-files">18.6.3. Installing score files</a></span></dt>
                   3840: <dt><span class="sect2"><a href="#hardcoded-paths">18.6.4. Packages with hardcoded paths to other interpreters</a></span></dt>
                   3841: <dt><span class="sect2"><a href="#perl-modules">18.6.5. Packages installing perl modules</a></span></dt>
                   3842: <dt><span class="sect2"><a href="#faq.info-files">18.6.6. Packages installing info files</a></span></dt>
                   3843: <dt><span class="sect2"><a href="#manpages">18.6.7. Packages installing man pages</a></span></dt>
                   3844: <dt><span class="sect2"><a href="#gconf2-data-files">18.6.8. Packages installing GConf2 data files</a></span></dt>
                   3845: <dt><span class="sect2"><a href="#scrollkeeper-data-files">18.6.9. Packages installing scrollkeeper data files</a></span></dt>
                   3846: <dt><span class="sect2"><a href="#x11-fonts">18.6.10. Packages installing X11 fonts</a></span></dt>
                   3847: <dt><span class="sect2"><a href="#gtk2-modules">18.6.11. Packages installing GTK2 modules</a></span></dt>
                   3848: <dt><span class="sect2"><a href="#sgml-xml-data">18.6.12. Packages installing SGML or XML data</a></span></dt>
                   3849: <dt><span class="sect2"><a href="#mime-database">18.6.13. Packages installing extensions to the MIME database</a></span></dt>
                   3850: <dt><span class="sect2"><a href="#intltool">18.6.14. Packages using intltool</a></span></dt>
                   3851: <dt><span class="sect2"><a href="#startup-scripts">18.6.15. Packages installing startup scripts</a></span></dt>
                   3852: <dt><span class="sect2"><a href="#tex-packages">18.6.16. Packages installing TeX modules</a></span></dt>
                   3853: <dt><span class="sect2"><a href="#emulation-packages">18.6.17. Packages supporting running binaries in
1.87      wiz      3854:     emulation</a></span></dt>
1.90      rillig   3855: <dt><span class="sect2"><a href="#hicolor-theme">18.6.18. Packages installing hicolor theme icons</a></span></dt>
                   3856: <dt><span class="sect2"><a href="#desktop-files">18.6.19. Packages installing desktop files</a></span></dt>
1.77      rillig   3857: </dl></dd>
1.90      rillig   3858: <dt><span class="sect1"><a href="#punting">18.7. Marking packages as having problems</a></span></dt>
1.77      rillig   3859: </dl></dd>
1.90      rillig   3860: <dt><span class="chapter"><a href="#debug">19. Debugging</a></span></dt>
                   3861: <dt><span class="chapter"><a href="#submit">20. Submitting and Committing</a></span></dt>
1.77      rillig   3862: <dd><dl>
1.90      rillig   3863: <dt><span class="sect1"><a href="#submitting-binary-packages">20.1. Submitting binary packages</a></span></dt>
                   3864: <dt><span class="sect1"><a href="#submitting-your-package">20.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   3865: <dt><span class="sect1"><a href="#general-notes-for-changes">20.3. General notes when adding, updating, or removing packages</a></span></dt>
                   3866: <dt><span class="sect1"><a href="#committing-importing">20.4. Committing: Importing a package into CVS</a></span></dt>
                   3867: <dt><span class="sect1"><a href="#updating-package">20.5. Updating a package to a newer version</a></span></dt>
                   3868: <dt><span class="sect1"><a href="#moving-package">20.6. Moving a package in pkgsrc</a></span></dt>
                   3869: </dl></dd>
                   3870: <dt><span class="chapter"><a href="#devfaq">21. Frequently Asked Questions</a></span></dt>
                   3871: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
                   3872: <dd><dl>
                   3873: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                   3874: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                   3875: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                   3876: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
1.85      jmmv     3877: </dl></dd>
1.75      rillig   3878: </dl>
                   3879: </div>
1.77      rillig   3880: </div>
                   3881: <div class="chapter" lang="en">
                   3882: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   3883: <a name="creating"></a>Chapter 9. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91      rillig   3884: <div class="toc">
                   3885: <p><b>Table of Contents</b></p>
                   3886: <dl>
                   3887: <dt><span class="sect1"><a href="#creating.common">9.1. Common types of packages</a></span></dt>
                   3888: <dd><dl>
                   3889: <dt><span class="sect2"><a href="#creating.perl-module">9.1.1. Perl modules</a></span></dt>
                   3890: <dt><span class="sect2"><a href="#creating.kde-app">9.1.2. KDE applications</a></span></dt>
                   3891: </dl></dd>
                   3892: <dt><span class="sect1"><a href="#creating.examples">9.2. Examples</a></span></dt>
                   3893: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">9.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
                   3894: </dl>
                   3895: </div>
1.77      rillig   3896: <p>When you find a package that is not yet in pkgsrc, you
1.91      rillig   3897: most likely have a URL from where you can download the source
                   3898: code. Starting with this URL, creating a package involves only a
                   3899: few steps.</p>
1.77      rillig   3900: <div class="procedure"><ol type="1">
1.91      rillig   3901: <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   3902: <li><p>Then, choose one of the top-level directories as the
1.91      rillig   3903: category in which you want to place your package. You can also create a
                   3904: directory of your own (maybe called <code class="filename">local</code>). In that
                   3905: category directory, create another directory for your package and change
                   3906: into it.</p></li>
                   3907: <li><p>Run the program <span><strong class="command">url2pkg</strong></span>, which will ask
                   3908: you for a URL. Enter the URL of the distribution file (in most cases a
                   3909: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
                   3910: of your package are created automatically. The distribution file is
                   3911: extracted automatically to fill in some details in the
                   3912: <code class="filename">Makefile</code> that would otherwise have to be done
                   3913: manually.</p></li>
                   3914: <li>
                   3915: <p>Examine the extracted files to determine the dependencies of
                   3916: your package. Ideally, this is mentioned in some
                   3917: <code class="filename">README</code> file, but things may differ. For each of
                   3918: these dependencies, look where it exists in pkgsrc, and if there is a
                   3919: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   3920: line to your package <code class="filename">Makefile</code> which includes that
                   3921: file just before the last line. If the
                   3922: <code class="filename">buildlink3.mk</code> file does not exist, add a
                   3923: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   3924: version of the dependency and where it can be found in pkgsrc. This line
                   3925: should be placed in the third paragraph. If the dependency is only
                   3926: needed for building the package, but not when using it, use
                   3927: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
                   3928: Your package may then look like this:</p>
1.77      rillig   3929: <pre class="programlisting">
                   3930:     [...]
                   3931: 
                   3932:     BUILD_DEPENDS+= lua&gt;=5.0:../../lang/lua
                   3933:     DEPENDS+=       screen-[0-9]*:../../misc/screen
                   3934:     DEPENDS+=       screen&gt;=4.0:../../misc/screen
                   3935: 
                   3936:     [...]
                   3937: 
                   3938:     .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
                   3939:     .include "../../devel/glib2/buildlink3.mk"
                   3940:     .include "../../mk/bsd.pkg.mk"
                   3941: </pre>
                   3942: </li>
1.91      rillig   3943: <li><p>Run <span><strong class="command">pkglint</strong></span> to see what things still need
                   3944: to be done to make your package a &#8220;<span class="quote">good</span>&#8221; one. If you don't
                   3945: know what pkglint's warnings want to tell you, try <span><strong class="command">pkglint
                   3946: --explain</strong></span> or <span><strong class="command">pkglint
                   3947: -e</strong></span>, which outputs additional
                   3948: explanations.</p></li>
                   3949: <li><p>In many cases the package is not yet ready to build. You can
                   3950: find instructions for the most common cases in the next section, <a href="#creating.common" title="9.1. Common types of packages">Section 9.1, &#8220;Common types of packages&#8221;</a>. After you have followed the instructions
                   3951: over there, you can hopefully continue here.</p></li>
                   3952: <li><p>Run <span><strong class="command">bmake clean</strong></span> to clean the working
                   3953: directory from the extracted files. Besides these files, a lot of cache
                   3954: files and other system information has been saved in the working
                   3955: directory, which may become wrong after you edited the
                   3956: <code class="filename">Makefile</code>.</p></li>
                   3957: <li><p>Now, run <span><strong class="command">bmake</strong></span> to build the package. For
                   3958: the various things that can go wrong in this phase, consult <a href="#fixes" title="Chapter 18. Making your package work">Chapter 18, <i>Making your package work</i></a>.</p></li>
                   3959: <li><p>When the package builds fine, the next step is to install
                   3960: the package. Run <span><strong class="command">bmake install</strong></span> and hope that
                   3961: everything works.</p></li>
                   3962: <li><p>Up to now, the file <code class="filename">PLIST</code>, which
                   3963: contains a list of the files that are installed by the package, is
                   3964: nearly empty. Run <span><strong class="command">bmake print-PLIST
                   3965: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   3966: the file using your preferred text editor to see if the list of
                   3967: files looks plausible.</p></li>
                   3968: <li><p>Run <span><strong class="command">pkglint</strong></span> again to see if the generated
                   3969: <code class="filename">PLIST</code> contains garbage or not.</p></li>
                   3970: <li><p>When you ran <span><strong class="command">bmake install</strong></span>, the package
                   3971: has been registered in the database of installed files, but with an
                   3972: empty list of files. To fix this, run <span><strong class="command">bmake deinstall</strong></span>
                   3973: and <span><strong class="command">bmake install</strong></span> again. Now the package is
                   3974: registered with the list of files from
                   3975: <code class="filename">PLIST</code>.</p></li>
                   3976: <li><p>Run <span><strong class="command">bmake package</strong></span> to create a binary
                   3977: package from the set of installed files.</p></li>
1.77      rillig   3978: </ol></div>
1.91      rillig   3979: <div class="sect1" lang="en">
                   3980: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3981: <a name="creating.common"></a>9.1. Common types of packages</h2></div></div></div>
                   3982: <div class="sect2" lang="en">
                   3983: <div class="titlepage"><div><div><h3 class="title">
                   3984: <a name="creating.perl-module"></a>9.1.1. Perl modules</h3></div></div></div>
                   3985: <p>Simple Perl modules are handled automatically by
                   3986: <span><strong class="command">url2pkg</strong></span>, including dependencies.</p>
                   3987: </div>
                   3988: <div class="sect2" lang="en">
                   3989: <div class="titlepage"><div><div><h3 class="title">
                   3990: <a name="creating.kde-app"></a>9.1.2. KDE applications</h3></div></div></div>
                   3991: <p>KDE applications should always include
                   3992: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
                   3993: settings that are typical of KDE packages.</p>
                   3994: </div>
                   3995: </div>
                   3996: <div class="sect1" lang="en">
                   3997: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3998: <a name="creating.examples"></a>9.2. Examples</h2></div></div></div>
                   3999: <div class="sect2" lang="en">
                   4000: <div class="titlepage"><div><div><h3 class="title">
                   4001: <a name="creating.nvu"></a>9.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
                   4002: <div class="sect3" lang="en">
                   4003: <div class="titlepage"><div><div><h4 class="title">
                   4004: <a name="creating.nvu.init"></a>9.2.1.1. The initial package</h4></div></div></div>
                   4005: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
                   4006: that the &#8220;<span class="quote">nvu</span>&#8221; package has not yet been imported into
                   4007: pkgsrc. As the description says it has to do with the web, the obvious
                   4008: choice for the category is &#8220;<span class="quote">www</span>&#8221;.</p>
                   4009: <pre class="programlisting">
                   4010:     <code class="prompt">$</code> mkdir www/nvu
                   4011:     <code class="prompt">$</code> cd www/nvu
                   4012: </pre>
                   4013: <p>The web site says that the sources are available as a tar file, so
                   4014: I fed that URL to the <span><strong class="command">url2pkg</strong></span> program:</p>
                   4015: <pre class="programlisting">
                   4016:     <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   4017: </pre>
                   4018: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   4019: below the <code class="varname">DISTNAME</code> line, as the package name should
                   4020: not have the word &#8220;<span class="quote">sources</span>&#8221; in it. I also filled in the
                   4021: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   4022: <code class="varname">COMMENT</code> fields. Then the package
                   4023: <code class="filename">Makefile</code> looked like that:</p>
                   4024: <pre class="programlisting">
                   4025:     # $NetBSD$
                   4026:     #
                   4027: 
                   4028:     DISTNAME=       nvu-1.0-sources
                   4029:     PKGNAME=        nvu-1.0
                   4030:     CATEGORIES=     www
                   4031:     MASTER_SITES=   http://cvs.nvu.com/download/
                   4032:     EXTRACT_SUFX=   .tar.bz2
                   4033: 
                   4034:     MAINTAINER=     rillig@NetBSD.org
                   4035:     HOMEPAGE=       http://cvs.nvu.com/
                   4036:     COMMENT=        Web Authoring System
                   4037: 
                   4038:     # url2pkg-marker (please do not remove this line.)
                   4039:     .include "../../mk/bsd.pkg.mk"
                   4040: </pre>
                   4041: <p>Then, I quit the editor and watched pkgsrc downloading a large
                   4042: source archive:</p>
                   4043: <pre class="programlisting">
                   4044:     url2pkg&gt; Running "make makesum" ...
                   4045:     =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4046:     =&gt; Fetching nvu-1.0-sources.tar.bz2
                   4047:     Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   4048:     100% |*************************************| 28992 KB  150.77 KB/s    00:00 ETA
                   4049:     29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   4050:     url2pkg&gt; Running "make extract" ...
                   4051:     =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4052:     =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   4053:     =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   4054:     work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
                   4055:     ===&gt; Installing dependencies for nvu-1.0
                   4056:     ===&gt; Overriding tools for nvu-1.0
                   4057:     ===&gt; Extracting for nvu-1.0
                   4058:     url2pkg&gt; Adjusting the Makefile.
                   4059: 
                   4060:     Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
                   4061: 
                   4062:     Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
                   4063: </pre>
                   4064: </div>
                   4065: <div class="sect3" lang="en">
                   4066: <div class="titlepage"><div><div><h4 class="title">
                   4067: <a name="creating.nvu.problems"></a>9.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
                   4068: <p>Now that the package has been extracted, let's see what's inside
                   4069: it. The package has a <code class="filename">README.txt</code>, but that only
                   4070: says something about mozilla, so it's probably useless for seeing what
                   4071: dependencies this package has. But since there is a GNU configure script
                   4072: in the package, let's hope that it will complain about everything it
                   4073: needs.</p>
                   4074: <pre class="programlisting">
                   4075:     <code class="prompt">$</code> bmake
                   4076:     =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4077:     =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   4078:     =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   4079:     ===&gt; Patching for nvu-1.0
                   4080:     ===&gt; Creating toolchain wrappers for nvu-1.0
                   4081:     ===&gt; Configuring for nvu-1.0
                   4082:     [...]
                   4083:     configure: error: Perl 5.004 or higher is required.
                   4084:     [...]
                   4085:     WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   4086:     [...]
                   4087: </pre>
                   4088: <p>That worked quite well. So I opened the package Makefile in my
                   4089: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
                   4090: just appended &#8220;<span class="quote">perl</span>&#8221; to it. Since the dependencies of the
                   4091: package have changed now, and since a perl wrapper is automatically
                   4092: installed in the &#8220;<span class="quote">tools</span>&#8221; phase, I need to build the package
                   4093: from scratch.</p>
                   4094: <pre class="programlisting">
                   4095:     <code class="prompt">$</code> bmake clean
                   4096:     ===&gt; Cleaning for nvu-1.0
                   4097:     <code class="prompt">$</code> bmake
                   4098:     [...]
                   4099:     *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   4100:     GNU Make.  You will not be able to build Mozilla without GNU Make.
                   4101:     [...]
                   4102: </pre>
                   4103: <p>So I added &#8220;<span class="quote">gmake</span>&#8221; to the
                   4104: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
                   4105: <pre class="programlisting">
                   4106:     [...]
                   4107:     checking for GTK - version &gt;= 1.2.0... no
                   4108:     *** Could not run GTK test program, checking why...
                   4109:     [...]
                   4110: </pre>
                   4111: <p>Now to the other dependencies. The first question is: Where is the
                   4112: GTK package hidden in pkgsrc?</p>
                   4113: <pre class="programlisting">
                   4114:     <code class="prompt">$</code> echo ../../*/gtk*
                   4115:     [many packages ...]
                   4116:     <code class="prompt">$</code> echo ../../*/gtk
                   4117:     ../../x11/gtk
                   4118:     <code class="prompt">$</code> echo ../../*/gtk2
                   4119:     ../../x11/gtk2
                   4120:     <code class="prompt">$</code> echo ../../*/gtk2/bui*
                   4121:     ../../x11/gtk2/buildlink3.mk
                   4122: </pre>
                   4123: <p>The first try was definitely too broad. The second one had exactly
                   4124: one result, which is very good. But there is one pitfall with GNOME
                   4125: packages. Before GNOME 2 had been released, there were already many
                   4126: GNOME 1 packages in pkgsrc. To be able to continue to use these
                   4127: packages, the GNOME 2 packages were imported as separate packages, and
                   4128: their names usually have a &#8220;<span class="quote">2</span>&#8221; appended. So I checked
                   4129: whether this was the case here, and indeed it was.</p>
                   4130: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
                   4131: file, adding the dependency is very easy. I just inserted an
                   4132: <code class="literal">.include</code> line before the last line of the package
                   4133: <code class="filename">Makefile</code>, so that it now looks like this:</p>
                   4134: <pre class="programlisting">
                   4135:     [...]
                   4136:     .include "../../x11/gtk2/buildlink3.mk"
                   4137:     .include "../../mk/bsd.pkg.mk
                   4138: </pre>
                   4139: <p>After another <span><strong class="command">bmake clean &amp;&amp; bmake</strong></span>, the answer
                   4140: was:</p>
                   4141: <pre class="programlisting">
                   4142:     [...]
                   4143:     checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   4144:     checking for GTK - version &gt;= 1.2.0... no
                   4145:     *** Could not run GTK test program, checking why...
                   4146:     *** The test program failed to compile or link. See the file config.log for the
                   4147:     *** exact error that occured. This usually means GTK was incorrectly installed
                   4148:     *** or that you have moved GTK since it was installed. In the latter case, you
                   4149:     *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   4150:     configure: error: Test for GTK failed.
                   4151:     [...]
                   4152: </pre>
                   4153: <p>In this particular case, the assumption that &#8220;<span class="quote">every package
                   4154: prefers GNOME 2</span>&#8221; had been wrong. The first of the lines above
                   4155: told me that this package really wanted to have the GNOME 1 version of
                   4156: GTK. If the package had looked for GTK2, it would have looked for
                   4157: <span><strong class="command">pkg-config</strong></span> instead of <span><strong class="command">gtk-config</strong></span>.
                   4158: So I changed the <code class="literal">x11/gtk2</code> to
                   4159: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
                   4160: and tried again.</p>
                   4161: <pre class="programlisting">
                   4162:     [...]
                   4163:     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
                   4164:     In file included from xpidl.c:42:
                   4165:     xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   4166:     In file included from xpidl.c:42:
                   4167:     xpidl.h:132: error: parse error before "IDL_ns"
                   4168:     [...]
                   4169: </pre>
                   4170: <p>The package still does not find all of its dependencies. Now the
                   4171: question is: Which package provides the
                   4172: <code class="filename">libIDL/IDL.h</code> header file?</p>
                   4173: <pre class="programlisting">
                   4174:     <code class="prompt">$</code> echo ../../*/*idl*
                   4175:     ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   4176:     <code class="prompt">$</code> echo ../../*/*IDL*
                   4177:     ../../net/libIDL
                   4178: </pre>
                   4179: <p>Let's take the one from the second try. So I included the
                   4180: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
                   4181: again. But the error didn't change. After digging through some of the
                   4182: code, I concluded that the build process of the package was broken and
                   4183: couldn't have ever worked, but since the Mozilla source tree is quite
                   4184: large, I didn't want to fix it. So I added the following to the package
                   4185: <code class="filename">Makefile</code> and tried again:</p>
                   4186: <pre class="programlisting">
                   4187:     CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
                   4188:     BUILDLINK_TRANSFORM+=   -l:IDL:IDL-2
                   4189: </pre>
                   4190: <p>The latter line is needed because the package expects the library
                   4191: <code class="filename">libIDL.so</code>, but only
                   4192: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
                   4193: wrapper to rewrite that on the fly.</p>
                   4194: <p>The next problem was related to a recent change of the FreeType
                   4195: 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>
                   4196: which patch files were relevant for this issue and copied them to the
                   4197: <code class="filename">patches</code> directory. Then I retried, fixed the
                   4198: patches so that they applied cleanly and retried again. This time,
                   4199: everything worked.</p>
                   4200: </div>
                   4201: <div class="sect3" lang="en">
                   4202: <div class="titlepage"><div><div><h4 class="title">
                   4203: <a name="creating.nvu.inst"></a>9.2.1.3. Installing the package</h4></div></div></div>
                   4204: <pre class="programlisting">
                   4205:     <code class="prompt">$</code> bmake CHECK_FILES=no install
                   4206:     [...]
                   4207:     <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
                   4208:     <code class="prompt">$</code> bmake deinstall
                   4209:     <code class="prompt">$</code> bmake install
                   4210: </pre>
                   4211: </div>
                   4212: </div>
                   4213: </div>
1.77      rillig   4214: </div>
1.75      rillig   4215: <div class="chapter" lang="en">
                   4216: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   4217: <a name="components"></a>Chapter 10. Package components - files, directories and contents</h2></div></div></div>
1.75      rillig   4218: <div class="toc">
                   4219: <p><b>Table of Contents</b></p>
                   4220: <dl>
1.90      rillig   4221: <dt><span class="sect1"><a href="#components.Makefile">10.1. <code class="filename">Makefile</code></a></span></dt>
                   4222: <dt><span class="sect1"><a href="#components.distinfo">10.2. <code class="filename">distinfo</code></a></span></dt>
                   4223: <dt><span class="sect1"><a href="#components.patches">10.3. patches/*</a></span></dt>
                   4224: <dd><dl>
1.93      rillig   4225: <dt><span class="sect2"><a href="#components.patch.structure">10.3.1. Structure of a single patch file</a></span></dt>
                   4226: <dt><span class="sect2"><a href="#components.patches.caveats">10.3.2. Creating patch files</a></span></dt>
                   4227: <dt><span class="sect2"><a href="#components.patches.sources">10.3.3. Sources where the patch files come from</a></span></dt>
                   4228: <dt><span class="sect2"><a href="#components.patches.guidelines">10.3.4. Patching guidelines</a></span></dt>
                   4229: <dt><span class="sect2"><a href="#components.patches.feedback">10.3.5. Feedback to the author</a></span></dt>
1.90      rillig   4230: </dl></dd>
                   4231: <dt><span class="sect1"><a href="#other-mandatory-files">10.4. Other mandatory files</a></span></dt>
                   4232: <dt><span class="sect1"><a href="#components.optional">10.5. Optional files</a></span></dt>
                   4233: <dd><dl>
                   4234: <dt><span class="sect2"><a href="#components.optional.bin">10.5.1. Files affecting the binary package</a></span></dt>
                   4235: <dt><span class="sect2"><a href="#components.optional.build">10.5.2. Files affecting the build process</a></span></dt>
                   4236: <dt><span class="sect2"><a href="#components.optional.none">10.5.3. Files affecting nothing at all</a></span></dt>
1.78      rillig   4237: </dl></dd>
1.90      rillig   4238: <dt><span class="sect1"><a href="#work-dir">10.6. <code class="filename">work*</code></a></span></dt>
                   4239: <dt><span class="sect1"><a href="#files-dir">10.7. <code class="filename">files/*</code></a></span></dt>
1.75      rillig   4240: </dl>
                   4241: </div>
1.87      wiz      4242: <p>Whenever you're preparing a package, there are a number of
                   4243: files involved which are described in the following
                   4244: sections.</p>
1.75      rillig   4245: <div class="sect1" lang="en">
                   4246: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   4247: <a name="components.Makefile"></a>10.1. <code class="filename">Makefile</code>
                   4248: </h2></div></div></div>
1.75      rillig   4249: <p>Building, installation and creation of a binary package are all
1.87      wiz      4250:   controlled by the package's <code class="filename">Makefile</code>.
                   4251:   The <code class="filename">Makefile</code> describes various things about
                   4252:   a package, for example from where to get it, how to configure,
                   4253:   build, and install it.</p>
1.76      rillig   4254: <p>A package <code class="filename">Makefile</code> contains several
1.87      wiz      4255:   sections that describe the package.</p>
1.75      rillig   4256: <p>In the first section there are the following variables, which
1.87      wiz      4257:   should appear exactly in the order given here.  The order and
                   4258:   grouping of the variables is mostly historical and has no further
                   4259:   meaning.</p>
1.75      rillig   4260: <div class="itemizedlist"><ul type="disc">
                   4261: <li><p><code class="varname">DISTNAME</code> is the basename of the
1.87      wiz      4262:     distribution file to be downloaded from the package's
                   4263:     website.</p></li>
1.75      rillig   4264: <li><p><code class="varname">PKGNAME</code> is the name of the
1.87      wiz      4265:     package, as used by pkgsrc. You only need to provide it if
                   4266:     <code class="varname">DISTNAME</code> (which is the default) is not a good
                   4267:     name for the package in pkgsrc.  Usually it is the pkgsrc
                   4268:     directory name together with the version number. It must match the
                   4269:     regular expression
                   4270:     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
                   4271:     starts with a letter or digit, and contains only letters, digits,
                   4272:     dashes, underscores, dots and plus signs.</p></li>
                   4273: <li><p><code class="varname">SVR4_PKGNAME</code> is the name of
                   4274:     the package file to create if the <code class="varname">PKGNAME</code>
                   4275:     isn't unique on a SVR4 system. The default is
                   4276:     <code class="varname">PKGNAME</code>, which may be shortened when you use
1.91      rillig   4277:     <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      4278:     <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
                   4279:     does not produce an unique package name on a SVR4 system.
                   4280:     The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
                   4281:     characters.</p></li>
1.75      rillig   4282: <li>
                   4283: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87      wiz      4284:     which the package fits in. You can choose any of the top-level
                   4285:     directories of pkgsrc for it.</p>
1.75      rillig   4286: <p>Currently the following values are available for
1.87      wiz      4287:     <code class="varname">CATEGORIES</code>. If more than
                   4288:     one is used, they need to be separated by spaces:</p>
1.75      rillig   4289: <pre class="programlisting">
1.87      wiz      4290:       archivers     cross         geography     meta-pkgs     security
                   4291:       audio         databases     graphics      misc          shells
                   4292:       benchmarks    devel         ham           multimedia    sysutils
                   4293:       biology       editors       inputmethod   net           textproc
                   4294:       cad           emulators     lang          news          time
                   4295:       chat          finance       mail          parallel      wm
                   4296:       comms         fonts         math          pkgtools      www
                   4297:       converters    games         mbone         print         x11
                   4298:     </pre>
1.75      rillig   4299: </li>
1.81      rillig   4300: <li><p><code class="varname">MASTER_SITES</code>,
1.87      wiz      4301:     <code class="varname">DYNAMIC_MASTER_SITES</code>,
                   4302:     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
                   4303:     and <code class="varname">DISTFILES</code> are discussed in detail in
1.90      rillig   4304:     <a href="#build.fetch" title="16.5. The fetch phase">Section 16.5, &#8220;The <span class="emphasis"><em>fetch</em></span> phase&#8221;</a>.</p></li>
1.75      rillig   4305: </ul></div>
                   4306: <p>The second section contains information about separately
1.87      wiz      4307:   downloaded patches, if any.
                   4308:   </p>
1.75      rillig   4309: <div class="itemizedlist"><ul type="disc">
                   4310: <li><p><code class="varname">PATCHFILES:</code>
1.87      wiz      4311:     Name(s) of additional files that contain distribution patches.
                   4312:     There is no default. pkgsrc will look for them at
                   4313:     <code class="varname">PATCH_SITES</code>.
                   4314:     They will automatically be uncompressed before patching if
                   4315:     the names end with <code class="filename">.gz</code> or
                   4316:     <code class="filename">.Z</code>.</p></li>
1.75      rillig   4317: <li><p><code class="varname">PATCH_SITES</code>:
1.87      wiz      4318:     Primary location(s) for distribution patch files (see
                   4319:     <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
1.75      rillig   4320: </ul></div>
                   4321: <p>The third section contains the following variables.
1.87      wiz      4322:   </p>
1.75      rillig   4323: <div class="itemizedlist"><ul type="disc">
                   4324: <li><p><code class="varname">MAINTAINER</code> is the email address
1.87      wiz      4325:     of the person who feels responsible for this package, and who is
                   4326:     most likely to look at problems or questions regarding this
                   4327:     package which have been reported with <a 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>. Other
                   4328:     developers should contact the <code class="varname">MAINTAINER</code> before
                   4329:     making major changes to the package. When packaging a new program,
                   4330:     set <code class="varname">MAINTAINER</code> to yourself. If you really can't
                   4331:     maintain the package for future updates, set it to
                   4332:     <code class="email">&lt;<a href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>&gt;</code>.</p></li>
1.75      rillig   4333: <li><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87      wiz      4334:     find more information about the package.</p></li>
1.75      rillig   4335: <li><p><code class="varname">COMMENT</code> is a one-line
1.87      wiz      4336:     description of the package (should not include the package
                   4337:     name).</p></li>
1.75      rillig   4338: </ul></div>
                   4339: <p>Other variables that affect the build:
1.87      wiz      4340:   </p>
1.75      rillig   4341: <div class="itemizedlist"><ul type="disc"><li>
                   4342: <p><code class="varname">WRKSRC</code>: The directory where the
1.87      wiz      4343:       interesting distribution files of the package are found. The
                   4344:       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
                   4345:       works for most packages.</p>
1.75      rillig   4346: <p>If a package doesn't create a subdirectory for itself
1.87      wiz      4347:       (most GNU software does, for instance), but extracts itself in
                   4348:       the current directory, you should set
                   4349:       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
                   4350: <p>If a package doesn't create a subdirectory with the
                   4351:       name of <code class="varname">DISTNAME</code> but some different name,
                   4352:       set <code class="varname">WRKSRC</code> to point to the proper name in
                   4353:       <code class="filename">${WRKDIR}</code>, for example
                   4354:       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.91      rillig   4355:       <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   4356: <p>The name of the working directory created by pkgsrc is
1.87      wiz      4357:       taken from the <code class="varname">WRKDIR_BASENAME</code>
                   4358:       variable. By default, its value is
                   4359:       <code class="filename">work</code>. If you want to use the same
                   4360:       pkgsrc tree for building different kinds of binary packages,
                   4361:       you can change the variable according to your needs. Two
                   4362:       other variables handle common cases of setting
                   4363:       <code class="varname">WRKDIR_BASENAME</code> individually. If
                   4364:       <code class="varname">OBJHOSTNAME</code> is defined in
                   4365:       <code class="filename">/etc/mk.conf</code>, the first component of
                   4366:       the host's name is attached to the directory name. If
                   4367:       <code class="varname">OBJMACHINE</code> is defined, the platform name
                   4368:       is attached, which might look like
                   4369:       <code class="filename">work.i386</code> or
                   4370:       <code class="filename">work.sparc</code>.</p>
1.75      rillig   4371: </li></ul></div>
                   4372: <p>Please pay attention to the following gotchas:</p>
                   4373: <div class="itemizedlist"><ul type="disc">
1.87      wiz      4374: <li><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88      wiz      4375:       installed in compressed form by the package.  For packages using
                   4376:       BSD-style makefiles which honor MANZ, there is
                   4377:       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.76      rillig   4378: <li><p>Replace <code class="filename">/usr/local</code> with
1.88      wiz      4379:       &#8220;<span class="quote">${PREFIX}</span>&#8221; in all files (see patches,
                   4380:       below).</p></li>
1.90      rillig   4381: <li><p>If the package installs any info files, see <a href="#faq.info-files" title="18.6.6. Packages installing info files">Section 18.6.6, &#8220;Packages installing info files&#8221;</a>.</p></li>
1.75      rillig   4382: </ul></div>
                   4383: </div>
                   4384: <div class="sect1" lang="en">
                   4385: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   4386: <a name="components.distinfo"></a>10.2. <code class="filename">distinfo</code>
                   4387: </h2></div></div></div>
1.76      rillig   4388: <p>The <code class="filename">distinfo</code> file contains the message
1.87      wiz      4389:   digest, or checksum, of each distfile needed for the package. This
                   4390:   ensures that the distfiles retrieved from the Internet have not been
                   4391:   corrupted during transfer or altered by a malign force to introduce
                   4392:   a security hole. Due to recent rumor about weaknesses of digest
                   4393:   algorithms, all distfiles are protected using both SHA1 and RMD160
                   4394:   message digests, as well as the file size.</p>
1.76      rillig   4395: <p>The <code class="filename">distinfo</code> file also contains the
1.87      wiz      4396:   checksums for all the patches found in the
1.90      rillig   4397:   <code class="filename">patches</code> directory (see <a href="#components.patches" title="10.3. patches/*">Section 10.3, &#8220;patches/*&#8221;</a>).</p>
1.76      rillig   4398: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.87      wiz      4399:   <span><strong class="command">make makedistinfo</strong></span> or <span><strong class="command">make mdi</strong></span>
                   4400:   command.</p>
1.75      rillig   4401: <p>Some packages have different sets of distfiles depending on
1.91      rillig   4402:   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      4403:   <code class="filename">distinfo</code> file and care should be taken when
                   4404:   upgrading such a package to ensure distfile information is not
                   4405:   lost.</p>
1.75      rillig   4406: </div>
                   4407: <div class="sect1" lang="en">
                   4408: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   4409: <a name="components.patches"></a>10.3. patches/*</h2></div></div></div>
1.93      rillig   4410: <p>Many packages still don't work out-of-the box on the various
                   4411:   platforms that are supported by pkgsrc. Therefore, a number of custom
                   4412:   patch files are needed to make the package work. These patch files are
                   4413:   found in the <code class="filename">patches/</code> directory.</p>
                   4414: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
                   4415:   applied to the files in <code class="varname">WRKSRC</code> directory after
                   4416:   extracting them, in <a href="http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_13_03" target="_top">alphabetic
                   4417:   order</a>, so <code class="filename">patch-aa</code> is applied before
1.87      wiz      4418:   <code class="filename">patch-ab</code>, etc.</p>
1.93      rillig   4419: <div class="sect2" lang="en">
                   4420: <div class="titlepage"><div><div><h3 class="title">
                   4421: <a name="components.patch.structure"></a>10.3.1. Structure of a single patch file</h3></div></div></div>
1.76      rillig   4422: <p>The <code class="filename">patch-*</code> files should be in
1.87      wiz      4423:   <span><strong class="command">diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93      rillig   4424:   problems. (To force patches to apply with fuzz you can set
                   4425:   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94      dmcmahil 4426:   should contain only changes for a single file, and no file should be
1.93      rillig   4427:   patched by more than one patch file. This helps to keep future
                   4428:   modifications simple.</p>
                   4429: <p>Each patch file is structured as follows: In the first line,
                   4430:   there is the RCS Id of the patch itself. The second line should be
                   4431:   empty for aesthetic reasons. After that, there should be a comment for
                   4432:   each change that the patch does. There are a number of standard
                   4433:   cases:</p>
                   4434: <div class="itemizedlist"><ul type="disc">
                   4435: <li><p>Patches that replace the <code class="literal">==</code>
                   4436:   operator for <a 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
                   4437:   should contain a reference to , to avoid
                   4438:   redundant explanations.</p></li>
                   4439: <li><p>Patches for commonly known vulnerabilities should
                   4440:   mention the vulnerability ID (CAN, CVE).</p></li>
                   4441: <li><p>Patches that change source code should mention the
                   4442:   platform and other environment (for example, the compiler) that the
                   4443:   patch is needed for.</p></li>
                   4444: </ul></div>
                   4445: <p>In all other cases, the patch should be commented so that any
                   4446:   developer who knows the code of the application can make some use of
                   4447:   the patch. Special care should be taken for the upstream developers,
                   4448:   since we generally want that they accept our patches, so we have less
                   4449:   work in the future.</p>
                   4450: </div>
                   4451: <div class="sect2" lang="en">
                   4452: <div class="titlepage"><div><div><h3 class="title">
                   4453: <a name="components.patches.caveats"></a>10.3.2. Creating patch files</h3></div></div></div>
                   4454: <p>One important thing to mention is to pay attention that no RCS
                   4455:   IDs get stored in the patch files, as these will cause problems when
1.87      wiz      4456:   later checked into the NetBSD CVS tree. Use the
1.93      rillig   4457:   <span><strong class="command">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
                   4458:   problems.</p>
1.87      wiz      4459: <p>For even more automation, we recommend using
                   4460:   <span><strong class="command">mkpatches</strong></span> from the same package to make a
                   4461:   whole set of patches. You just have to backup files before you
                   4462:   edit them to <code class="filename">filename.orig</code>, e.g. with
                   4463:   <span><strong class="command">cp -p filename filename.orig</strong></span> or, easier, by
                   4464:   using <span><strong class="command">pkgvi</strong></span> again from the same package. If
                   4465:   you upgrade a package this way, you can easily compare the new
                   4466:   set of patches with the previously existing one with
                   4467:   <span><strong class="command">patchdiff</strong></span>. Copy the patches you want to use
                   4468:   or update from the <code class="filename">work/.newpatches</code>
                   4469:   directory to <code class="filename">patches/</code>.</p>
                   4470: <p>When you have finished a package, remember to generate
                   4471:   the checksums for the patch files by using the <span><strong class="command">make
1.90      rillig   4472:   makepatchsum</strong></span> command, see <a href="#components.distinfo" title="10.2. distinfo">Section 10.2, &#8220;<code class="filename">distinfo</code>&#8221;</a>.</p>
1.87      wiz      4473: <p>When adding a patch that corrects a problem in the
                   4474:   distfile (rather than e.g. enforcing pkgsrc's view of where
                   4475:   man pages should go), send the patch as a bug report to the
                   4476:   maintainer.  This benefits non-pkgsrc users of the package,
                   4477:   and usually makes it possible to remove the patch in future
                   4478:   version.</p>
1.93      rillig   4479: </div>
                   4480: <div class="sect2" lang="en">
                   4481: <div class="titlepage"><div><div><h3 class="title">
                   4482: <a name="components.patches.sources"></a>10.3.3. Sources where the patch files come from</h3></div></div></div>
1.87      wiz      4483: <p>If you want to share patches between multiple packages
                   4484:   in pkgsrc, e.g. because they use the same distfiles, set
                   4485:   <code class="varname">PATCHDIR</code> to the path where the patch files
                   4486:   can be found, e.g.:</p>
                   4487: <pre class="programlisting">
                   4488:     PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93      rillig   4489: </pre>
1.75      rillig   4490: <p>Patch files that are distributed by the author or other
1.87      wiz      4491:     maintainers can be listed in
                   4492:     <code class="varname">PATCHFILES</code>.</p>
                   4493: <p>If it is desired to store any patches that should not be
                   4494:     committed into pkgsrc, they can be kept outside the pkgsrc
                   4495:     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
                   4496:     directory tree there is expected to have the same
                   4497:     &#8220;<span class="quote">category/package</span>&#8221; structure as pkgsrc, and
                   4498:     patches are expected to be stored inside these dirs (also
                   4499:     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
                   4500:     example, if you want to keep a private patch for
                   4501:     <code class="filename">pkgsrc/graphics/png</code>, keep it in
                   4502:     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
                   4503:     files in the named directory are expected to be patch files,
                   4504:     and <span class="emphasis"><em>they are applied after pkgsrc patches are
                   4505:     applied</em></span>.</p>
1.93      rillig   4506: </div>
1.85      jmmv     4507: <div class="sect2" lang="en">
                   4508: <div class="titlepage"><div><div><h3 class="title">
1.93      rillig   4509: <a name="components.patches.guidelines"></a>10.3.4. Patching guidelines</h3></div></div></div>
1.85      jmmv     4510: <p>When fixing a portability issue in the code do not use
                   4511:       preprocessor magic to check for the current operating system nor
                   4512:       platform.  Doing so hurts portability to other platforms because
                   4513:       the OS-specific details are not abstracted appropriately.</p>
                   4514: <p>The general rule to follow is: instead of checking for the
                   4515:       operating system the application is being built on, check for the
                   4516:       specific <span class="emphasis"><em>features</em></span> you need.  For example,
                   4517:       instead of assuming that kqueue is available under NetBSD and
                   4518:       using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.89      rillig   4519:       kqueue support, add a check that detects kqueue itself &mdash;
1.85      jmmv     4520:       yes, this generally involves patching the
                   4521:       <span><strong class="command">configure</strong></span> script.  There is absolutely nothing
                   4522:       that prevents some OSes from adopting interfaces from other OSes
                   4523:       (e.g. Linux implementing kqueue), something that the above checks
                   4524:       cannot take into account.</p>
                   4525: <p>Of course, checking for features generally involves more
                   4526:       work on the developer's side, but the resulting changes are
1.87      wiz      4527:       cleaner and there are chances they will work on many other
1.85      jmmv     4528:       platforms.  Not to mention that there are higher chances of being
                   4529:       later integrated into the mainstream sources.  Remember:
                   4530:       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
                   4531: <p>Some typical examples:</p>
                   4532: <div class="table">
1.90      rillig   4533: <a name="patch-examples"></a><p class="title"><b>Table 10.1. Patching examples</b></p>
1.91      rillig   4534: <div class="table-contents"><table summary="Patching examples" border="1">
1.85      jmmv     4535: <colgroup>
                   4536: <col>
                   4537: <col>
                   4538: <col>
                   4539: </colgroup>
                   4540: <thead><tr>
                   4541: <th>Where</th>
                   4542: <th>Incorrect</th>
                   4543: <th>Correct</th>
                   4544: </tr></thead>
                   4545: <tbody>
                   4546: <tr>
                   4547: <td>configure script</td>
                   4548: <td>
                   4549:                <pre class="programlisting">case ${target_os} in
1.87      wiz      4550:                netbsd*) have_kvm=yes ;;
                   4551:                *)       have_kvm=no  ;;
                   4552:                esac</pre>
1.85      jmmv     4553:              </td>
                   4554: <td>
                   4555:                <pre class="programlisting">AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)</pre>
                   4556:              </td>
                   4557: </tr>
                   4558: <tr>
                   4559: <td>C source file</td>
                   4560: <td>
                   4561:                <pre class="programlisting">#if defined(__NetBSD__)
1.87      wiz      4562:                #  include &lt;sys/event.h&gt;
                   4563:                #endif</pre>
1.85      jmmv     4564:              </td>
                   4565: <td>
                   4566:                <pre class="programlisting">#if defined(HAVE_SYS_EVENT_H)
1.87      wiz      4567:                #  include &lt;sys/event.h&gt;
                   4568:                #endif</pre>
1.85      jmmv     4569:              </td>
                   4570: </tr>
                   4571: <tr>
                   4572: <td>C source file</td>
                   4573: <td>
                   4574: <pre class="programlisting">int
1.87      wiz      4575:              monitor_file(...)
                   4576:              {
                   4577:              #if defined(__NetBSD__)
                   4578:              int fd = kqueue();
                   4579:              ...
                   4580:              #else
                   4581:              ...
                   4582:              #endif
                   4583:              }</pre>
1.85      jmmv     4584:              </td>
                   4585: <td>
                   4586:                <pre class="programlisting">int
1.87      wiz      4587:                monitor_file(...)
                   4588:                {
                   4589:                #if defined(HAVE_KQUEUE)
                   4590:                int fd = kqueue();
                   4591:                ...
                   4592:                #else
                   4593:                ...
                   4594:                #endif
                   4595:                }</pre>
1.85      jmmv     4596:              </td>
                   4597: </tr>
                   4598: </tbody>
1.91      rillig   4599: </table></div>
1.85      jmmv     4600: </div>
1.91      rillig   4601: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.85      jmmv     4602:       packager-friendly software</em></span> article (<a href="http://www.onlamp.com/pub/a/onlamp/2005/03/31/packaging.html" target="_top">part
                   4603:       1</a>, <a href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
                   4604:       2</a>).  It summarizes multiple details on how to make
                   4605:       software easier to package; all the suggestions in it were
                   4606:       collected from our experience in pkgsrc work, so they are possibly
                   4607:       helpful when creating patches too.</p>
                   4608: </div>
                   4609: <div class="sect2" lang="en">
                   4610: <div class="titlepage"><div><div><h3 class="title">
1.93      rillig   4611: <a name="components.patches.feedback"></a>10.3.5. Feedback to the author</h3></div></div></div>
1.85      jmmv     4612: <p>Always, always, <span class="strong"><strong>always</strong></span>
                   4613:       feed back any <span class="emphasis"><em>portability fixes</em></span> or
                   4614:       improvements you do to a package to the mainstream developers.
                   4615:       This is the only way to get their attention on portability issues
                   4616:       and to ensure that future versions can be built out-of-the box on
                   4617:       NetBSD.  Furthermore, any user that gets newer distfiles will get
                   4618:       the fixes straight from the packaged code.</p>
1.93      rillig   4619: <p>This generally involves cleaning up the patches
                   4620:       (because sometimes the patches that are
1.85      jmmv     4621:       added to pkgsrc are quick hacks), filling bug reports in the
                   4622:       appropriate trackers for the projects and working with the
                   4623:       mainstream authors to accept your changes.  It is
                   4624:       <span class="emphasis"><em>extremely important</em></span> that you do it so that
                   4625:       the packages in pkgsrc are kept simple and thus further changes
                   4626:       can be done without much hassle.</p>
                   4627: <p>Support the idea of free software!</p>
                   4628: </div>
1.75      rillig   4629: </div>
                   4630: <div class="sect1" lang="en">
                   4631: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   4632: <a name="other-mandatory-files"></a>10.4. Other mandatory files</h2></div></div></div>
1.75      rillig   4633: <div class="variablelist"><dl>
1.76      rillig   4634: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75      rillig   4635: <dd><p>A multi-line description of the piece of software.  This should include
1.87      wiz      4636:          any credits where they are due.  Please bear in mind that others do not
                   4637:          share your sense of humour (or spelling idiosyncrasies), and that others
                   4638:          will read everything that you write here.</p></dd>
1.76      rillig   4639: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87      wiz      4640: <dd><p>This file governs the files that are installed on your
                   4641:          system: all the binaries, manual pages, etc. There are other
                   4642:          directives which may be entered in this file, to control the
                   4643:          creation and deletion of directories, and the location of
1.90      rillig   4644:          inserted files.  See <a href="#plist" title="Chapter 12. PLIST issues">Chapter 12, <i>PLIST issues</i></a> for more
1.87      wiz      4645:          information.</p></dd>
1.75      rillig   4646: </dl></div>
                   4647: </div>
                   4648: <div class="sect1" lang="en">
                   4649: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   4650: <a name="components.optional"></a>10.5. Optional files</h2></div></div></div>
1.78      rillig   4651: <div class="sect2" lang="en">
                   4652: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   4653: <a name="components.optional.bin"></a>10.5.1. Files affecting the binary package</h3></div></div></div>
1.75      rillig   4654: <div class="variablelist"><dl>
1.76      rillig   4655: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.75      rillig   4656: <dd><p>This shell script is invoked twice by <a 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      4657:            First time after package extraction and before files are
                   4658:            moved in place, the second time after the files to install
                   4659:            are moved in place. This can be used to do any custom
                   4660:            procedures not possible with @exec commands in
                   4661:            <code class="filename">PLIST</code>. See <a 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
1.90      rillig   4662:            <a 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 href="#files-and-dirs-outside-prefix" title="14.1. Files and directories outside the installation prefix">Section 14.1, &#8220;Files and directories outside the installation prefix&#8221;</a>.</p></dd>
1.76      rillig   4663: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75      rillig   4664: <dd><p>This script is executed before and after any files are removed.  It is
1.87      wiz      4665:            this script's responsibility to clean up any additional messy details
                   4666:            around the package's installation, since all pkg_delete knows is how to
                   4667:            delete the files created in the original distribution.
                   4668:            See <a 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>
                   4669:            and <a 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   4670: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75      rillig   4671: <dd>
                   4672: <p>This file is displayed after installation of the package.
1.87      wiz      4673:            Useful for things like legal notices on almost-free
                   4674:            software and hints for updating config files after
                   4675:            installing modules for apache, PHP etc.
                   4676:            Please note that you can modify variables in it easily by using
                   4677:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   4678:            <code class="filename">Makefile</code>:</p>
1.75      rillig   4679: <pre class="programlisting">
1.87      wiz      4680:              MESSAGE_SUBST+=  SOMEVAR="somevalue"
                   4681:            </pre>
1.75      rillig   4682: <p>replaces "${SOMEVAR}" with &#8220;<span class="quote">somevalue</span>&#8221; in
1.87      wiz      4683:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   4684:            performed for <code class="varname">PKGNAME</code>,
                   4685:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
                   4686:            <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
                   4687:            <code class="varname">X11BASE</code>,
                   4688:            <code class="varname">PKG_SYSCONFDIR</code>,
                   4689:            <code class="varname">ROOT_GROUP</code>, and
                   4690:            <code class="varname">ROOT_GROUP</code>.</p>
                   4691: <p>You can display a different or additional files by
                   4692:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   4693:            default is <code class="filename">MESSAGE</code>, if the file
                   4694:            exists.</p>
1.75      rillig   4695: </dd>
1.78      rillig   4696: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
                   4697: <dd><p>FIXME: There is no documentation on the
                   4698:        alternatives framework.</p></dd>
                   4699: </dl></div>
                   4700: </div>
                   4701: <div class="sect2" lang="en">
                   4702: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   4703: <a name="components.optional.build"></a>10.5.2. Files affecting the build process</h3></div></div></div>
1.78      rillig   4704: <div class="variablelist"><dl>
                   4705: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   4706: <dd><p>This file contains arbitrary things that could
                   4707:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   4708:        to be used by more than one package. This file should only be
                   4709:        used when the packages that will use the file are known in
                   4710:        advance. For other purposes it is often better to write a
                   4711:        <code class="filename">*.mk</code> file and give it a good name that
                   4712:        describes what it does.</p></dd>
                   4713: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   4714: <dd><p>This file contains the dependency information
1.90      rillig   4715:        for the buildlink3 framework (see <a href="#buildlink" title="Chapter 13. Buildlink methodology">Chapter 13, <i>Buildlink methodology</i></a>).</p></dd>
1.78      rillig   4716: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   4717: <dd><p>This file contains workarounds for compiler bugs
                   4718:        and similar things. It is included automatically by the pkgsrc
                   4719:        infrastructure, so you don't need an extra
                   4720:        <code class="literal">.include</code> line for
                   4721:        it.</p></dd>
                   4722: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   4723: <dd><p>This file contains the code for the
1.90      rillig   4724:        package-specific options (see <a href="#options" title="Chapter 15. Options handling">Chapter 15, <i>Options handling</i></a>) that can be
1.78      rillig   4725:        selected by the user. If a package has only one or two options,
                   4726:        it is equally acceptable to put the code directly into the
                   4727:        <code class="filename">Makefile</code>.</p></dd>
                   4728: </dl></div>
                   4729: </div>
                   4730: <div class="sect2" lang="en">
                   4731: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   4732: <a name="components.optional.none"></a>10.5.3. Files affecting nothing at all</h3></div></div></div>
1.78      rillig   4733: <div class="variablelist"><dl>
                   4734: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   4735: <dd><p>These files do not take place in the creation of
                   4736:        a package and thus are purely informative to the package
                   4737:        developer.</p></dd>
                   4738: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   4739: <dd><p>This file contains things that need to be done
                   4740:        to make the package even
                   4741:        better.</p></dd>
1.75      rillig   4742: </dl></div>
                   4743: </div>
1.78      rillig   4744: </div>
1.75      rillig   4745: <div class="sect1" lang="en">
                   4746: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   4747: <a name="work-dir"></a>10.6. <code class="filename">work*</code>
                   4748: </h2></div></div></div>
1.75      rillig   4749: <p>When you type <span><strong class="command">make</strong></span>, the distribution files are
1.87      wiz      4750:     unpacked into the directory denoted by
                   4751:     <code class="varname">WRKDIR</code>. It can be removed by running
                   4752:     <span><strong class="command">make clean</strong></span>. Besides the sources, this
                   4753:     directory is also used to keep various timestamp files.
                   4754:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   4755:     The default is <code class="filename">${.CURDIR}/work</code>
                   4756:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   4757:     if <code class="varname">OBJMACHINE</code> is set.</p>
1.75      rillig   4758: </div>
                   4759: <div class="sect1" lang="en">
                   4760: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   4761: <a name="files-dir"></a>10.7. <code class="filename">files/*</code>
                   4762: </h2></div></div></div>
1.75      rillig   4763: <p>If you have any files that you wish to be placed in the package prior
1.87      wiz      4764:     to configuration or building, you could place these files here and use
                   4765:     a <span><strong class="command">${CP}</strong></span> command in the
                   4766:     &#8220;<span class="quote">pre-configure</span>&#8221; target to achieve
                   4767:     this. Alternatively, you could simply diff the file against
                   4768:     <code class="filename">/dev/null</code> and use the patch mechanism to manage
                   4769:     the creation of this file.</p>
                   4770: <p>If you want to share files in this way with other
                   4771:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   4772:     to the other package's <code class="filename">files</code> directory,
                   4773:     e.g.:</p>
                   4774: <pre class="programlisting">
                   4775:       FILESDIR=${.CURDIR}/../xemacs/files
                   4776:     </pre>
1.75      rillig   4777: </div>
                   4778: </div>
                   4779: <div class="chapter" lang="en">
                   4780: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   4781: <a name="makefile"></a>Chapter 11. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75      rillig   4782: <div class="toc">
                   4783: <p><b>Table of Contents</b></p>
                   4784: <dl>
1.97    ! rillig   4785: <dt><span class="sect1"><a href="#makefile.style">11.1. Caveats</a></span></dt>
        !          4786: <dt><span class="sect1"><a href="#makefile.variables">11.2. <code class="filename">Makefile</code> variables</a></span></dt>
        !          4787: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">11.2.1. Naming conventions</a></span></dt></dl></dd>
        !          4788: <dt><span class="sect1"><a href="#makefile.code">11.3. Code snippets</a></span></dt>
        !          4789: <dd><dl>
        !          4790: <dt><span class="sect2"><a href="#adding-to-list">11.3.1. Adding things to a list</a></span></dt>
        !          4791: <dt><span class="sect2"><a href="#converting-internal-to-external">11.3.2. Converting an internal list into an external list</a></span></dt>
        !          4792: <dt><span class="sect2"><a href="#passing-variable-to-shell">11.3.3. Passing variables to a shell command</a></span></dt>
        !          4793: <dt><span class="sect2"><a href="#quoting-guideline">11.3.4. Quoting guideline</a></span></dt>
        !          4794: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">11.3.5. Workaround for a bug in BSD Make</a></span></dt>
1.75      rillig   4795: </dl></dd>
                   4796: </dl>
                   4797: </div>
1.76      rillig   4798: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75      rillig   4799:   each of which forms a well-defined part of the pkgsrc system. Using
                   4800:   the <a 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
                   4801:   like pkgsrc requires some discipline to keep the code correct and
                   4802:   understandable.</p>
1.76      rillig   4803: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75      rillig   4804:   programming are variables (which are actually macros) and shell
                   4805:   commands. Among these shell commands may even be more complex ones
                   4806:   like <a 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
                   4807:   as intended it is necessary to quote all variables correctly when they
                   4808:   are used.</p>
                   4809: <p>This chapter describes some patterns, that appear quite often in
1.76      rillig   4810:   <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75      rillig   4811:   with them.</p>
                   4812: <div class="sect1" lang="en">
                   4813: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.97    ! rillig   4814: <a name="makefile.style"></a>11.1. Caveats</h2></div></div></div>
        !          4815: <div class="itemizedlist"><ul type="disc"><li>
        !          4816: <p>When you are creating a file as a
        !          4817:     target of a rule, always write the data to a temporary file first
        !          4818:     and finally rename that file. Otherwise there might occur an error
        !          4819:     in the middle of generating the file, and when the user runs
        !          4820:     <a 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
        !          4821:     regenerated properly. Example:</p>
        !          4822: <pre class="programlisting">
        !          4823:     wrong:
        !          4824:             @echo "line 1" &gt; ${.TARGET}
        !          4825:             @echo "line 2" &gt;&gt; ${.TARGET}
        !          4826:             @false
        !          4827: 
        !          4828:     correct:
        !          4829:             @echo "line 1" &gt; ${.TARGET}.tmp
        !          4830:             @echo "line 2" &gt;&gt; ${.TARGET}.tmp
        !          4831:             @false
        !          4832:             @mv ${.TARGET}.tmp ${.TARGET}
        !          4833: </pre>
        !          4834: <p>When you run <span><strong class="command">make wrong</strong></span> twice, the file
        !          4835:     <code class="filename">wrong</code> will exist, although there was an error
        !          4836:     message in the first run. On the other hand, running <span><strong class="command">make
        !          4837:     correct</strong></span> gives an error message twice, as expected.</p>
        !          4838: <p>You might remember that <a 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
        !          4839:     <code class="literal">${.TARGET}</code> in case of error, but this only
        !          4840:     happens when it is interrupted, for example by pressing
        !          4841:     <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
        !          4842:     when one of the commands fails (like <a 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>
        !          4843: </li></ul></div>
        !          4844: </div>
        !          4845: <div class="sect1" lang="en">
        !          4846: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
        !          4847: <a name="makefile.variables"></a>11.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76      rillig   4848: <p><code class="filename">Makefile</code> variables contain strings that
1.75      rillig   4849:     can be processed using the five operators ``='', ``+='', ``?='',
                   4850:     ``:='', and ``!='', which are described in the <a 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
                   4851:     page.</p>
                   4852: <p>When a variable's value is parsed from a
1.76      rillig   4853:     <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75      rillig   4854:     backslash character ``\'' are handled specially. If a backslash is
                   4855:     followed by a newline, any whitespace immediately in front of the
                   4856:     backslash, the backslash, the newline, and any whitespace
                   4857:     immediately behind the newline are replaced with a single space. A
                   4858:     backslash character and an immediately following hash character are
                   4859:     replaced with a single hash character. Otherwise, the backslash is
                   4860:     passed as is. In a variable assignment, any hash character that is
                   4861:     not preceded by a backslash starts a comment that continues upto the
                   4862:     end of the logical line.</p>
                   4863: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
                   4864:     the only way to create a variable consisting of a single backslash
                   4865:     is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
                   4866: <p>So far for defining variables. The other thing you can do with
                   4867:     variables is evaluating them. A variable is evaluated when it is
                   4868:     part of the right side of the ``:='' or the ``!='' operator, or
                   4869:     directly before executing a shell command which the variable is part
                   4870:     of. In all other cases, <a 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
                   4871:     is, variables are not evaluated until there's no other way. The
                   4872:     ``modifiers'' mentioned in the man page also evaluate the
                   4873:     variable.</p>
                   4874: <p>Some of the modifiers split the string into words and then
                   4875:     operate on the words, others operate on the string as a whole. When
                   4876:     a string is split into words, it is split as you would expect
                   4877:     it from <a 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.89      rillig   4878: <p>No rule without exception&mdash;the <span><strong class="command">.for</strong></span>
1.75      rillig   4879:     loop does not follow the shell quoting rules but splits at sequences
                   4880:     of whitespace.</p>
                   4881: <p>There are several types of variables that should be handled
                   4882:     differently. Strings and two types of lists.</p>
                   4883: <div class="itemizedlist"><ul type="disc">
                   4884: <li><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
                   4885:       characters. Nevertheless, you should restrict yourself to only
                   4886:       using printable characters. Examples are
                   4887:       <code class="varname">PREFIX</code> and
                   4888:       <code class="varname">COMMENT</code>.</p></li>
                   4889: <li><p><span class="emphasis"><em>Internal lists</em></span> are lists that
                   4890:       are never exported to any shell command. Their elements are
                   4891:       separated by whitespace. Therefore, the elements themselves cannot
                   4892:       have embedded whitespace. Any other characters are allowed.
                   4893:       Internal lists can be used in <span><strong class="command">.for</strong></span> loops.
                   4894:       Examples are <code class="varname">DEPENDS</code> and
                   4895:       <code class="varname">BUILD_DEPENDS</code>.</p></li>
                   4896: <li><p><span class="emphasis"><em>External lists</em></span> are lists that
                   4897:       may be exported to a shell command. Their elements can contain any
                   4898:       characters, including whitespace. That's why they cannot be used
                   4899:       in <span><strong class="command">.for</strong></span> loops. Examples are
                   4900:       <code class="varname">DISTFILES</code> and
                   4901:       <code class="varname">MASTER_SITES</code>.</p></li>
                   4902: </ul></div>
                   4903: <div class="sect2" lang="en">
                   4904: <div class="titlepage"><div><div><h3 class="title">
1.97    ! rillig   4905: <a name="makefile.variables.names"></a>11.2.1. Naming conventions</h3></div></div></div>
1.75      rillig   4906: <div class="itemizedlist"><ul type="disc">
                   4907: <li><p>All variable names starting with an underscore
                   4908:        are reserved for use by the pkgsrc infrastructure. They shall
                   4909:        not be used by package
1.76      rillig   4910:        <code class="filename">Makefile</code>s.</p></li>
1.75      rillig   4911: <li><p>In <span><strong class="command">.for</strong></span> loops you should use
                   4912:        lowercase variable names for the iteration
                   4913:        variables.</p></li>
                   4914: <li><p>All list variables should have a ``plural''
                   4915:        name, e.g. <code class="varname">PKG_OPTIONS</code> or
                   4916:        <code class="varname">DISTFILES</code>.</p></li>
                   4917: </ul></div>
                   4918: </div>
                   4919: </div>
                   4920: <div class="sect1" lang="en">
                   4921: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.97    ! rillig   4922: <a name="makefile.code"></a>11.3. Code snippets</h2></div></div></div>
1.75      rillig   4923: <p>This section presents you with some code snippets you should
                   4924:     use in your own code. If you don't find anything appropriate here,
                   4925:     you should test your code and add it here.</p>
                   4926: <div class="sect2" lang="en">
                   4927: <div class="titlepage"><div><div><h3 class="title">
1.97    ! rillig   4928: <a name="adding-to-list"></a>11.3.1. Adding things to a list</h3></div></div></div>
1.75      rillig   4929: <pre class="programlisting">
                   4930:     STRING=                 foo * bar `date`
                   4931:     INT_LIST=               # empty
                   4932:     ANOTHER_INT_LIST=       apache-[0-9]*:../../www/apache
                   4933:     EXT_LIST=               # empty
                   4934:     ANOTHER_EXT_LIST=       a=b c=d
1.1       grant    4935: 
1.75      rillig   4936:     INT_LIST+=              ${STRING}               # 1
                   4937:     INT_LIST+=              ${ANOTHER_INT_LIST}     # 2
                   4938:     EXT_LIST+=              ${STRING:Q}             # 3
                   4939:     EXT_LIST+=              ${ANOTHER_EXT_LIST}     # 4
1.1       grant    4940: </pre>
1.75      rillig   4941: <p>When you add a string to an external list (example 3), it
                   4942:       must be quoted. In all other cases, you must not add a quoting
                   4943:       level. You must not merge internal and external lists, unless you
                   4944:       are sure that all entries are correctly interpreted in both
                   4945:       lists.</p>
                   4946: </div>
                   4947: <div class="sect2" lang="en">
                   4948: <div class="titlepage"><div><div><h3 class="title">
1.97    ! rillig   4949: <a name="converting-internal-to-external"></a>11.3.2. Converting an internal list into an external list</h3></div></div></div>
1.75      rillig   4950: <pre class="programlisting">
                   4951:     EXT_LIST=       # empty
                   4952:     .for i in ${INT_LIST}
                   4953:     EXT_LIST+=      ${i:Q}""
                   4954:     .endfor
1.1       grant    4955: </pre>
1.75      rillig   4956: <p>This code converts the internal list
                   4957:       <code class="varname">INT_LIST</code> into the external list
                   4958:       <code class="varname">EXT_LIST</code>. As the elements of an internal list
                   4959:       are unquoted they must be quoted here. The reason for appending
                   4960:       <code class="varname">""</code> is explained below.</p>
                   4961: </div>
                   4962: <div class="sect2" lang="en">
                   4963: <div class="titlepage"><div><div><h3 class="title">
1.97    ! rillig   4964: <a name="passing-variable-to-shell"></a>11.3.3. Passing variables to a shell command</h3></div></div></div>
1.79      rillig   4965: <p>Sometimes you may want to print an arbitrary string. There
                   4966:        are many ways to get it wrong and only few that can handle every
                   4967:        nastiness.</p>
1.75      rillig   4968: <pre class="programlisting">
                   4969:     STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
                   4970:     EXT_LIST=       string=${STRING:Q} x=second\ item
1.1       grant    4971: 
1.75      rillig   4972:     all:
                   4973:             echo ${STRING}                  # 1
                   4974:             echo "${STRING}"                # 2
                   4975:             echo "${STRING:Q}"              # 3
                   4976:             echo ${STRING:Q}                # 4
                   4977:             echo x${STRING:Q} | sed 1s,.,,  # 5
1.79      rillig   4978:             printf "%s\\n" ${STRING:Q}""    # 6
1.75      rillig   4979:             env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
1.1       grant    4980: </pre>
1.75      rillig   4981: <p>Example 1 leads to a syntax error in the shell, as the
                   4982:       characters are just copied.</p>
                   4983: <p>Example 2 leads to a syntax error too, and if you leave out
                   4984:       the last " character from <code class="varname">${STRING}</code>,
                   4985:       <a 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
                   4986:       variable would be evaluated, too.</p>
                   4987: <p>Example 3 outputs each space character preceded by a
                   4988:       backslash (or not), depending on the implementation of the
                   4989:       <a 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>
                   4990: <p>Example 4 handles correctly every string that does not start
                   4991:       with a dash. In that case, the result depends on the
                   4992:       implementation of the <a 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
                   4993:       guarantee that your input does not start with a dash, this form is
                   4994:       appropriate.</p>
                   4995: <p>Example 5 handles even the case of a leading dash
                   4996:       correctly.</p>
1.79      rillig   4997: <p>Example 6 also works with every string and is the
                   4998:       light-weight solution, since it does not involve a pipe, which has
                   4999:       its own problems.</p>
1.75      rillig   5000: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
                   5001:       because the quoting has already been done when adding elements to
                   5002:       the list.</p>
                   5003: <p>As internal lists shall not be passed to the shell, there is
                   5004:       no example for it.</p>
                   5005: </div>
                   5006: <div class="sect2" lang="en">
                   5007: <div class="titlepage"><div><div><h3 class="title">
1.97    ! rillig   5008: <a name="quoting-guideline"></a>11.3.4. Quoting guideline</h3></div></div></div>
1.75      rillig   5009: <p>There are many possible sources of wrongly quoted variables.
                   5010:       This section lists some of the commonly known ones.</p>
                   5011: <div class="itemizedlist"><ul type="disc">
                   5012: <li>
                   5013: <p>Whenever you use the value of a list, think
                   5014:        about what happens to leading or trailing whitespace. If the
                   5015:        list is a well-formed shell expression, you can apply the
                   5016:        <code class="varname">:M*</code> modifier to strip leading and trailing
                   5017:        whitespace from each word. The <code class="varname">:M</code> operator
                   5018:        first splits its argument according to the rules of the shell,
                   5019:        and then creates a new list consisting of all words that match
                   5020:        the shell glob expression <code class="varname">*</code>, that is: all.
                   5021:        One class of situations where this is needed is when adding a
                   5022:        variable like <code class="varname">CPPFLAGS</code> to
                   5023:        <code class="varname">CONFIGURE_ARGS</code>. If the configure script
                   5024:        invokes other configure scripts, it strips the leading and
                   5025:        trailing whitespace from the variable and then passes it to the
                   5026:        other configure scripts. But these configure scripts expect the
                   5027:        (child) <code class="varname">CPPFLAGS</code> variable to be the same as
                   5028:        the parent <code class="varname">CPPFLAGS</code>. That's why we better
                   5029:        pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
                   5030:        here is how we do it:</p>
                   5031: <pre class="programlisting">
                   5032:     CPPFLAGS=               # empty
                   5033:     CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX:Q}\"
                   5034:     CPPFLAGS+=              ${MY_CPPFLAGS}
1.1       grant    5035: 
1.75      rillig   5036:     CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
1.1       grant    5037: 
1.75      rillig   5038:     all:
                   5039:             echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
                   5040:             echo x${CONFIGURE_ARGS}x        # properly trimmed
1.1       grant    5041: </pre>
1.75      rillig   5042: </li>
                   5043: <li><p>The example above contains one bug: The
                   5044:        <code class="varname">${PREFIX}</code> is a properly quoted shell
                   5045:        expression, but there is the C compiler after it, which also
                   5046:        expects a properly quoted string (this time in C syntax). The
                   5047:        version above is therefore only correct if
                   5048:        <code class="varname">${PREFIX}</code> does not have embedded backslashes
                   5049:        or double quotes. If you want to allow these, you have to add
                   5050:        another layer of quoting to each variable that is used as a C
                   5051:        string literal. You cannot use the <code class="varname">:Q</code>
                   5052:        operator for it, as this operator only works for the
                   5053:        shell.</p></li>
                   5054: <li>
                   5055: <p>Whenever a variable can be empty, the
                   5056:        <code class="varname">:Q</code> operator can have surprising results. Here
                   5057:        are two completely different cases which can be solved with the
                   5058:        same trick.</p>
                   5059: <pre class="programlisting">
                   5060:     EMPTY=                  # empty
                   5061:     empty_test:
                   5062:             for i in a ${EMPTY:Q} c; do \
                   5063:                     echo "$$i"; \
                   5064:             done
1.1       grant    5065: 
1.75      rillig   5066:     for_test:
                   5067:     .for i in a:\ a:\test.txt
                   5068:             echo ${i:Q}
                   5069:             echo "foo"
                   5070:     .endfor
1.1       grant    5071: </pre>
1.75      rillig   5072: <p>The first example will only print two of the three lines
                   5073:        we might have expected. This is because
                   5074:        <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
                   5075:        the shell cannot see. The workaround is to write
                   5076:        <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
                   5077:        as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
                   5078:        -f ${FNAME:Q}</code> (both of these are wrong).</p>
                   5079: <p>The second example will only print three lines instead of
                   5080:        four. The first line looks like <code class="varname">a:\ echo foo</code>.
                   5081:        This is because the backslash of the value
                   5082:        <code class="varname">a:\</code> is interpreted as a line-continuation by
                   5083:        <a 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
                   5084:        <a 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
                   5085:        <code class="varname">${i:Q}""</code>.</p>
                   5086: </li>
                   5087: </ul></div>
                   5088: </div>
                   5089: <div class="sect2" lang="en">
                   5090: <div class="titlepage"><div><div><h3 class="title">
1.97    ! rillig   5091: <a name="bsd-make-bug-workaround"></a>11.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.75      rillig   5092: <p>The pkgsrc bmake program does not handle the following
                   5093:       assignment correctly. In case <code class="varname">_othervar_</code>
                   5094:       contains a ``-'' character, one of the closing braces is included
                   5095:       in <code class="varname">${VAR}</code> after this code executes.</p>
                   5096: <pre class="programlisting">
                   5097:     VAR:=   ${VAR:N${_othervar_:C/-//}}
1.1       grant    5098: </pre>
1.75      rillig   5099: <p>For a more complex code snippet and a workaround, see the
1.91      rillig   5100:       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   5101:       <code class="varname">bug1</code>.</p>
                   5102: </div>
                   5103: </div>
                   5104: </div>
                   5105: <div class="chapter" lang="en">
                   5106: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   5107: <a name="plist"></a>Chapter 12. PLIST issues</h2></div></div></div>
1.75      rillig   5108: <div class="toc">
                   5109: <p><b>Table of Contents</b></p>
                   5110: <dl>
1.90      rillig   5111: <dt><span class="sect1"><a href="#rcs-id">12.1. RCS ID</a></span></dt>
                   5112: <dt><span class="sect1"><a href="#automatic-plist-generation">12.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   5113: <dt><span class="sect1"><a href="#print-PLIST">12.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span></a></span></dt>
                   5114: <dt><span class="sect1"><a href="#plist.misc">12.4. Variable substitution in PLIST</a></span></dt>
                   5115: <dt><span class="sect1"><a href="#manpage-compression">12.5. Man page compression</a></span></dt>
                   5116: <dt><span class="sect1"><a href="#using-PLIST_SRC">12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   5117: <dt><span class="sect1"><a href="#platform-specific-plist">12.7. Platform-specific and differing PLISTs</a></span></dt>
                   5118: <dt><span class="sect1"><a href="#faq.common-dirs">12.8. Sharing directories between packages</a></span></dt>
1.75      rillig   5119: </dl>
                   5120: </div>
1.87      wiz      5121: <p>The <code class="filename">PLIST</code> file contains a package's
                   5122:   &#8220;<span class="quote">packing list</span>&#8221;, i.e. a list of files that belong to
                   5123:   the package (relative to the <code class="filename">${PREFIX}</code>
                   5124:   directory it's been installed in) plus some additional statements
                   5125:   - see the <a 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.
                   5126:   This chapter addresses some issues that need attention when
                   5127:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   5128:   below!).</p>
1.75      rillig   5129: <div class="sect1" lang="en">
                   5130: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5131: <a name="rcs-id"></a>12.1. RCS ID</h2></div></div></div>
1.87      wiz      5132: <p>Be sure to add a RCS ID line as the first thing in any
                   5133:     <code class="filename">PLIST</code> file you write:</p>
1.75      rillig   5134: <pre class="programlisting">
1.87      wiz      5135:       @comment $NetBSD$
                   5136:     </pre>
1.75      rillig   5137: </div>
                   5138: <div class="sect1" lang="en">
                   5139: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5140: <a name="automatic-plist-generation"></a>12.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.75      rillig   5141: <p>You can use the <span><strong class="command">make print-PLIST</strong></span> command
1.87      wiz      5142:     to output a PLIST that matches any new files since the package
1.90      rillig   5143:     was extracted.  See <a href="#build.helpful-targets" title="16.17. Other helpful targets">Section 16.17, &#8220;Other helpful targets&#8221;</a> for
1.87      wiz      5144:     more information on this target.</p>
1.75      rillig   5145: </div>
                   5146: <div class="sect1" lang="en">
                   5147: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   5148: <a name="print-PLIST"></a>12.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span>
                   5149: </h2></div></div></div>
1.87      wiz      5150: <p>If you have used any of the *-dirs packages, as explained in
1.90      rillig   5151:     <a href="#faq.common-dirs" title="12.8. Sharing directories between packages">Section 12.8, &#8220;Sharing directories between packages&#8221;</a>, you may have noticed that
1.87      wiz      5152:     <span><strong class="command">make print-PLIST</strong></span> outputs a set of
                   5153:     <code class="varname">@comment</code>s instead of real
                   5154:     <code class="varname">@dirrm</code> lines.  You can also do this for
                   5155:     specific directories and files, so that the results of that
                   5156:     command are very close to reality. This helps <span class="emphasis"><em>a
                   5157:     lot</em></span> during the update of packages.</p>
                   5158: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   5159:     of AWK patterns and actions that are used to filter the output of
                   5160:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   5161:     scripting you like to it, but be careful with quoting.</p>
                   5162: <p>For example, to get all files inside the
                   5163:     <code class="filename">libdata/foo</code> directory removed from the
                   5164:     resulting PLIST:</p>
                   5165: <pre class="programlisting">
                   5166:       PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
                   5167:     </pre>
                   5168: <p>And to get all the <code class="varname">@dirrm</code> lines referring
                   5169:     to a specific (shared) directory converted to
                   5170:     <code class="varname">@comment</code>s:</p>
1.75      rillig   5171: <pre class="programlisting">
1.87      wiz      5172:       PRINT_PLIST_AWK+=       /^@dirrm share\/specific/ { print "@comment " $$0; next; }
                   5173:     </pre>
1.75      rillig   5174: </div>
                   5175: <div class="sect1" lang="en">
                   5176: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5177: <a name="plist.misc"></a>12.4. Variable substitution in PLIST</h2></div></div></div>
1.87      wiz      5178: <p>A number of variables are substituted automatically in
                   5179:     PLISTs when a package is installed on a system. This includes the
                   5180:     following variables:</p>
1.75      rillig   5181: <div class="variablelist"><dl>
                   5182: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   5183: <dd>
                   5184: <p>Some packages like emacs and perl embed information
1.87      wiz      5185:          about which architecture they were built on into the
                   5186:          pathnames where they install their files. To handle this
                   5187:          case, PLIST will be preprocessed before actually used, and
                   5188:          the symbol
                   5189:          &#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221; will be
                   5190:          replaced by what <span><strong class="command">uname -p</strong></span> gives. The
                   5191:          same is done if the string
                   5192:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   5193:          PLIST somewhere - use this on packages that have GNU
                   5194:          autoconf-created configure scripts.</p>
1.75      rillig   5195: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   5196: <h3 class="title">Legacy note</h3>
                   5197: <p>There used to be a symbol
1.87      wiz      5198:            &#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221; that
                   5199:            was replaced by the output of <span><strong class="command">uname
                   5200:            -m</strong></span>, but that's no longer supported and has
                   5201:            been removed.</p>
1.75      rillig   5202: </div>
                   5203: </dd>
                   5204: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   5205: <dd>
                   5206: <p>Some packages want to embed the OS name and version
1.87      wiz      5207:          into some paths.  To do this, use these variables in the
                   5208:          <code class="filename">PLIST</code>:
                   5209:          </p>
1.75      rillig   5210: <div class="itemizedlist"><ul type="disc">
                   5211: <li><p><code class="varname">${OPSYS}</code> - output of &#8220;<span class="quote"><span><strong class="command">uname -s</strong></span></span>&#8221;</p></li>
                   5212: <li><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. &#8220;<span class="quote">solaris</span>&#8221;)</p></li>
                   5213: <li><p><code class="varname">${OS_VERSION}</code> - &#8220;<span class="quote"><span><strong class="command">uname -r</strong></span></span>&#8221;</p></li>
                   5214: </ul></div>
                   5215: </dd>
                   5216: </dl></div>
1.87      wiz      5217: <p>For a complete list of values which are replaced by
                   5218:     default, please look in <code class="filename">bsd.pkg.mk</code> (and
                   5219:     search for <code class="varname">PLIST_SUBST</code>).</p>
                   5220: <p>If you want to change other variables not listed above, you
                   5221:     can add variables and their expansions to this variable in the
1.90      rillig   5222:     following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a href="#components.optional" title="10.5. Optional files">Section 10.5, &#8220;Optional files&#8221;</a>):</p>
1.75      rillig   5223: <pre class="programlisting">
1.87      wiz      5224:       PLIST_SUBST+=   SOMEVAR="somevalue"
                   5225:     </pre>
1.75      rillig   5226: <p>This replaces all occurrences of &#8220;<span class="quote">${SOMEVAR}</span>&#8221;
1.87      wiz      5227:     in the <code class="filename">PLIST</code> with
                   5228:     &#8220;<span class="quote">somevalue</span>&#8221;.</p>
1.75      rillig   5229: </div>
                   5230: <div class="sect1" lang="en">
                   5231: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5232: <a name="manpage-compression"></a>12.5. Man page compression</h2></div></div></div>
1.75      rillig   5233: <p>Man pages should be installed in compressed form if
1.87      wiz      5234:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   5235:     and uncompressed otherwise. To handle this in the
                   5236:     <code class="filename">PLIST</code> file, the suffix &#8220;<span class="quote">.gz</span>&#8221; is
                   5237:     appended/removed automatically for man pages according to
                   5238:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   5239:     or not, see above for details. This modification of the
                   5240:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   5241:     <code class="filename">PLIST</code> itself.</p>
1.75      rillig   5242: </div>
                   5243: <div class="sect1" lang="en">
                   5244: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   5245: <a name="using-PLIST_SRC"></a>12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
                   5246: </h2></div></div></div>
1.76      rillig   5247: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87      wiz      5248:     in generating the binary package, set the variable
                   5249:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
                   5250:     The files are later concatenated using <a 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
                   5251:     important. The default for <code class="varname">PLIST_SRC</code> is
                   5252:     <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75      rillig   5253: </div>
                   5254: <div class="sect1" lang="en">
                   5255: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5256: <a name="platform-specific-plist"></a>12.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75      rillig   5257: <p>Some packages decide to install a different set of files based on
1.87      wiz      5258:     the operating system being used. These differences can be
                   5259:     automatically handled by using the following files:</p>
1.75      rillig   5260: <div class="itemizedlist"><ul type="disc">
1.76      rillig   5261: <li><p><code class="filename">PLIST.common</code></p></li>
                   5262: <li><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   5263: <li><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   5264: <li><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   5265: <li><p><code class="filename">PLIST.common_end</code></p></li>
1.75      rillig   5266: </ul></div>
                   5267: </div>
                   5268: <div class="sect1" lang="en">
                   5269: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5270: <a name="faq.common-dirs"></a>12.8. Sharing directories between packages</h2></div></div></div>
1.87      wiz      5271: <p>A &#8220;<span class="quote">shared directory</span>&#8221; is a directory where
                   5272:     multiple (and unrelated) packages install files.  These
                   5273:     directories are problematic because you have to add special tricks
                   5274:     in the PLIST to conditionally remove them, or have some
                   5275:     centralized package handle them.</p>
                   5276: <p>Within pkgsrc, you'll find both approaches.  If a directory
                   5277:     is shared by a few unrelated packages, it's often not worth to add
                   5278:     an extra package to remove it.  Therefore, one simply does:</p>
                   5279: <pre class="programlisting">
                   5280:       @unexec ${RMDIR} %D/path/to/shared/directory 2&gt;/dev/null || ${TRUE}
                   5281:     </pre>
                   5282: <p>in the PLISTs of all affected packages, instead of the
                   5283:     regular "@dirrm" line.</p>
                   5284: <p>However, if the directory is shared across many packages, two
                   5285:     different solutions are available:</p>
1.75      rillig   5286: <div class="orderedlist"><ol type="1">
1.87      wiz      5287: <li><p>If the packages have a common dependency, the directory
                   5288:        can be removed in that.  For example, see
1.91      rillig   5289:        <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      5290:        removes the shared directory
                   5291:        <code class="filename">share/omf</code>.</p></li>
                   5292: <li><p>If the packages using the directory are not related at
                   5293:        all (they have no common dependencies), a *-dirs package is
                   5294:        used.</p></li>
1.75      rillig   5295: </ol></div>
1.87      wiz      5296: <p>From now on, we'll discuss the second solution.  To get an
                   5297:     idea of the *-dirs packages available, issue:</p>
1.75      rillig   5298: <pre class="programlisting">
1.87      wiz      5299:       <code class="prompt">%</code> cd .../pkgsrc
                   5300:       <code class="prompt">%</code> ls -d */*-dirs
                   5301:     </pre>
                   5302: <p>Their use from other packages is very simple.  The
                   5303:     <code class="varname">USE_DIRS</code> variable takes a list of package names
                   5304:     (without the &#8220;<span class="quote">-dirs</span>&#8221; part) together with the required
                   5305:     version number (always pick the latest one when writing new
                   5306:     packages).</p>
                   5307: <p>For example, if a package installs files under
                   5308:     <code class="filename">share/applications</code>, it should have the
                   5309:     following line in it:</p>
                   5310: <pre class="programlisting">
                   5311:       USE_DIRS+=      xdg-1.1
                   5312:     </pre>
                   5313: <p>After regenerating the PLIST using <span><strong class="command">make
                   5314:     print-PLIST</strong></span>, you should get the right (commented out)
                   5315:     lines.</p>
                   5316: <p>Note that even if your package is using
                   5317:     <code class="filename">$X11BASE</code>, it must not depend on the
                   5318:     *-x11-dirs packages.  Just specify the name without that part and
                   5319:     pkgsrc (in particular, <code class="filename">mk/dirs.mk</code>) will take
                   5320:     care of it.</p>
1.75      rillig   5321: </div>
                   5322: </div>
                   5323: <div class="chapter" lang="en">
                   5324: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   5325: <a name="buildlink"></a>Chapter 13. Buildlink methodology</h2></div></div></div>
1.75      rillig   5326: <div class="toc">
                   5327: <p><b>Table of Contents</b></p>
                   5328: <dl>
1.90      rillig   5329: <dt><span class="sect1"><a href="#converting-to-buildlink3">13.1. Converting packages to use buildlink3</a></span></dt>
                   5330: <dt><span class="sect1"><a href="#creating-buildlink3.mk">13.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75      rillig   5331: <dd><dl>
1.90      rillig   5332: <dt><span class="sect2"><a href="#anatomy-of-bl3">13.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   5333: <dt><span class="sect2"><a href="#updating-buildlink-depends">13.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</a></span></dt>
1.75      rillig   5334: </dl></dd>
1.90      rillig   5335: <dt><span class="sect1"><a href="#writing-builtin.mk">13.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.75      rillig   5336: <dd><dl>
1.90      rillig   5337: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">13.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
                   5338: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">13.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.75      rillig   5339: </dl></dd>
                   5340: </dl>
                   5341: </div>
                   5342: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87      wiz      5343:   are seen by a package's configure and build processes.  This is implemented
                   5344:   in a two step process:</p>
1.75      rillig   5345: <div class="orderedlist"><ol type="1">
                   5346: <li><p>Symlink headers and libraries for dependencies into
1.87      wiz      5347:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   5348:       of <code class="varname">WRKDIR</code>.</p></li>
1.75      rillig   5349: <li><p>Create wrapper scripts that are used in place of the normal compiler
1.87      wiz      5350:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   5351:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   5352:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   5353:       native compiler on some operating systems look like GCC, so that
                   5354:       packages that expect GCC won't require modifications to build with
                   5355:       those native compilers.</p></li>
1.75      rillig   5356: </ol></div>
                   5357: <p>This normalizes the environment in which a package is built so that the
1.87      wiz      5358:   package may be built consistently despite what other software may be
                   5359:   installed. Please note that the normal system header and library paths,
                   5360:   e.g. <code class="filename">/usr/include</code>,
                   5361:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   5362:   designed to insulate the package build from non-system-supplied
                   5363:   software.</p>
1.75      rillig   5364: <div class="sect1" lang="en">
                   5365: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5366: <a name="converting-to-buildlink3"></a>13.1. Converting packages to use buildlink3</h2></div></div></div>
1.75      rillig   5367: <p>The process of converting packages to use the buildlink3
1.87      wiz      5368:     framework (&#8220;<span class="quote">bl3ifying</span>&#8221;) is fairly straightforward.
                   5369:     The things to keep in mind are:</p>
1.75      rillig   5370: <div class="orderedlist"><ol type="1">
1.87      wiz      5371: <li><p>Ensure that the build always calls the wrapper scripts
                   5372:        instead of the actual toolchain.  Some packages are tricky,
                   5373:        and the only way to know for sure is the check
                   5374:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   5375:        wrappers are being invoked.</p></li>
                   5376: <li><p>Don't override <code class="varname">PREFIX</code> from within
                   5377:        the package Makefile, e.g. Java VMs, standalone shells,
                   5378:        etc., because the code to symlink files into
                   5379:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
                   5380:        relative to &#8220;<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>&#8221;.
                   5381:        </p></li>
                   5382: <li><p>Remember that <span class="emphasis"><em>only</em></span> the
                   5383:        <code class="filename">buildlink3.mk</code> files that you list in a
                   5384:        package's Makefile are added as dependencies for that package.
                   5385:        </p></li>
1.75      rillig   5386: </ol></div>
1.87      wiz      5387: <p>If a dependency on a particular package is required for its libraries and
                   5388:     headers, then we replace:</p>
1.75      rillig   5389: <pre class="programlisting">
1.87      wiz      5390:       DEPENDS+=   foo&gt;=1.1.0:../../category/foo
                   5391:     </pre>
1.75      rillig   5392: <p>with</p>
                   5393: <pre class="programlisting">
1.87      wiz      5394:       .include "../../category/foo/buildlink3.mk"
                   5395:     </pre>
1.75      rillig   5396: <p>The buildlink3.mk files usually define the required dependencies.
                   5397:     If you need a newer version of the dependency when using buildlink3.mk
1.87      wiz      5398:     files, then you can define it in your Makefile; for example:</p>
1.75      rillig   5399: <pre class="programlisting">
1.87      wiz      5400:       BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
                   5401:       .include "../../category/foo/buildlink3.mk"
                   5402:     </pre>
1.76      rillig   5403: <p>There are several <code class="filename">buildlink3.mk</code>
1.87      wiz      5404:     files in <code class="filename">pkgsrc/mk</code>
                   5405:     that handle special package issues:</p>
1.75      rillig   5406: <div class="itemizedlist"><ul type="disc">
1.76      rillig   5407: <li><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87      wiz      5408:        the native or a pkgsrc Berkeley DB implementation based on
                   5409:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   5410:        <code class="varname">BDB_DEFAULT</code>.</p></li>
1.76      rillig   5411: <li><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87      wiz      5412:        comes with neither Curses nor NCurses, this will take care
1.91      rillig   5413:        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   5414: <li><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87      wiz      5415:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   5416:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   5417:        require a Kerberos 5 implementation.</p></li>
1.88      wiz      5418: <li><p><code class="filename">motif.buildlink3.mk</code> checks for a
                   5419:        system-provided Motif installation or adds a dependency on
1.91      rillig   5420:        <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      5421:        <code class="varname">MOTIF_TYPE</code> to &#8220;<span class="quote">dt</span>&#8221;,
                   5422:        &#8220;<span class="quote">lesstif</span>&#8221;, or &#8220;<span class="quote">openmotif</span>&#8221; to choose
                   5423:        which Motif version will be used.</p></li>
1.76      rillig   5424: <li><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87      wiz      5425:        variables that may be used by packages that use the
                   5426:        Open Sound System (OSS) API.</p></li>
1.76      rillig   5427: <li><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.93      rillig   5428:        either Postgres 8.0, 8.1, or 8.2, whichever is found installed. See
1.87      wiz      5429:        the file for more information.</p></li>
1.76      rillig   5430: <li><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87      wiz      5431:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.91      rillig   5432:        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   5433: <li><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87      wiz      5434:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   5435:        library.</p></li>
1.75      rillig   5436: </ul></div>
1.76      rillig   5437: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87      wiz      5438:     files provide a more complete
                   5439:     description of how to use them properly.</p>
1.75      rillig   5440: </div>
                   5441: <div class="sect1" lang="en">
                   5442: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5443: <a name="creating-buildlink3.mk"></a>13.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.87      wiz      5444: <p>A package's <code class="filename">buildlink3.mk</code> file is
                   5445:     included by Makefiles to indicate the need to compile and link
                   5446:     against header files and libraries provided by the package.  A
                   5447:     <code class="filename">buildlink3.mk</code> file should always provide
                   5448:     enough information to add the correct type of dependency
                   5449:     relationship and include any other
                   5450:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   5451:     headers and libraries that it needs in turn.</p>
                   5452: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.91      rillig   5453:     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      5454:     package is highly recommended.  For most packages, the following
                   5455:     command will generate a good starting point for
                   5456:     <code class="filename">buildlink3.mk</code> files:</p>
                   5457: <pre class="screen">
                   5458: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   5459: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   5460:     </pre>
1.75      rillig   5461: <div class="sect2" lang="en">
                   5462: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   5463: <a name="anatomy-of-bl3"></a>13.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75      rillig   5464: <p>The following real-life example
1.87      wiz      5465:       <code class="filename">buildlink3.mk</code> is taken
                   5466:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75      rillig   5467: <pre class="programlisting">
1.87      wiz      5468:        # $NetBSD: buildlink3.mk,v 1.7 2004/03/18 09:12:12 jlam Exp $
1.1       grant    5469: 
1.87      wiz      5470:        BUILDLINK_DEPTH:=       ${BUILDLINK_DEPTH}+
                   5471:        TIFF_BUILDLINK3_MK:=    ${TIFF_BUILDLINK3_MK}+
1.1       grant    5472: 
1.87      wiz      5473:        .if !empty(BUILDLINK_DEPTH:M+)
                   5474:        BUILDLINK_DEPENDS+=     tiff
                   5475:        .endif
                   5476: 
                   5477:        BUILDLINK_PACKAGES:=    ${BUILDLINK_PACKAGES:Ntiff}
                   5478:        BUILDLINK_PACKAGES+=    tiff
                   5479: 
                   5480:        .if !empty(TIFF_BUILDLINK3_MK:M+)
                   5481:        BUILDLINK_API_DEPENDS.tiff+=        tiff&gt;=3.6.1
                   5482:        BUILDLINK_PKGSRCDIR.tiff?=      ../../graphics/tiff
                   5483:        .endif  # TIFF_BUILDLINK3_MK
                   5484: 
                   5485:        .include "../../devel/zlib/buildlink3.mk"
                   5486:        .include "../../graphics/jpeg/buildlink3.mk"
                   5487: 
                   5488:        BUILDLINK_DEPTH:=       ${BUILDLINK_DEPTH:S/+$//}
                   5489:       </pre>
                   5490: <p>The header and footer manipulate
                   5491:       <code class="varname">BUILDLINK_DEPTH</code>, which is common across all
                   5492:       <code class="filename">buildlink3.mk</code> files and is used to track
                   5493:       at what depth we are including
                   5494:       <code class="filename">buildlink3.mk</code> files.</p>
                   5495: <p>The first section controls if the dependency on
                   5496:       <em class="replaceable"><code>pkg</code></em> is added.
                   5497:       <code class="varname">BUILDLINK_DEPENDS</code> is the global list of
                   5498:       packages for which dependencies are added by
                   5499:       buildlink3.</p>
                   5500: <p>The second section advises pkgsrc that the
                   5501:       <code class="filename">buildlink3.mk</code> file for
                   5502:       <em class="replaceable"><code>pkg</code></em> has been included at some point.
                   5503:       <code class="varname">BUILDLINK_PACKAGES</code> is the global list of
                   5504:       packages for which <code class="filename">buildlink3.mk</code> files
                   5505:       have been included.  It must <span class="emphasis"><em>always</em></span> be
                   5506:       appended to within a <code class="filename">buildlink3.mk</code>
                   5507:       file.</p>
                   5508: <p>The third section is protected from multiple inclusion
                   5509:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   5510:       added.  Several important variables are set in the section:</p>
                   5511: <div class="itemizedlist"><ul type="disc">
                   5512: <li><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5513:          is the actual dependency recorded in the installed
                   5514:          package; this should always be set using
                   5515:          <span><strong class="command">+=</strong></span> to ensure that
                   5516:          we're appending to any pre-existing list of values.  This
                   5517:          variable should be set to the first version of the
                   5518:          package that had an API change.
                   5519:          </p></li>
                   5520: <li><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
                   5521:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   5522:          pkgsrc directory.</p></li>
                   5523: <li><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   5524:          (not shown above) controls whether we use
                   5525:          <code class="varname">BUILD_DEPENDS</code> or
                   5526:          <code class="varname">DEPENDS</code> to add the dependency on
                   5527:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   5528:          selected by setting
                   5529:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   5530:          to &#8220;<span class="quote">build</span>&#8221;.  By default, the full dependency is
                   5531:          used.</p></li>
                   5532: <li><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5533:            and
                   5534:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   5535:            (not shown above) are lists of subdirectories of
1.76      rillig   5536:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   5537:            to add to the header and library search paths.  These
                   5538:            default to &#8220;<span class="quote">include</span>&#8221; and &#8220;<span class="quote">lib</span>&#8221;
1.87      wiz      5539:          respectively.</p></li>
                   5540: <li><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5541:            (not shown above) is the list of preprocessor flags to add
                   5542:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
                   5543:            configure and build phases.  The &#8220;<span class="quote">-I</span>&#8221; option
                   5544:            should be avoided and instead be handled using
                   5545:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87      wiz      5546:          above.</p></li>
1.75      rillig   5547: </ul></div>
1.87      wiz      5548: <p>The following variables are all optionally defined within
                   5549:       this second section (protected against multiple inclusion) and
                   5550:       control which package files are symlinked into
                   5551:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   5552:       transformed during the symlinking:</p>
1.75      rillig   5553: <div class="itemizedlist"><ul type="disc">
1.87      wiz      5554: <li><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5555:            (not shown above) is a shell glob pattern relative to
1.76      rillig   5556:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   5557:            to be symlinked into
1.76      rillig   5558:            <code class="filename">${BUILDLINK_DIR}</code>,
1.87      wiz      5559:          e.g. <code class="filename">include/*.h</code>.</p></li>
                   5560: <li><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
                   5561:            (not shown above) is a shell pipeline that
                   5562:            outputs to stdout a list of files relative to
                   5563:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   5564:            The resulting files are to be symlinked
                   5565:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   5566:            this takes the <code class="filename">+CONTENTS</code> of a
                   5567:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   5568:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
                   5569: <li><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5570:            (not shown above) is a filter command that filters
1.76      rillig   5571:            <code class="filename">+CONTENTS</code> input into a list of files
1.75      rillig   5572:            relative to
1.76      rillig   5573:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   5574:            on stdout.  By default for overwrite packages,
                   5575:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76      rillig   5576:            outputs the contents of the <code class="filename">include</code>
                   5577:            and <code class="filename">lib</code> directories in the package
                   5578:            <code class="filename">+CONTENTS</code>, and for pkgviews packages,
1.75      rillig   5579:            it outputs any libtool archives in
1.87      wiz      5580:            <code class="filename">lib</code> directories.</p></li>
1.95      tron     5581: <li><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5582:            (not shown above) is a list of sed arguments used to
                   5583:            transform the name of the source filename into a
                   5584:            destination filename, e.g. <span><strong class="command">-e
1.87      wiz      5585:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75      rillig   5586: </ul></div>
1.87      wiz      5587: <p>The last section includes any
                   5588:       <code class="filename">buildlink3.mk</code> needed for
                   5589:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   5590:       Including these <code class="filename">buildlink3.mk</code> files
                   5591:       means that the headers and libraries for these
                   5592:       dependencies are also symlinked into
                   5593:       <code class="filename">${BUILDLINK_DIR}</code>
                   5594:       whenever the <em class="replaceable"><code>pkg</code></em>
                   5595:       <code class="filename">buildlink3.mk</code>
                   5596:       file is included.</p>
1.75      rillig   5597: </div>
                   5598: <div class="sect2" lang="en">
                   5599: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   5600: <a name="updating-buildlink-depends"></a>13.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      5601: <p>The situation that requires increasing the dependency listed in
1.75      rillig   5602:        <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5603:        after a package update is when the API or interface to the
1.87      wiz      5604:       header files change.</p>
                   5605: <p>In this case,
                   5606:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5607:       should be adjusted to require at least the new package
                   5608:       version.  In some cases, the packages that depend on this new
                   5609:       version may need their <code class="varname">PKGREVISION</code>s
                   5610:       increased and, if they have <code class="filename">buildlink3.mk</code>
                   5611:       files, their
                   5612:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5613:       adjusted, too.  This is needed so pkgsrc will require the
                   5614:       correct package dependency and not settle for an older one
                   5615:       when building the source.</p>
                   5616: <p><code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5617:        should be increased when the binary interface or sonames
                   5618:        (major number of the library version) of any installed
                   5619:        shared libraries change.  This is needed so that binary
                   5620:        packages made using it will require the correct package
                   5621:        dependency and not settle for an older one which will not
1.87      wiz      5622:       contain the necessary shared libraries.</p>
1.90      rillig   5623: <p>See <a href="#dependencies" title="18.1.6. Handling dependencies">Section 18.1.6, &#8220;Handling dependencies&#8221;</a> for
1.75      rillig   5624:        more information about dependencies on other packages,
                   5625:        including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87      wiz      5626:       <code class="varname">ABI_DEPENDS</code> definitions.</p>
                   5627: <p>Please take careful consideration before adjusting
                   5628:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5629:       or
                   5630:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5631:       as we don't want to cause unneeded package deletions and
                   5632:       rebuilds.  In many cases, new versions of packages work just
                   5633:       fine with older dependencies.</p>
                   5634: <p>Also it is not needed to set
1.75      rillig   5635:        <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5636:        when it is identical to
1.87      wiz      5637:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.        </p>
1.75      rillig   5638: </div>
                   5639: </div>
                   5640: <div class="sect1" lang="en">
                   5641: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5642: <a name="writing-builtin.mk"></a>13.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87      wiz      5643: <p>Some packages in pkgsrc install headers and libraries that
1.75      rillig   5644:       coincide with headers and libraries present in the base system.
1.76      rillig   5645:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   5646:       packages should also include a <code class="filename">builtin.mk</code>
1.75      rillig   5647:       file that includes the necessary checks to decide whether using
                   5648:       the built-in software or the pkgsrc software is
1.87      wiz      5649:     appropriate.</p>
                   5650: <p>The only requirements of a builtin.mk file for
                   5651:     <em class="replaceable"><code>pkg</code></em> are:</p>
1.75      rillig   5652: <div class="orderedlist"><ol type="1">
1.87      wiz      5653: <li><p>It should set
                   5654:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5655:        to either &#8220;<span class="quote">yes</span>&#8221; or &#8220;<span class="quote">no</span>&#8221;
                   5656:        after it is included.</p></li>
                   5657: <li><p>It should <span class="emphasis"><em>not</em></span> override any
                   5658:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5659:        which is already set before the
                   5660:        <code class="filename">builtin.mk</code> file is included.</p></li>
                   5661: <li><p>It should be written to allow multiple inclusion.  This
                   5662:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   5663:        attention to <code class="filename">Makefile</code> coding.</p></li>
1.75      rillig   5664: </ol></div>
                   5665: <div class="sect2" lang="en">
                   5666: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   5667: <a name="anatomy-of-builtin.mk"></a>13.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
1.75      rillig   5668: <p>The following is the recommended template for builtin.mk
1.87      wiz      5669:       files:</p>
1.75      rillig   5670: <pre class="programlisting">
1.87      wiz      5671:        .if !defined(IS_BUILTIN.foo)
                   5672:        #
                   5673:        # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   5674:        # genuinely exists in the system or not.
                   5675:        #
                   5676:        IS_BUILTIN.foo?=        no
                   5677: 
                   5678:        # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   5679:        # version can be determined.
                   5680:        #
                   5681:        .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   5682:        BUILTIN_PKG.foo?=       foo-1.0
                   5683:        .  endif
                   5684:        .endif  # IS_BUILTIN.foo
                   5685: 
                   5686:        .if !defined(USE_BUILTIN.foo)
                   5687:        USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   5688:        .  if defined(BUILTIN_PKG.foo)
                   5689:        .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   5690:        .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   5691:        USE_BUILTIN.foo!=                                                       \
                   5692:        if ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}; then     \
                   5693:        ${ECHO} "yes";                                            \
                   5694:        else                                                              \
                   5695:        ${ECHO} "no";                                             \
                   5696:        fi
                   5697:        .      endif
                   5698:        .    endfor
                   5699:        .  endif
                   5700:        .endif  # USE_BUILTIN.foo
                   5701: 
                   5702:        CHECK_BUILTIN.foo?=     no
                   5703:        .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   5704:        #
                   5705:        # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   5706:        # "yes" or "no".
                   5707:        #
                   5708:        .endif  # CHECK_BUILTIN.foo
                   5709:       </pre>
                   5710: <p>The first section sets
                   5711:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5712:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   5713:       in the base system.  This should not be a base system software
                   5714:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
                   5715:       it should only be &#8220;<span class="quote">yes</span>&#8221; if the actual package is
                   5716:       included as part of the base system.  This variable is only
                   5717:       used internally within the <code class="filename">builtin.mk</code>
                   5718:       file.</p>
                   5719: <p>The second section sets
                   5720:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5721:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   5722:       system if it exists (if
                   5723:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5724:       is &#8220;<span class="quote">yes</span>&#8221;).  This variable is only used internally
                   5725:       within the <code class="filename">builtin.mk</code> file.</p>
                   5726: <p>The third section sets
                   5727:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5728:       and is <span class="emphasis"><em>required</em></span> in all
                   5729:       <code class="filename">builtin.mk</code> files.  The code in this
                   5730:       section must make the determination whether the built-in
                   5731:       software is adequate to satisfy the dependencies listed in
                   5732:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5733:       This is typically done by comparing
                   5734:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5735:       against each of the dependencies in
                   5736:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5737:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5738:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   5739:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   5740:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5741:       may be &#8220;<span class="quote">yes</span>&#8221; even if
                   5742:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5743:       is &#8220;<span class="quote">no</span>&#8221; because we may make the determination
                   5744:       that the built-in version of the software is similar enough to
                   5745:       be used as a replacement.</p>
                   5746: <p>The last section is guarded by
                   5747:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   5748:       and includes code that uses the value of
                   5749:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5750:       set in the previous section.  This typically includes, e.g.,
                   5751:       adding additional dependency restrictions and listing additional
                   5752:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   5753:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75      rillig   5754: </div>
                   5755: <div class="sect2" lang="en">
                   5756: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   5757: <a name="native-or-pkgsrc-preference"></a>13.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87      wiz      5758: <p>When building packages, it's possible to choose whether to set
                   5759:        a global preference for using either the built-in (native)
                   5760:        version or the pkgsrc version of software to satisfy a
                   5761:        dependency.  This is controlled by setting
                   5762:        <code class="varname">PREFER_PKGSRC</code> and
                   5763:        <code class="varname">PREFER_NATIVE</code>.  These variables take values
                   5764:        of either &#8220;<span class="quote">yes</span>&#8221;, &#8220;<span class="quote">no</span>&#8221;, or a list of
                   5765:        packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
                   5766:        use the pkgsrc versions of software, while
                   5767:        <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
                   5768:        built-in versions.  Preferences are determined by the most
                   5769:        specific instance of the package in either
                   5770:        <code class="varname">PREFER_PKGSRC</code> or
                   5771:        <code class="varname">PREFER_NATIVE</code>.  If a package is specified
                   5772:        in neither or in both variables, then
                   5773:        <code class="varname">PREFER_PKGSRC</code> has precedence over
                   5774:        <code class="varname">PREFER_NATIVE</code>.  For example, to require
                   5775:        using pkgsrc versions of software for all but the most basic
                   5776:       bits on a NetBSD system, you can set:</p>
                   5777: <pre class="programlisting">
                   5778:        PREFER_PKGSRC=  yes
                   5779:        PREFER_NATIVE=  getopt skey tcp_wrappers
                   5780:       </pre>
                   5781: <p>A package <span class="emphasis"><em>must</em></span> have a
                   5782:       <code class="filename">builtin.mk</code>
                   5783:       file to be listed in <code class="varname">PREFER_NATIVE</code>,
                   5784:       otherwise it is simply ignored in that list.</p>
1.75      rillig   5785: </div>
                   5786: </div>
                   5787: </div>
                   5788: <div class="chapter" lang="en">
                   5789: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   5790: <a name="pkginstall"></a>Chapter 14. The pkginstall framework</h2></div></div></div>
1.75      rillig   5791: <div class="toc">
                   5792: <p><b>Table of Contents</b></p>
                   5793: <dl>
1.90      rillig   5794: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">14.1. Files and directories outside the installation prefix</a></span></dt>
1.75      rillig   5795: <dd><dl>
1.90      rillig   5796: <dt><span class="sect2"><a href="#dirs-outside-prefix">14.1.1. Directory manipulation</a></span></dt>
                   5797: <dt><span class="sect2"><a href="#files-outside-prefix">14.1.2. File manipulation</a></span></dt>
1.75      rillig   5798: </dl></dd>
1.90      rillig   5799: <dt><span class="sect1"><a href="#conf-files">14.2. Configuration files</a></span></dt>
1.75      rillig   5800: <dd><dl>
1.90      rillig   5801: <dt><span class="sect2"><a href="#conf-files-sysconfdir">14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   5802: <dt><span class="sect2"><a href="#conf-files-configure">14.2.2. Telling the software where configuration files are</a></span></dt>
                   5803: <dt><span class="sect2"><a href="#conf-files-patching">14.2.3. Patching installations</a></span></dt>
                   5804: <dt><span class="sect2"><a href="#conf-files-disable">14.2.4. Disabling handling of configuration files</a></span></dt>
                   5805: </dl></dd>
                   5806: <dt><span class="sect1"><a href="#rcd-scripts">14.3. System startup scripts</a></span></dt>
                   5807: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">14.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
                   5808: <dt><span class="sect1"><a href="#users-and-groups">14.4. System users and groups</a></span></dt>
                   5809: <dt><span class="sect1"><a href="#shells">14.5. System shells</a></span></dt>
                   5810: <dd><dl><dt><span class="sect2"><a href="#shells-disable">14.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   5811: <dt><span class="sect1"><a href="#fonts">14.6. Fonts</a></span></dt>
                   5812: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">14.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.75      rillig   5813: </dl>
                   5814: </div>
                   5815: <p>This chapter describes the framework known as
                   5816: <code class="literal">pkginstall</code>, whose key features are:</p>
                   5817: <div class="itemizedlist"><ul type="disc">
                   5818: <li><p>Generic installation and manipulation of directories and files
                   5819:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
                   5820: <li><p>Automatic handling of configuration files during installation,
                   5821:     provided that packages are correctly designed.</p></li>
                   5822: <li><p>Generation and installation of system startup scripts.</p></li>
                   5823: <li><p>Registration of system users and groups.</p></li>
                   5824: <li><p>Registration of system shells.</p></li>
                   5825: <li><p>Automatic updating of fonts databases.</p></li>
                   5826: </ul></div>
                   5827: <p>The following sections inspect each of the above points in detail.</p>
                   5828: <p>You may be thinking that many of the things described here could be
                   5829: easily done with simple code in the package's post-installation target
                   5830: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   5831: as the code in them is only executed when building from source.  Machines
                   5832: using binary packages could not benefit from it at all (as the code itself
                   5833: could be unavailable).  Therefore, the only way to achieve any of the items
                   5834: described above is by means of the installation scripts, which are
                   5835: automatically generated by pkginstall.</p>
                   5836: <div class="sect1" lang="en">
                   5837: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5838: <a name="files-and-dirs-outside-prefix"></a>14.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76      rillig   5839: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75      rillig   5840: of files and directories that belong to a package.  The names used in it
1.76      rillig   5841: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75      rillig   5842: which means that it cannot register files outside this directory (absolute
                   5843: path names are not allowed).  Despite this restriction, some packages need
                   5844: to install files outside this location; e.g., under
1.76      rillig   5845: <code class="filename">${VARBASE}</code> or
1.87      wiz      5846: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   5847: is to create such files during installation time by using
                   5848: installation scripts.</p>
                   5849: <p>The generic installation scripts are shell scripts that can
                   5850: contain arbitrary code.  The list of scripts to execute is taken from
                   5851: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   5852: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   5853: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   5854: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   5855: commands, so they have the potential to create and manage files
                   5856: anywhere in the file system.</p>
                   5857: <p>Using these general installation files is not recommended, but
                   5858: may be needed in some special cases.  One reason for avoiding them is
                   5859: that the user has to trust the packager that there is no unwanted or
                   5860: simply erroneous code included in the installation script. Also,
                   5861: previously there were many similar scripts for the same functionality,
                   5862: and fixing a common error involved finding and changing all of
                   5863: them.</p>
                   5864: <p>The pkginstall framework offers another, standardized way.  It
                   5865: provides generic scripts to abstract the manipulation of such files
                   5866: and directories based on variables set in the package's
                   5867: <code class="filename">Makefile</code>.  The rest of this section describes
                   5868: these variables.</p>
1.75      rillig   5869: <div class="sect2" lang="en">
                   5870: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   5871: <a name="dirs-outside-prefix"></a>14.1.1. Directory manipulation</h3></div></div></div>
1.75      rillig   5872: <p>The following variables can be set to request the creation of
                   5873: directories anywhere in the file system:</p>
                   5874: <div class="itemizedlist"><ul type="disc">
                   5875: <li><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
                   5876:     contain a list of directories that should be created and should attempt
                   5877:     to be destroyed by the installation scripts.  The difference between
                   5878:     the two is that the latter prompts the administrator to remove any
                   5879:     directories that may be left after deinstallation (because they were
                   5880:     not empty), while the former does not.</p></li>
                   5881: <li>
                   5882: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   5883:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   5884:     which directories should be created and should attempt to be destroyed
                   5885:     by the installation scripts.  Each tuple holds the following values,
                   5886:     separated by spaces: the directory name, its owner, its group and its
                   5887:     numerical mode.  For example:</p>
                   5888: <pre class="programlisting">
                   5889:     MAKE_DIRS_PERMS+=         ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
1.1       grant    5890: </pre>
1.75      rillig   5891: <p>The difference between the two is exactly the same as their
                   5892:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5893: </li>
                   5894: </ul></div>
                   5895: </div>
                   5896: <div class="sect2" lang="en">
                   5897: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   5898: <a name="files-outside-prefix"></a>14.1.2. File manipulation</h3></div></div></div>
1.75      rillig   5899: <p>Creating non-empty files outside the installation prefix is tricky
1.76      rillig   5900: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75      rillig   5901: To overcome this problem, the only solution is to extract the file in the
                   5902: known place (i.e., inside the installation prefix) and copy it to the
                   5903: appropriate location during installation (done by the installation scripts
                   5904: generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
                   5905: file</em></span> in the following paragraphs, which describe the variables
                   5906: that can be used to automatically and consistently handle files outside the
                   5907: installation prefix:</p>
                   5908: <div class="itemizedlist"><ul type="disc">
                   5909: <li>
                   5910: <p><code class="varname">CONF_FILES</code> and
                   5911:     <code class="varname">SUPPORT_FILES</code> are pairs of master and target files.
                   5912:     During installation time, the master file is copied to the target one
                   5913:     if and only if the latter does not exist.  Upon deinstallation, the
                   5914:     target file is removed provided that it was not modified by the
                   5915:     installation.</p>
                   5916: <p>The difference between the two is that the latter prompts the
                   5917:     administrator to remove any files that may be left after
                   5918:     deinstallation (because they were not empty), while the former does
                   5919:     not.</p>
                   5920: </li>
                   5921: <li>
                   5922: <p><code class="varname">CONF_FILES_PERMS</code> and
                   5923:     <code class="varname">SUPPORT_FILES_PERMS</code> contain tuples describing master
                   5924:     files as well as their target locations.  For each of them, it also
                   5925:     specifies their owner, their group and their numeric permissions, in
                   5926:     this order.  For example:</p>
                   5927: <pre class="programlisting">
                   5928:     SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1       grant    5929: </pre>
1.75      rillig   5930: <p>The difference between the two is exactly the same as their
                   5931:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5932: </li>
                   5933: </ul></div>
                   5934: </div>
                   5935: </div>
                   5936: <div class="sect1" lang="en">
                   5937: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5938: <a name="conf-files"></a>14.2. Configuration files</h2></div></div></div>
1.75      rillig   5939: <p>Configuration files are special in the sense that they are installed
                   5940: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
                   5941: need special treatment during installation (most of which is automated by
                   5942: pkginstall).  The main concept you must bear in mind is that files marked
                   5943: as configuration files are automatically copied to the right place (somewhere
                   5944: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
                   5945: and only if</em></span> they didn't exist before.  Similarly, they will not
                   5946: be removed if they have local modifications.  This ensures that
                   5947: administrators never lose any custom changes they may have made.</p>
                   5948: <div class="sect2" lang="en">
                   5949: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   5950: <a name="conf-files-sysconfdir"></a>14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
1.75      rillig   5951: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   5952: specifies where configuration files shall be installed.  Its contents are
                   5953: set based upon the following variables:</p>
                   5954: <div class="itemizedlist"><ul type="disc">
                   5955: <li><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76      rillig   5956:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75      rillig   5957:     be overridden by the user to point to his preferred location (e.g.,
1.76      rillig   5958:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75      rillig   5959:     Packages must not use it directly.</p></li>
                   5960: <li>
                   5961: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   5962:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   5963:     for the package being built shall be installed.  The definition of this
                   5964:     variable only makes sense in the package's
1.76      rillig   5965:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75      rillig   5966: <p>As an example, consider the Apache package,
1.91      rillig   5967:     <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   5968:     configuration files under the
1.76      rillig   5969:     <code class="filename">httpd/</code> subdirectory of
1.75      rillig   5970:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   5971:     Makefile.</p>
                   5972: </li>
                   5973: <li><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
                   5974:     variable that holds this package's configuration directory (if
                   5975:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   5976:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   5977:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
                   5978: <li><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
                   5979:     directory where the configuration files for the package identified by
                   5980:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   5981: </ul></div>
                   5982: <p>Based on the above variables, pkginstall determines the value of
                   5983: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
                   5984: variable that can be used within a package to refer to its configuration
                   5985: directory.  The algorithm used to set its value is basically the
                   5986: following:</p>
                   5987: <div class="orderedlist"><ol type="1">
                   5988: <li><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
                   5989:     its value is used.</p></li>
                   5990: <li><p>If the previous variable is not defined but
                   5991:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76      rillig   5992:     <code class="filename">Makefile</code>, the resulting value is
                   5993:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.75      rillig   5994: <li><p>Otherwise, it is set to
1.76      rillig   5995:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75      rillig   5996: </ol></div>
1.76      rillig   5997: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.90      rillig   5998: automatically added to <code class="filename">OWN_DIRS</code>.  See <a href="#dirs-outside-prefix" title="14.1.1. Directory manipulation">Section 14.1.1, &#8220;Directory manipulation&#8221;</a> what this means.</p>
1.75      rillig   5999: </div>
                   6000: <div class="sect2" lang="en">
                   6001: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   6002: <a name="conf-files-configure"></a>14.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75      rillig   6003: <p>Given that pkgsrc (and users!) expect configuration files to be in a
                   6004: known place, you need to teach each package where it shall install its
                   6005: files.  In some cases you will have to patch the package Makefiles to
                   6006: achieve it.  If you are lucky, though, it may be as easy as passing an
                   6007: extra flag to the configuration script; this is the case of GNU Autoconf-
                   6008: generated files:</p>
                   6009: <pre class="programlisting">
                   6010:     CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1       grant    6011: </pre>
1.75      rillig   6012: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
                   6013: for</em></span> its configuration files, not where they will be originally
                   6014: installed (although the difference is never explicit,
                   6015: unfortunately).</p>
                   6016: </div>
                   6017: <div class="sect2" lang="en">
                   6018: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   6019: <a name="conf-files-patching"></a>14.2.3. Patching installations</h3></div></div></div>
1.75      rillig   6020: <p>As said before, pkginstall automatically handles configuration files.
                   6021: This means that <span class="strong"><strong>the packages themselves must not
1.76      rillig   6022: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75      rillig   6023: directly</strong></span>.  Bad news is that many software installation scripts
                   6024: will, out of the box, mess with the contents of that directory.  So what is
                   6025: the correct procedure to fix this issue?</p>
                   6026: <p>You must teach the package (usually by manually patching it) to
                   6027: install any configuration files under the examples hierarchy,
1.76      rillig   6028: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   6029: <code class="filename">PLIST</code> registers them and the administrator always
1.75      rillig   6030: has the original copies available.</p>
                   6031: <p>Once the required configuration files are in place (i.e., under the
                   6032: examples hierarchy), the pkginstall framework can use them as master copies
                   6033: during the package installation to update what is in
1.76      rillig   6034: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
1.75      rillig   6035: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.90      rillig   6036: used.  Check out <a href="#files-outside-prefix" title="14.1.2. File manipulation">Section 14.1.2, &#8220;File manipulation&#8221;</a> for information
1.75      rillig   6037: about their syntax and their purpose.  Here is an example, taken from the
1.91      rillig   6038: <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   6039: <pre class="programlisting">
                   6040:     EGDIR=        ${PREFIX}/share/doc/mutt/samples
                   6041:     CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1       grant    6042: </pre>
1.75      rillig   6043: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
                   6044: package and has no meaning outside it.</p>
                   6045: </div>
                   6046: <div class="sect2" lang="en">
                   6047: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   6048: <a name="conf-files-disable"></a>14.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75      rillig   6049: <p>The automatic copying of config files can be toggled by setting the
                   6050: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   6051: installation.</p>
                   6052: </div>
                   6053: </div>
                   6054: <div class="sect1" lang="en">
                   6055: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6056: <a name="rcd-scripts"></a>14.3. System startup scripts</h2></div></div></div>
1.75      rillig   6057: <p>System startup scripts are special files because they must be
                   6058: installed in a place known by the underlying OS, usually outside the
1.90      rillig   6059: installation prefix.  Therefore, the same rules described in <a href="#files-and-dirs-outside-prefix" title="14.1. Files and directories outside the installation prefix">Section 14.1, &#8220;Files and directories outside the installation prefix&#8221;</a> apply, and the same solutions
1.75      rillig   6060: can be used.  However, pkginstall provides a special mechanism to handle
                   6061: these files.</p>
                   6062: <p>In order to provide system startup scripts, the package has
                   6063: to:</p>
                   6064: <div class="orderedlist"><ol type="1">
1.76      rillig   6065: <li><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75      rillig   6066:     the <code class="literal">.sh</code> suffix appended.  Considering the
1.91      rillig   6067:     <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   6068:     <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.75      rillig   6069: <li>
                   6070: <p>Tell pkginstall to handle it, appending the name of the script,
                   6071:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   6072:     Continuing the previous example:</p>
                   6073: <pre class="programlisting">
                   6074:     RCD_SCRIPTS+=   cupsd
1.1       grant    6075: </pre>
1.75      rillig   6076: </li>
                   6077: </ol></div>
                   6078: <p>Once this is done, pkginstall will do the following steps for each
                   6079: script in an automated fashion:</p>
                   6080: <div class="orderedlist"><ol type="1">
                   6081: <li><p>Process the file found in the files directory applying all the
1.76      rillig   6082:     substitutions described in the <code class="filename">FILES_SUBST</code>
1.75      rillig   6083:     variable.</p></li>
                   6084: <li><p>Copy the script from the files directory to the examples
1.76      rillig   6085:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
1.75      rillig   6086:     that this master file must be explicitly registered in the
1.76      rillig   6087:     <code class="filename">PLIST</code>.</p></li>
1.75      rillig   6088: <li><p>Add code to the installation scripts to copy the startup script
                   6089:     from the examples hierarchy into the system-wide startup scripts
                   6090:     directory.</p></li>
                   6091: </ol></div>
                   6092: <div class="sect2" lang="en">
                   6093: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   6094: <a name="rcd-scripts-disable"></a>14.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75      rillig   6095: <p>The automatic copying of config files can be toggled by setting the
                   6096: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   6097: installation.  Note that the scripts will be always copied inside the
1.76      rillig   6098: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75      rillig   6099: matter what the value of this variable is.</p>
                   6100: </div>
                   6101: </div>
                   6102: <div class="sect1" lang="en">
                   6103: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6104: <a name="users-and-groups"></a>14.4. System users and groups</h2></div></div></div>
1.75      rillig   6105: <p>If a package needs to create special users and/or groups during
                   6106: installation, it can do so by using the pkginstall framework.</p>
                   6107: <p>Users can be created by adding entries to the
                   6108: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   6109: syntax:</p>
                   6110: <pre class="programlisting">
                   6111:     user:group
1.1       grant    6112: </pre>
1.87      wiz      6113: <p>Further specification of user details may be done by setting
                   6114: per-user variables.
                   6115: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   6116: numeric UID for the user.
                   6117: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   6118: user's description or comment.
                   6119: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   6120: user's home directory, and defaults to
                   6121: <code class="filename">/nonexistent</code> if not specified.
                   6122: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94      dmcmahil 6123: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87      wiz      6124: not specified.</p>
1.75      rillig   6125: <p>Similarly, groups can be created by adding entries to the
                   6126: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   6127: <pre class="programlisting">
                   6128:     group
1.1       grant    6129: </pre>
1.93      rillig   6130: <p>The numeric GID of the group may be set by defining
1.75      rillig   6131: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   6132: <p>If a package needs to create the users and groups at an earlier
                   6133: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
                   6134: either <code class="literal">configure</code> or <code class="literal">build</code> to
                   6135: indicate the phase before which the users and groups are created.  In
                   6136: this case, the numeric UIDs and GIDs of the created users and groups
                   6137: are automatically hardcoded into the final installation scripts.</p>
                   6138: </div>
                   6139: <div class="sect1" lang="en">
                   6140: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6141: <a name="shells"></a>14.5. System shells</h2></div></div></div>
1.75      rillig   6142: <p>Packages that install system shells should register them in the shell
1.76      rillig   6143: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75      rillig   6144: administrator.  This must be done from the installation scripts to keep
                   6145: binary packages working on any system.  pkginstall provides an easy way to
                   6146: accomplish this task.</p>
                   6147: <p>When a package provides a shell interpreter, it has to set the
                   6148: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   6149: add some hooks to the installation scripts to handle it.  Consider the
1.91      rillig   6150: 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   6151: <pre class="programlisting">
                   6152:     PKG_SHELL=      ${PREFIX}/bin/zsh
1.1       grant    6153: </pre>
1.75      rillig   6154: <div class="sect2" lang="en">
                   6155: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   6156: <a name="shells-disable"></a>14.5.1. Disabling shell registration</h3></div></div></div>
1.75      rillig   6157: <p>The automatic registration of shell interpreters can be disabled by
1.76      rillig   6158: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75      rillig   6159: environment variable to <code class="literal">NO</code>.</p>
                   6160: </div>
                   6161: </div>
                   6162: <div class="sect1" lang="en">
                   6163: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6164: <a name="fonts"></a>14.6. Fonts</h2></div></div></div>
1.75      rillig   6165: <p>Packages that install X11 fonts should update the database files
                   6166: that index the fonts within each fonts directory.  This can easily be
                   6167: accomplished within the pkginstall framework.</p>
                   6168: <p>When a package installs X11 fonts, it must list the directories in
                   6169: which fonts are installed in the
                   6170: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
                   6171: where <em class="replaceable"><code>type</code></em> can be one of &#8220;<span class="quote">ttf</span>&#8221;,
                   6172: &#8220;<span class="quote">type1</span>&#8221; or &#8220;<span class="quote">x11</span>&#8221;.  This will add hooks to the
                   6173: installation scripts to run the appropriate commands to update the fonts
                   6174: database files within each of those directories.  For convenience, if the
                   6175: directory path is relative, it is taken to be relative to the package's
1.91      rillig   6176: 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   6177: <pre class="programlisting">
                   6178:     FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
1.1       grant    6179: </pre>
1.75      rillig   6180: <div class="sect2" lang="en">
                   6181: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   6182: <a name="fonts-disable"></a>14.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75      rillig   6183: <p>The automatic update of fonts databases can be disabled by
1.76      rillig   6184: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75      rillig   6185: environment variable to <code class="literal">NO</code>.</p>
                   6186: </div>
                   6187: </div>
                   6188: </div>
                   6189: <div class="chapter" lang="en">
                   6190: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   6191: <a name="options"></a>Chapter 15. Options handling</h2></div></div></div>
1.75      rillig   6192: <div class="toc">
                   6193: <p><b>Table of Contents</b></p>
                   6194: <dl>
1.90      rillig   6195: <dt><span class="sect1"><a href="#global-default-options">15.1. Global default options</a></span></dt>
                   6196: <dt><span class="sect1"><a href="#converting-to-options">15.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
                   6197: <dt><span class="sect1"><a href="#option-names">15.3. Option Names</a></span></dt>
1.75      rillig   6198: </dl>
                   6199: </div>
                   6200: <p>Many packages have the ability to be built to support different
1.76      rillig   6201: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
1.75      rillig   6202: in pkgsrc that provides generic handling of those options that
                   6203: determine different ways in which the packages can be built.  It's
                   6204: possible for the user to specify exactly which sets of options will be
                   6205: built into a package or to allow a set of global default options
                   6206: apply.</p>
                   6207: <div class="sect1" lang="en">
                   6208: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6209: <a name="global-default-options"></a>15.1. Global default options</h2></div></div></div>
1.75      rillig   6210: <p>Global default options are listed in
                   6211: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   6212: that should be built into every package if that option is supported.
1.76      rillig   6213: This variable should be set in <code class="filename">/etc/mk.conf</code>.</p>
1.75      rillig   6214: </div>
                   6215: <div class="sect1" lang="en">
                   6216: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   6217: <a name="converting-to-options"></a>15.2. Converting packages to use <code class="filename">bsd.options.mk</code>
                   6218: </h2></div></div></div>
1.75      rillig   6219: <p>The following example shows how
1.76      rillig   6220: <code class="filename">bsd.options.mk</code> should be used
1.75      rillig   6221: by the hypothetical ``wibble'' package, either in the package
1.76      rillig   6222: <code class="filename">Makefile</code>, or in a file,
                   6223: e.g. <code class="filename">options.mk</code>, that is included by the
                   6224: main package <code class="filename">Makefile</code>.</p>
1.75      rillig   6225: <pre class="programlisting">
                   6226:     PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   6227:     PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   6228:     PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   6229:     PKG_OPTIONS_GROUP.database=     mysql pgsql
                   6230:     PKG_SUGGESTED_OPTIONS=          wibble-foo
                   6231:     PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   6232:     PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
1.1       grant    6233: 
1.75      rillig   6234:     .include "../../mk/bsd.prefs.mk"
1.69      rillig   6235: 
1.75      rillig   6236:     # this package was previously named wibble2
                   6237:     .if defined(PKG_OPTIONS.wibble2)
                   6238:     PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   6239:     PKG_OPTIONS_DEPRECATED_WARNINGS+= \
1.78      rillig   6240:             "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
1.75      rillig   6241:     .endif
1.69      rillig   6242: 
1.75      rillig   6243:     .include "../../mk/bsd.options.mk"
1.69      rillig   6244: 
1.75      rillig   6245:     # Package-specific option-handling
1.69      rillig   6246: 
1.75      rillig   6247:     ###
                   6248:     ### FOO support
                   6249:     ###
                   6250:     .if !empty(PKG_OPTIONS:Mwibble-foo)
                   6251:     CONFIGURE_ARGS+=    --enable-foo
                   6252:     .endif
1.69      rillig   6253: 
1.75      rillig   6254:     ###
                   6255:     ### LDAP support
                   6256:     ###
                   6257:     .if !empty(PKG_OPTIONS:Mldap)
1.77      rillig   6258:     .  include "../../databases/openldap-client/buildlink3.mk"
                   6259:     CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
1.75      rillig   6260:     .endif
1.69      rillig   6261: 
1.75      rillig   6262:     ###
                   6263:     ### database support
                   6264:     ###
                   6265:     .if !empty(PKG_OPTIONS:Mmysql)
                   6266:     .  include "../../mk/mysql.buildlink3.mk"
                   6267:     .endif
                   6268:     .if !empty(PKG_OPTIONS:Mpgsql)
                   6269:     .  include "../../mk/pgsql.buildlink3.mk"
                   6270:     .endif
                   6271: </pre>
                   6272: <p>The first section contains the information about which build
                   6273: options are supported by the package, and any default options settings
                   6274: if needed.</p>
                   6275: <div class="orderedlist"><ol type="1">
                   6276: <li><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
                   6277: <a 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
                   6278: options.  It should be set to
1.78      rillig   6279: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   6280: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   6281: at the point where the options are processed.</p></li>
1.75      rillig   6282: <li><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
                   6283: build options supported by the package.</p></li>
                   6284: <li><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
                   6285: list of names of groups of mutually exclusive options.  The options in
                   6286: each group are listed in
                   6287: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   6288: The most specific setting of any option from the group takes
                   6289: precedence over all other options in the group.  Options from the
                   6290: groups will be automatically added to
                   6291: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
                   6292: <li><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
                   6293: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   6294: packages will fail if no option from the group is
                   6295: selected.</p></li>
                   6296: <li><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
                   6297: of names of sets of options.  At least one option from each set must
                   6298: be selected.  The options in each set are listed in
                   6299: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   6300: Options from the sets will be automatically added to
                   6301: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   6302: fail if no option from the set is selected.</p></li>
                   6303: <li><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
                   6304: build options which are enabled by default.</p></li>
                   6305: <li><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
                   6306: of
                   6307: &#8220;<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>&#8221;
1.76      rillig   6308: pairs that map legacy <code class="filename">/etc/mk.conf</code> variables to
1.75      rillig   6309: their option counterparts.  Pairs should be added with
                   6310: &#8220;<span class="quote">+=</span>&#8221; to keep the listing of global legacy variables.  A
                   6311: warning will be issued if the user uses a legacy
                   6312: variable.</p></li>
                   6313: <li><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
                   6314: of
                   6315: &#8220;<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>&#8221;
                   6316: pairs that map options that have been renamed to their new
                   6317: counterparts.  Pairs should be added with &#8220;<span class="quote">+=</span>&#8221; to keep
                   6318: the listing of global legacy options.  A warning will be issued if
                   6319: the user uses a legacy option.</p></li>
                   6320: <li><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
                   6321: options implied by deprecated variables used.  This can be used for
                   6322: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   6323: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   6324: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
                   6325: <li><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
                   6326: a list of warnings about deprecated variables or options used, and
                   6327: what to use instead.</p></li>
                   6328: </ol></div>
                   6329: <p>A package should never modify
                   6330: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   6331: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   6332: To suggest a default set of options, use
                   6333: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   6334: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76      rillig   6335: including <code class="filename">bsd.options.mk</code>.  If none of
1.75      rillig   6336: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   6337: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   6338: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   6339: happen with platform-specific options if none of them is supported on
                   6340: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   6341: empty list and the package is otherwise treated as not using the
                   6342: options framework.</p>
1.76      rillig   6343: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75      rillig   6344: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   6345: build options, properly filtered to remove unsupported and duplicate
                   6346: options.</p>
                   6347: <p>The remaining sections contain the logic that is specific to
                   6348: each option.  The correct way to check for an option is to check
                   6349: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   6350: <pre class="programlisting">
                   6351:     .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
                   6352: </pre>
                   6353: </div>
                   6354: <div class="sect1" lang="en">
                   6355: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6356: <a name="option-names"></a>15.3. Option Names</h2></div></div></div>
1.75      rillig   6357: <p>Options that enable similar features in different packages (like
                   6358: optional support for a library) should use a common name in all
                   6359: packages that support it (like the name of the library).  If another
                   6360: package already has an option with the same meaning, use the same
                   6361: name.</p>
                   6362: <p>Options that enable features specific to one package, where it's
                   6363: unlikely that another (unrelated) package has the same (or a similar)
                   6364: optional feature, should use a name prefixed with
                   6365: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   6366: <p>If a group of related packages share an optional feature
                   6367: specific to that group, prefix it with the name of the
                   6368: &#8220;<span class="quote">main</span>&#8221; package
                   6369: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   6370: <p>For new options, add a line to
1.76      rillig   6371: <code class="filename">mk/defaults/options.description</code>.  Lines have two
1.75      rillig   6372: fields, separated by tab.  The first field is the option name, the
                   6373: second its description.  The description should be a whole sentence
                   6374: (starting with an uppercase letter and ending with a period) that
                   6375: describes what enabling the option does.  E. g. &#8220;<span class="quote">Enable ispell
                   6376: support.</span>&#8221; The file is sorted by option names.</p>
                   6377: </div>
                   6378: </div>
                   6379: <div class="chapter" lang="en">
                   6380: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   6381: <a name="build"></a>Chapter 16. The build process</h2></div></div></div>
1.75      rillig   6382: <div class="toc">
                   6383: <p><b>Table of Contents</b></p>
                   6384: <dl>
1.90      rillig   6385: <dt><span class="sect1"><a href="#build.intro">16.1. Introduction</a></span></dt>
                   6386: <dt><span class="sect1"><a href="#build.prefix">16.2. Program location</a></span></dt>
                   6387: <dt><span class="sect1"><a href="#build.builddirs">16.3. Directories used during the build process</a></span></dt>
                   6388: <dt><span class="sect1"><a href="#build.running">16.4. Running a phase</a></span></dt>
                   6389: <dt><span class="sect1"><a href="#build.fetch">16.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   6390: <dd><dl>
                   6391: <dt><span class="sect2"><a href="#build.fetch.what">16.5.1. What to fetch and where to get it from</a></span></dt>
                   6392: <dt><span class="sect2"><a href="#build.fetch.how">16.5.2. How are the files fetched?</a></span></dt>
                   6393: </dl></dd>
                   6394: <dt><span class="sect1"><a href="#build.checksum">16.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   6395: <dt><span class="sect1"><a href="#build.extract">16.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   6396: <dt><span class="sect1"><a href="#build.patch">16.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   6397: <dt><span class="sect1"><a href="#build.tools">16.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   6398: <dt><span class="sect1"><a href="#build.wrapper">16.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   6399: <dt><span class="sect1"><a href="#build.configure">16.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   6400: <dt><span class="sect1"><a href="#build.build">16.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   6401: <dt><span class="sect1"><a href="#build.test">16.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   6402: <dt><span class="sect1"><a href="#build.install">16.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   6403: <dt><span class="sect1"><a href="#build.package">16.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   6404: <dt><span class="sect1"><a href="#build.clean">16.16. Cleaning up</a></span></dt>
                   6405: <dt><span class="sect1"><a href="#build.helpful-targets">16.17. Other helpful targets</a></span></dt>
1.75      rillig   6406: </dl>
                   6407: </div>
                   6408: <div class="sect1" lang="en">
                   6409: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6410: <a name="build.intro"></a>16.1. Introduction</h2></div></div></div>
1.75      rillig   6411: <p>This chapter gives a detailed description on how a package is
1.87      wiz      6412:     built. Building a package is separated into different
                   6413:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   6414:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
                   6415:     described in the following sections. Each phase is splitted into
                   6416:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   6417:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   6418:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   6419:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   6420:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97    ! rillig   6421: <p>Never override the regular targets (like
        !          6422:     <code class="varname">fetch</code>), if you have to, override the
        !          6423:     <code class="varname">do-*</code> ones instead.</p>
1.75      rillig   6424: <p>The basic steps for building a program are always the same.  First
1.87      wiz      6425:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   6426:     the local system and then extracted. After any pkgsrc-specific patches
                   6427:     to compile properly are applied, the software can be configured, then
                   6428:     built (usually by compiling), and finally the generated binaries, etc.
                   6429:     can be put into place on the system.</p>
1.97    ! rillig   6430: <p>To get more details about what is happening at each step,
        !          6431:     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
        !          6432:     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
        !          6433:     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75      rillig   6434: </div>
                   6435: <div class="sect1" lang="en">
                   6436: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6437: <a name="build.prefix"></a>16.2. Program location</h2></div></div></div>
1.75      rillig   6438: <p>Before outlining the process performed by the NetBSD package system in
1.87      wiz      6439:     the next section, here's a brief discussion on where programs are
                   6440:     installed, and which variables influence this.</p>
1.75      rillig   6441: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87      wiz      6442:     where all files of the final program shall be installed. It is
                   6443:     usually set to <code class="varname">LOCALBASE</code>
                   6444:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88      wiz      6445:     for pkgs in the <code class="filename">cross</code> category.  The value of
1.87      wiz      6446:     <code class="varname">PREFIX</code> needs to be put
                   6447:     into the various places in the program's source where paths to
1.90      rillig   6448:     these files are encoded.  See <a href="#components.patches" title="10.3. patches/*">Section 10.3, &#8220;patches/*&#8221;</a> and <a href="#fixes.libtool" title="18.3.1. Shared libraries - libtool">Section 18.3.1, &#8220;Shared libraries - libtool&#8221;</a> for more details.</p>
1.75      rillig   6449: <p>When choosing which of these variables to use,
1.87      wiz      6450:     follow the following rules:</p>
1.75      rillig   6451: <div class="itemizedlist"><ul type="disc">
1.88      wiz      6452: <li><p><code class="varname">PREFIX</code> always points to the location
                   6453:        where the current pkg will be installed.  When referring to a
                   6454:        pkg's own installation path, use
                   6455:        &#8220;<span class="quote">${PREFIX}</span>&#8221;.</p></li>
                   6456: <li><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
                   6457:        are installed.  If you need to construct a -I or -L argument
                   6458:        to the compiler to find includes and libraries installed by
                   6459:        another non-X11 pkg, use &#8220;<span class="quote">${LOCALBASE}</span>&#8221;. The name
1.87      wiz      6460:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   6461:        installed all packages in <code class="filename">/usr/local</code>. As
                   6462:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   6463:        administrator, this variable is a misnomer.</p></li>
1.88      wiz      6464: <li><p><code class="varname">X11BASE</code> is where the actual X11
                   6465:        distribution (from xsrc, etc.) is installed. When looking for
                   6466:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
                   6467:        installed by a package), use &#8220;<span class="quote">${X11BASE}</span>&#8221;.</p></li>
                   6468: <li>
                   6469: <p>X11-based packages are special in that they may be
                   6470:        installed in either <code class="varname">X11BASE</code> or
                   6471:        <code class="varname">LOCALBASE</code>.</p>
1.75      rillig   6472: <p>Usually, X11 packages should be installed under
1.88      wiz      6473:        <code class="varname">LOCALBASE</code> whenever possible.  Note that you
                   6474:        will need to include
                   6475:        <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
                   6476:        request the presence of X11 and to get the right compilation
                   6477:        flags.</p>
1.75      rillig   6478: <p>Even though, there are some packages that cannot be installed
1.87      wiz      6479:        under <code class="varname">LOCALBASE</code>: those that come with app-defaults
                   6480:        files. These packages are special and they must be placed under
                   6481:        <code class="varname">X11BASE</code>. To accomplish this, set either
                   6482:        <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
                   6483:        your package.</p>
1.75      rillig   6484: <p>Some notes: If you need
1.87      wiz      6485:        to find includes or libraries installed by a pkg that has
                   6486:        <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
                   6487:        its pkg <code class="filename">Makefile</code>, you need to look in
                   6488:        <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
                   6489:        <code class="filename">${LOCALBASE}</code>. To force installation of
                   6490:        all X11 packages in <code class="varname">LOCALBASE</code>, the
1.91      rillig   6491:        <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      6492:        is enabled by default.</p>
1.75      rillig   6493: </li>
1.88      wiz      6494: <li><p><code class="varname">X11PREFIX</code> should be used to refer to
                   6495:        the installed location of an X11
                   6496:        package. <code class="varname">X11PREFIX</code> will be set to
                   6497:        <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
                   6498:        to <code class="varname">LOCALBASE</code> if xpkgwedge is
                   6499:        installed.</p></li>
                   6500: <li>
                   6501: <p>If xpkgwedge is installed, it is possible to have some
                   6502:        packages installed in <code class="varname">X11BASE</code> and some in
                   6503:        <code class="varname">LOCALBASE</code>.  To determine the prefix of an
                   6504:        installed package, the <code class="varname">EVAL_PREFIX</code>
                   6505:        definition can be used. It takes pairs in the format
                   6506:        &#8220;<span class="quote">DIRNAME=&lt;package&gt;</span>&#8221;, and the <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
                   6507:        variable <code class="varname">DIRNAME</code> will be set to the prefix
                   6508:        of the installed package &lt;package&gt;, or
                   6509:        &#8220;<span class="quote">${X11PREFIX}</span>&#8221; if the package is not
                   6510:        installed.</p>
1.75      rillig   6511: <p>This is best illustrated by example.</p>
                   6512: <p>The following lines are taken from
1.87      wiz      6513:        <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75      rillig   6514: <pre class="programlisting">
1.87      wiz      6515:          EVAL_PREFIX+=           GTKDIR=gtk+
                   6516:          CONFIGURE_ARGS+=        --with-guile-prefix=${LOCALBASE:Q}
                   6517:          CONFIGURE_ARGS+=        --with-gtk-prefix=${GTKDIR:Q}
                   6518:          CONFIGURE_ARGS+=        --enable-multibyte
                   6519:        </pre>
1.88      wiz      6520: <p>Specific defaults can be defined for the packages
                   6521:        evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
                   6522:        definition of the form:</p>
1.75      rillig   6523: <pre class="programlisting">
1.87      wiz      6524:          GTKDIR_DEFAULT= ${LOCALBASE}
                   6525:        </pre>
1.75      rillig   6526: <p>where <code class="varname">GTKDIR</code> corresponds
1.87      wiz      6527:        to the first definition in
                   6528:        the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75      rillig   6529: </li>
1.76      rillig   6530: <li><p>Within <code class="filename">${PREFIX}</code>, packages should
1.87      wiz      6531:        install files according to <a 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
                   6532:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   6533:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75      rillig   6534: </ul></div>
                   6535: </div>
                   6536: <div class="sect1" lang="en">
                   6537: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6538: <a name="build.builddirs"></a>16.3. Directories used during the build process</h2></div></div></div>
1.75      rillig   6539: <p>When building a package, a number of directories is used to store
1.87      wiz      6540:     source files, temporary files, pkgsrc-internal files, and so on. These
                   6541:     directories are explained here.</p>
1.75      rillig   6542: <p>Some of the directory variables contain relative pathnames. There
1.87      wiz      6543:     are two common base directories for these relative directories:
                   6544:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   6545:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   6546:     inside the package itself.</p>
1.75      rillig   6547: <div class="variablelist"><dl>
                   6548: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   6549: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87      wiz      6550:       root directory. Generally, you don't need
                   6551:       it.</p></dd>
1.97    ! rillig   6552: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
        !          6553: <dd><p>This is an absolute pathname that points to the
        !          6554:       current package.</p></dd>
1.75      rillig   6555: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
                   6556: <dd><p>This is a pathname relative to
1.87      wiz      6557:       <code class="varname">PKGSRCDIR</code> that points to the current
                   6558:       package.</p></dd>
1.75      rillig   6559: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   6560: <dd><p>This is an absolute pathname pointing to the directory
1.93      rillig   6561:       where all work takes place. The distfiles are extracted to this
1.87      wiz      6562:       directory. It also contains temporary directories and log files used by
                   6563:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   6564:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75      rillig   6565: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   6566: <dd><p>This is an absolute pathname pointing to the directory
1.87      wiz      6567:       where the distfiles are extracted. It is usually a direct subdirectory
                   6568:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   6569:       that isn't hidden. This variable may be changed by a package
                   6570:       <code class="filename">Makefile</code>.</p></dd>
1.75      rillig   6571: </dl></div>
                   6572: </div>
                   6573: <div class="sect1" lang="en">
                   6574: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6575: <a name="build.running"></a>16.4. Running a phase</h2></div></div></div>
1.75      rillig   6576: <p>You can run a particular phase by typing <span><strong class="command">make
1.87      wiz      6577:     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
                   6578:     phase. This will automatically run all phases that are required for this
                   6579:     phase. The default phase is <code class="varname">build</code>, that is, when you
                   6580:     run <span><strong class="command">make</strong></span> without parameters in a package directory,
                   6581:     the package will be built, but not installed.</p>
1.75      rillig   6582: </div>
                   6583: <div class="sect1" lang="en">
                   6584: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6585: <a name="build.fetch"></a>16.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81      rillig   6586: <p>The first step in building a package is to fetch the
1.88      wiz      6587:     distribution files (distfiles) from the sites that are providing
                   6588:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   6589:     phase.</p>
1.81      rillig   6590: <div class="sect2" lang="en">
                   6591: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   6592: <a name="build.fetch.what"></a>16.5.1. What to fetch and where to get it from</h3></div></div></div>
1.88      wiz      6593: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   6594:       defines all URLs from where the distfile, whose name is
                   6595:       derived from the <code class="varname">DISTNAME</code> variable, is
                   6596:       fetched. The more complicated cases are described
                   6597:       below.</p>
                   6598: <p>The variable <code class="varname">DISTFILES</code> specifies
                   6599:       the list of distfiles that have to be fetched. Its value
                   6600:       defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
                   6601:       so that most packages don't need to define it at all.
                   6602:       <code class="varname">EXTRACT_SUFX</code> is
                   6603:       <code class="literal">.tar.gz</code> by default, but can be changed
                   6604:       freely. Note that if your package requires additional
                   6605:       distfiles to the default one, you cannot just append the
                   6606:       additional filenames using the <code class="literal">+=</code>
                   6607:       operator, but you have write for example:</p>
1.81      rillig   6608: <pre class="programlisting">
1.88      wiz      6609:        DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
                   6610:       </pre>
                   6611: <p>Each distfile is fetched from a list of sites, usually
                   6612:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   6613:       <code class="varname">DISTFILES</code> or multiple
                   6614:       <code class="varname">PATCHFILES</code> from different sites, you can
                   6615:       set
                   6616:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   6617:       to the list of URLs where the file
                   6618:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   6619:       (including the suffix) can be found.</p>
                   6620: <pre class="programlisting">
                   6621:        DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   6622:        DISTFILES+=     foo-file.tar.gz
                   6623:        SITES.foo-file.tar.gz= \
                   6624:        http://www.somewhere.com/somehow/ \
                   6625:        http://www.somewhereelse.com/mirror/somehow/
                   6626:       </pre>
1.81      rillig   6627: <p>When actually fetching the distfiles, each item from
1.88      wiz      6628:       <code class="varname">MASTER_SITES</code> or
                   6629:       <code class="varname">SITES.*</code> gets the name of each distfile
                   6630:       appended to it, without an intermediate slash. Therefore,
                   6631:       all site values have to end with a slash or other separator
                   6632:       character. This allows for example to set
                   6633:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   6634:       that gets the name of the distfile as a parameter. In this
                   6635:       case, the definition would look like:</p>
1.81      rillig   6636: <pre class="programlisting">
1.88      wiz      6637:        MASTER_SITES=   http://www.example.com/download.cgi?file=
                   6638:       </pre>
1.81      rillig   6639: <p>There are some predefined values for
1.88      wiz      6640:       <code class="varname">MASTER_SITES</code>, which can be used in
                   6641:       packages.  The names of the variables should speak for
                   6642:       themselves.</p>
                   6643: <pre class="programlisting">
                   6644:        ${MASTER_SITE_APACHE}
                   6645:        ${MASTER_SITE_BACKUP}
                   6646:        ${MASTER_SITE_CYGWIN}
                   6647:        ${MASTER_SITE_DEBIAN}
                   6648:        ${MASTER_SITE_FREEBSD}
                   6649:        ${MASTER_SITE_FREEBSD_LOCAL}
1.93      rillig   6650:        ${MASTER_SITE_GENTOO}
1.88      wiz      6651:        ${MASTER_SITE_GNOME}
                   6652:        ${MASTER_SITE_GNU}
                   6653:        ${MASTER_SITE_GNUSTEP}
                   6654:        ${MASTER_SITE_IFARCHIVE}
                   6655:        ${MASTER_SITE_KDE}
                   6656:        ${MASTER_SITE_MOZILLA}
                   6657:        ${MASTER_SITE_MYSQL}
                   6658:        ${MASTER_SITE_OPENOFFICE}
                   6659:        ${MASTER_SITE_PERL_CPAN}
                   6660:        ${MASTER_SITE_PGSQL}
                   6661:        ${MASTER_SITE_R_CRAN}
                   6662:        ${MASTER_SITE_SOURCEFORGE}
                   6663:        ${MASTER_SITE_SOURCEFORGE_JP}
                   6664:        ${MASTER_SITE_SUNSITE}
                   6665:        ${MASTER_SITE_SUSE}
                   6666:        ${MASTER_SITE_TEX_CTAN}
                   6667:        ${MASTER_SITE_XCONTRIB}
                   6668:        ${MASTER_SITE_XEMACS}
                   6669:       </pre>
                   6670: <p>Some explanations for the less self-explaining ones:
                   6671:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.93      rillig   6672:       for packages that are maintained in <a 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
                   6673:       package source distributions that are maintained in <a 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      6674: <p>If you choose one of these predefined sites, you may
                   6675:       want to specify a subdirectory of that site. Since these
                   6676:       macros may expand to more than one actual site, you
                   6677:       <span class="emphasis"><em>must</em></span> use the following construct to
                   6678:       specify a subdirectory:</p>
1.81      rillig   6679: <pre class="programlisting">
1.88      wiz      6680:        MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   6681:        MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
                   6682:       </pre>
1.81      rillig   6683: <p>Note the trailing slash after the subdirectory
1.88      wiz      6684:       name.</p>
1.81      rillig   6685: </div>
                   6686: <div class="sect2" lang="en">
                   6687: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   6688: <a name="build.fetch.how"></a>16.5.2. How are the files fetched?</h3></div></div></div>
1.88      wiz      6689: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   6690:       all the distfiles exist in a local directory
1.93      rillig   6691:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88      wiz      6692:       user). If the files do not exist, they are fetched using
                   6693:       commands of the form</p>
1.75      rillig   6694: <pre class="programlisting">
1.88      wiz      6695:        ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   6696:       </pre>
                   6697: <p>where <code class="literal">${site}</code> varies through
                   6698:       several possibilities in turn: first,
                   6699:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   6700:       sites specified in either <code class="varname">SITES.file</code> if
                   6701:       defined, else <code class="varname">MASTER_SITES</code> or
                   6702:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   6703:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91      rillig   6704:       all except the first and the last can be optionally sorted
                   6705:       by the user, via setting either
                   6706:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   6707:       <code class="varname">MASTER_SORT_AWK</code> or
1.88      wiz      6708:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.97    ! rillig   6709: <p>The distfiles mirror run by the NetBSD Foundation uses the
        !          6710:       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
        !          6711:       distfiles, if they are freely distributable.  Packages setting
        !          6712:       <code class="varname">NO_SRC_ON_FTP</code> (usually to
        !          6713:       &#8220;<span class="quote">${RESTRICTED}</span>&#8221;) will not have their distfiles
        !          6714:       mirrored.</p>
1.81      rillig   6715: </div>
1.75      rillig   6716: </div>
                   6717: <div class="sect1" lang="en">
                   6718: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6719: <a name="build.checksum"></a>16.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88      wiz      6720: <p>After the distfile(s) are fetched, their checksum is
                   6721:     generated and compared with the checksums stored in the
                   6722:     distinfo file. If the checksums don't match, the build is
                   6723:     aborted. This is to ensure the same distfile is used for
                   6724:     building, and that the distfile wasn't changed, e.g. by some
                   6725:     malign force, deliberately changed distfiles on the master
                   6726:     distribution site or network lossage.</p>
1.75      rillig   6727: </div>
                   6728: <div class="sect1" lang="en">
                   6729: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6730: <a name="build.extract"></a>16.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75      rillig   6731: <p>When the distfiles are present on the local system, they
1.88      wiz      6732:     need to be extracted, as they usually come in the form of some
                   6733:     compressed archive format.</p>
1.75      rillig   6734: <p>By default, all <code class="varname">DISTFILES</code> are
1.88      wiz      6735:     extracted. If you only need some of them, you can set the
                   6736:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   6737:     files.</p>
                   6738: <p>Extracting the files is usually done by a little
1.93      rillig   6739:     program, <code class="filename">mk/extract/extract</code>, which
1.88      wiz      6740:     already knows how to extract various archive formats, so most
                   6741:     likely you will not need to change anything here. But if you
                   6742:     need, the following variables may help you:</p>
1.75      rillig   6743: <div class="variablelist"><dl>
                   6744: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   6745: <dd><p>Use these variables to override the default
1.88      wiz      6746:       options for an extract command, which are defined in
1.93      rillig   6747:       <code class="filename">mk/extract/extract</code>.</p></dd>
1.75      rillig   6748: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   6749: <dd><p>This variable can be set to
1.93      rillig   6750:       <code class="literal">gtar</code>, <code class="literal">nbtar</code> (which is the
                   6751:       default value), <code class="literal">pax</code>, or an
1.88      wiz      6752:       absolute pathname pointing to the command with which tar
                   6753:       archives should be
                   6754:       extracted.</p></dd>
1.75      rillig   6755: </dl></div>
1.88      wiz      6756: <p>If the <code class="filename">extract</code> program doesn't
                   6757:     serve your needs, you can also override the
                   6758:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   6759:     command used for extracting the files. This command is
                   6760:     executed in the <code class="filename">${WRKSRC}</code>
                   6761:     directory. During execution of this command, the shell
                   6762:     variable <code class="varname">extract_file</code> holds the absolute
                   6763:     pathname of the file that is going to be extracted.</p>
1.75      rillig   6764: <p>And if that still does not suffice, you can override the
1.88      wiz      6765:     <code class="varname">do-extract</code> target in the package
                   6766:     Makefile.</p>
1.75      rillig   6767: </div>
                   6768: <div class="sect1" lang="en">
                   6769: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6770: <a name="build.patch"></a>16.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75      rillig   6771: <p>After extraction, all the patches named by the
1.88      wiz      6772:     <code class="varname">PATCHFILES</code>, those present in the patches
                   6773:     subdirectory of the package as well as in
                   6774:     $LOCALPATCHES/$PKGPATH (e.g.
                   6775:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   6776:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   6777:     <code class="filename">.gz</code> are uncompressed before they are
                   6778:     applied, files ending in <code class="filename">.orig</code> or
                   6779:     <code class="filename">.rej</code> are ignored. Any special options to
                   6780:     <a 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
1.90      rillig   6781:     <code class="varname">PATCH_DIST_ARGS</code>.  See <a href="#components.patches" title="10.3. patches/*">Section 10.3, &#8220;patches/*&#8221;</a> for more details.</p>
1.88      wiz      6782: <p>By default <a 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
                   6783:     it fail if the patches apply with some lines of fuzz. Please
                   6784:     fix (regen) the patches so that they apply cleanly. The
                   6785:     rationale behind this is that patches that don't apply cleanly
                   6786:     may end up being applied in the wrong place, and cause severe
                   6787:     harm there.</p>
1.75      rillig   6788: </div>
                   6789: <div class="sect1" lang="en">
                   6790: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6791: <a name="build.tools"></a>16.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
                   6792: <p>This is covered in <a href="#tools" title="Chapter 17. Tools needed for building or running">Chapter 17, <i>Tools needed for building or running</i></a>.
1.88      wiz      6793:     </p>
1.75      rillig   6794: </div>
                   6795: <div class="sect1" lang="en">
                   6796: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6797: <a name="build.wrapper"></a>16.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75      rillig   6798: <p>This phase creates wrapper programs for the compilers and
1.88      wiz      6799:     linkers. The following variables can be used to tweak the
                   6800:     wrappers.</p>
1.75      rillig   6801: <div class="variablelist"><dl>
                   6802: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   6803: <dd><p>The command used to print progress
1.88      wiz      6804:       messages. Does nothing by default. Set to
                   6805:       <code class="literal">${ECHO}</code> to see the progress
                   6806:       messages.</p></dd>
1.75      rillig   6807: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   6808: <dd><p>This variable can be set to
1.88      wiz      6809:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   6810:       depending on whether you want additional information in the
                   6811:       wrapper log file.</p></dd>
1.75      rillig   6812: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   6813: <dd><p>This variable can be set to
1.88      wiz      6814:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   6815:       on whether the wrapper should use its cache, which will
                   6816:       improve the speed. The default value is
                   6817:       <code class="literal">yes</code>, but is forced to
                   6818:       <code class="literal">no</code> if the platform does not support
                   6819:       it.</p></dd>
1.75      rillig   6820: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88      wiz      6821: <dd><p>A list of reordering commands. A reordering
                   6822:       command has the form
                   6823:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   6824:       It ensures that that
                   6825:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   6826:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   6827:       </p></dd>
1.75      rillig   6828: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
                   6829: <dd><p>A list of transformation commands. [TODO:
1.88      wiz      6830:       investigate further]</p></dd>
1.75      rillig   6831: </dl></div>
                   6832: </div>
                   6833: <div class="sect1" lang="en">
                   6834: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6835: <a name="build.configure"></a>16.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88      wiz      6836: <p>Most pieces of software need information on the header
                   6837:     files, system calls, and library routines which are available
                   6838:     on the platform they run on. The process of determining this
                   6839:     information is known as configuration, and is usually
                   6840:     automated. In most cases, a script is supplied with the
                   6841:     distfiles, and its invocation results in generation of header
                   6842:     files, Makefiles, etc.</p>
                   6843: <p>If the package contains a configure script, this can be
                   6844:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
                   6845:     &#8220;<span class="quote">yes</span>&#8221;. If the configure script is a GNU autoconf
                   6846:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
                   6847:     &#8220;<span class="quote">yes</span>&#8221; instead. What happens in the
                   6848:     <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
                   6849: <pre class="programlisting">
                   6850:       .for d in ${CONFIGURE_DIRS}
                   6851:       cd ${WRKSRC} &amp;&amp; cd ${d} &amp;&amp; env ${CONFIGURE_ENV} \
                   6852:       ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
                   6853:       .endfor
                   6854:     </pre>
                   6855: <p><code class="varname">CONFIGURE_DIRS</code> (default:
                   6856:     &#8220;<span class="quote">.</span>&#8221;) is a list of pathnames relative to
                   6857:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   6858:     configure script is run with the environment
                   6859:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   6860:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   6861:     <code class="varname">CONFIGURE_ENV</code>,
                   6862:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
                   6863:     &#8220;<span class="quote">./configure</span>&#8221;) and
                   6864:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   6865:     package.</p>
                   6866: <p>If the program uses an <code class="filename">Imakefile</code>
                   6867:     for configuration, the appropriate steps can be invoked by
                   6868:     setting <code class="varname">USE_IMAKE</code> to
                   6869:     &#8220;<span class="quote">yes</span>&#8221;. (If you only want the package installed in
                   6870:     <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
1.97    ! rillig   6871:     <code class="varname">USE_X11BASE</code> instead.)  You can add variables to
        !          6872:     xmkmf's environment by adding them to the
        !          6873:     <code class="varname">SCRIPTS_ENV</code> variable.</p>
        !          6874: <p>If there is no configure step at all, set
        !          6875:     <code class="varname">NO_CONFIGURE</code> to &#8220;<span class="quote">yes</span>&#8221;.</p>
1.75      rillig   6876: </div>
                   6877: <div class="sect1" lang="en">
                   6878: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6879: <a name="build.build"></a>16.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88      wiz      6880: <p>For building a package, a rough equivalent of the
                   6881:     following code is executed.</p>
1.75      rillig   6882: <pre class="programlisting">
1.88      wiz      6883:       .for d in ${BUILD_DIRS}
                   6884:       cd ${WRKSRC} &amp;&amp; cd ${d} &amp;&amp; env ${MAKE_ENV} \
                   6885:       ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
                   6886:       -f ${MAKE_FILE} ${BUILD_TARGET}
                   6887:       .endfor
                   6888:     </pre>
                   6889: <p><code class="varname">BUILD_DIRS</code> (default:
                   6890:     &#8220;<span class="quote">.</span>&#8221;) is a list of pathnames relative to
                   6891:     <code class="varname">WRKSRC</code>. In each of these directories,
                   6892:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   6893:     <code class="varname">MAKE_ENV</code> and arguments
                   6894:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   6895:     <code class="varname">MAKE_ENV</code>,
                   6896:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   6897:     <code class="varname">MAKE_FILE</code> and
                   6898:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   6899:     package.</p>
1.75      rillig   6900: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.88      wiz      6901:     &#8220;<span class="quote">gmake</span>&#8221; if <code class="varname">USE_TOOLS</code> contains
                   6902:     &#8220;<span class="quote">gmake</span>&#8221;, &#8220;<span class="quote">make</span>&#8221; otherwise. The
                   6903:     default value of <code class="varname">MAKE_FILE</code> is
                   6904:     &#8220;<span class="quote">Makefile</span>&#8221;, and <code class="varname">BUILD_TARGET</code>
                   6905:     defaults to &#8220;<span class="quote">all</span>&#8221;.</p>
1.97    ! rillig   6906: <p>If there is no build step at all, set
        !          6907:     <code class="varname">NO_BUILD</code> to &#8220;<span class="quote">yes</span>&#8221;.</p>
1.75      rillig   6908: </div>
                   6909: <div class="sect1" lang="en">
                   6910: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6911: <a name="build.test"></a>16.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75      rillig   6912: <p>[TODO]</p>
                   6913: </div>
                   6914: <div class="sect1" lang="en">
                   6915: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6916: <a name="build.install"></a>16.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75      rillig   6917: <p>Once the build stage has completed, the final step is to
1.88      wiz      6918:     install the software in public directories, so users can
                   6919:     access the programs and files.</p>
1.75      rillig   6920: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88      wiz      6921:     equivalent of the following code is executed. Additionally,
                   6922:     before and after this code, much magic is performed to do
                   6923:     consistency checks, registering the package, and so on.</p>
                   6924: <pre class="programlisting">
                   6925:       .for d in ${INSTALL_DIRS}
                   6926:       cd ${WRKSRC} &amp;&amp; cd ${d} &amp;&amp; env ${MAKE_ENV} \
                   6927:       ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
                   6928:       -f ${MAKE_FILE} ${BUILD_TARGET}
                   6929:       .endfor
                   6930:     </pre>
1.75      rillig   6931: <p>The variable's meanings are analogous to the ones in the
1.88      wiz      6932:     <span class="emphasis"><em>build</em></span> phase.
                   6933:     <code class="varname">INSTALL_DIRS</code> defaults to
                   6934:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
                   6935:     is &#8220;<span class="quote">install</span>&#8221; by default, plus
                   6936:     &#8220;<span class="quote">install.man</span>&#8221; if <code class="varname">USE_IMAKE</code> is
                   6937:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   6938:     defined.</p>
1.75      rillig   6939: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88      wiz      6940:     variables are useful. They are all variations of the
                   6941:     <a 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
                   6942:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   6943:     install command. The specialized variants, together with their
                   6944:     intended use, are:</p>
1.75      rillig   6945: <div class="variablelist"><dl>
                   6946: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88      wiz      6947: <dd><p>directories that contain
                   6948:       binaries</p></dd>
1.75      rillig   6949: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88      wiz      6950: <dd><p>directories that contain
                   6951:       scripts</p></dd>
1.75      rillig   6952: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88      wiz      6953: <dd><p>directories that contain shared and static
                   6954:       libraries</p></dd>
1.75      rillig   6955: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88      wiz      6956: <dd><p>directories that contain data
                   6957:       files</p></dd>
1.75      rillig   6958: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88      wiz      6959: <dd><p>directories that contain man
                   6960:       pages</p></dd>
1.75      rillig   6961: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88      wiz      6962: <dd><p>binaries that can be stripped from debugging
                   6963:       symbols</p></dd>
1.75      rillig   6964: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88      wiz      6965: <dd><p>binaries that cannot be
                   6966:       stripped</p></dd>
1.75      rillig   6967: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88      wiz      6968: <dd><p>game
                   6969:       binaries</p></dd>
1.75      rillig   6970: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88      wiz      6971: <dd><p>shared and static
                   6972:       libraries</p></dd>
1.75      rillig   6973: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   6974: <dd><p>data files</p></dd>
                   6975: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88      wiz      6976: <dd><p>data files for
                   6977:       games</p></dd>
1.75      rillig   6978: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   6979: <dd><p>man pages</p></dd>
                   6980: </dl></div>
                   6981: <p>Some other variables are:</p>
                   6982: <div class="variablelist"><dl>
                   6983: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   6984: <dd><p>A list of directories relative to
1.88      wiz      6985:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
                   6986:       beginning of the <span class="emphasis"><em>install</em></span> phase.  If
                   6987:       this variable is set,
                   6988:       <code class="varname">NO_MTREE</code>=&#8220;<span class="quote">yes</span>&#8221; is assumed,
                   6989:       which means that the package claims to create all needed
                   6990:       directories itself before installing files to it. Therefore
                   6991:       this variable should only be set in
                   6992:       <code class="filename">Makefile</code>s that are under control of the
                   6993:       package's author. The directories are created with the
                   6994:       correct ownership, depending on their
                   6995:       name.</p></dd>
1.75      rillig   6996: </dl></div>
1.97    ! rillig   6997: <p>In the rare cases that a package shouldn't install anything,
        !          6998:     set <code class="varname">NO_INSTALL</code> to &#8220;<span class="quote">yes</span>&#8221;. This is
        !          6999:     mostly relevant for packages in the <code class="filename">regress</code>
        !          7000:     category.</p>
1.75      rillig   7001: </div>
                   7002: <div class="sect1" lang="en">
                   7003: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   7004: <a name="build.package"></a>16.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88      wiz      7005: <p>Once the install stage has completed, a binary package of
                   7006:     the installed files can be built.  These binary packages can be
                   7007:     used for quick installation without previous compilation, e.g. by
                   7008:     the <span><strong class="command">make bin-install</strong></span> or by using
                   7009:     <span><strong class="command">pkg_add</strong></span>.</p>
                   7010: <p>By default, the binary packages are created in
                   7011:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   7012:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   7013:     one for each category in the <code class="varname">CATEGORIES</code>
                   7014:     variable.  <code class="varname">PACKAGES</code> defaults to
                   7015:     <code class="filename">pkgsrc/packages</code>.</p>
1.97    ! rillig   7016: <p>If there should be no binary package, set
        !          7017:     <code class="varname">NO_PACKAGE</code> to &#8220;<span class="quote">yes</span>&#8221;.
        !          7018:     This should only be used in rare cases, like when a package
        !          7019:     definitely is only usable on the machine where it is built and even
        !          7020:     then, a binary package can be useful.</p>
1.88      wiz      7021: </div>
                   7022: <div class="sect1" lang="en">
                   7023: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   7024: <a name="build.clean"></a>16.16. Cleaning up</h2></div></div></div>
1.88      wiz      7025: <p>Once you're finished with a package, you can clean the work
                   7026:     directory by running <span><strong class="command">make clean</strong></span>.  If you want
                   7027:     to clean the work directories of all dependencies too, use
                   7028:     <span><strong class="command">make clean-depends</strong></span>.</p>
1.75      rillig   7029: </div>
                   7030: <div class="sect1" lang="en">
                   7031: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   7032: <a name="build.helpful-targets"></a>16.17. Other helpful targets</h2></div></div></div>
1.75      rillig   7033: <div class="variablelist"><dl>
                   7034: <dt><span class="term">pre/post-*</span></dt>
1.88      wiz      7035: <dd><p>For any of the main targets described in the
                   7036:          previous section, two auxiliary targets exist with
1.87      wiz      7037:          &#8220;<span class="quote">pre-</span>&#8221; and &#8220;<span class="quote">post-</span>&#8221; used as a
                   7038:          prefix for the main target's name.  These targets are
1.88      wiz      7039:          invoked before and after the main target is called,
                   7040:          allowing extra configuration or installation steps be
                   7041:          performed from a package's Makefile, for example, which
                   7042:          a program's configure script or install target
                   7043:          omitted.</p></dd>
1.75      rillig   7044: <dt><span class="term">do-*</span></dt>
1.88      wiz      7045: <dd><p>Should one of the main targets do the wrong thing,
                   7046:          and should there be no variable to fix this, you can
                   7047:          redefine it with the do-* target.  (Note that redefining
                   7048:          the target itself instead of the do-* target is a bad
                   7049:          idea, as the pre-* and post-* targets won't be called
                   7050:          anymore, etc.) You will not usually need to do
                   7051:          this.</p></dd>
1.75      rillig   7052: <dt><span class="term">reinstall</span></dt>
1.88      wiz      7053: <dd>
                   7054: <p>If you did a <span><strong class="command">make install</strong></span> and
                   7055:          you noticed some file was not installed properly, you
                   7056:          can repeat the installation with this target, which will
                   7057:          ignore the &#8220;<span class="quote">already installed</span>&#8221; flag.</p>
                   7058: <p>This is the default value of
                   7059:          <code class="varname">DEPENDS_TARGET</code> except in the case of
                   7060:          <span><strong class="command">make update</strong></span> and <span><strong class="command">make
                   7061:          package</strong></span>, where the defaults are
                   7062:          &#8220;<span class="quote">package</span>&#8221; and &#8220;<span class="quote">update</span>&#8221;,
                   7063:          respectively.</p>
                   7064: </dd>
1.75      rillig   7065: <dt><span class="term">deinstall</span></dt>
                   7066: <dd>
1.88      wiz      7067: <p>This target does a <a 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
                   7068:          current directory, effectively de-installing the
                   7069:          package. The following variables can be used to tune the
                   7070:          behaviour:</p>
1.75      rillig   7071: <div class="variablelist"><dl>
                   7072: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
                   7073: <dd><p>Add a "-v" to the <a 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>
                   7074: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88      wiz      7075: <dd><p>Remove all packages that require (depend on)
                   7076:                the given package.  This can be used to remove any
                   7077:                packages that may have been pulled in by a given
                   7078:                package, e.g. if <span><strong class="command">make deinstall
1.87      wiz      7079:                DEINSTALLDEPENDS=1</strong></span> is done in
1.88      wiz      7080:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   7081:                likely to remove whole KDE. Works by adding
                   7082:                &#8220;<span class="quote">-R</span>&#8221; to the <a 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>
                   7083:                command line.</p></dd>
1.75      rillig   7084: </dl></div>
                   7085: </dd>
1.88      wiz      7086: <dt><span class="term">bin-install</span></dt>
                   7087: <dd><p>Install a binary package from local disk and via FTP
                   7088:          from a list of sites (see the
                   7089:          <code class="varname">BINPKG_SITES</code> variable), and do a
                   7090:          <span><strong class="command">make package</strong></span> if no binary package is
                   7091:          available anywhere.  The arguments given to
                   7092:          <span><strong class="command">pkg_add</strong></span> can be set via
                   7093:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   7094:          operation, etc.</p></dd>
1.75      rillig   7095: <dt><span class="term">update</span></dt>
                   7096: <dd>
1.88      wiz      7097: <p>This target causes the current package to be
                   7098:          updated to the latest version.  The package and all
                   7099:          depending packages first get de-installed, then current
                   7100:          versions of the corresponding packages get compiled and
                   7101:          installed.  This is similar to manually noting which
                   7102:          packages are currently installed, then performing a
                   7103:          series of <span><strong class="command">make deinstall</strong></span> and
                   7104:          <span><strong class="command">make install</strong></span> (or whatever
                   7105:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   7106:          packages.</p>
                   7107: <p>You can use the &#8220;<span class="quote">update</span>&#8221; target to
                   7108:          resume package updating in case a previous <span><strong class="command">make
                   7109:          update</strong></span> was interrupted for some reason.
                   7110:          However, in this case, make sure you don't call
                   7111:          <span><strong class="command">make clean</strong></span> or otherwise remove the
                   7112:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   7113:          Otherwise, you lose the ability to automatically update
                   7114:          the current package along with the dependent packages
                   7115:          you have installed.</p>
                   7116: <p>Resuming an interrupted <span><strong class="command">make
                   7117:          update</strong></span> will only work as long as the package
                   7118:          tree remains unchanged.  If the source code for one of
                   7119:          the packages to be updated has been changed, resuming
                   7120:          <span><strong class="command">make update</strong></span> will most certainly
                   7121:          fail!</p>
                   7122: <p>The following variables can be used either on the
                   7123:          command line or in <code class="filename">/etc/mk.conf</code> to
                   7124:          alter the behaviour of <span><strong class="command">make
                   7125:          update</strong></span>:</p>
1.75      rillig   7126: <div class="variablelist"><dl>
                   7127: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88      wiz      7128: <dd><p>Install target to recursively use for the
                   7129:                updated package and the dependent packages.
                   7130:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
                   7131:                set, &#8220;<span class="quote">install</span>&#8221; otherwise for
                   7132:                <span><strong class="command">make update</strong></span>.  Other good
                   7133:                targets are &#8220;<span class="quote">package</span>&#8221; or
                   7134:                &#8220;<span class="quote">bin-install</span>&#8221;.  Do not set this to
                   7135:                &#8220;<span class="quote">update</span>&#8221; or you will get stuck in an
                   7136:                endless loop!</p></dd>
1.75      rillig   7137: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88      wiz      7138: <dd><p>Don't clean up after updating.  Useful if
                   7139:                you want to leave the work sources of the updated
                   7140:                packages around for inspection or other purposes.
                   7141:                Be sure you eventually clean up the source tree
                   7142:                (see the &#8220;<span class="quote">clean-update</span>&#8221; target below)
                   7143:                or you may run into troubles with old source code
                   7144:                still lying around on your next
                   7145:                <span><strong class="command">make</strong></span> or <span><strong class="command">make
                   7146:                update</strong></span>.</p></dd>
1.75      rillig   7147: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88      wiz      7148: <dd><p>Deinstall each package before installing
                   7149:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   7150:                may be necessary if the
                   7151:                &#8220;<span class="quote">clean-update</span>&#8221; target (see below) was
                   7152:                called after interrupting a running <span><strong class="command">make
                   7153:                update</strong></span>.</p></dd>
1.75      rillig   7154: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88      wiz      7155: <dd><p>Allows you to disable recursion and hardcode
                   7156:                the target for packages.  The default is
                   7157:                &#8220;<span class="quote">update</span>&#8221; for the update target,
                   7158:                facilitating a recursive update of prerequisite
                   7159:                packages.  Only set
                   7160:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   7161:                disable recursive updates. Use
                   7162:                <code class="varname">UPDATE_TARGET</code> instead to just
                   7163:                set a specific target for each package to be
                   7164:                installed during <span><strong class="command">make update</strong></span>
                   7165:                (see above).</p></dd>
1.75      rillig   7166: </dl></div>
                   7167: </dd>
                   7168: <dt><span class="term">clean-update</span></dt>
                   7169: <dd>
1.88      wiz      7170: <p>Clean the source tree for all packages that would
                   7171:          get updated if <span><strong class="command">make update</strong></span> was called
                   7172:          from the current directory.  This target should not be
                   7173:          used if the current package (or any of its depending
                   7174:          packages) have already been de-installed (e.g., after
                   7175:          calling <span><strong class="command">make update</strong></span>) or you may lose
                   7176:          some packages you intended to update. As a rule of
                   7177:          thumb: only use this target <span class="emphasis"><em>before</em></span>
                   7178:          the first time you run <span><strong class="command">make update</strong></span>
                   7179:          and only if you have a dirty package tree (e.g., if you
                   7180:          used <code class="varname">NOCLEAN</code>).</p>
                   7181: <p>If you are unsure about whether your tree is
                   7182:          clean, you can either perform a <span><strong class="command">make
                   7183:          clean</strong></span> at the top of the tree, or use the
                   7184:          following sequence of commands from the directory of the
                   7185:          package you want to update (<span class="emphasis"><em>before</em></span>
                   7186:          running <span><strong class="command">make update</strong></span> for the first
                   7187:          time, otherwise you lose all the packages you wanted to
                   7188:          update!):</p>
1.87      wiz      7189: <pre class="screen">
                   7190: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75      rillig   7191: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87      wiz      7192: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   7193:          </pre>
1.88      wiz      7194: <p>The following variables can be used either on the
                   7195:          command line or in <code class="filename">/etc/mk.conf</code> to
                   7196:          alter the behaviour of <span><strong class="command">make
                   7197:          clean-update</strong></span>:</p>
1.75      rillig   7198: <div class="variablelist"><dl>
                   7199: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.88      wiz      7200: <dd><p>After <span><strong class="command">make clean</strong></span>, do not
                   7201:                reconstruct the list of directories to update for
                   7202:                this package.  Only use this if <span><strong class="command">make
                   7203:                update</strong></span> successfully installed all
                   7204:                packages you wanted to update.  Normally, this is
                   7205:                done automatically on <span><strong class="command">make
                   7206:                update</strong></span>, but may have been suppressed by
                   7207:                the <code class="varname">NOCLEAN</code> variable (see
                   7208:                above).</p></dd>
1.75      rillig   7209: </dl></div>
                   7210: </dd>
1.88      wiz      7211: <dt><span class="term">replace</span></dt>
                   7212: <dd>
                   7213: <p>Update the installation of the current package.  This
                   7214:          differs from update in that it does not replace dependent
1.93      rillig   7215:          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      7216:          target to work.</p>
                   7217: <p><span class="emphasis"><em>Be careful when using this
                   7218:          target!</em></span> There are no guarantees that dependent
                   7219:          packages will still work, in particular they will most
                   7220:          certainly break if you <span><strong class="command">make replace</strong></span> a
                   7221:          library package whose shared library major version changed
                   7222:          between your installed version and the new one.  For this
                   7223:          reason, this target is not officially supported and only
                   7224:          recommended for advanced users.</p>
                   7225: </dd>
1.75      rillig   7226: <dt><span class="term">info</span></dt>
                   7227: <dd><p>This target invokes <a 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      7228:          package. You can use this to check which version of a
                   7229:          package is installed.</p></dd>
                   7230: <dt><span class="term">index</span></dt>
                   7231: <dd>
                   7232: <p>This is a top-level command, i.e. it should be used in
                   7233:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   7234:          database of all packages in the local pkgsrc tree, including
                   7235:          dependencies, comment, maintainer, and some other useful
                   7236:          information.  Individual entries are created by running
                   7237:          <span><strong class="command">make describe</strong></span> in the packages'
                   7238:          directories.  This index file is saved as
                   7239:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
                   7240:          verbose format by running <span><strong class="command">make
                   7241:          print-index</strong></span>.  You can search in it with
                   7242:          <span><strong class="command">make search
                   7243:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   7244:          extract a list of all packages that depend on a particular
                   7245:          one by running <span><strong class="command">make show-deps
                   7246:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   7247: <p>Running this command takes a very long time, some
                   7248:          hours even on fast machines!</p>
                   7249: </dd>
1.75      rillig   7250: <dt><span class="term">readme</span></dt>
1.88      wiz      7251: <dd>
                   7252: <p>This target generates a
                   7253:          <code class="filename">README.html</code> file, which can be
1.91      rillig   7254:          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      7255:          contain references to any packages which are in the
                   7256:          <code class="varname">PACKAGES</code> directory on the local
                   7257:          host. The generated files can be made to refer to URLs
                   7258:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   7259:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
                   7260:          wanted to generate <code class="filename">README.html</code>
                   7261:          files which pointed to binary packages on the local
                   7262:          machine, in the directory
                   7263:          <code class="filename">/usr/packages</code>, set
                   7264:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   7265:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   7266:          <code class="varname">${PACKAGES}</code> directory and its
                   7267:          subdirectories will be searched for all the binary
                   7268:          packages.</p>
                   7269: <p>The target can be run at the toplevel or in category
                   7270:          directories, in which case it descends recursively.</p>
                   7271: </dd>
1.75      rillig   7272: <dt><span class="term">readme-all</span></dt>
1.88      wiz      7273: <dd><p>This is a top-level command, run it in
                   7274:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   7275:          file <code class="filename">README-all.html</code> which contains a
                   7276:          list of all packages currently available in the NetBSD
                   7277:          Packages Collection, together with the category they belong
                   7278:          to and a short description. This file is compiled from the
                   7279:          <code class="filename">pkgsrc/*/README.html</code> files, so be sure
                   7280:          to run this <span class="emphasis"><em>after</em></span> a <span><strong class="command">make
                   7281:          readme</strong></span>.</p></dd>
1.75      rillig   7282: <dt><span class="term">cdrom-readme</span></dt>
1.88      wiz      7283: <dd><p>This is very much the same as the
                   7284:          &#8220;<span class="quote">readme</span>&#8221; target (see above), but is to be
                   7285:          used when generating a pkgsrc tree to be written to a
                   7286:          CD-ROM.  This target also produces
                   7287:          <code class="filename">README.html</code> files, and can be made
                   7288:          to refer to URLs based on
                   7289:          <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87      wiz      7290:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75      rillig   7291: <dt><span class="term">show-distfiles</span></dt>
1.88      wiz      7292: <dd><p>This target shows which distfiles and patchfiles
                   7293:          are needed to build the package
                   7294:          (<code class="varname">ALLFILES</code>, which contains all
                   7295:          <code class="varname">DISTFILES</code> and
1.87      wiz      7296:          <code class="varname">PATCHFILES</code>, but not
                   7297:          <code class="filename">patches/*</code>).</p></dd>
1.75      rillig   7298: <dt><span class="term">show-downlevel</span></dt>
1.88      wiz      7299: <dd><p>This target shows nothing if the package is not
                   7300:          installed. If a version of this package is installed,
                   7301:          but is not the version provided in this version of
                   7302:          pkgsrc, then a warning message is displayed. This target
                   7303:          can be used to show which of your installed packages are
                   7304:          downlevel, and so the old versions can be deleted, and
                   7305:          the current ones added.</p></dd>
1.75      rillig   7306: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88      wiz      7307: <dd><p>This target shows the directory in the pkgsrc
                   7308:          hierarchy from which the package can be built and
                   7309:          installed. This may not be the same directory as the one
                   7310:          from which the package was installed. This target is
                   7311:          intended to be used by people who may wish to upgrade
                   7312:          many packages on a single host, and can be invoked from
                   7313:          the top-level pkgsrc Makefile by using the
1.87      wiz      7314:          &#8220;<span class="quote">show-host-specific-pkgs</span>&#8221; target.</p></dd>
1.75      rillig   7315: <dt><span class="term">show-installed-depends</span></dt>
1.88      wiz      7316: <dd><p>This target shows which installed packages match
                   7317:          the current package's <code class="varname">DEPENDS</code>. Useful
                   7318:          if out of date dependencies are causing build
                   7319:          problems.</p></dd>
1.75      rillig   7320: <dt><span class="term">check-shlibs</span></dt>
1.88      wiz      7321: <dd><p>After a package is installed, check all its
                   7322:          binaries and (on ELF platforms) shared libraries to see
                   7323:          if they find the shared libs they need.  Run by default
                   7324:          if <code class="varname">PKG_DEVELOPER</code> is set in
1.87      wiz      7325:          <code class="filename">/etc/mk.conf</code>.</p></dd>
1.75      rillig   7326: <dt><span class="term">print-PLIST</span></dt>
                   7327: <dd>
                   7328: <p>After a &#8220;<span class="quote">make install</span>&#8221; from a new or
1.88      wiz      7329:          upgraded pkg, this prints out an attempt to generate a
                   7330:          new <code class="filename">PLIST</code> from a <span><strong class="command">find
                   7331:          -newer work/.extract_done</strong></span>.  An attempt is made
                   7332:          to care for shared libs etc., but it is
1.87      wiz      7333:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   7334:          result before putting it into
                   7335:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   7336:          diff the output of this command against an already
                   7337:          existing <code class="filename">PLIST</code> file.</p>
1.88      wiz      7338: <p>If the package installs files via <a 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
                   7339:          other methods that don't update file access times, be
                   7340:          sure to add these files manually to your
1.87      wiz      7341:          <code class="filename">PLIST</code>, as the &#8220;<span class="quote">find
                   7342:          -newer</span>&#8221; command used by this target won't catch
                   7343:          them!</p>
1.90      rillig   7344: <p>See <a href="#print-PLIST" title="12.3. Tweaking output of make print-PLIST">Section 12.3, &#8220;Tweaking output of <span><strong class="command">make print-PLIST</strong></span>&#8221;</a> for more
1.87      wiz      7345:          information on this target.</p>
1.75      rillig   7346: </dd>
                   7347: <dt><span class="term">bulk-package</span></dt>
                   7348: <dd>
1.88      wiz      7349: <p>Used to do bulk builds. If an appropriate binary
                   7350:          package already exists, no action is taken. If not, this
                   7351:          target will compile, install and package it (and its
                   7352:          depends, if <code class="varname">PKG_DEPENDS</code> is set
                   7353:          properly. See <a href="#binary.configuration" title="6.3.1. Configuration">Section 6.3.1, &#8220;Configuration&#8221;</a>).
                   7354:          After creating the binary package, the sources, the
                   7355:          just-installed package and its required packages are
                   7356:          removed, preserving free disk space.</p>
                   7357: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7358:          all packages installed on a system!</em></span></p>
1.75      rillig   7359: </dd>
                   7360: <dt><span class="term">bulk-install</span></dt>
                   7361: <dd>
1.88      wiz      7362: <p>Used during bulk-installs to install required
                   7363:          packages. If an up-to-date binary package is available,
                   7364:          it will be installed via <a 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,
                   7365:          <span><strong class="command">make bulk-package</strong></span> will be executed,
1.87      wiz      7366:          but the installed binary won't be removed.</p>
1.88      wiz      7367: <p>A binary package is considered
                   7368:          &#8220;<span class="quote">up-to-date</span>&#8221; to be installed via
                   7369:          <a 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>
                   7370: <div class="itemizedlist"><ul type="disc">
                   7371: <li><p>None of the package's files
                   7372:              (<code class="filename">Makefile</code>, ...) were modified
                   7373:              since it was built.</p></li>
                   7374: <li><p>None of the package's required (binary)
                   7375:              packages were modified since it was built.</p></li>
1.75      rillig   7376: </ul></div>
1.88      wiz      7377: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7378:          all packages installed on a system!</em></span></p>
1.75      rillig   7379: </dd>
                   7380: </dl></div>
                   7381: </div>
                   7382: </div>
                   7383: <div class="chapter" lang="en">
                   7384: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   7385: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.75      rillig   7386: <div class="toc">
                   7387: <p><b>Table of Contents</b></p>
                   7388: <dl>
1.90      rillig   7389: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                   7390: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                   7391: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.97    ! rillig   7392: <dt><span class="sect1"><a href="#tools.questions">17.4. Questions regarding the tools</a></span></dt>
1.75      rillig   7393: </dl>
                   7394: </div>
1.87      wiz      7395: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75      rillig   7396: by pkgsrc and also for individual packages to define what commands
                   7397: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
                   7398: or for later run-time of an installed packaged (such as
                   7399: <code class="varname">DEPENDS</code>).
                   7400: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87      wiz      7401: package will not be used.</p>
                   7402: <p>When building a package, the replacement tools are
1.75      rillig   7403: made available in a directory (as symlinks or wrapper scripts)
                   7404: that is early in the executable search path. Just like the buildlink
1.87      wiz      7405: system, this helps with consistent builds.</p>
                   7406: <p>A tool may be needed to help build a specific package. For example,
                   7407: perl, GNU make (gmake) or yacc may be needed.</p>
                   7408: <p>Also a tool may be needed, for example, because the native system's supplied
1.75      rillig   7409: tool may be inefficient for building a package with pkgsrc.
                   7410: For example, a package may need GNU awk, bison (instead of
1.87      wiz      7411: yacc) or a better sed.</p>
                   7412: <p>The tools used by a package can be listed by running
                   7413: <span><strong class="command">make show-tools</strong></span>.</p>
1.75      rillig   7414: <div class="sect1" lang="en">
                   7415: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   7416: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
1.87      wiz      7417: <p>The default set of tools used by pkgsrc is defined in
1.76      rillig   7418: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.75      rillig   7419: such as: <span><strong class="command">cat</strong></span>, <span><strong class="command">awk</strong></span>,
                   7420: <span><strong class="command">chmod</strong></span>, <span><strong class="command">test</strong></span>, and so on.
                   7421: These can be seen by running:
1.87      wiz      7422: <span><strong class="command">make show-var VARNAME=USE_TOOLS</strong></span>.</p>
                   7423: <p>If a package needs a specific program to build
1.75      rillig   7424: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87      wiz      7425: to define the tools needed.</p>
1.75      rillig   7426: </div>
                   7427: <div class="sect1" lang="en">
                   7428: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   7429: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
1.87      wiz      7430: <p>In the following examples, the :pkgsrc means to use the pkgsrc version
1.75      rillig   7431: and not the native version for a build dependency.
                   7432: And the :run means that it is used for a
                   7433: run-time dependencies also (and becomes a DEPENDS).
                   7434: The default is a build dependency which can be set with
                   7435: :build. (So in this example, it is the same as gmake:build
1.87      wiz      7436: and pkg-config:build.)</p>
1.75      rillig   7437: <pre class="programlisting">
                   7438: USE_TOOLS+=     mktemp:pkgsrc
                   7439: USE_TOOLS+=     gmake perl:run pkg-config
                   7440: </pre>
1.87      wiz      7441: <p>When using the tools framework, a
1.75      rillig   7442: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   7443: which contains the full path to the appropriate tool. For example,
                   7444: <code class="varname">TOOLS_PATH.bash</code> could be &#8220;<span class="quote">/bin/bash</span>&#8221;
1.87      wiz      7445: on Linux systems.</p>
                   7446: <p>If you always need a pkgsrc version of the
1.75      rillig   7447: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   7448: </p>
                   7449: </div>
                   7450: <div class="sect1" lang="en">
                   7451: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   7452: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
1.87      wiz      7453: <p>When improving or porting pkgsrc to a new platform, have a look
1.75      rillig   7454: at (or create) the corresponding platform specific make file fragment under
1.76      rillig   7455: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75      rillig   7456: the name of the common tools. For example:</p>
                   7457: <pre class="programlisting">
                   7458: .if exists(/usr/bin/bzcat)
                   7459: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   7460: .elif exists(/usr/bin/bzip2)
                   7461: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   7462: .endif
1.69      rillig   7463: 
1.75      rillig   7464: TOOLS_PLATFORM.true?=           true                    # shell builtin
                   7465: </pre>
                   7466: </div>
1.97    ! rillig   7467: <div class="sect1" lang="en">
        !          7468: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
        !          7469: <a name="tools.questions"></a>17.4. Questions regarding the tools</h2></div></div></div>
        !          7470: <div class="qandaset">
        !          7471: <dl>
        !          7472: <dt>17.4.1. <a href="#tools.new">How do I add a new tool?</a>
        !          7473: </dt>
        !          7474: <dt>17.4.2. <a href="#tools.listall">How do I get a list of all available
        !          7475:        tools?</a>
        !          7476: </dt>
        !          7477: <dt>17.4.3. <a href="#tools.used">How can I get a list of all the tools that a
        !          7478:        package is using while being built? I want to know whether it
        !          7479:        uses sed or not.</a>
        !          7480: </dt>
        !          7481: </dl>
        !          7482: <table border="0" summary="Q and A Set">
        !          7483: <col align="left" width="1%">
        !          7484: <tbody>
        !          7485: <tr class="question">
        !          7486: <td align="left" valign="top">
        !          7487: <a name="tools.new"></a><a name="id2680589"></a><b>17.4.1.</b>
        !          7488: </td>
        !          7489: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
        !          7490: </tr>
        !          7491: <tr class="answer">
        !          7492: <td align="left" valign="top"></td>
        !          7493: <td align="left" valign="top"><p>TODO</p></td>
        !          7494: </tr>
        !          7495: <tr class="question">
        !          7496: <td align="left" valign="top">
        !          7497: <a name="tools.listall"></a><a name="id2680599"></a><b>17.4.2.</b>
        !          7498: </td>
        !          7499: <td align="left" valign="top"><p>How do I get a list of all available
        !          7500:        tools?</p></td>
        !          7501: </tr>
        !          7502: <tr class="answer">
        !          7503: <td align="left" valign="top"></td>
        !          7504: <td align="left" valign="top"><p>TODO</p></td>
        !          7505: </tr>
        !          7506: <tr class="question">
        !          7507: <td align="left" valign="top">
        !          7508: <a name="tools.used"></a><a name="id2680610"></a><b>17.4.3.</b>
        !          7509: </td>
        !          7510: <td align="left" valign="top"><p>How can I get a list of all the tools that a
        !          7511:        package is using while being built? I want to know whether it
        !          7512:        uses sed or not.</p></td>
        !          7513: </tr>
        !          7514: <tr class="answer">
        !          7515: <td align="left" valign="top"></td>
        !          7516: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
        !          7517:        to do it.)</p></td>
        !          7518: </tr>
        !          7519: </tbody>
        !          7520: </table>
        !          7521: </div>
        !          7522: </div>
1.75      rillig   7523: </div>
                   7524: <div class="chapter" lang="en">
                   7525: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   7526: <a name="fixes"></a>Chapter 18. Making your package work</h2></div></div></div>
1.75      rillig   7527: <div class="toc">
                   7528: <p><b>Table of Contents</b></p>
                   7529: <dl>
1.90      rillig   7530: <dt><span class="sect1"><a href="#general-operation">18.1. General operation</a></span></dt>
1.75      rillig   7531: <dd><dl>
1.90      rillig   7532: <dt><span class="sect2"><a href="#portability-of-packages">18.1.1. Portability of packages</a></span></dt>
                   7533: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">18.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
                   7534: <dt><span class="sect2"><a href="#user-interaction">18.1.3. User interaction</a></span></dt>
                   7535: <dt><span class="sect2"><a href="#handling-licenses">18.1.4. Handling licenses</a></span></dt>
                   7536: <dt><span class="sect2"><a href="#restricted-packages">18.1.5. Restricted packages</a></span></dt>
                   7537: <dt><span class="sect2"><a href="#dependencies">18.1.6. Handling dependencies</a></span></dt>
                   7538: <dt><span class="sect2"><a href="#conflicts">18.1.7. Handling conflicts with other packages</a></span></dt>
                   7539: <dt><span class="sect2"><a href="#not-building-packages">18.1.8. Packages that cannot or should not be built</a></span></dt>
                   7540: <dt><span class="sect2"><a href="#undeletable-packages">18.1.9. Packages which should not be deleted, once installed</a></span></dt>
                   7541: <dt><span class="sect2"><a href="#security-handling">18.1.10. Handling packages with security problems</a></span></dt>
                   7542: <dt><span class="sect2"><a href="#bumping-pkgrevision">18.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   7543: <dt><span class="sect2"><a href="#fixes.subst">18.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   7544: </dl></dd>
                   7545: <dt><span class="sect1"><a href="#fixes.fetch">18.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   7546: <dd><dl>
                   7547: <dt><span class="sect2"><a href="#no-plain-download">18.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   7548: <dt><span class="sect2"><a href="#modified-distfiles-same-name">18.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
                   7549: </dl></dd>
                   7550: <dt><span class="sect1"><a href="#fixes.configure">18.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   7551: <dd><dl>
                   7552: <dt><span class="sect2"><a href="#fixes.libtool">18.3.1. Shared libraries - libtool</a></span></dt>
                   7553: <dt><span class="sect2"><a href="#using-libtool">18.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   7554: <dt><span class="sect2"><a href="#autoconf-automake">18.3.3. GNU Autoconf/Automake</a></span></dt>
                   7555: </dl></dd>
                   7556: <dt><span class="sect1"><a href="#programming-languages">18.4. Programming languages</a></span></dt>
                   7557: <dd><dl>
                   7558: <dt><span class="sect2"><a href="#basic-programming-languages">18.4.1. C, C++, and Fortran</a></span></dt>
                   7559: <dt><span class="sect2"><a href="#java-programming-language">18.4.2. Java</a></span></dt>
                   7560: <dt><span class="sect2"><a href="#perl-scripts">18.4.3. Packages containing perl scripts</a></span></dt>
                   7561: <dt><span class="sect2"><a href="#other-programming-languages">18.4.4. Other programming languages</a></span></dt>
                   7562: </dl></dd>
                   7563: <dt><span class="sect1"><a href="#fixes.build">18.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   7564: <dd><dl>
                   7565: <dt><span class="sect2"><a href="#fixes.build.cpp">18.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   7566: <dt><span class="sect2"><a href="#compiler-bugs">18.5.2. How to handle compiler bugs</a></span></dt>
                   7567: <dt><span class="sect2"><a href="#undefined-reference">18.5.3. Undefined reference to &#8220;<span class="quote">...</span>&#8221;</a></span></dt>
                   7568: <dt><span class="sect2"><a href="#out-of-memory">18.5.4. Running out of memory</a></span></dt>
                   7569: </dl></dd>
                   7570: <dt><span class="sect1"><a href="#fixes.install">18.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   7571: <dd><dl>
                   7572: <dt><span class="sect2"><a href="#install-scripts">18.6.1. Creating needed directories</a></span></dt>
                   7573: <dt><span class="sect2"><a href="#where-to-install-documentation">18.6.2. Where to install documentation</a></span></dt>
                   7574: <dt><span class="sect2"><a href="#installing-score-files">18.6.3. Installing score files</a></span></dt>
                   7575: <dt><span class="sect2"><a href="#hardcoded-paths">18.6.4. Packages with hardcoded paths to other interpreters</a></span></dt>
                   7576: <dt><span class="sect2"><a href="#perl-modules">18.6.5. Packages installing perl modules</a></span></dt>
                   7577: <dt><span class="sect2"><a href="#faq.info-files">18.6.6. Packages installing info files</a></span></dt>
                   7578: <dt><span class="sect2"><a href="#manpages">18.6.7. Packages installing man pages</a></span></dt>
                   7579: <dt><span class="sect2"><a href="#gconf2-data-files">18.6.8. Packages installing GConf2 data files</a></span></dt>
                   7580: <dt><span class="sect2"><a href="#scrollkeeper-data-files">18.6.9. Packages installing scrollkeeper data files</a></span></dt>
                   7581: <dt><span class="sect2"><a href="#x11-fonts">18.6.10. Packages installing X11 fonts</a></span></dt>
                   7582: <dt><span class="sect2"><a href="#gtk2-modules">18.6.11. Packages installing GTK2 modules</a></span></dt>
                   7583: <dt><span class="sect2"><a href="#sgml-xml-data">18.6.12. Packages installing SGML or XML data</a></span></dt>
                   7584: <dt><span class="sect2"><a href="#mime-database">18.6.13. Packages installing extensions to the MIME database</a></span></dt>
                   7585: <dt><span class="sect2"><a href="#intltool">18.6.14. Packages using intltool</a></span></dt>
                   7586: <dt><span class="sect2"><a href="#startup-scripts">18.6.15. Packages installing startup scripts</a></span></dt>
                   7587: <dt><span class="sect2"><a href="#tex-packages">18.6.16. Packages installing TeX modules</a></span></dt>
                   7588: <dt><span class="sect2"><a href="#emulation-packages">18.6.17. Packages supporting running binaries in
1.87      wiz      7589:     emulation</a></span></dt>
1.90      rillig   7590: <dt><span class="sect2"><a href="#hicolor-theme">18.6.18. Packages installing hicolor theme icons</a></span></dt>
                   7591: <dt><span class="sect2"><a href="#desktop-files">18.6.19. Packages installing desktop files</a></span></dt>
1.75      rillig   7592: </dl></dd>
1.90      rillig   7593: <dt><span class="sect1"><a href="#punting">18.7. Marking packages as having problems</a></span></dt>
1.75      rillig   7594: </dl>
                   7595: </div>
                   7596: <div class="sect1" lang="en">
                   7597: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   7598: <a name="general-operation"></a>18.1. General operation</h2></div></div></div>
1.75      rillig   7599: <div class="sect2" lang="en">
                   7600: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   7601: <a name="portability-of-packages"></a>18.1.1. Portability of packages</h3></div></div></div>
1.78      rillig   7602: <p>One appealing feature of pkgsrc is that it runs on many
1.87      wiz      7603:     different platforms. As a result, it is important to ensure,
                   7604:     where possible, that packages in pkgsrc are portable. This
                   7605:     chapter mentions some particular details you should pay
                   7606:     attention to while working on pkgsrc.</p>
1.78      rillig   7607: </div>
                   7608: <div class="sect2" lang="en">
                   7609: <div class="titlepage"><div><div><h3 class="title">
1.93      rillig   7610: <a name="pulling-vars-from-etc-mk.conf"></a>18.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code>
                   7611: </h3></div></div></div>
1.78      rillig   7612: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87      wiz      7613:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
                   7614:     which is <code class="filename">/etc/mk.conf</code> by default. When you
                   7615:     want to use those variables in the preprocessor directives of
                   7616:     <a 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
                   7617:     <code class="literal">.for</code>), you need to include the file
                   7618:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   7619:     loads the user preferences.</p>
1.78      rillig   7620: <p>But note that some variables may not be completely defined
1.87      wiz      7621:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
                   7622:     included, as they may contain references to variables that are
                   7623:     not yet defined. In shell commands this is no problem, since
                   7624:     variables are actually macros, which are only expanded when they
                   7625:     are used. But in the preprocessor directives mentioned above and
                   7626:     in dependency lines (of the form <code class="literal">target:
                   7627:     dependencies</code>) the variables are expanded at load
                   7628:     time.</p>
1.78      rillig   7629: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   7630: <h3 class="title">Note</h3>
                   7631: <p>Currently there is no exhaustive list of all
1.87      wiz      7632:     variables that tells you whether they can be used at load time
                   7633:     or only at run time, but it is in preparation.</p>
1.78      rillig   7634: </div>
                   7635: </div>
                   7636: <div class="sect2" lang="en">
                   7637: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   7638: <a name="user-interaction"></a>18.1.3. User interaction</h3></div></div></div>
1.88      wiz      7639: <p>Occasionally, packages require interaction from the user,
                   7640:     and this can be in a number of ways:</p>
1.78      rillig   7641: <div class="itemizedlist"><ul type="disc">
1.79      rillig   7642: <li><p>When fetching the distfiles, some packages require user
1.87      wiz      7643:        interaction such as entering username/password or accepting a
                   7644:        license on a web page.</p></li>
1.88      wiz      7645: <li><p>When extracting the distfiles, some packages may ask for
                   7646:        passwords.</p></li>
1.78      rillig   7647: <li><p>help to configure the package before it is built</p></li>
                   7648: <li><p>help during the build process</p></li>
                   7649: <li><p>help during the installation of a package</p></li>
                   7650: </ul></div>
1.88      wiz      7651: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
                   7652:     provided to notify the pkgsrc mechanism of an interactive stage
                   7653:     which will be needed, and this should be set in the package's
                   7654:     <code class="filename">Makefile</code>, e.g.:</p>
1.75      rillig   7655: <pre class="programlisting">
1.87      wiz      7656:       INTERACTIVE_STAGE=      build
                   7657:     </pre>
1.78      rillig   7658: <p>Multiple interactive stages can be specified:</p>
1.75      rillig   7659: <pre class="programlisting">
1.87      wiz      7660:       INTERACTIVE_STAGE=      configure install
                   7661:     </pre>
1.88      wiz      7662: <p>The user can then decide to skip this package by setting the
                   7663:     <code class="varname">BATCH</code> variable.</p>
1.75      rillig   7664: </div>
                   7665: <div class="sect2" lang="en">
                   7666: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   7667: <a name="handling-licenses"></a>18.1.4. Handling licenses</h3></div></div></div>
1.78      rillig   7668: <p>A package may be covered by a license which the user has
1.87      wiz      7669:     or has not agreed to accept.  For these cases, pkgsrc contains
                   7670:     a mechanism to note that a package is covered by a particular
                   7671:     license, and the package cannot be built unless the user has
                   7672:     accepted the license.  (Installation of binary packages are
                   7673:     not currently subject to this mechanism.)  Packages with
                   7674:     licenses that are either Open Source according to the Open
                   7675:     Source Initiative or Free according to the Free Software
                   7676:     Foundation will not be marked with a license tag.  Packages
                   7677:     with licenses that have not been determined to meet either
                   7678:     definition will be marked with a license tag referring to the
                   7679:     license.  This will prevent building unless pkgsrc is informed
                   7680:     that the license is acceptable, and enables displaying the
                   7681:     license.</p>
1.78      rillig   7682: <p>The license tag mechanism is intended to address
1.87      wiz      7683:     copyright-related issues surrounding building, installing and
                   7684:     using a package, and not to address redistribution issues (see
                   7685:     <code class="varname">RESTRICTED</code> and
                   7686:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).  However, the above
                   7687:     definition of licenses for which tags are not needed implies
                   7688:     that packages with redistribution restrictions should have
                   7689:     tags.</p>
                   7690: <p>Denoting that a package is covered by a particular license
                   7691:     is done by placing the license in
                   7692:     <code class="filename">pkgsrc/licenses</code> and setting the
                   7693:     <code class="varname">LICENSE</code> variable to a string identifying the
1.91      rillig   7694:     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      7695: <pre class="programlisting">
                   7696:       LICENSE=        xv-license
                   7697:     </pre>
                   7698: <p>When trying to build, the user will get a notice that the
                   7699:     package is covered by a license which has not been
                   7700:     accepted:</p>
                   7701: <pre class="programlisting">
                   7702:       <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   7703:       ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
                   7704:       ===&gt;     To view the license, enter "/usr/bin/make show-license".
                   7705:       ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
                   7706:       ===&gt;     ACCEPTABLE_LICENSES+=xv-license
                   7707:       *** Error code 1
                   7708:     </pre>
1.78      rillig   7709: <p>The license can be viewed with <span><strong class="command">make
1.87      wiz      7710:     show-license</strong></span>, and if it is considered appropriate,
                   7711:     the line printed above can be added to
                   7712:     <code class="filename">/etc/mk.conf</code> to indicate acceptance of
                   7713:     the particular license:</p>
1.78      rillig   7714: <pre class="programlisting">
1.87      wiz      7715:       ACCEPTABLE_LICENSES+=xv-license
                   7716:     </pre>
1.78      rillig   7717: <p>When adding a package with a new license, the license
1.87      wiz      7718:     text should be added to <code class="filename">pkgsrc/licenses</code>
                   7719:     for displaying. A list of known licenses can be seen in this
1.91      rillig   7720:     directory.</p>
1.78      rillig   7721: <p>The use of <code class="varname">LICENSE=shareware</code>,
1.87      wiz      7722:     <code class="varname">LICENSE=no-commercial-use</code>, and similar
                   7723:     language is deprecated because it does not crisply refer to
                   7724:     a particular license text.  Another problem with such usage
                   7725:     is that it does not enable a user to denote acceptance of
                   7726:     the license for a single package without accepting the same
                   7727:     license text for another package.  In particular, this can
                   7728:     be inappropriate when e.g. one accepts a particular license to
                   7729:     indicate to pkgsrc that a fee has been paid.</p>
1.75      rillig   7730: </div>
                   7731: <div class="sect2" lang="en">
                   7732: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   7733: <a name="restricted-packages"></a>18.1.5. Restricted packages</h3></div></div></div>
1.75      rillig   7734: <p>Some licenses restrict how software may be re-distributed.
1.87      wiz      7735:     In order to satisfy these restrictions, the package system
                   7736:     defines five make variables that can be set to note these
                   7737:     restrictions:</p>
1.75      rillig   7738: <div class="itemizedlist"><ul type="disc">
                   7739: <li>
                   7740: <p><code class="varname">RESTRICTED</code></p>
                   7741: <p>This variable should be set whenever a restriction
1.87      wiz      7742:        exists (regardless of its kind).  Set this variable to a
                   7743:        string containing the reason for the restriction.</p>
1.75      rillig   7744: </li>
                   7745: <li>
                   7746: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
                   7747: <p>Binaries may not be placed on CD-ROM.  Set this
1.87      wiz      7748:        variable to <code class="varname">${RESTRICTED}</code> whenever a
                   7749:        binary package may not be included on a CD-ROM.</p>
1.75      rillig   7750: </li>
                   7751: <li>
                   7752: <p><code class="varname">NO_BIN_ON_FTP</code></p>
                   7753: <p>Binaries may not be placed on an FTP server.  Set
1.87      wiz      7754:        this variable to <code class="varname">${RESTRICTED}</code>
1.93      rillig   7755:        whenever a binary package may not be made available
1.87      wiz      7756:        on the Internet.</p>
1.75      rillig   7757: </li>
                   7758: <li>
                   7759: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
                   7760: <p>Distfiles may not be placed on CD-ROM.  Set this
1.87      wiz      7761:        variable to <code class="varname">${RESTRICTED}</code> if
                   7762:        re-distribution of the source code or other distfile(s) is
                   7763:        not allowed on CD-ROMs.</p>
1.75      rillig   7764: </li>
                   7765: <li>
                   7766: <p><code class="varname">NO_SRC_ON_FTP</code></p>
                   7767: <p>Distfiles may not be placed on FTP.  Set this variable
1.87      wiz      7768:        to <code class="varname">${RESTRICTED}</code> if re-distribution of
                   7769:        the source code or other distfile(s) via the Internet is not
                   7770:        allowed.  If this variable is not set, the distfile(s) will
                   7771:        be mirrored on ftp.NetBSD.org.</p>
1.75      rillig   7772: </li>
                   7773: </ul></div>
                   7774: <p>Please note that the use of <code class="varname">NO_PACKAGE</code>,
1.87      wiz      7775:     <code class="varname">IGNORE</code>, <code class="varname">NO_CDROM</code>, or other
                   7776:     generic make variables to denote restrictions is deprecated,
                   7777:     because they unconditionally prevent users from generating
                   7778:     binary packages!</p>
1.75      rillig   7779: </div>
                   7780: <div class="sect2" lang="en">
                   7781: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   7782: <a name="dependencies"></a>18.1.6. Handling dependencies</h3></div></div></div>
1.75      rillig   7783: <p>Your package may depend on some other package being present
1.88      wiz      7784:     - and there are various ways of expressing this dependency.
                   7785:     pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
                   7786:     <code class="varname">DEPENDS</code> definitions, the
                   7787:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   7788:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   7789:     to handle dependencies, and which uses the variables named above.
1.90      rillig   7790:     See <a href="#buildlink" title="Chapter 13. Buildlink methodology">Chapter 13, <i>Buildlink methodology</i></a> for more information.</p>
1.75      rillig   7791: <p>The basic difference between the two variables is as
1.87      wiz      7792:     follows: The <code class="varname">DEPENDS</code> definition registers
                   7793:     that pre-requisite in the binary package so it will be pulled in
                   7794:     when the binary package is later installed, whilst the
                   7795:     <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
                   7796:     dependency that is only needed for building the package.</p>
1.75      rillig   7797: <p>This means that if you only need a package present whilst
1.87      wiz      7798:     you are building, it should be noted as a
                   7799:     <code class="varname">BUILD_DEPENDS</code>.</p>
1.75      rillig   7800: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87      wiz      7801:     <code class="varname">DEPENDS</code> definition is:</p>
1.75      rillig   7802: <pre class="programlisting">
1.87      wiz      7803:       &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
                   7804:     </pre>
1.75      rillig   7805: <p>Please note that the &#8220;<span class="quote">pre-req-package-name</span>&#8221;
1.87      wiz      7806:     may include any of the wildcard version numbers recognized by
                   7807:     <a 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   7808: <div class="orderedlist"><ol type="1">
                   7809: <li>
                   7810: <p>If your package needs another package's binaries or
1.87      wiz      7811:        libraries to build or run, and if that package has a
                   7812:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75      rillig   7813: <pre class="programlisting">
1.87      wiz      7814:          .include "../../graphics/jpeg/buildlink3.mk"
                   7815:        </pre>
1.75      rillig   7816: </li>
                   7817: <li>
                   7818: <p>If your package needs to use another package to build
1.87      wiz      7819:        itself and there is no <code class="filename">buildlink3.mk</code>
                   7820:        file available, use the <code class="varname">BUILD_DEPENDS</code>
                   7821:        definition:</p>
1.75      rillig   7822: <pre class="programlisting">
1.87      wiz      7823:          BUILD_DEPENDS+= autoconf-2.13:../../devel/autoconf
                   7824:        </pre>
1.75      rillig   7825: </li>
                   7826: <li>
                   7827: <p>If your package needs a library with which to link and
1.76      rillig   7828:        again there is no <code class="filename">buildlink3.mk</code> file
1.87      wiz      7829:        available, this is specified using the
                   7830:        <code class="varname">DEPENDS</code> definition. For example:</p>
1.75      rillig   7831: <pre class="programlisting">
1.87      wiz      7832:          DEPENDS+=       xpm-3.4j:../../graphics/xpm
                   7833:        </pre>
1.75      rillig   7834: <p>You can also use wildcards in package dependences:</p>
                   7835: <pre class="programlisting">
1.87      wiz      7836:          DEPENDS+=       xpm-[0-9]*:../../graphics/xpm
                   7837:        </pre>
1.75      rillig   7838: <p>Note that such wildcard dependencies are retained when
1.87      wiz      7839:        creating binary packages.  The dependency is checked when
                   7840:        installing the binary package and any package which matches
                   7841:        the pattern will be used.  Wildcard dependencies should be
                   7842:        used with care.</p>
1.75      rillig   7843: <p>The &#8220;<span class="quote">-[0-9]*</span>&#8221; should be used instead of
1.87      wiz      7844:        &#8220;<span class="quote">-*</span>&#8221; to avoid potentially ambiguous matches
                   7845:        such as &#8220;<span class="quote">tk-postgresql</span>&#8221; matching a
                   7846:        &#8220;<span class="quote">tk-*</span>&#8221; <code class="varname">DEPENDS</code>.</p>
1.75      rillig   7847: <p>Wildcards can also be used to specify that a package
1.87      wiz      7848:        will only build against a certain minimum version of a
                   7849:        pre-requisite:</p>
1.75      rillig   7850: <pre class="programlisting">
1.87      wiz      7851:          DEPENDS+=       tiff&gt;=3.5.4:../../graphics/tiff
                   7852:        </pre>
1.75      rillig   7853: <p>This means that the package will build against version
1.87      wiz      7854:        3.5.4 of the tiff library or newer.  Such a dependency may
                   7855:        be warranted if, for example, the API of the library has
                   7856:        changed with version 3.5.4 and a package would not compile
                   7857:        against an earlier version of tiff.</p>
1.75      rillig   7858: <p>Please note that such dependencies should only be
1.87      wiz      7859:        updated if a package requires a newer pre-requisite, but
1.93      rillig   7860:        not to denote recommendations such as
1.87      wiz      7861:        ABI changes that do not prevent a package from building
                   7862:        correctly.  Such recommendations can be expressed using
                   7863:        <code class="varname">ABI_DEPENDS</code>:</p>
1.75      rillig   7864: <pre class="programlisting">
1.87      wiz      7865:          ABI_DEPENDS+=   tiff&gt;=3.6.1:../../graphics/tiff
                   7866:        </pre>
1.75      rillig   7867: <p>In addition to the above <code class="varname">DEPENDS</code>
1.87      wiz      7868:        line, this denotes that while a package will build against
                   7869:        tiff&gt;=3.5.4, at least version 3.6.1 is recommended.
                   7870:        <code class="varname">ABI_DEPENDS</code> entries will be turned into
                   7871:        dependencies unless explicitly ignored (in which case a
                   7872:        warning will be printed).</p>
1.75      rillig   7873: <p>To ignore these ABI dependency recommendations and just
1.87      wiz      7874:        use the required <code class="varname">DEPENDS</code>, set
                   7875:        <code class="varname">USE_ABI_DEPENDS=NO</code>.   This may make
                   7876:        it easier and faster to update packages built using pkgsrc,
                   7877:        since older compatible dependencies can continue to be
                   7878:        used. This is useful for people who watch their rebuilds
                   7879:        very carefully; it is not very good as a general-purpose
                   7880:        hammer.  If you use it, you need to be mindful of possible
                   7881:        ABI changes, including those from the underlying OS.</p>
1.75      rillig   7882: <p>Packages that are built with recommendations ignored
1.87      wiz      7883:        may not be uploaded to ftp.NetBSD.org by developers and
                   7884:        should not be used across different systems that may have
                   7885:        different versions of binary packages installed.</p>
1.75      rillig   7886: <p>For security fixes, please update the package
1.90      rillig   7887:        vulnerabilities file. See <a href="#security-handling" title="18.1.10. Handling packages with security problems">Section 18.1.10, &#8220;Handling packages with security problems&#8221;</a> for more
1.87      wiz      7888:        information.</p>
1.75      rillig   7889: </li>
                   7890: <li>
                   7891: <p>If your package needs some executable to be able to run
1.87      wiz      7892:        correctly and if there's no
                   7893:        <code class="filename">buildlink3.mk</code> file, this is specified
                   7894:        using the <code class="varname">DEPENDS</code> variable. The
1.91      rillig   7895:        <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      7896:        be able to execute the latex binary from the teTeX package
                   7897:        when it runs, and that is specified:</p>
1.75      rillig   7898: <pre class="programlisting">
1.87      wiz      7899:          DEPENDS+=        teTeX-[0-9]*:../../print/teTeX
                   7900:        </pre>
1.75      rillig   7901: <p>The comment about wildcard dependencies from previous
1.87      wiz      7902:        paragraph applies here, too.</p>
1.75      rillig   7903: </li>
                   7904: </ol></div>
                   7905: <p>If your package needs files from another package to build,
1.87      wiz      7906:     add the relevant distribution files to
                   7907:     <code class="varname">DISTFILES</code>, so they will be extracted
1.91      rillig   7908:     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      7909:     (It relies on the jpeg sources being present in source form
                   7910:     during the build.)</p>
1.75      rillig   7911: </div>
                   7912: <div class="sect2" lang="en">
                   7913: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   7914: <a name="conflicts"></a>18.1.7. Handling conflicts with other packages</h3></div></div></div>
1.75      rillig   7915: <p>Your package may conflict with other packages a user might
1.87      wiz      7916:     already have installed on his system, e.g. if your package
1.88      wiz      7917:     installs the same set of files as another package in the pkgsrc
                   7918:     tree.</p>
1.75      rillig   7919: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
1.87      wiz      7920:     space-separated list of packages (including version string) your
                   7921:     package conflicts with.</p>
1.91      rillig   7922: <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>
                   7923:     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      7924:     install the same shared library, thus you set in
                   7925:     <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
                   7926: <pre class="programlisting">
                   7927:       CONFLICTS=      Xaw-Xpm-[0-9]*
                   7928:     </pre>
                   7929: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
1.75      rillig   7930: <pre class="programlisting">
1.87      wiz      7931:       CONFLICTS=      Xaw3d-[0-9]*
                   7932:     </pre>
1.75      rillig   7933: <p>Packages will automatically conflict with other packages
1.87      wiz      7934:     with the name prefix and a different version
                   7935:     string. &#8220;<span class="quote">Xaw3d-1.5</span>&#8221; e.g. will automatically
                   7936:     conflict with the older version &#8220;<span class="quote">Xaw3d-1.3</span>&#8221;.</p>
1.75      rillig   7937: </div>
                   7938: <div class="sect2" lang="en">
                   7939: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   7940: <a name="not-building-packages"></a>18.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.75      rillig   7941: <p>There are several reasons why a package might be
1.88      wiz      7942:     instructed to not build under certain circumstances.  If the
1.87      wiz      7943:     package builds and runs on most platforms, the exceptions
                   7944:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
                   7945:     the package builds and runs on a small handful of platforms,
                   7946:     set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
                   7947:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   7948:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   7949:     (OS-version-platform) that can use glob-style
                   7950:     wildcards.</p>
1.88      wiz      7951: <p>Some packages are tightly bound to a specific version of an
1.91      rillig   7952:     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      7953:     backwards compatible with other versions of the OS, and should be
                   7954:     uploaded to a version specific directory on the FTP server.  Mark
                   7955:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
                   7956:     &#8220;<span class="quote">yes</span>&#8221;.  This variable is not currently used by any of
                   7957:     the package system internals, but may be used in the
                   7958:     future.</p>
1.75      rillig   7959: <p>If the package should be skipped (for example, because it
1.87      wiz      7960:     provides functionality already provided by the system), set
1.88      wiz      7961:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   7962:     the package should fail because some preconditions are not met,
                   7963:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87      wiz      7964:     message.</p>
1.75      rillig   7965: </div>
                   7966: <div class="sect2" lang="en">
                   7967: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   7968: <a name="undeletable-packages"></a>18.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.75      rillig   7969: <p>To ensure that a package may not be deleted, once it has been
1.87      wiz      7970:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   7971:     be set in the package Makefile. This will be carried into any
                   7972:     binary package that is made from this pkgsrc entry. A
                   7973:     &#8220;<span class="quote">preserved</span>&#8221; package will
                   7974:     not be deleted using <a 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
                   7975:     &#8220;<span class="quote">-f</span>&#8221; option is used.</p>
1.75      rillig   7976: </div>
                   7977: <div class="sect2" lang="en">
                   7978: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   7979: <a name="security-handling"></a>18.1.10. Handling packages with security problems</h3></div></div></div>
1.75      rillig   7980: <p>When a vulnerability is found, this should be noted in
1.87      wiz      7981:     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
                   7982:     and after committing that file, use <span><strong class="command">make upload</strong></span>
                   7983:     in the same directory to update the file on ftp.NetBSD.org.</p>
1.75      rillig   7984: <p>After fixing the vulnerability by a patch, its
1.87      wiz      7985:     <code class="varname">PKGREVISION</code> should be increased (this
                   7986:     is of course not necessary if the problem is fixed by using
                   7987:     a newer release of the software).</p>
1.75      rillig   7988: <p>Also, if the fix should be applied to the stable pkgsrc
1.87      wiz      7989:     branch, be sure to submit a pullup request!</p>
1.75      rillig   7990: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87      wiz      7991:     semi-automatically by a weekly cron job.</p>
1.75      rillig   7992: </div>
                   7993: <div class="sect2" lang="en">
                   7994: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   7995: <a name="bumping-pkgrevision"></a>18.1.11. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.75      rillig   7996: <p>When making fixes to an existing package it can be useful
1.87      wiz      7997:     to change the version number in <code class="varname">PKGNAME</code>. To
                   7998:     avoid conflicting with future versions by the original author, a
                   7999:     &#8220;<span class="quote">nb1</span>&#8221;, &#8220;<span class="quote">nb2</span>&#8221;, ... suffix can be used
                   8000:     on package versions by setting <code class="varname">PKGREVISION=1</code>
                   8001:     (2, ...). The &#8220;<span class="quote">nb</span>&#8221; is treated like a
                   8002:     &#8220;<span class="quote">.</span>&#8221; by the package tools. e.g.</p>
                   8003: <pre class="programlisting">
                   8004:       DISTNAME=       foo-17.42
                   8005:       PKGREVISION=    9
                   8006:     </pre>
1.75      rillig   8007: <p>will result in a <code class="varname">PKGNAME</code> of
1.87      wiz      8008:     &#8220;<span class="quote">foo-17.42nb9</span>&#8221;. If you want to use the original
                   8009:     value of <code class="varname">PKGNAME</code> without the &#8220;<span class="quote">nbX</span>&#8221;
                   8010:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   8011:     <code class="varname">PKGNAME_NOREV</code>.</p>
1.75      rillig   8012: <p>When a new release of the package is released, the
1.87      wiz      8013:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   8014:     minor release of the above package, things should be like:</p>
1.75      rillig   8015: <pre class="programlisting">
1.87      wiz      8016:       DISTNAME=       foo-17.43
                   8017:     </pre>
                   8018: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   8019:     non-trivial change in the resulting binary package.  Without a
                   8020:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   8021:     version installed has no way of knowing that their package is out
                   8022:     of date.  Thus, changes without increasing
                   8023:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   8024:     trivial that no reasonable person would want to upgrade", and this
                   8025:     is the rough test for when increasing
                   8026:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   8027:     changes that do not merit increasing
                   8028:     <code class="varname">PKGREVISION</code> are:</p>
                   8029: <pre class="programlisting">
                   8030:       Changing <code class="varname">HOMEPAGE</code>, <code class="varname">MAINTAINER</code>,
                   8031:       or comments in Makefile.
                   8032:       Changing build variables if the resulting binary package is the same.
                   8033:       Changing <code class="filename">DESCR</code>.
                   8034:       Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.
                   8035:     </pre>
                   8036: <p>Examples of changes that do merit an increase to
                   8037:     <code class="varname">PKGREVISION</code> include:</p>
                   8038: <pre class="programlisting">
                   8039:       Security fixes
                   8040:       Changes or additions to a patch file
                   8041:       Changes to the <code class="filename">PLIST</code>
                   8042:     </pre>
1.78      rillig   8043: <p>PKGREVISION must also be incremented when dependencies have ABI
                   8044:     changes.</p>
1.75      rillig   8045: </div>
1.79      rillig   8046: <div class="sect2" lang="en">
                   8047: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8048: <a name="fixes.subst"></a>18.1.12. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.79      rillig   8049: <p>When you want to replace the same text in multiple files
1.87      wiz      8050:     or when the replacement text varies, patches alone cannot help.
                   8051:     This is where the SUBST framework comes in. It provides an
                   8052:     easy-to-use interface for replacing text in files.
                   8053:     Example:</p>
                   8054: <pre class="programlisting">
                   8055:       SUBST_CLASSES+=                 fix-paths
                   8056:       SUBST_STAGE.fix-paths=          pre-configure
                   8057:       SUBST_MESSAGE.fix-paths=        Fixing absolute paths.
                   8058:       SUBST_FILES.fix-paths=          src/*.c
                   8059:       SUBST_FILES.fix-paths+=         scripts/*.sh
                   8060:       SUBST_SED.fix-paths=            -e 's,"/usr/local,"${PREFIX},g'
                   8061:       SUBST_SED.fix-paths+=           -e 's,"/var/log,"${VARBASE}/log,g'
                   8062:     </pre>
1.79      rillig   8063: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87      wiz      8064:     that are used to identify the different SUBST blocks that are
                   8065:     defined. The SUBST framework is heavily used by pkgsrc, so it is
                   8066:     important to always use the <code class="literal">+=</code> operator with
                   8067:     this variable. Otherwise some substitutions may be
                   8068:     skipped.</p>
1.79      rillig   8069: <p>The remaining variables of each SUBST block are
1.87      wiz      8070:     parameterized with the identifier from the first line
                   8071:     (<code class="literal">fix-paths</code> in this case.) They can be seen as
                   8072:     parameters to a function call.</p>
1.79      rillig   8073: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87      wiz      8074:     which the replacement will take place. All combinations of
                   8075:     <code class="literal">pre-</code>, <code class="literal">do-</code> and
                   8076:     <code class="literal">post-</code> together with a phase name are
                   8077:     possible, though only few are actually used. Most commonly used
                   8078:     are <code class="literal">post-patch</code> and
                   8079:     <code class="literal">pre-configure</code>. Of these two,
                   8080:     <code class="literal">pre-configure</code> should be preferred because
                   8081:     then it is possible to run <span><strong class="command">bmake patch</strong></span> and
                   8082:     have the state after applying the patches but before making any
                   8083:     other changes. This is especially useful when you are debugging
                   8084:     a package in order to create new patches for it. Similarly,
                   8085:     <code class="literal">post-build</code> is preferred over
                   8086:     <code class="literal">pre-install</code>, because the install phase should
                   8087:     generally be kept as simple as possible. When you use
                   8088:     <code class="literal">post-build</code>, you have the same files in the
                   8089:     working directory that will be installed later, so you can check
                   8090:     if the substitution has succeeded.</p>
1.79      rillig   8091: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87      wiz      8092:     that is printed just before the substitution is done.</p>
1.79      rillig   8093: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87      wiz      8094:     globbing patterns that specifies the files in which the
                   8095:     substitution will take place. The patterns are interpreted
                   8096:     relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79      rillig   8097: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.87      wiz      8098:     <a 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
                   8099:     command should be prefixed with <code class="literal">-e</code>, so that
                   8100:     all SUBST blocks look uniform.</p>
1.79      rillig   8101: <p>There are some more variables, but they are so seldomly
1.87      wiz      8102:     used that they are only documented in the
                   8103:     <code class="filename">mk/subst.mk</code> file.</p>
1.79      rillig   8104: </div>
1.75      rillig   8105: </div>
                   8106: <div class="sect1" lang="en">
                   8107: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   8108: <a name="fixes.fetch"></a>18.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.75      rillig   8109: <div class="sect2" lang="en">
                   8110: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8111: <a name="no-plain-download"></a>18.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.75      rillig   8112: <p>If you need to download from a dynamic URL you can set
1.87      wiz      8113:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span><strong class="command">make
                   8114:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   8115:     with the name of each file to download as an argument, expecting
                   8116:     it to output the URL of the directory from which to download
1.91      rillig   8117:     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      8118:     example of this usage.</p>
1.75      rillig   8119: <p>If the download can't be automated, because the user must
1.87      wiz      8120:     submit personal information to apply for a password, or must pay
                   8121:     for the source, or whatever, you can set
                   8122:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   8123:     displayed to the user before aborting the build. Example:</p>
                   8124: <pre class="programlisting">
                   8125:       FETCH_MESSAGE=  "Please download the files"
                   8126:       FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   8127:       FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
                   8128:     </pre>
1.75      rillig   8129: </div>
                   8130: <div class="sect2" lang="en">
                   8131: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8132: <a name="modified-distfiles-same-name"></a>18.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.75      rillig   8133: <p>Sometimes authors of a software package make some
1.87      wiz      8134:     modifications after the software was released, and they put up a
                   8135:     new distfile without changing the package's version number. If a
                   8136:     package is already in pkgsrc at that time, the checksum will
                   8137:     no longer match. The contents of the new distfile should be
                   8138:     compared against the old one before changing anything, to make
                   8139:     sure the distfile was really updated on purpose, and that
                   8140:     no trojan horse or so crept in.
1.97    ! rillig   8141:     Please mention that the distfiles were compared and what was found
        !          8142:     in your commit message.
1.87      wiz      8143:     Then, the correct way to work around this is to
                   8144:     set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
                   8145:     usually based on <code class="varname">PKGNAME_NOREV</code>. All
                   8146:     <code class="varname">DISTFILES</code> and
1.93      rillig   8147:     <code class="varname">PATCHFILES</code> for this package will be put in that
1.97    ! rillig   8148:     subdirectory of the local distfiles directory.
        !          8149:     (See <a href="#bumping-pkgrevision" title="18.1.11. How to handle incrementing versions when fixing an existing package">Section 18.1.11, &#8220;How to handle incrementing versions when fixing an existing package&#8221;</a> for more details.)
        !          8150:     In case this
1.87      wiz      8151:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
                   8152:     including the <code class="filename">nbX</code> suffix) or a date stamp
                   8153:     can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
                   8154:     Do not forget regenerating the <code class="filename">distinfo</code> file
                   8155:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   8156:     path in the filenames.
1.97    ! rillig   8157:     Also increase the PKGREVISION if the installed package is different.
1.87      wiz      8158:     Furthermore, a mail to the package's authors seems appropriate
                   8159:     telling them that changing distfiles after releases without
                   8160:     changing the file names is not good practice.</p>
1.75      rillig   8161: </div>
                   8162: </div>
                   8163: <div class="sect1" lang="en">
                   8164: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   8165: <a name="fixes.configure"></a>18.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.75      rillig   8166: <div class="sect2" lang="en">
                   8167: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8168: <a name="fixes.libtool"></a>18.3.1. Shared libraries - libtool</h3></div></div></div>
1.75      rillig   8169: <p>pkgsrc supports many different machines, with different
1.87      wiz      8170:     object formats like a.out and ELF, and varying abilities to do
                   8171:     shared library and dynamic loading at all. To accompany this,
                   8172:     varying commands and options have to be passed to the
                   8173:     compiler, linker, etc. to get the Right Thing, which can be
                   8174:     pretty annoying especially if you don't have all the machines
                   8175:     at your hand to test things.  The
1.91      rillig   8176:     <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      8177:     can help here, as it just &#8220;<span class="quote">knows</span>&#8221; how to build
                   8178:     both static and dynamic libraries from a set of source files,
                   8179:     thus being platform-independent.</p>
                   8180: <p>Here's how to use libtool in a package in seven simple
                   8181:     steps:</p>
1.75      rillig   8182: <div class="orderedlist"><ol type="1">
                   8183: <li><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87      wiz      8184:        Makefile.</p></li>
1.75      rillig   8185: <li><p>For library objects, use &#8220;<span class="quote">${LIBTOOL} --mode=compile
1.87      wiz      8186:        ${CC}</span>&#8221; in place of &#8220;<span class="quote">${CC}</span>&#8221;. You could even
                   8187:        add it to the definition of <code class="varname">CC</code>, if only
                   8188:        libraries are being built in a given Makefile. This one command
                   8189:        will build both PIC and non-PIC library objects, so you need not
                   8190:        have separate shared and non-shared library rules.</p></li>
1.75      rillig   8191: <li>
                   8192: <p>For the linking of the library, remove any
1.87      wiz      8193:        &#8220;<span class="quote">ar</span>&#8221;, &#8220;<span class="quote">ranlib</span>&#8221;, and &#8220;<span class="quote">ld
                   8194:        -Bshareable</span>&#8221; commands, and instead use:</p>
1.75      rillig   8195: <pre class="programlisting">
1.87      wiz      8196:          ${LIBTOOL} --mode=link ${CC} -o ${.TARGET:.a=.la} ${OBJS:.o=.lo} \
                   8197:          -rpath ${PREFIX}/lib -version-info major:minor
                   8198:        </pre>
1.75      rillig   8199: <p>Note that the library is changed to have a
1.87      wiz      8200:        <code class="filename">.la</code> extension, and the objects are
                   8201:        changed to have a <code class="filename">.lo</code>
                   8202:        extension. Change <code class="varname">OBJS</code> as
                   8203:        necessary. This automatically creates all of the
                   8204:        <code class="filename">.a</code>,
                   8205:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   8206:        necessary) in the build directory. Be sure to include
                   8207:        &#8220;<span class="quote">-version-info</span>&#8221;, especially when major and
                   8208:        minor are zero, as libtool will otherwise strip off the
                   8209:        shared library version.</p>
1.75      rillig   8210: <p>From the libtool manual:</p>
                   8211: <pre class="programlisting">
1.87      wiz      8212:          So, libtool library versions are described by three integers:
1.69      rillig   8213: 
1.87      wiz      8214:          CURRENT
                   8215:          The most recent interface number that this library implements.
1.69      rillig   8216: 
1.87      wiz      8217:          REVISION
                   8218:          The implementation number of the CURRENT interface.
1.69      rillig   8219: 
1.87      wiz      8220:          AGE
                   8221:          The difference between the newest and oldest interfaces that
                   8222:          this library implements.  In other words, the library implements
                   8223:          all the interface numbers in the range from number `CURRENT -
                   8224:          AGE' to `CURRENT'.
1.1       grant    8225: 
1.87      wiz      8226:          If two libraries have identical CURRENT and AGE numbers, then the
                   8227:          dynamic linker chooses the library with the greater REVISION number.
                   8228:        </pre>
1.75      rillig   8229: <p>The &#8220;<span class="quote">-release</span>&#8221; option will produce
1.87      wiz      8230:        different results for a.out and ELF (excluding symlinks)
                   8231:        in only one case. An ELF library of the form
                   8232:        &#8220;<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;
                   8233:        will have a symlink of
                   8234:        &#8220;<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;
                   8235:        on an a.out platform. This is handled
                   8236:        automatically.</p>
1.75      rillig   8237: <p>The &#8220;<span class="quote">-rpath argument</span>&#8221; is the install
1.87      wiz      8238:        directory of the library being built.</p>
1.76      rillig   8239: <p>In the <code class="filename">PLIST</code>, include only the
1.87      wiz      8240:        <code class="filename">.la</code> file, the other files will be
                   8241:        added automatically.</p>
1.75      rillig   8242: </li>
                   8243: <li>
1.76      rillig   8244: <p>When linking shared object (<code class="filename">.so</code>)
1.87      wiz      8245:        files, i.e. files that are loaded via <a 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
                   8246:        shared libraries, use &#8220;<span class="quote">-module
                   8247:        -avoid-version</span>&#8221; to prevent them getting version
                   8248:        tacked on.</p>
1.76      rillig   8249: <p>The <code class="filename">PLIST</code> file gets the
1.87      wiz      8250:        <code class="filename">foo.so</code> entry.</p>
1.75      rillig   8251: </li>
                   8252: <li>
                   8253: <p>When linking programs that depend on these libraries
1.87      wiz      8254:        <span class="emphasis"><em>before</em></span> they are installed, preface
                   8255:        the <a 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 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}
                   8256:        --mode=link</span>&#8221;, and it will find the correct
                   8257:        libraries (static or shared), but please be aware that
                   8258:        libtool will not allow you to specify a relative path in
                   8259:        -L (such as &#8220;<span class="quote">-L../somelib</span>&#8221;), because it
                   8260:        expects you to change that argument to be the
                   8261:        <code class="filename">.la</code> file. e.g.</p>
1.75      rillig   8262: <pre class="programlisting">
1.87      wiz      8263:          ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
                   8264:        </pre>
1.75      rillig   8265: <p>should be changed to:</p>
                   8266: <pre class="programlisting">
1.87      wiz      8267:          ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
                   8268:        </pre>
1.75      rillig   8269: <p>and it will do the right thing with the libraries.</p>
                   8270: </li>
                   8271: <li>
                   8272: <p>When installing libraries, preface the <a href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
1.87      wiz      8273:        or <a 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}
                   8274:        --mode=install</span>&#8221;, and change the library name to
                   8275:        <code class="filename">.la</code>. e.g.</p>
1.75      rillig   8276: <pre class="programlisting">
1.87      wiz      8277:          ${LIBTOOL} --mode=install ${BSD_INSTALL_DATA} ${SOMELIB:.a=.la} ${PREFIX}/lib
                   8278:        </pre>
1.76      rillig   8279: <p>This will install the static <code class="filename">.a</code>,
1.87      wiz      8280:        shared library, any needed symlinks, and run
                   8281:        <a 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   8282: </li>
1.76      rillig   8283: <li><p>In your <code class="filename">PLIST</code>, include only
1.87      wiz      8284:        the <code class="filename">.la</code>
                   8285:        file (this is a change from previous behaviour).</p></li>
1.75      rillig   8286: </ol></div>
                   8287: </div>
                   8288: <div class="sect2" lang="en">
                   8289: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8290: <a name="using-libtool"></a>18.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75      rillig   8291: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87      wiz      8292:     package Makefile. This will override the package's own libtool
                   8293:     in most cases.  For older libtool using packages,  libtool is
                   8294:     made by ltconfig script during the do-configure step; you can
                   8295:     check the libtool script location by doing <span><strong class="command">make
                   8296:     configure; find work*/ -name libtool</strong></span>.</p>
1.75      rillig   8297: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87      wiz      8298:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
                   8299:     default, it is set to &#8220;<span class="quote">libtool */libtool
                   8300:     */*/libtool</span>&#8221;.  If this does not match the location of the
                   8301:     package's libtool script(s), set it as appropriate.</p>
1.76      rillig   8302: <p>If you do not need <code class="filename">*.a</code> static
1.87      wiz      8303:     libraries built and installed, then use
                   8304:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75      rillig   8305: <p>If your package makes use of the platform-independent library
1.87      wiz      8306:     for loading dynamic shared objects, that comes with libtool
                   8307:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   8308: <p>Some packages use libtool incorrectly so that the package
                   8309:     may not work or build in some circumstances. Some of the more
                   8310:     common errors are:</p>
1.75      rillig   8311: <div class="itemizedlist"><ul type="disc">
                   8312: <li>
                   8313: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87      wiz      8314:        executable or library. This in itself isn't a problem if one of two things
                   8315:        has been done:</p>
1.75      rillig   8316: <div class="orderedlist"><ol type="1">
                   8317: <li><p>The shared object is named correctly, i.e.
1.87      wiz      8318:            <code class="filename">libfoo.la</code>, not
                   8319:            <code class="filename">foo.la</code></p></li>
1.75      rillig   8320: <li><p>The -dlopen option is used when linking an executable.</p></li>
                   8321: </ol></div>
                   8322: </li>
                   8323: <li><p>The use of libltdl without the correct calls to initialisation routines.
1.87      wiz      8324:        The function lt_dlinit() should be called and the macro
                   8325:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   8326:        executables.</p></li>
1.75      rillig   8327: </ul></div>
                   8328: </div>
                   8329: <div class="sect2" lang="en">
                   8330: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8331: <a name="autoconf-automake"></a>18.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75      rillig   8332: <p>If a package needs GNU autoconf or automake to be executed
1.87      wiz      8333:     to regenerate the configure script and Makefile.in makefile
                   8334:     templates, then they should be executed in a pre-configure
                   8335:     target.</p>
1.75      rillig   8336: <p>For packages that need only autoconf:</p>
                   8337: <pre class="programlisting">
1.87      wiz      8338:       AUTOCONF_REQD=  2.50            # if default version is not good enough
                   8339:       USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
                   8340:       ...
1.1       grant    8341: 
1.87      wiz      8342:       pre-configure:
                   8343:       cd ${WRKSRC}; autoconf
1.1       grant    8344: 
1.87      wiz      8345:       ...
                   8346:     </pre>
1.75      rillig   8347: <p>and for packages that need automake and autoconf:</p>
                   8348: <pre class="programlisting">
1.87      wiz      8349:       AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
                   8350:       USE_TOOLS+=     automake        # use "automake14" for automake-1.4
                   8351:       ...
                   8352: 
                   8353:       pre-configure:
                   8354:       cd ${WRKSRC};                          \
                   8355:       aclocal; autoheader;                   \
                   8356:       automake -a --foreign -i; autoconf
1.1       grant    8357: 
1.87      wiz      8358:       ...
                   8359:     </pre>
1.75      rillig   8360: <p>Packages which use GNU Automake will almost certainly
1.87      wiz      8361:     require GNU Make.</p>
1.75      rillig   8362: <p>There are times when the configure process makes
1.87      wiz      8363:     additional changes to the generated files, which then causes
                   8364:     the build process to try to re-execute the automake sequence.
                   8365:     This is prevented by touching various files in the configure
                   8366:     stage. If this causes problems with your package you can set
                   8367:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   8368:     Makefile.</p>
1.75      rillig   8369: </div>
                   8370: </div>
                   8371: <div class="sect1" lang="en">
                   8372: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   8373: <a name="programming-languages"></a>18.4. Programming languages</h2></div></div></div>
1.87      wiz      8374: <div class="sect2" lang="en">
                   8375: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8376: <a name="basic-programming-languages"></a>18.4.1. C, C++, and Fortran</h3></div></div></div>
1.87      wiz      8377: <p>Compilers for the C, C++, and Fortran languages comes with
                   8378:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   8379:     is written in C and will hide all other compilers (via the wrapper
1.90      rillig   8380:     framework, see <a href="#buildlink" title="Chapter 13. Buildlink methodology">Chapter 13, <i>Buildlink methodology</i></a>).</p>
1.87      wiz      8381: <p>To declare which language's compiler a package needs, set
                   8382:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
                   8383:     currently are &#8220;<span class="quote">c</span>&#8221;, &#8220;<span class="quote">c++</span>&#8221;, and
                   8384:     &#8220;<span class="quote">fortran</span>&#8221; (and any combination).  The default is
                   8385:     &#8220;<span class="quote">c</span>&#8221;.  Packages using GNU configure scripts, even if
                   8386:     written in C++, usually need a C compiler for the configure
                   8387:     phase.</p>
                   8388: </div>
                   8389: <div class="sect2" lang="en">
                   8390: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8391: <a name="java-programming-language"></a>18.4.2. Java</h3></div></div></div>
1.87      wiz      8392: <p>If a program is written in Java, use the Java framework in
                   8393:     pkgsrc.  The package must include
                   8394:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   8395:     provides the following variables:</p>
                   8396: <div class="itemizedlist"><ul type="disc">
                   8397: <li><p><code class="varname">USE_JAVA</code> defines if a build
                   8398:       dependency on the JDK is added.  If
                   8399:       <code class="varname">USE_JAVA</code> is set to &#8220;<span class="quote">run</span>&#8221;, then
                   8400:       there is only a runtime dependency on the JDK.  The default is
                   8401:       &#8220;<span class="quote">yes</span>&#8221;, which also adds a build dependency on the
                   8402:       JDK.</p></li>
                   8403: <li><p>Set <code class="varname">USE_JAVA2</code> to declare that
                   8404:       a package needs a Java2 implementation.  The supported values
                   8405:       are &#8220;<span class="quote">yes</span>&#8221;, &#8220;<span class="quote">1.4</span>&#8221;, and
                   8406:       &#8220;<span class="quote">1.5</span>&#8221;.  &#8220;<span class="quote">yes</span>&#8221; accepts any Java2
                   8407:       implementation, &#8220;<span class="quote">1.4</span>&#8221; insists on versions 1.4 or
                   8408:       above, and &#8220;<span class="quote">1.5</span>&#8221; only accepts versions 1.5 or
                   8409:       above. This variable is not set by default.</p></li>
                   8410: </ul></div>
                   8411: </div>
                   8412: <div class="sect2" lang="en">
                   8413: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8414: <a name="perl-scripts"></a>18.4.3. Packages containing perl scripts</h3></div></div></div>
1.87      wiz      8415: <p>If your package contains interpreted perl scripts, add
                   8416:     &#8220;<span class="quote">perl</span>&#8221; to the <code class="varname">USE_TOOLS</code> variable
                   8417:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   8418:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   8419:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
                   8420:     that you want adjusted.  Every occurrence of
                   8421:     <code class="filename">*/bin/perl</code> will be replaced with the full
                   8422:     path to the perl executable.</p>
                   8423: <p>If a particular version of perl is needed, set the
                   8424:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
                   8425:     default is &#8220;<span class="quote">5.0</span>&#8221;.</p>
1.90      rillig   8426: <p>See <a href="#perl-modules" title="18.6.5. Packages installing perl modules">Section 18.6.5, &#8220;Packages installing perl modules&#8221;</a> for information
1.87      wiz      8427:     about handling perl modules.</p>
                   8428: </div>
                   8429: <div class="sect2" lang="en">
                   8430: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8431: <a name="other-programming-languages"></a>18.4.4. Other programming languages</h3></div></div></div>
1.87      wiz      8432: <p>Currently, there is no special handling for other languages
                   8433:     in pkgsrc.  If a compiler package provides a
                   8434:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   8435:     just add a (build) dependency on the appropriate compiler
                   8436:     package.</p>
                   8437: </div>
                   8438: </div>
                   8439: <div class="sect1" lang="en">
                   8440: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   8441: <a name="fixes.build"></a>18.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77      rillig   8442: <p>The most common failures when building a package are that
                   8443:        some platforms do not provide certain header files, functions or
                   8444:        libraries, or they provide the functions in a library that the
                   8445:        original package author didn't know. To work around this, you
                   8446:        can rewrite the source code in most cases so that it does not
                   8447:        use the missing functions or provides a replacement function.</p>
                   8448: <div class="sect2" lang="en">
                   8449: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8450: <a name="fixes.build.cpp"></a>18.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77      rillig   8451: <p>If a package already comes with a GNU configure script, the
                   8452:        preferred way to fix the build failure is to change the
                   8453:        configure script, not the code. In the other cases, you can
                   8454:        utilize the C preprocessor, which defines certain macros
                   8455:        depending on the operating system and hardware architecture it
                   8456:        compiles for. These macros can be queried using for example
                   8457:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   8458:        system, hardware architecture and compiler has its own macro.
                   8459:        For example, if the macros <code class="varname">__GNUC__</code>,
                   8460:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   8461:        are all defined, you know that you are using NetBSD on an i386
                   8462:        compatible CPU, and your compiler is GCC.</p>
                   8463: <p>The list of the following macros for hardware and
                   8464:        operating system depends on the compiler that is used. For
                   8465:        example, if you want to conditionally compile code on Solaris,
                   8466:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   8467:        does not define it. Use <code class="varname">__sun</code> instead.</p>
1.75      rillig   8468: <div class="sect3" lang="en">
                   8469: <div class="titlepage"><div><div><h4 class="title">
1.90      rillig   8470: <a name="fixes.build.cpp.os"></a>18.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.75      rillig   8471: <p>To distinguish between 4.4 BSD-derived systems and the
                   8472:         rest of the world, you should use the following code.</p>
                   8473: <pre class="programlisting">
                   8474:     #include &lt;sys/param.h&gt;
                   8475:     #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
                   8476:       /* BSD-specific code goes here */
                   8477:     #else
                   8478:       /* non-BSD-specific code goes here */
                   8479:     #endif
                   8480: </pre>
1.77      rillig   8481: <p>If this distinction is not fine enough, you can also test
                   8482:        for the following macros.</p>
1.75      rillig   8483: <pre class="programlisting">
                   8484:     FreeBSD     __FreeBSD__
                   8485:     DragonFly   __DragonFly__
                   8486:     Interix     __INTERIX
1.97    ! rillig   8487:     IRIX        __sgi (TODO: get a definite source for this)
1.75      rillig   8488:     Linux       linux, __linux, __linux__
                   8489:     NetBSD      __NetBSD__
                   8490:     OpenBSD     __OpenBSD__
                   8491:     Solaris     sun, __sun
                   8492: </pre>
                   8493: </div>
                   8494: <div class="sect3" lang="en">
                   8495: <div class="titlepage"><div><div><h4 class="title">
1.90      rillig   8496: <a name="fixes.build.cpp.arch"></a>18.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.75      rillig   8497: <pre class="programlisting">
                   8498:     i386        i386, __i386, __i386__
                   8499:     MIPS        __mips
                   8500:     SPARC       sparc, __sparc
                   8501: </pre>
                   8502: </div>
                   8503: <div class="sect3" lang="en">
                   8504: <div class="titlepage"><div><div><h4 class="title">
1.90      rillig   8505: <a name="fixes.build.cpp.compiler"></a>18.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.75      rillig   8506: <pre class="programlisting">
                   8507:     GCC         __GNUC__ (major version), __GNUC_MINOR__
1.97    ! rillig   8508:     MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
        !          8509:     SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
        !          8510:     SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75      rillig   8511: </pre>
                   8512: </div>
                   8513: </div>
1.78      rillig   8514: <div class="sect2" lang="en">
                   8515: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8516: <a name="compiler-bugs"></a>18.5.2. How to handle compiler bugs</h3></div></div></div>
1.78      rillig   8517: <p>Some source files trigger bugs in the compiler, based on
1.87      wiz      8518:         combinations of compiler version and architecture and almost
                   8519:         always relation to optimisation being enabled.  Common symptoms
                   8520:         are gcc internal errors or never finishing compiling a
1.78      rillig   8521:        file.</p>
                   8522: <p>Typically, a workaround involves testing the
                   8523:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   8524:         optimisation for that combination of file,
                   8525:        <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
1.87      wiz      8526:        in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
1.78      rillig   8527:        number of examples.</p>
                   8528: </div>
                   8529: <div class="sect2" lang="en">
                   8530: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8531: <a name="undefined-reference"></a>18.5.3. Undefined reference to &#8220;<span class="quote">...</span>&#8221;</h3></div></div></div>
1.92      rillig   8532: <p>This error message often means that a package did not
1.78      rillig   8533:        link to a shared library it needs. The following functions are
                   8534:        known to cause this error message over and over.</p>
                   8535: <div class="informaltable">
                   8536: <a name="undefined-reference-functions"></a><table border="1">
                   8537: <colgroup>
                   8538: <col>
                   8539: <col>
                   8540: <col>
                   8541: </colgroup>
                   8542: <thead><tr>
                   8543: <th>Function</th>
                   8544: <th>Library</th>
                   8545: <th>Affected platforms</th>
                   8546: </tr></thead>
                   8547: <tbody>
                   8548: <tr>
                   8549: <td>accept, bind, connect</td>
                   8550: <td>-lsocket</td>
                   8551: <td>Solaris</td>
                   8552: </tr>
                   8553: <tr>
                   8554: <td>crypt</td>
                   8555: <td>-lcrypt</td>
                   8556: <td>DragonFly, NetBSD</td>
                   8557: </tr>
                   8558: <tr>
                   8559: <td>dlopen, dlsym</td>
                   8560: <td>-ldl</td>
                   8561: <td>Linux</td>
                   8562: </tr>
                   8563: <tr>
                   8564: <td>gethost*</td>
                   8565: <td>-lnsl</td>
                   8566: <td>Solaris</td>
                   8567: </tr>
                   8568: <tr>
                   8569: <td>inet_aton</td>
                   8570: <td>-lresolv</td>
                   8571: <td>Solaris</td>
                   8572: </tr>
                   8573: <tr>
                   8574: <td>nanosleep, sem_*, timer_*</td>
                   8575: <td>-lrt</td>
                   8576: <td>Solaris</td>
                   8577: </tr>
                   8578: <tr>
                   8579: <td>openpty</td>
                   8580: <td>-lutil</td>
                   8581: <td>Linux</td>
                   8582: </tr>
                   8583: </tbody>
                   8584: </table>
                   8585: </div>
                   8586: <p>To fix these linker errors, it is often sufficient to say
1.87      wiz      8587:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   8588:     -l<em class="replaceable"><code>foo</code></em></code> to the package
                   8589:     <code class="filename">Makefile</code> and then say <span><strong class="command">bmake clean;
                   8590:     bmake</strong></span>.</p>
1.92      rillig   8591: <div class="sect3" lang="en">
                   8592: <div class="titlepage"><div><div><h4 class="title">
                   8593: <a name="undefined-reference-sunpro"></a>18.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
                   8594: <p>When you are using the SunPro compiler, there is another
                   8595: possibility. That compiler cannot handle the following code:</p>
                   8596: <pre class="programlisting">
                   8597:     extern int extern_func(int);
1.93      rillig   8598: 
1.92      rillig   8599:     static inline int
                   8600:     inline_func(int x)
                   8601:     {
                   8602:         return extern_func(x);
                   8603:     }
1.93      rillig   8604: 
1.92      rillig   8605:     int main(void)
                   8606:     {
                   8607:         return 0;
                   8608:     }
                   8609: </pre>
                   8610: <p>It generates the code for <code class="function">inline_func</code> even if
                   8611: that function is never used. This code then refers to
                   8612: <code class="function">extern_func</code>, which can usually not be resolved. To
                   8613: solve this problem you can try to tell the package to disable inlining
                   8614: of functions.</p>
                   8615: </div>
1.87      wiz      8616: </div>
                   8617: <div class="sect2" lang="en">
                   8618: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8619: <a name="out-of-memory"></a>18.5.4. Running out of memory</h3></div></div></div>
1.87      wiz      8620: <p>Sometimes packages fail to build because the compiler runs
                   8621:     into an operating system specific soft limit.  With the
                   8622:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
                   8623:     to unlimit the resources.  Currently, the allowed values are
                   8624:     &#8220;<span class="quote">datasize</span>&#8221; and &#8220;<span class="quote">stacksize</span>&#8221; (or both).
                   8625:     Setting this variable is similar to running the shell builtin
                   8626:     <span><strong class="command">ulimit</strong></span> command to raise the maximum data
                   8627:     segment size or maximum stack size of a process, respectively, to
                   8628:     their hard limits.</p>
1.78      rillig   8629: </div>
1.75      rillig   8630: </div>
                   8631: <div class="sect1" lang="en">
                   8632: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   8633: <a name="fixes.install"></a>18.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75      rillig   8634: <div class="sect2" lang="en">
                   8635: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8636: <a name="install-scripts"></a>18.6.1. Creating needed directories</h3></div></div></div>
1.78      rillig   8637: <p>The BSD-compatible <span><strong class="command">install</strong></span> supplied
1.87      wiz      8638:     with some operating systems cannot create more than one
                   8639:     directory at a time. As such, you should call
                   8640:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   8641: <pre class="programlisting">
                   8642:       ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   8643:       ${INSTALL_DATA_DIR} ${PREFIX}/dir2
                   8644:     </pre>
1.78      rillig   8645: <p>You can also just append &#8220;<span class="quote"><code class="literal">dir1
1.87      wiz      8646:     dir2</code></span>&#8221; to the
                   8647:     <code class="varname">INSTALLATION_DIRS</code> variable, which will
                   8648:     automatically do the right thing.</p>
1.75      rillig   8649: </div>
                   8650: <div class="sect2" lang="en">
                   8651: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8652: <a name="where-to-install-documentation"></a>18.6.2. Where to install documentation</h3></div></div></div>
1.83      wiz      8653: <p>In general, documentation should be installed into
1.87      wiz      8654:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8655:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
                   8656:     includes the version number of the package).</p>
1.84      wiz      8657: <p>Many modern packages using GNU autoconf allow to set the
1.87      wiz      8658:     directory where HTML documentation is installed with the
                   8659:     &#8220;<span class="quote">--with-html-dir</span>&#8221; option. Sometimes using this flag
                   8660:     is needed because otherwise the documentation ends up in
                   8661:     <code class="filename">${PREFIX}/share/doc/html</code> or other
                   8662:     places.</p>
                   8663: <p>An exception to the above is that library API documentation
1.91      rillig   8664:     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      8665:     browsers (devhelp) should be left at their default location, which
                   8666:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   8667:     documentation can be recognized from files ending in
                   8668:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   8669:     (It is also acceptable to install such files in
                   8670:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8671:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   8672:     <code class="filename">.devhelp*</code> file must be directly in that
                   8673:     directory then, no additional subdirectory level is allowed in
                   8674:     this case. This is usually achieved by using
                   8675:     &#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;.
                   8676:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   8677:     though.)</p>
1.75      rillig   8678: </div>
                   8679: <div class="sect2" lang="en">
                   8680: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8681: <a name="installing-score-files"></a>18.6.3. Installing score files</h3></div></div></div>
1.75      rillig   8682: <p>Certain packages, most of them in the games category, install
1.87      wiz      8683:     a score file that allows all users on the system to record their
                   8684:     highscores.  In order for this to work, the binaries need to be
                   8685:     installed setgid and the score files owned by the appropriate
                   8686:     group and/or owner (traditionally the "games" user/group).  The
                   8687:     following variables, documented in more detail in
                   8688:     <code class="filename">mk/defaults/mk.conf</code>, control this
                   8689:     behaviour: <code class="varname">SETGIDGAME</code>,
                   8690:     <code class="varname">GAMEDATAMODE</code>, <code class="varname">GAMEGRP</code>,
                   8691:     <code class="varname">GAMEMODE</code>, <code class="varname">GAMEOWN</code>.</p>
1.75      rillig   8692: <p>Note that per default, setgid installation of games is
1.87      wiz      8693:     disabled;  setting <code class="varname">SETGIDGAME=YES</code> will set all
                   8694:     the other variables accordingly.</p>
1.75      rillig   8695: <p>A package should therefor never hard code file ownership or
1.87      wiz      8696:     access permissions but rely on <code class="varname">INSTALL_GAME</code> and
                   8697:     <code class="varname">INSTALL_GAME_DATA</code> to set these
                   8698:     correctly.</p>
1.75      rillig   8699: </div>
                   8700: <div class="sect2" lang="en">
                   8701: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8702: <a name="hardcoded-paths"></a>18.6.4. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87      wiz      8703: <p>Your package may also contain scripts with hardcoded paths to
                   8704:       other interpreters besides (or as well as) perl.  To correct the
                   8705:       full pathname to the script interpreter, you need to set the
                   8706:       following definitions in your <code class="filename">Makefile</code> (we
                   8707:     shall use <span><strong class="command">tclsh</strong></span> in this example):</p>
                   8708: <pre class="programlisting">
                   8709:       REPLACE_INTERPRETER+=   tcl
                   8710:       REPLACE.tcl.old=        .*/bin/tclsh
                   8711:       REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   8712:       REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   8713:       # relative to ${WRKSRC}, just as in REPLACE_PERL
                   8714:     </pre>
1.75      rillig   8715: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   8716: <h3 class="title">Note</h3>
                   8717: <p>Before March 2006, these variables were called
1.87      wiz      8718:     <code class="varname">_REPLACE.*</code> and
                   8719:     <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75      rillig   8720: </div>
                   8721: </div>
                   8722: <div class="sect2" lang="en">
                   8723: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8724: <a name="perl-modules"></a>18.6.5. Packages installing perl modules</h3></div></div></div>
1.75      rillig   8725: <p>Makefiles of packages providing perl5 modules should include
1.87      wiz      8726:     the Makefile fragment
                   8727:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
                   8728:     <span><strong class="command">do-configure</strong></span> target for the standard perl
                   8729:     configuration for such modules as well as various hooks to tune
                   8730:     this configuration.  See comments in this file for
                   8731:     details.</p>
1.75      rillig   8732: <p>Perl5 modules will install into different places depending
1.87      wiz      8733:     on the version of perl used during the build process.  To
                   8734:     address this, pkgsrc will append lines to the
                   8735:     <code class="filename">PLIST</code> corresponding to the files listed in
                   8736:     the installed <code class="filename">.packlist</code> file generated by
                   8737:     most perl5 modules.  This is invoked by defining
                   8738:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
                   8739:     paths to packlist files, e.g.:</p>
1.75      rillig   8740: <pre class="programlisting">
1.87      wiz      8741:       PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
                   8742:     </pre>
1.75      rillig   8743: <p>The variables <code class="varname">PERL5_SITELIB</code>,
1.87      wiz      8744:     <code class="varname">PERL5_SITEARCH</code>, and
                   8745:     <code class="varname">PERL5_ARCHLIB</code> represent the three locations
                   8746:     in which perl5 modules may be installed, and may be used by
                   8747:     perl5 packages that don't have a packlist.  These three
                   8748:     variables are also substituted for in the
                   8749:     <code class="filename">PLIST</code>.</p>
1.75      rillig   8750: </div>
                   8751: <div class="sect2" lang="en">
                   8752: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8753: <a name="faq.info-files"></a>18.6.6. Packages installing info files</h3></div></div></div>
1.75      rillig   8754: <p>Some packages install info files or use the
1.87      wiz      8755:     &#8220;<span class="quote">makeinfo</span>&#8221;  or &#8220;<span class="quote">install-info</span>&#8221;
                   8756:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   8757:     the package Makefile so that <code class="filename">INSTALL</code> and
                   8758:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   8759:     handle registration of the info files in the Info directory
                   8760:     file. The &#8220;<span class="quote">install-info</span>&#8221; command used for the info
                   8761:     files registration is either provided by the system, or by a
                   8762:     special purpose package automatically added as dependency if
                   8763:     needed.</p>
1.75      rillig   8764: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87      wiz      8765:     <code class="filename">${PREFIX}</code> where info files are primarily
                   8766:     located. <code class="varname">PKGINFODIR</code> defaults to
                   8767:     &#8220;<span class="quote">info</span>&#8221; and can be overridden by the user.</p>
1.75      rillig   8768: <p>The info files for the package should be listed in the
1.87      wiz      8769:     package <code class="filename">PLIST</code>; however any split info files
                   8770:     need not be listed.</p>
1.75      rillig   8771: <p>A package which needs the &#8220;<span class="quote">makeinfo</span>&#8221; command
1.87      wiz      8772:     at build time must add &#8220;<span class="quote">makeinfo</span>&#8221; to
                   8773:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
                   8774:     version of the &#8220;<span class="quote">makeinfo</span>&#8221; command is needed it
                   8775:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   8776:     variable in the package <code class="filename">Makefile</code>. By
                   8777:     default, a minimum version of 3.12 is required. If the system
                   8778:     does not provide a <span><strong class="command">makeinfo</strong></span> command or if it
                   8779:     does not match the required minimum, a build dependency on the
1.91      rillig   8780:     <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      8781:     be added automatically.</p>
1.75      rillig   8782: <p>The build and installation process of the software provided
1.87      wiz      8783:     by the package should not use the
                   8784:     <span><strong class="command">install-info</strong></span> command as the registration of
                   8785:     info files is the task of the package
                   8786:     <code class="filename">INSTALL</code> script, and it must use the
                   8787:     appropriate <span><strong class="command">makeinfo</strong></span> command.</p>
1.75      rillig   8788: <p>To achieve this goal, the pkgsrc infrastructure creates
1.87      wiz      8789:     overriding scripts for the <span><strong class="command">install-info</strong></span> and
                   8790:     <span><strong class="command">makeinfo</strong></span> commands in a directory listed early
                   8791:     in <code class="varname">PATH</code>.</p>
1.75      rillig   8792: <p>The script overriding <span><strong class="command">install-info</strong></span> has
1.87      wiz      8793:     no effect except the logging of a message. The script overriding
                   8794:     <span><strong class="command">makeinfo</strong></span> logs a message and according to the
                   8795:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
                   8796:     <span><strong class="command">makeinfo</strong></span> command or exit on error.</p>
1.75      rillig   8797: </div>
                   8798: <div class="sect2" lang="en">
                   8799: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8800: <a name="manpages"></a>18.6.7. Packages installing man pages</h3></div></div></div>
1.81      rillig   8801: <p>All packages that install manual pages should install them
1.87      wiz      8802:     into the same directory, so that there is one common place to look
                   8803:     for them. In pkgsrc, this place is
                   8804:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   8805:     should be used in packages. The default for
                   8806:     <code class="varname">PKGMANDIR</code> is
                   8807:     &#8220;<span class="quote"><code class="filename">man</code></span>&#8221;. Another often-used value
                   8808:     is &#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;.</p>
1.75      rillig   8809: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   8810: <h3 class="title">Note</h3>
1.87      wiz      8811: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   8812:     is far from complete.</p>
1.75      rillig   8813: </div>
1.81      rillig   8814: <p>The <code class="filename">PLIST</code> files can just use
1.87      wiz      8815:     <code class="filename">man/</code> as the top level directory for the man
                   8816:     page file entries, and the pkgsrc framework will convert as
                   8817:     needed. In all other places, the correct
                   8818:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   8819: <p>Packages that are
                   8820:     configured with <code class="varname">GNU_CONFIGURE</code> set as
                   8821:     &#8220;<span class="quote">yes</span>&#8221;, by default will use the
                   8822:     <code class="filename">./configure</code>
                   8823:     --mandir switch to set where the man pages should be installed.
                   8824:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   8825:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   8826: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   8827:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
                   8828:     to &#8220;<span class="quote">no</span>&#8221;.
                   8829:     Or if the <code class="filename">./configure</code> script uses
                   8830:     a non-standard use of --mandir, you can set
                   8831:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.90      rillig   8832: <p>See <a href="#manpage-compression" title="12.5. Man page compression">Section 12.5, &#8220;Man page compression&#8221;</a> for
1.87      wiz      8833:     information on installation of compressed manual pages.</p>
1.75      rillig   8834: </div>
                   8835: <div class="sect2" lang="en">
                   8836: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8837: <a name="gconf2-data-files"></a>18.6.8. Packages installing GConf2 data files</h3></div></div></div>
1.87      wiz      8838: <p>If a package installs <code class="filename">.schemas</code> or
                   8839:     <code class="filename">.entries</code> files, used by GConf2,
                   8840:     you need to take some extra steps to make sure they get registered
                   8841:     in the database:</p>
1.75      rillig   8842: <div class="orderedlist"><ol type="1">
1.76      rillig   8843: <li><p>Include <code class="filename">../../devel/GConf2/schemas.mk</code>
1.87      wiz      8844:        instead of its <code class="filename">buildlink3.mk</code> file.  This
                   8845:        takes care of rebuilding the GConf2 database at installation and
                   8846:        deinstallation time, and tells the package where to install
                   8847:        GConf2 data files using some standard configure arguments.  It
                   8848:        also disallows any access to the database directly from the
                   8849:        package.</p></li>
1.75      rillig   8850: <li><p>Ensure that the package installs its
1.87      wiz      8851:        <code class="filename">.schemas</code> files under
                   8852:        <code class="filename">${PREFIX}/share/gconf/schemas</code>.  If they get
                   8853:        installed under <code class="filename">${PREFIX}/etc</code>, you will
                   8854:        need to manually patch the package.</p></li>
1.75      rillig   8855: <li><p>Check the PLIST and remove any entries under the etc/gconf
1.87      wiz      8856:        directory, as they will be handled automatically.  See
1.90      rillig   8857:        <a href="#faq.conf" title="8.14. How do I change the location of configuration files?">Section 8.14, &#8220;How do I change the location of configuration files?&#8221;</a> for more information.</p></li>
1.75      rillig   8858: <li><p>Define the <code class="varname">GCONF2_SCHEMAS</code> variable in
1.87      wiz      8859:        your <code class="filename">Makefile</code> with a list of all
                   8860:        <code class="filename">.schemas</code> files installed by the package, if
                   8861:        any.  Names must not contain any directories in them.</p></li>
1.75      rillig   8862: <li><p>Define the <code class="varname">GCONF2_ENTRIES</code> variable in
1.87      wiz      8863:        your <code class="filename">Makefile</code> with a
                   8864:        list of all <code class="filename">.entries</code> files installed by the
                   8865:        package, if any. Names must not contain any directories in
                   8866:        them.</p></li>
1.75      rillig   8867: </ol></div>
                   8868: </div>
                   8869: <div class="sect2" lang="en">
                   8870: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8871: <a name="scrollkeeper-data-files"></a>18.6.9. Packages installing scrollkeeper data files</h3></div></div></div>
1.87      wiz      8872: <p>If a package installs <code class="filename">.omf</code> files, used by
                   8873:     scrollkeeper, you need to take some extra steps to make sure they
                   8874:     get registered in the database:</p>
1.75      rillig   8875: <div class="orderedlist"><ol type="1">
                   8876: <li><p>Include
1.87      wiz      8877:        <code class="filename">../../textproc/scrollkeeper/omf.mk</code>
                   8878:        instead of its <code class="filename">buildlink3.mk</code> file.  This
                   8879:        takes care of rebuilding the scrollkeeper database at
                   8880:        installation and deinstallation time, and disallows any access
                   8881:        to it directly from the package.</p></li>
1.75      rillig   8882: <li><p>Check the PLIST and remove any entries under the
1.87      wiz      8883:        <code class="filename">libdata/scrollkeeper</code> directory, as they
                   8884:        will be handled automatically.</p></li>
1.76      rillig   8885: <li><p>Remove the <code class="filename">share/omf</code> directory from
1.87      wiz      8886:        the PLIST.  It will be handled by scrollkeeper.</p></li>
1.75      rillig   8887: </ol></div>
                   8888: </div>
                   8889: <div class="sect2" lang="en">
                   8890: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8891: <a name="x11-fonts"></a>18.6.10. Packages installing X11 fonts</h3></div></div></div>
1.75      rillig   8892: <p>If a package installs font files, you will need to rebuild
1.87      wiz      8893:     the fonts database in the directory where they get installed at
                   8894:     installation and deinstallation time.  This can be automatically
                   8895:     done by using the pkginstall framework.</p>
1.75      rillig   8896: <p>You can list the directories where fonts are installed in the
1.87      wiz      8897:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   8898:     variables, where <em class="replaceable"><code>type</code></em> can be one of
                   8899:     &#8220;<span class="quote">ttf</span>&#8221;, &#8220;<span class="quote">type1</span>&#8221; or &#8220;<span class="quote">x11</span>&#8221;.
                   8900:     Also make sure that the database file
                   8901:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75      rillig   8902: <p>Note that you should not create new directories for fonts;
1.87      wiz      8903:     instead use the standard ones to avoid that the user needs to
                   8904:     manually configure his X server to find them.</p>
1.75      rillig   8905: </div>
                   8906: <div class="sect2" lang="en">
                   8907: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8908: <a name="gtk2-modules"></a>18.6.11. Packages installing GTK2 modules</h3></div></div></div>
1.75      rillig   8909: <p>If a package installs GTK2 immodules or loaders, you need to
1.87      wiz      8910:     take some extra steps to get them registered in the GTK2 database
                   8911:     properly:</p>
1.75      rillig   8912: <div class="orderedlist"><ol type="1">
                   8913: <li><p>Include
1.87      wiz      8914:       <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
                   8915:       <code class="filename">buildlink3.mk</code> file.  This takes care of
                   8916:       rebuilding the database at installation and deinstallation time.</p></li>
                   8917: <li><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
                   8918:       your package installs GTK2 immodules.</p></li>
                   8919: <li><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
                   8920:       GTK2 loaders.</p></li>
1.75      rillig   8921: <li>
1.87      wiz      8922: <p>Patch the package to not touch any of the GTK2
                   8923:       databases directly.  These are:</p>
1.75      rillig   8924: <div class="itemizedlist"><ul type="disc">
1.76      rillig   8925: <li><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
                   8926: <li><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75      rillig   8927: </ul></div>
                   8928: </li>
1.87      wiz      8929: <li><p>Check the <code class="filename">PLIST</code> and remove
                   8930:       any entries under the <code class="filename">libdata/gtk-2.0</code>
                   8931:       directory, as they will be handled automatically.</p></li>
1.75      rillig   8932: </ol></div>
                   8933: </div>
                   8934: <div class="sect2" lang="en">
                   8935: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8936: <a name="sgml-xml-data"></a>18.6.12. Packages installing SGML or XML data</h3></div></div></div>
1.75      rillig   8937: <p>If a package installs SGML or XML data files that need to be
1.87      wiz      8938:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   8939:     etc.), you need to take some extra steps:</p>
1.75      rillig   8940: <div class="orderedlist"><ol type="1">
                   8941: <li><p>Include
1.87      wiz      8942:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   8943:        your <code class="filename">Makefile</code>, which takes care of
                   8944:        registering those files in system-wide catalogs at
                   8945:        installation and deinstallation time.</p></li>
1.75      rillig   8946: <li><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87      wiz      8947:        any SGML catalogs installed by the package.</p></li>
1.75      rillig   8948: <li><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87      wiz      8949:        any XML catalogs installed by the package.</p></li>
1.75      rillig   8950: <li><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87      wiz      8951:        to be added to the SGML catalog.  These come in groups of
                   8952:        three strings; see xmlcatmgr(1) for more information
                   8953:        (specifically, arguments recognized by the 'add' action).
                   8954:        Note that you will normally not use this variable.</p></li>
1.75      rillig   8955: <li><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87      wiz      8956:        to be added to the XML catalog.  These come in groups of three
                   8957:        strings; see xmlcatmgr(1) for more information (specifically,
                   8958:        arguments recognized by the 'add' action).  Note that you will
                   8959:        normally not use this variable.</p></li>
1.75      rillig   8960: </ol></div>
                   8961: </div>
                   8962: <div class="sect2" lang="en">
                   8963: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8964: <a name="mime-database"></a>18.6.13. Packages installing extensions to the MIME database</h3></div></div></div>
1.75      rillig   8965: <p>If a package provides extensions to the MIME database by
1.87      wiz      8966:     installing <code class="filename">.xml</code> files inside
                   8967:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   8968:     need to take some extra steps to ensure that the database is kept
                   8969:     consistent with respect to these new files:</p>
1.75      rillig   8970: <div class="orderedlist"><ol type="1">
                   8971: <li><p>Include
1.87      wiz      8972:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   8973:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   8974:        this same directory, which is reserved for inclusion from
                   8975:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   8976:        care of rebuilding the MIME database at installation and
                   8977:        deinstallation time, and disallows any access to it directly
                   8978:        from the package.</p></li>
1.75      rillig   8979: <li><p>Check the PLIST and remove any entries under the
1.87      wiz      8980:        <code class="filename">share/mime</code> directory,
                   8981:        <span class="emphasis"><em>except</em></span> for files saved under
                   8982:        <code class="filename">share/mime/packages</code>.  The former are
                   8983:        handled automatically by
                   8984:        the update-mime-database program, but the latter are
                   8985:        package-dependent and must be removed by the package that
                   8986:        installed them in the first place.</p></li>
1.76      rillig   8987: <li><p>Remove any <code class="filename">share/mime/*</code> directories
1.87      wiz      8988:        from the PLIST.  They will be handled by the shared-mime-info
                   8989:        package.</p></li>
1.75      rillig   8990: </ol></div>
                   8991: </div>
                   8992: <div class="sect2" lang="en">
                   8993: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8994: <a name="intltool"></a>18.6.14. Packages using intltool</h3></div></div></div>
1.93      rillig   8995: <p>If a package uses intltool during its build, add
                   8996:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87      wiz      8997:     which forces it to use the intltool package provided by pkgsrc,
                   8998:     instead of the one bundled with the distribution file.</p>
1.75      rillig   8999: <p>This tracks intltool's build-time dependencies and uses the
1.87      wiz      9000:     latest available version; this way, the package benefits of any
                   9001:     bug fixes that may have appeared since it was released.</p>
1.75      rillig   9002: </div>
                   9003: <div class="sect2" lang="en">
                   9004: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   9005: <a name="startup-scripts"></a>18.6.15. Packages installing startup scripts</h3></div></div></div>
1.75      rillig   9006: <p>If a package contains a rc.d script, it won't be copied into
1.87      wiz      9007:     the startup directory by default, but you can enable it, by adding
                   9008:     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
                   9009:     <code class="filename">/etc/mk.conf</code>. This option will copy the scripts
                   9010:     into <code class="filename">/etc/rc.d</code> when a package is installed, and
                   9011:     it will automatically remove the scripts when the package is
                   9012:     deinstalled.</p>
1.75      rillig   9013: </div>
                   9014: <div class="sect2" lang="en">
                   9015: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   9016: <a name="tex-packages"></a>18.6.16. Packages installing TeX modules</h3></div></div></div>
1.75      rillig   9017: <p>If a package installs TeX packages into the texmf tree,
1.87      wiz      9018:     the <code class="filename">ls-R</code> database of the tree needs to be
                   9019:     updated.</p>
1.75      rillig   9020: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   9021: <h3 class="title">Note</h3>
                   9022: <p>Except the main TeX packages such as teTeX-texmf,
1.87      wiz      9023:     packages should install files
                   9024:     into <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
                   9025:     not <code class="varname">PKG_TEXMFPREFIX</code>.</p>
1.75      rillig   9026: </div>
                   9027: <div class="orderedlist"><ol type="1">
                   9028: <li><p>Include
1.87      wiz      9029:       <code class="filename">../../print/teTeX/module.mk</code> instead
                   9030:       of <code class="filename">../../mk/tex.buildlink3.mk</code>.  This
                   9031:       takes care of rebuilding the <code class="filename">ls-R</code>
                   9032:       database at installation and deinstallation time.</p></li>
1.75      rillig   9033: <li>
                   9034: <p>If your package installs files into a texmf
1.87      wiz      9035:       tree other than the one
                   9036:       at <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
                   9037:       set <code class="varname">TEXMFDIRS</code> to the list of all texmf
                   9038:       trees that need database update.</p>
1.75      rillig   9039: <p>If your package also installs font map files that need
1.87      wiz      9040:       to be registered using <span><strong class="command">updmap</strong></span>,
                   9041:       set <code class="varname">TEX_FONTMAPS</code> to the list of all
                   9042:       such font map files.  Then <span><strong class="command">updmap</strong></span> will
                   9043:       be run automatically at installation/deinstallation to
                   9044:       enable/disable font map files for TeX output
                   9045:       drivers.</p>
1.75      rillig   9046: </li>
1.76      rillig   9047: <li><p>Make sure that none of <code class="filename">ls-R</code>
1.87      wiz      9048:       databases are included in <code class="filename">PLIST</code>, as
                   9049:       they will be removed only by the teTeX-bin package.</p></li>
1.75      rillig   9050: </ol></div>
                   9051: </div>
1.85      jmmv     9052: <div class="sect2" lang="en">
                   9053: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   9054: <a name="emulation-packages"></a>18.6.17. Packages supporting running binaries in
1.87      wiz      9055:     emulation</h3></div></div></div>
                   9056: <p>There are some packages that provide libraries and
                   9057:     executables for running binaries from a one operating system
                   9058:     on a different one (if the latter supports it).  One example
                   9059:     is running Linux binaries on NetBSD.</p>
1.91      rillig   9060: <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      9061:     helps in extracting and packaging Linux rpm packages.</p>
                   9062: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
                   9063:     avoid the <span><strong class="command">check-shlibs</strong></span> target, which tests
                   9064:     if all libraries for each installed executable can be found by
                   9065:     the dynamic linker.  Since the standard dynamic linker is run,
                   9066:     this fails for emulation packages, because the libraries used
                   9067:     by the emulation are not in the standard directories.</p>
                   9068: </div>
                   9069: <div class="sect2" lang="en">
                   9070: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   9071: <a name="hicolor-theme"></a>18.6.18. Packages installing hicolor theme icons</h3></div></div></div>
1.85      jmmv     9072: <p>If a package installs images under the
1.87      wiz      9073:     <code class="filename">share/icons/hicolor</code> and/or updates the
                   9074:     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
                   9075:     database, you need to take some extra steps to make sure that the
                   9076:     shared theme directory is handled appropriately and that the cache
                   9077:     database is rebuilt:</p>
1.85      jmmv     9078: <div class="orderedlist"><ol type="1">
                   9079: <li><p>Include
1.87      wiz      9080:        <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
                   9081: <li><p>Check the <code class="filename">PLIST</code> and remove the
                   9082:        entry that refers to the theme cache.</p></li>
1.85      jmmv     9083: <li><p>Ensure that the PLIST does not remove the shared icon
                   9084:          directories from the <code class="filename">share/icons/hicolor</code>
                   9085:          hierarchy because they will be handled automatically.</p></li>
                   9086: </ol></div>
                   9087: <p>The best way to verify that the PLIST is correct with
                   9088:       respect to the last two points is to regenerate it using
                   9089:       <span><strong class="command">make print-PLIST</strong></span>.</p>
                   9090: </div>
                   9091: <div class="sect2" lang="en">
                   9092: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   9093: <a name="desktop-files"></a>18.6.19. Packages installing desktop files</h3></div></div></div>
1.85      jmmv     9094: <p>If a package installs <code class="filename">.desktop</code> files
                   9095:       under <code class="filename">share/applications</code> and these include
                   9096:       MIME information, you need to take extra steps to ensure that they
                   9097:       are registered into the MIME database:</p>
                   9098: <div class="orderedlist"><ol type="1">
                   9099: <li><p>Include
                   9100:          <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
                   9101: <li><p>Check the PLIST and remove the entry that refers to the
                   9102:          <code class="filename">share/applications/mimeinfo.cache</code> file.
                   9103:          It will be handled automatically.</p></li>
                   9104: </ol></div>
                   9105: <p>The best way to verify that the PLIST is correct with
                   9106:       respect to the last point is to regenerate it using <span><strong class="command">make
                   9107:       print-PLIST</strong></span>.</p>
1.75      rillig   9108: </div>
                   9109: </div>
1.87      wiz      9110: <div class="sect1" lang="en">
                   9111: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9112: <a name="punting"></a>18.7. Marking packages as having problems</h2></div></div></div>
1.87      wiz      9113: <p>In some cases one does not have the time to solve a problem
                   9114:   immediately.  There are currently two ways to declare that one knows
                   9115:   that a package has problems.</p>
                   9116: <div class="itemizedlist"><ul type="disc">
                   9117: <li><p>The first way is to plainly mark it as broken.  For
                   9118:     this, one just sets the variable <code class="varname">BROKEN</code> to the
                   9119:     reason why the package is broken (similar to the
                   9120:     <code class="varname">RESTRICTED</code> variable).  A user trying to build
                   9121:     the package will immediately be shown this message, and the build
                   9122:     will not be even tried.</p></li>
                   9123: <li><p>After each pkgsrc freeze period (a time when the
                   9124:     tree is stabilized and a new pkgsrc branch is cut), the packages
                   9125:     that were not building in the official branch build on the latest
                   9126:     NetBSD release will be marked as broken on that branch.  This is
                   9127:     done by setting the <code class="varname">BROKEN_IN</code> variable to the
                   9128:     branch name (or appending the branch name to it).  If a user tries
                   9129:     to build such a package and the build fails, the user gets a
                   9130:     message that says that the package was broken on the respective
                   9131:     branch(es).</p></li>
                   9132: </ul></div>
                   9133: <p>Both types of packages are removed from pkgsrc in irregular
                   9134:   intervals.</p>
                   9135: </div>
1.75      rillig   9136: </div>
                   9137: <div class="chapter" lang="en">
                   9138: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   9139: <a name="debug"></a>Chapter 19. Debugging</h2></div></div></div>
1.88      wiz      9140: <p>To check out all the gotchas when building a package, here are
                   9141:   the steps that I do in order to get a package working.  Please note
                   9142:   this is basically the same as what was explained in the previous
                   9143:   sections, only with some debugging aids.</p>
1.75      rillig   9144: <div class="itemizedlist"><ul type="disc">
1.88      wiz      9145: <li><p>Be sure to set <code class="varname">PKG_DEVELOPER=1</code> in
                   9146:       <code class="filename">/etc/mk.conf</code></p></li>
1.75      rillig   9147: <li>
1.91      rillig   9148: <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      9149:       create a directory for a new package, change into it, then run
                   9150:       <span><strong class="command">url2pkg</strong></span>:</p>
1.75      rillig   9151: <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>
                   9152: <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>
                   9153: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
                   9154: </li>
1.76      rillig   9155: <li><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
                   9156: <li><p>Fill in the <code class="filename">DESCR</code> file</p></li>
1.87      wiz      9157: <li><p>Run <span><strong class="command">make configure</strong></span></p></li>
1.75      rillig   9158: <li><p>Add any dependencies glimpsed from documentation and the
1.88      wiz      9159:       configure step to the package's
                   9160:       <code class="filename">Makefile</code>.</p></li>
1.75      rillig   9161: <li>
                   9162: <p>Make the package compile, doing multiple rounds of</p>
                   9163: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   9164: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   9165: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
                   9166: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
                   9167: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
                   9168: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
                   9169: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88      wiz      9170: <p>Doing this step as non-root user will ensure that no files
                   9171:       are modified that shouldn't be, especially during the build
                   9172:       phase.  <span><strong class="command">mkpatches</strong></span>,
                   9173:       <span><strong class="command">patchdiff</strong></span> and <span><strong class="command">pkgvi</strong></span> are
1.91      rillig   9174:       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      9175:       package.</p>
1.75      rillig   9176: </li>
1.88      wiz      9177: <li><p>Look at the <code class="filename">Makefile</code>, fix if
1.90      rillig   9178:       necessary; see <a href="#components.Makefile" title="10.1. Makefile">Section 10.1, &#8220;<code class="filename">Makefile</code>&#8221;</a>.</p></li>
1.75      rillig   9179: <li>
1.76      rillig   9180: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75      rillig   9181: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9182: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST &gt;PLIST</code></strong>
                   9183: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
                   9184: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9185: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88      wiz      9186: <p>You usually need to be <code class="username">root</code> to do
                   9187:       this.  Look if there are any files left:</p>
1.75      rillig   9188: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9189: <p>If this reveals any files that are missing in
1.88      wiz      9190:       <code class="filename">PLIST</code>, add them.</p>
1.75      rillig   9191: </li>
                   9192: <li>
1.88      wiz      9193: <p>Now that the <code class="filename">PLIST</code> is OK, install the
                   9194:       package again and make a binary package:</p>
1.75      rillig   9195: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
                   9196: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
                   9197: </li>
                   9198: <li>
                   9199: <p>Delete the installed package:</p>
1.88      wiz      9200: <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   9201: </li>
                   9202: <li>
1.88      wiz      9203: <p>Repeat the above <span><strong class="command">make print-PLIST</strong></span>
                   9204:       command, which shouldn't find anything now:</p>
1.75      rillig   9205: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9206: </li>
                   9207: <li>
                   9208: <p>Reinstall the binary package:</p>
1.93      rillig   9209: <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   9210: </li>
1.88      wiz      9211: <li><p>Play with it.  Make sure everything works.</p></li>
1.75      rillig   9212: <li>
1.91      rillig   9213: <p>Run <span><strong class="command">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      9214:       reports:</p>
1.75      rillig   9215: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
                   9216: </li>
1.90      rillig   9217: <li><p>Submit (or commit, if you have cvs access); see <a href="#submit" title="Chapter 20. Submitting and Committing">Chapter 20, <i>Submitting and Committing</i></a>.</p></li>
1.75      rillig   9218: </ul></div>
                   9219: </div>
                   9220: <div class="chapter" lang="en">
                   9221: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   9222: <a name="submit"></a>Chapter 20. Submitting and Committing</h2></div></div></div>
1.75      rillig   9223: <div class="toc">
                   9224: <p><b>Table of Contents</b></p>
                   9225: <dl>
1.90      rillig   9226: <dt><span class="sect1"><a href="#submitting-binary-packages">20.1. Submitting binary packages</a></span></dt>
                   9227: <dt><span class="sect1"><a href="#submitting-your-package">20.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   9228: <dt><span class="sect1"><a href="#general-notes-for-changes">20.3. General notes when adding, updating, or removing packages</a></span></dt>
                   9229: <dt><span class="sect1"><a href="#committing-importing">20.4. Committing: Importing a package into CVS</a></span></dt>
                   9230: <dt><span class="sect1"><a href="#updating-package">20.5. Updating a package to a newer version</a></span></dt>
                   9231: <dt><span class="sect1"><a href="#moving-package">20.6. Moving a package in pkgsrc</a></span></dt>
1.75      rillig   9232: </dl>
                   9233: </div>
                   9234: <div class="sect1" lang="en">
                   9235: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9236: <a name="submitting-binary-packages"></a>20.1. Submitting binary packages</h2></div></div></div>
1.75      rillig   9237: <p>Our policy is that we accept binaries only from pkgsrc
                   9238:        developers to guarantee that the packages don't contain any
                   9239:        trojan horses etc. This is not to annoy anyone but rather to
                   9240:        protect our users! You're still free to put up your home-made
                   9241:        binary packages and tell the world where to get them. NetBSD
                   9242:        developers doing bulk builds and wanting to upload them please
                   9243:        see <a href="#bulk-upload" title="6.3.8. Uploading results of a bulk build">Section 6.3.8, &#8220;Uploading results of a bulk build&#8221;</a>.</p>
                   9244: </div>
                   9245: <div class="sect1" lang="en">
                   9246: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9247: <a name="submitting-your-package"></a>20.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75      rillig   9248: <p>First, check that your package is complete, compiles and
1.90      rillig   9249:        runs well; see <a href="#debug" title="Chapter 19. Debugging">Chapter 19, <i>Debugging</i></a> and the rest of this
1.75      rillig   9250:        document. Next, generate an uuencoded gzipped <a 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   9251:        archive that contains all files that make up the package.
1.87      wiz      9252:        Finally, send this package to the pkgsrc bug tracking system,
                   9253:        either with the <a 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
                   9254:        that, go to the web page
                   9255:        <a href="http://www.NetBSD.org/Misc/send-pr.html" target="_top">http://www.NetBSD.org/Misc/send-pr.html</a>,
                   9256:        which contains some instructions and a link to a form, where you
                   9257:        can submit packages.</p>
                   9258: <p>In the form of the problem report, the category should be
                   9259:        &#8220;<span class="quote">pkg</span>&#8221;, the synopsis should include the package name
                   9260:        and version number, and the description field should contain a
                   9261:        short description of your package (contents of the COMMENT
                   9262:        variable or DESCR file are OK). The uuencoded package data should
                   9263:        go into the &#8220;<span class="quote">fix</span>&#8221; field.</p>
1.75      rillig   9264: <p>If you want to submit several packages, please send a
                   9265:        separate PR for each one, it's easier for us to track things
                   9266:        that way.</p>
                   9267: <p>Alternatively, you can also import new packages into
                   9268:        pkgsrc-wip (&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;); see the
                   9269:        homepage at <a href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
                   9270:        for details.</p>
                   9271: </div>
                   9272: <div class="sect1" lang="en">
                   9273: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9274: <a name="general-notes-for-changes"></a>20.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75      rillig   9275: <p>Please note all package additions, updates, moves, and
1.93      rillig   9276:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75      rillig   9277:        important to keep this file up to date and conforming to the
                   9278:        existing format, because it will be used by scripts to
                   9279:        automatically update pages on <a href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
                   9280:        sites. Additionally, check the
1.76      rillig   9281:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75      rillig   9282:        for the package you updated or removed, in case it was mentioned
                   9283:        there.</p>
                   9284: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   9285:        bumped, the change should appear in
1.93      rillig   9286:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75      rillig   9287:        related or otherwise relevant. Mass bumps that result from a
                   9288:        dependency being updated should not be mentioned. In all other
                   9289:        cases it's the developer's decision.</p>
                   9290: <p>There is a make target that helps in creating proper
1.93      rillig   9291:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span><strong class="command">make
1.75      rillig   9292:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   9293:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93      rillig   9294:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75      rillig   9295:   file is up-to-date (to avoid having to resolve conflicts later-on)
                   9296:   and then to <span><strong class="command">cd</strong></span> to the package directory.  For
                   9297:   package updates, <span><strong class="command">make changes-entry</strong></span> is enough.
                   9298:   For new packages, or package moves or removals, set the
                   9299:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   9300:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.76      rillig   9301:   in <code class="filename">/etc/mk.conf</code> if your local login name is
1.75      rillig   9302:   not the same as your NetBSD login name. Don't forget to commit
1.93      rillig   9303:   the changes to <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>!</p>
1.75      rillig   9304: </div>
                   9305: <div class="sect1" lang="en">
                   9306: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9307: <a name="committing-importing"></a>20.4. Committing: Importing a package into CVS</h2></div></div></div>
1.87      wiz      9308: <p>This section is only of interest for pkgsrc developers with write
1.75      rillig   9309:   access to the pkgsrc repository. Please remember that cvs
                   9310:   imports files relative to the current working directory, and that
                   9311:   the pathname that you
                   9312:   give the <span><strong class="command">cvs import</strong></span> command is so that it knows where
                   9313:   to place the files in the repository.  Newly created packages should be
                   9314:   imported with a vendor tag of &#8220;<span class="quote">TNF</span>&#8221; and a release tag of
1.87      wiz      9315:   &#8220;<span class="quote">pkgsrc-base</span>&#8221;, e.g:</p>
1.75      rillig   9316: <pre class="programlisting">
                   9317:     <code class="prompt">$</code> cd .../pkgsrc/category/pkgname
                   9318:     <code class="prompt">$</code> cvs import pkgsrc/category/pkgname TNF pkgsrc-base
                   9319: </pre>
1.87      wiz      9320: <p>Remember to move the directory from which you imported out of
1.75      rillig   9321:   the way, or cvs will complain the next time you &#8220;<span class="quote">cvs
                   9322:   update</span>&#8221; your source tree.  Also don't forget to add the new
1.87      wiz      9323:   package to the category's <code class="filename">Makefile</code>.</p>
                   9324: <p>The commit message of the initial import should include part of the
1.76      rillig   9325:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87      wiz      9326:   what the package is/does.</p>
                   9327: <p>For new packages, &#8220;<span class="quote">cvs import</span>&#8221; is preferred to &#8220;<span class="quote">cvs
1.75      rillig   9328:   add</span>&#8221; because the former gets everything with a single command,
1.87      wiz      9329:   and provides a consistent tag.</p>
1.75      rillig   9330: </div>
                   9331: <div class="sect1" lang="en">
                   9332: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9333: <a name="updating-package"></a>20.5. Updating a package to a newer version</h2></div></div></div>
1.87      wiz      9334: <p>Please always put a concise, appropriate and relevant summary of the
1.75      rillig   9335:   changes between old and new versions into the commit log when updating
1.87      wiz      9336:   a package. There are various reasons for this:</p>
1.75      rillig   9337: <div class="itemizedlist"><ul type="disc">
1.87      wiz      9338: <li><p>A URL is volatile, and can change over time. It may go away completely
                   9339:   or its information may be overwritten by newer information.</p></li>
                   9340: <li><p>Having the change information between old and new versions in our CVS
                   9341:   repository is very useful for people who use either cvs or anoncvs.</p></li>
                   9342: <li><p>Having the change information between old and new versions in our CVS
1.75      rillig   9343:   repository is very useful for people who read the pkgsrc-changes mailing
                   9344:   list, so that they can make tactical decisions about when to upgrade
1.87      wiz      9345:   the package.</p></li>
1.75      rillig   9346: </ul></div>
1.87      wiz      9347: <p>Please also recognize that, just because a new version of a package
1.75      rillig   9348:   has been released, it should not automatically be upgraded in the CVS
                   9349:   repository.  We prefer to be conservative in the packages that are
                   9350:   included in pkgsrc - development or beta packages are not really the
                   9351:   best thing for most places in which pkgsrc is used. Please use your
                   9352:   judgement about what should go into pkgsrc, and bear in mind that
1.87      wiz      9353:   stability is to be preferred above new and possibly untested features.</p>
1.75      rillig   9354: </div>
                   9355: <div class="sect1" lang="en">
                   9356: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9357: <a name="moving-package"></a>20.6. Moving a package in pkgsrc</h2></div></div></div>
1.75      rillig   9358: <div class="orderedlist"><ol type="1">
                   9359: <li><p>Make a copy of the directory somewhere else.</p></li>
                   9360: <li>
                   9361: <p>Remove all CVS dirs.</p>
1.87      wiz      9362: <p>Alternatively to the first two steps you can also do:</p>
1.75      rillig   9363: <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      9364: <p>and use that for further work.</p>
1.75      rillig   9365: </li>
                   9366: <li><p>Fix <code class="varname">CATEGORIES</code> and any
                   9367: <code class="varname">DEPENDS</code> paths that just did &#8220;<span class="quote">../package</span>&#8221;
                   9368: instead of &#8220;<span class="quote">../../category/package</span>&#8221;.</p></li>
                   9369: <li><p><span><strong class="command">cvs import</strong></span> the modified package in the new
                   9370: place.</p></li>
                   9371: <li>
                   9372: <p>Check if any package depends on it:
                   9373: </p>
                   9374: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   9375: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   9376: </li>
                   9377: <li><p>Fix paths in packages from step 5 to point to new location.</p></li>
                   9378: <li><p><span><strong class="command">cvs rm (-f)</strong></span> the package at the old location.</p></li>
1.76      rillig   9379: <li><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   9380: <li><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
1.75      rillig   9381: <li>
                   9382: <p>Commit the changed and removed files:</p>
                   9383: <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      9384: <p>(and any packages from step 5, of course).</p>
1.75      rillig   9385: </li>
                   9386: </ol></div>
                   9387: </div>
                   9388: </div>
                   9389: <div class="chapter" lang="en">
                   9390: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   9391: <a name="devfaq"></a>Chapter 21. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   9392: <p>This section contains the answers to questions that may
                   9393:        arise when you are writing a package. If you don't find your
                   9394:        question answered here, first have a look in the other chapters,
                   9395:        and if you still don't have the answer, ask on the
                   9396:        <code class="literal">pkgsrc-users</code> mailing list.</p>
                   9397: <div class="qandaset">
                   9398: <dl>
1.93      rillig   9399: <dt>21.1. <a href="#devfaq.makeflags">What is the difference between
1.75      rillig   9400:        MAKEFLAGS, .MAKEFLAGS and
                   9401:        MAKE_FLAGS?</a>
                   9402: </dt>
1.93      rillig   9403: <dt>21.2. <a href="#devfaq.make">What is the difference between
1.75      rillig   9404:        MAKE, GMAKE and
                   9405:        MAKE_PROGRAM?</a>
                   9406: </dt>
1.93      rillig   9407: <dt>21.3. <a href="#devfaq.cc">What is the difference between
1.75      rillig   9408:        CC, PKG_CC and
                   9409:        PKGSRC_COMPILER?</a>
                   9410: </dt>
1.93      rillig   9411: <dt>21.4. <a href="#devfaq.bl3flags">What is the difference between
1.75      rillig   9412:        BUILDLINK_LDFLAGS,
                   9413:        BUILDLINK_LDADD and
                   9414:        BUILDLINK_LIBS?</a>
                   9415: </dt>
1.93      rillig   9416: <dt>21.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75      rillig   9417:        VARNAME=BUILDLINK_PREFIX.foo
                   9418:        say it's empty?</a>
                   9419: </dt>
1.93      rillig   9420: <dt>21.6. <a href="#devfaq.master_sites">What does
1.78      rillig   9421:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   9422:        don't understand the := inside
                   9423:        it.</a>
                   9424: </dt>
1.93      rillig   9425: <dt>21.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78      rillig   9426:        developers?</a>
                   9427: </dt>
1.93      rillig   9428: <dt>21.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80      rillig   9429:        documentation?</a>
                   9430: </dt>
1.92      rillig   9431: <dt>21.9. <a href="#devfaq.too-much-time">I have a little time to kill.  What shall I
                   9432: do?</a>
                   9433: </dt>
1.75      rillig   9434: </dl>
                   9435: <table border="0" summary="Q and A Set">
                   9436: <col align="left" width="1%">
                   9437: <tbody>
                   9438: <tr class="question">
                   9439: <td align="left" valign="top">
1.97    ! rillig   9440: <a name="devfaq.makeflags"></a><a name="id2686192"></a><b>21.1.</b>
1.75      rillig   9441: </td>
                   9442: <td align="left" valign="top"><p>What is the difference between
                   9443:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   9444:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   9445: </tr>
                   9446: <tr class="answer">
1.91      rillig   9447: <td align="left" valign="top"></td>
1.75      rillig   9448: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
                   9449:        to the pkgsrc-internal invocations of <a 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
                   9450:        <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
                   9451:        the <code class="varname">MAKE_PROGRAM</code> when building the
                   9452:        package. [FIXME: What is .MAKEFLAGS for?]</p></td>
                   9453: </tr>
                   9454: <tr class="question">
                   9455: <td align="left" valign="top">
1.97    ! rillig   9456: <a name="devfaq.make"></a><a name="id2686298"></a><b>21.2.</b>
1.75      rillig   9457: </td>
                   9458: <td align="left" valign="top"><p>What is the difference between
                   9459:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   9460:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   9461: </tr>
                   9462: <tr class="answer">
1.91      rillig   9463: <td align="left" valign="top"></td>
1.75      rillig   9464: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
                   9465:        <a 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
                   9466:        infrastructure. <code class="varname">GMAKE</code> is the path to GNU
                   9467:        Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
                   9468:        use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
                   9469:        Make program that is used for building the
                   9470:        package.</p></td>
                   9471: </tr>
                   9472: <tr class="question">
                   9473: <td align="left" valign="top">
1.97    ! rillig   9474: <a name="devfaq.cc"></a><a name="id2686339"></a><b>21.3.</b>
1.75      rillig   9475: </td>
                   9476: <td align="left" valign="top"><p>What is the difference between
                   9477:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   9478:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   9479: </tr>
                   9480: <tr class="answer">
1.91      rillig   9481: <td align="left" valign="top"></td>
1.75      rillig   9482: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
                   9483:        compiler, which can be configured by the pkgsrc user.
                   9484:        <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
                   9485:        <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
                   9486:        path to a compiler, but the type of compiler that should be
1.76      rillig   9487:        used. See <code class="filename">mk/compiler.mk</code> for more
1.75      rillig   9488:        information about the latter variable.</p></td>
                   9489: </tr>
                   9490: <tr class="question">
                   9491: <td align="left" valign="top">
1.97    ! rillig   9492: <a name="devfaq.bl3flags"></a><a name="id2686446"></a><b>21.4.</b>
1.75      rillig   9493: </td>
                   9494: <td align="left" valign="top"><p>What is the difference between
                   9495:        <code class="varname">BUILDLINK_LDFLAGS</code>,
                   9496:        <code class="varname">BUILDLINK_LDADD</code> and
                   9497:        <code class="varname">BUILDLINK_LIBS</code>?</p></td>
                   9498: </tr>
                   9499: <tr class="answer">
1.91      rillig   9500: <td align="left" valign="top"></td>
1.75      rillig   9501: <td align="left" valign="top"><p>[FIXME]</p></td>
                   9502: </tr>
                   9503: <tr class="question">
                   9504: <td align="left" valign="top">
1.97    ! rillig   9505: <a name="devfaq.bl3prefix"></a><a name="id2686467"></a><b>21.5.</b>
1.75      rillig   9506: </td>
                   9507: <td align="left" valign="top"><p>Why does <span><strong class="command">make show-var
                   9508:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   9509:        say it's empty?</p></td>
                   9510: </tr>
                   9511: <tr class="answer">
1.91      rillig   9512: <td align="left" valign="top"></td>
1.75      rillig   9513: <td align="left" valign="top"><p>For optimization reasons, some variables are only
                   9514:        available in the &#8220;<span class="quote">wrapper</span>&#8221; phase and later. To
                   9515:        &#8220;<span class="quote">simulate</span>&#8221; the wrapper phase, append
                   9516:        <span><strong class="command">PKG_PHASE=wrapper</strong></span> to the above
                   9517:        command.</p></td>
                   9518: </tr>
1.78      rillig   9519: <tr class="question">
                   9520: <td align="left" valign="top">
1.97    ! rillig   9521: <a name="devfaq.master_sites"></a><a name="id2686497"></a><b>21.6.</b>
1.78      rillig   9522: </td>
                   9523: <td align="left" valign="top"><p>What does
                   9524:        <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   9525:        don't understand the <code class="literal">:=</code> inside
                   9526:        it.</p></td>
                   9527: </tr>
                   9528: <tr class="answer">
1.91      rillig   9529: <td align="left" valign="top"></td>
1.78      rillig   9530: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
                   9531:        assignment operator, like you might expect at first sight.
                   9532:        Instead, it is a degenerate form of
                   9533:        <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
                   9534:        which is documented in the <a 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
                   9535:        may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
                   9536:        case of <code class="varname">MASTER_SITE_*</code>,
                   9537:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   9538:        <em class="replaceable"><code>new_string</code></em> is
                   9539:        <code class="literal">package/</code>. That's where the
                   9540:        <code class="literal">:</code> and the <code class="literal">=</code> fall
                   9541:        together.</p></td>
                   9542: </tr>
                   9543: <tr class="question">
                   9544: <td align="left" valign="top">
1.97    ! rillig   9545: <a name="devfaq.mailinglists"></a><a name="id2686573"></a><b>21.7.</b>
1.78      rillig   9546: </td>
                   9547: <td align="left" valign="top"><p>Which mailing lists are there for package
                   9548:        developers?</p></td>
                   9549: </tr>
                   9550: <tr class="answer">
1.91      rillig   9551: <td align="left" valign="top"></td>
1.78      rillig   9552: <td align="left" valign="top"><div class="variablelist"><dl>
                   9553: <dt><span class="term"><a href="http://www.NetBSD.org/MailingLists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
                   9554: <dd><p>This is a list for technical discussions related
                   9555:        to pkgsrc development, e.g. soliciting feedback for changes to
                   9556:        pkgsrc infrastructure, proposed new features, questions related
                   9557:        to porting pkgsrc to a new platform, advice for maintaining a
                   9558:        package, patches that affect many packages, help requests moved
                   9559:        from pkgsrc-users when an infrastructure bug is found,
                   9560:        etc.</p></dd>
                   9561: <dt><span class="term"><a href="http://www.NetBSD.org/MailingLists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
                   9562: <dd><p>All bug reports in category "pkg" sent with
                   9563:        <a 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
                   9564:        directly; use one of the other mailing
                   9565:        lists.</p></dd>
                   9566: </dl></div></td>
                   9567: </tr>
1.80      rillig   9568: <tr class="question">
                   9569: <td align="left" valign="top">
1.97    ! rillig   9570: <a name="devfaq.documentation"></a><a name="id2686612"></a><b>21.8.</b>
1.80      rillig   9571: </td>
                   9572: <td align="left" valign="top"><p>Where is the pkgsrc
                   9573:        documentation?</p></td>
                   9574: </tr>
                   9575: <tr class="answer">
1.91      rillig   9576: <td align="left" valign="top"></td>
1.80      rillig   9577: <td align="left" valign="top">
                   9578: <p>There are many places where you can find
                   9579:        documentation about pkgsrc:</p>
                   9580: <div class="itemizedlist"><ul type="disc">
                   9581: <li><p>The pkgsrc guide (this document) is a collection
                   9582:        of chapters that explain large parts of pkgsrc, but some
                   9583:        chapters tend to be outdated. Which ones they are is hard to
                   9584:        say.</p></li>
                   9585: <li><p>On the mailing list archives (see <a href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>), you can find discussions
                   9586:        about certain features, announcements of new parts of the pkgsrc
                   9587:        infrastructure and sometimes even announcements that a certain
                   9588:        feature has been marked as obsolete. The benefit here is that
                   9589:        each message has a date appended to it.</p></li>
                   9590: <li><p>Many of the files in the
                   9591:        <code class="filename">mk/</code> directory start with a comment that
                   9592:        describes the purpose of the file and how it can be used by the
1.92      rillig   9593:        pkgsrc user and package authors. An easy way to find this
                   9594:        documentation is to run <span><strong class="command">bmake
                   9595:        help</strong></span>.</p></li>
1.80      rillig   9596: <li><p>The CVS log messages are a rich source of
                   9597:        information, but they tend to be highly abbreviated, especially
                   9598:        for actions that occur often. Some contain a detailed
                   9599:        description of what has changed, but they are geared towards the
                   9600:        other pkgsrc developers, not towards an average pkgsrc user.
                   9601:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   9602:        don't know what has been before, these messages may not be worth
                   9603:        too much to you.</p></li>
                   9604: <li><p>Some parts of pkgsrc are only &#8220;<span class="quote">implicitly
                   9605:        documented</span>&#8221;, that is the documentation exists only in the
                   9606:        mind of the developer who wrote the code. To get this
1.93      rillig   9607:        information, use the <span><strong class="command">cvs annotate</strong></span> command
1.80      rillig   9608:        to see who has written it and ask on the
                   9609:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   9610:        find your questions later (see above). To be sure that the
                   9611:        developer in charge reads the mail, you may CC him or
                   9612:        her.</p></li>
                   9613: </ul></div>
                   9614: </td>
                   9615: </tr>
1.92      rillig   9616: <tr class="question">
                   9617: <td align="left" valign="top">
1.97    ! rillig   9618: <a name="devfaq.too-much-time"></a><a name="id2686674"></a><b>21.9.</b>
1.92      rillig   9619: </td>
                   9620: <td align="left" valign="top"><p>I have a little time to kill.  What shall I
                   9621: do?</p></td>
                   9622: </tr>
                   9623: <tr class="answer">
                   9624: <td align="left" valign="top"></td>
                   9625: <td align="left" valign="top">
1.93      rillig   9626: <p>This is not really an FAQ yet, but here's the answer
1.92      rillig   9627: anyway.</p>
                   9628: <div class="itemizedlist"><ul type="disc">
                   9629: <li><p>Run <span><strong class="command">pkg_chk -N</strong></span> (from the
                   9630:     <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
                   9631:     will tell you about newer versions of installed packages that are
                   9632:     available, but not yet updated in pkgsrc.</p></li>
                   9633: <li><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
                   9634:     &mdash; it contains a list of suggested new packages and a list of
                   9635:     cleanups and enhancements for pkgsrc that would be nice to
                   9636:     have.</p></li>
                   9637: <li><p>Review packages for which review was requested on
                   9638:     the <a href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
                   9639:     mailing list.</p></li>
                   9640: </ul></div>
                   9641: </td>
                   9642: </tr>
1.75      rillig   9643: </tbody>
                   9644: </table>
                   9645: </div>
                   9646: </div>
1.85      jmmv     9647: <div class="chapter" lang="en">
                   9648: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   9649: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
1.85      jmmv     9650: <div class="toc">
                   9651: <p><b>Table of Contents</b></p>
                   9652: <dl>
1.90      rillig   9653: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                   9654: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                   9655: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                   9656: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
1.85      jmmv     9657: </dl>
                   9658: </div>
                   9659: <p>Quoting <a href="http://www.gnome.org/" target="_top">GNOME's web
                   9660: site</a>:</p>
                   9661: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   9662:   environment, an intuitive and attractive desktop for users, and the
                   9663:   GNOME development platform, an extensive framework for building
                   9664:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   9665: <p>pkgsrc provides a seamless way to automatically build and install
                   9666: a complete GNOME environment <span class="emphasis"><em>under many different
                   9667: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   9668: the most advanced build and packaging systems for GNOME due to its
                   9669: included technologies buildlink3, the wrappers and tools framework and
                   9670: automatic configuration file management.  Lots of efforts are put into
                   9671: achieving a completely clean deinstallation of installed software
                   9672: components.</p>
                   9673: <p>Given that pkgsrc is <a href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
                   9674: the above also means that great efforts are put into making GNOME work
                   9675: under this operating system.  Recently, <a href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
                   9676: pkgsrc as its preferred packaging system, contributing lots of
                   9677: portability fixes to make GNOME build and install under it.</p>
                   9678: <p>This chapter is aimed at pkgsrc developers and other people
                   9679: interested in helping our GNOME porting and packaging efforts.  It
                   9680: provides instructions on how to manage the existing packages and some
                   9681: important information regarding their internals.</p>
                   9682: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   9683: <h3 class="title">We need your help!</h3>
                   9684: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
                   9685:   and GNOME and are willing to learn new exciting stuff, please jump
                   9686:   straight to the <a href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
                   9687:   work</a> list!  There is still a long way to go to get a
                   9688:   fully-functional GNOME desktop under NetBSD and we need your help to
                   9689:   achieve it!</p>
                   9690: </div>
                   9691: <div class="sect1" lang="en">
                   9692: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9693: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
1.85      jmmv     9694: <p>pkgsrc includes three GNOME-related meta packages:</p>
                   9695: <div class="itemizedlist"><ul type="disc">
1.91      rillig   9696: <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     9697:     the core GNOME desktop environment.  It only includes the necessary
                   9698:     bits to get it to boot correctly, although it may lack important
                   9699:     functionality for daily operation.  The idea behind this package is
                   9700:     to let end users build their own configurations on top of this one,
                   9701:     first installing this meta package to achieve a functional setup and
                   9702:     then adding individual applications.</p></li>
1.91      rillig   9703: <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     9704:     complete installation of the GNOME platform and desktop as defined
                   9705:     by the GNOME project; this is based on the components distributed in
                   9706:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   9707:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   9708:     official FTP server.  Developer-only tools found in those
                   9709:     directories are not installed unless required by some other
                   9710:     component to work properly.  Similarly, packages from the bindings
                   9711:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   9712:     in unless required as a dependency for an end-user component.  This
1.91      rillig   9713:     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>
                   9714: <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     9715:     Installs all the tools required to build a GNOME component when
                   9716:     fetched from the CVS repository.  These are required to let the
                   9717:     <span><strong class="command">autogen.sh</strong></span> scripts work appropriately.</p></li>
                   9718: </ul></div>
                   9719: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   9720: sorted in a way that eases updates: a package may depend on other
                   9721: packages listed before it but not on any listed after it.  It is very
                   9722: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   9723: change it to alphabetical sorting!</em></span></p>
                   9724: </div>
                   9725: <div class="sect1" lang="en">
                   9726: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9727: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
1.85      jmmv     9728: <p>Almost all GNOME applications are written in C and use a common
                   9729: set of tools as their build system.  Things get different with the new
                   9730: bindings to other languages (such as Python), but the following will
                   9731: give you a general idea on the minimum required tools:</p>
                   9732: <div class="itemizedlist"><ul type="disc">
                   9733: <li>
                   9734: <p>Almost all GNOME applications use the GNU Autotools as their
                   9735:     build system.  As a general rule you will need to tell this to your
                   9736:     package:</p>
                   9737: <pre class="programlisting">GNU_CONFIGURE=yes
                   9738: USE_LIBTOOL=yes
                   9739: USE_TOOLS+=gmake</pre>
                   9740: </li>
                   9741: <li>
                   9742: <p>If the package uses pkg-config to detect dependencies, add this
                   9743:     tool to the list of required utilities:</p>
                   9744: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.91      rillig   9745: <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     9746:     the end of the build process to ensure that you did not miss to
                   9747:     specify any dependency in your package and that the version
                   9748:     requirements are all correct.</p>
                   9749: </li>
1.93      rillig   9750: <li><p>If the package uses intltool, be sure to add
                   9751:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85      jmmv     9752:     to handle dependencies and to force the package to use the latest
                   9753:     available version.</p></li>
                   9754: <li>
                   9755: <p>If the package uses gtk-doc (a documentation generation
                   9756:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   9757:     tool is rather big and the distfile should come with pregenerated
                   9758:     documentation anyway; if it does not, it is a bug that you ought to
                   9759:     report.  For such packages you should disable gtk-doc (unless it is
1.89      rillig   9760:     the default):</p>
                   9761: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
                   9762: <p>The default location of installed HTML files
                   9763:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   9764:     and should not be changed unless the package insists on installing
                   9765:     them somewhere else.  Otherwise programs as
                   9766:     <span><strong class="command">devhelp</strong></span> will not be able to open them.  You can
                   9767:     do that with an entry similar to:</p>
                   9768: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
1.85      jmmv     9769: </li>
                   9770: </ul></div>
                   9771: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   9772: files under the installation prefix to maintain databases.  In this
                   9773: context, shared means that those exact same directories and files are
                   9774: used among several different packages, leading to conflicts in the
                   9775: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   9776: handle the most common cases, so you have to forget about using
                   9777: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   9778: omitting shared files from them.  If you find yourself doing those,
                   9779: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   9780: <p>The following table lists the common situations that result in
                   9781: using shared directories or files.  For each of them, the appropriate
                   9782: solution is given.  After applying the solution be sure to
                   9783: <span class="emphasis"><em>regenerate the package's file list</em></span> with
                   9784: <span><strong class="command">make print-PLIST</strong></span> and ensure it is correct.</p>
                   9785: <div class="table">
1.90      rillig   9786: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
1.91      rillig   9787: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
1.85      jmmv     9788: <colgroup>
                   9789: <col>
                   9790: <col>
                   9791: </colgroup>
                   9792: <thead><tr>
                   9793: <th>If the package...</th>
                   9794: <th>Then...</th>
                   9795: </tr></thead>
                   9796: <tbody>
                   9797: <tr>
                   9798: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.90      rillig   9799: <td>See <a href="#scrollkeeper-data-files" title="18.6.9. Packages installing scrollkeeper data files">Section 18.6.9, &#8220;Packages installing scrollkeeper data files&#8221;</a>.</td>
1.85      jmmv     9800: </tr>
                   9801: <tr>
                   9802: <td>Installs icons under the
                   9803:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   9804:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.90      rillig   9805: <td>See <a href="#hicolor-theme" title="18.6.18. Packages installing hicolor theme icons">Section 18.6.18, &#8220;Packages installing hicolor theme icons&#8221;</a>.</td>
1.85      jmmv     9806: </tr>
                   9807: <tr>
                   9808: <td>Installs files under
                   9809:         <code class="filename">share/mime/packages</code>.</td>
1.90      rillig   9810: <td>See <a href="#mime-database" title="18.6.13. Packages installing extensions to the MIME database">Section 18.6.13, &#8220;Packages installing extensions to the MIME database&#8221;</a>.</td>
1.85      jmmv     9811: </tr>
                   9812: <tr>
                   9813: <td>Installs <code class="filename">.desktop</code> files under
                   9814:         <code class="filename">share/applications</code> and these include MIME
                   9815:         information.</td>
1.90      rillig   9816: <td>See <a href="#desktop-files" title="18.6.19. Packages installing desktop files">Section 18.6.19, &#8220;Packages installing desktop files&#8221;</a>.</td>
1.85      jmmv     9817: </tr>
                   9818: </tbody>
1.91      rillig   9819: </table></div>
1.85      jmmv     9820: </div>
1.91      rillig   9821: <br class="table-break">
1.85      jmmv     9822: </div>
                   9823: <div class="sect1" lang="en">
                   9824: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9825: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
1.85      jmmv     9826: <p>When seeing GNOME as a whole, there are two kinds of
                   9827: updates:</p>
                   9828: <div class="variablelist"><dl>
                   9829: <dt><span class="term">Major update</span></dt>
                   9830: <dd>
                   9831: <p>Given that there is still a very long way for GNOME 3 (if it
                   9832:       ever appears), we consider a major update one that goes from a
                   9833:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   9834:       where <code class="literal">Y</code> is even and greater than
                   9835:       <code class="literal">X</code>.  These are hard to achieve because they
                   9836:       introduce lots of changes in the components' code and almost all
                   9837:       GNOME distfiles are updated to newer versions.  Some of them can
                   9838:       even break API and ABI compatibility with the previous major
                   9839:       version series.  As a result, the update needs to be done all at
                   9840:       once to minimize breakage.</p>
                   9841: <p>A major update typically consists of around 80 package
                   9842:       updates and the addition of some new ones.</p>
                   9843: </dd>
                   9844: <dt><span class="term">Minor update</span></dt>
                   9845: <dd>
                   9846: <p>We consider a minor update one that goes from a
                   9847:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   9848:       one where <code class="literal">Y</code> is greater than
                   9849:       <code class="literal">X</code>.  These are easy to achieve because they do
                   9850:       not update all GNOME components, can be done in an incremental way
                   9851:       and do not break API nor ABI compatibility.</p>
                   9852: <p>A minor update typically consists of around 50 package
                   9853:       updates, although the numbers here may vary a lot.</p>
                   9854: </dd>
                   9855: </dl></div>
                   9856: <p>In order to update the GNOME components in pkgsrc to a new stable
                   9857: release (either major or minor), the following steps should be
                   9858: followed:</p>
                   9859: <div class="orderedlist"><ol type="1">
                   9860: <li>
                   9861: <p>Get a list of all the tarballs that form the new release by
                   9862:     using the following commands.  These will leave the full list of the
                   9863:     components's distfiles into the <code class="filename">list.txt</code>
                   9864:     file:</p>
1.88      wiz      9865: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85      jmmv     9866:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   9867:     awk '{ print $9 }' &gt;list.txt</code></strong>
1.88      wiz      9868: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85      jmmv     9869:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   9870:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
                   9871: </li>
                   9872: <li><p>Open each meta package's <code class="filename">Makefile</code> and
                   9873:     bump their version to the release you are updating them to.  The
                   9874:     three meta packages should be always consistent with versioning.
                   9875:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   9876:     in them.</p></li>
                   9877: <li>
                   9878: <p>For each meta package, update all its
                   9879:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   9880:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   9881:     newer version (even if found in the FTP) because the meta packages
                   9882:     are supposed to list the exact versions that form a specific GNOME
                   9883:     release.  Exceptions are permitted here if a newer version solves a
                   9884:     serious issue in the overall desktop experience; these typically
                   9885:     come in the form of a revision bump in pkgsrc, not in newer versions
                   9886:     from the developers.</p>
                   9887: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   9888:     should be updated to the latest version available (if found in
                   9889:     pkgsrc).  This is the case, for example, of the dependencies on the
1.91      rillig   9890:     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     9891: </li>
                   9892: <li>
                   9893: <p>Generate a patch from the modified meta packages and extract the
                   9894:     list of "new" lines.  This will provide you an outline on what
                   9895:     packages need to be updated in pkgsrc and in what order:</p>
1.93      rillig   9896: <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     9897: </li>
                   9898: <li><p>For major desktop updates it is recommended to zap all your
                   9899:     installed packages and start over from scratch at this point.</p></li>
                   9900: <li><p>Now comes the longest step by far: iterate over the contents
                   9901:     of <code class="filename">todo.txt</code> and update the packages listed in
                   9902:     it in order.  For major desktop updates none of these should be
1.93      rillig   9903:     committed until the entire set is completed because there are chances
1.85      jmmv     9904:     of breaking not-yet-updated packages.</p></li>
                   9905: <li><p>Once the packages are up to date and working, commit them to
                   9906:     the tree one by one with appropriate log messages.  At the end,
                   9907:     commit the three meta package updates and all the corresponding
                   9908:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
                   9909:     <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>
                   9910: </ol></div>
                   9911: </div>
                   9912: <div class="sect1" lang="en">
                   9913: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9914: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
1.85      jmmv     9915: <p>GNOME is a very big component in pkgsrc which approaches 100
                   9916: packages.  Please, it is very important that you always, always,
                   9917: <span class="strong"><strong>always</strong></span> feed back any portability
1.93      rillig   9918: fixes you do to a GNOME package to the mainstream developers (see <a href="#components.patches.feedback" title="10.3.5. Feedback to the author">Section 10.3.5, &#8220;Feedback to the author&#8221;</a>).  This is the only way to get
1.85      jmmv     9919: their attention on portability issues and to ensure that future versions
                   9920: can be built out-of-the box on NetBSD.  The less custom patches in
                   9921: pkgsrc, the easier further updates are.  Those developers in charge of
                   9922: issuing major GNOME updates will be grateful if you do that.</p>
                   9923: <p>The most common places to report bugs are the <a href="http://bugzilla.gnome.org/" target="_top">GNOME's Bugzilla</a> and the <a href="http://bugzilla.freedesktop.org/" target="_top">freedesktop.org's
                   9924: Bugzilla</a>.  Not all components use these to track bugs, but most
                   9925: of them do.  Do not be short on your reports: always provide detailed
                   9926: explanations of the current failure, how it can be improved to achieve
                   9927: maximum portability and, if at all possible, provide a patch against CVS
                   9928: head.  The more verbose you are, the higher chances of your patch being
                   9929: accepted.</p>
                   9930: <p>Also, please avoid using preprocessor magic to fix portability
                   9931: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   9932: GNOME to their operating system, the official GNOME sources are now
                   9933: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   9934: and similar macros.  This hurts portability.  Please see our patching
1.93      rillig   9935: guidelines (<a href="#components.patches.guidelines" title="10.3.4. Patching guidelines">Section 10.3.4, &#8220;Patching guidelines&#8221;</a>) for more
1.85      jmmv     9936: details.</p>
                   9937: </div>
                   9938: </div>
1.75      rillig   9939: </div>
                   9940: <div class="part" lang="en">
                   9941: <div class="titlepage"><div><div><h1 class="title">
                   9942: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
                   9943: <div class="partintro" lang="en">
                   9944: <div></div>
                   9945: <p>This part of the guide deals with everything
                   9946:        from the infrastructure that is behind the interfaces described
                   9947:        in the developer's guide. A casual package maintainer should not
                   9948:        need anything from this part.</p>
                   9949: <div class="toc">
                   9950: <p><b>Table of Contents</b></p>
                   9951: <dl>
1.90      rillig   9952: <dt><span class="chapter"><a href="#infr.design">23. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig   9953: <dd><dl>
1.90      rillig   9954: <dt><span class="sect1"><a href="#infr.vardef">23.1. The meaning of variable definitions</a></span></dt>
                   9955: <dt><span class="sect1"><a href="#infr.vardef.problems">23.2. Avoiding problems before they arise</a></span></dt>
                   9956: <dt><span class="sect1"><a href="#infr.var">23.3. Variable evaluation</a></span></dt>
1.75      rillig   9957: <dd><dl>
1.90      rillig   9958: <dt><span class="sect2"><a href="#infr.var.load">23.3.1. At load time</a></span></dt>
                   9959: <dt><span class="sect2"><a href="#infr.var.run">23.3.2. At runtime</a></span></dt>
1.75      rillig   9960: </dl></dd>
1.90      rillig   9961: <dt><span class="sect1"><a href="#infr.varspec">23.4. How can variables be specified?</a></span></dt>
                   9962: <dt><span class="sect1"><a href="#infr.design.intf">23.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   9963: <dd><dl>
1.90      rillig   9964: <dt><span class="sect2"><a href="#infr.design.intf.proc">23.5.1. Procedures with parameters</a></span></dt>
                   9965: <dt><span class="sect2"><a href="#infr.design.intf.action">23.5.2. Actions taken on behalf of parameters</a></span></dt>
1.81      rillig   9966: </dl></dd>
1.90      rillig   9967: <dt><span class="sect1"><a href="#infr.order">23.6. The order in which files are loaded</a></span></dt>
1.81      rillig   9968: <dd><dl>
1.90      rillig   9969: <dt><span class="sect2"><a href="#infr.order.prefs">23.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
                   9970: <dt><span class="sect2"><a href="#infr.order.pkg">23.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75      rillig   9971: </dl></dd>
                   9972: </dl></dd>
1.90      rillig   9973: <dt><span class="chapter"><a href="#regression">24. Regression tests</a></span></dt>
1.75      rillig   9974: <dd><dl>
1.90      rillig   9975: <dt><span class="sect1"><a href="#regression.descr">24.1. The regression tests framework</a></span></dt>
                   9976: <dt><span class="sect1"><a href="#regression.run">24.2. Running the regression tests</a></span></dt>
                   9977: <dt><span class="sect1"><a href="#regression.new">24.3. Adding a new regression test</a></span></dt>
1.75      rillig   9978: <dd><dl>
1.90      rillig   9979: <dt><span class="sect2"><a href="#regression.fun.override">24.3.1. Overridable functions</a></span></dt>
                   9980: <dt><span class="sect2"><a href="#regression.fun.helper">24.3.2. Helper functions</a></span></dt>
1.75      rillig   9981: </dl></dd>
                   9982: </dl></dd>
1.90      rillig   9983: <dt><span class="chapter"><a href="#porting">25. Porting pkgsrc</a></span></dt>
1.75      rillig   9984: <dd><dl>
1.90      rillig   9985: <dt><span class="sect1"><a href="#porting.opsys">25.1. Porting pkgsrc to a new operating system</a></span></dt>
                   9986: <dt><span class="sect1"><a href="#porting.compiler">25.2. Adding support for a new compiler</a></span></dt>
1.75      rillig   9987: </dl></dd>
                   9988: </dl>
                   9989: </div>
                   9990: </div>
                   9991: <div class="chapter" lang="en">
                   9992: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   9993: <a name="infr.design"></a>Chapter 23. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75      rillig   9994: <div class="toc">
                   9995: <p><b>Table of Contents</b></p>
                   9996: <dl>
1.90      rillig   9997: <dt><span class="sect1"><a href="#infr.vardef">23.1. The meaning of variable definitions</a></span></dt>
                   9998: <dt><span class="sect1"><a href="#infr.vardef.problems">23.2. Avoiding problems before they arise</a></span></dt>
                   9999: <dt><span class="sect1"><a href="#infr.var">23.3. Variable evaluation</a></span></dt>
1.81      rillig   10000: <dd><dl>
1.90      rillig   10001: <dt><span class="sect2"><a href="#infr.var.load">23.3.1. At load time</a></span></dt>
                   10002: <dt><span class="sect2"><a href="#infr.var.run">23.3.2. At runtime</a></span></dt>
1.81      rillig   10003: </dl></dd>
1.90      rillig   10004: <dt><span class="sect1"><a href="#infr.varspec">23.4. How can variables be specified?</a></span></dt>
                   10005: <dt><span class="sect1"><a href="#infr.design.intf">23.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10006: <dd><dl>
1.90      rillig   10007: <dt><span class="sect2"><a href="#infr.design.intf.proc">23.5.1. Procedures with parameters</a></span></dt>
                   10008: <dt><span class="sect2"><a href="#infr.design.intf.action">23.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75      rillig   10009: </dl></dd>
1.90      rillig   10010: <dt><span class="sect1"><a href="#infr.order">23.6. The order in which files are loaded</a></span></dt>
1.75      rillig   10011: <dd><dl>
1.90      rillig   10012: <dt><span class="sect2"><a href="#infr.order.prefs">23.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
                   10013: <dt><span class="sect2"><a href="#infr.order.pkg">23.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75      rillig   10014: </dl></dd>
                   10015: </dl>
                   10016: </div>
                   10017: <p>The pkgsrc infrastructure consists of many small Makefile
                   10018:        fragments. Each such fragment needs a properly specified
                   10019:        interface. This chapter explains how such an interface looks
                   10020:        like.</p>
                   10021: <div class="sect1" lang="en">
                   10022: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10023: <a name="infr.vardef"></a>23.1. The meaning of variable definitions</h2></div></div></div>
1.81      rillig   10024: <p>Whenever a variable is defined in the pkgsrc
                   10025:        infrastructure, the location and the way of definition provide
                   10026:        much information about the intended use of that variable.
                   10027:        Additionally, more documentation may be found in a header
                   10028:        comment or in this pkgsrc guide.</p>
                   10029: <p>A special file is
                   10030:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   10031:        variables that are intended to be user-defined. They are either
                   10032:        defined using the <code class="literal">?=</code> operator or they are
                   10033:        left undefined because defining them to anything would
                   10034:        effectively mean &#8220;<span class="quote">yes</span>&#8221;. All these variables may be
                   10035:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   10036:        file.</p>
                   10037: <p>Outside this file, the following conventions apply:
                   10038:        Variables that are defined using the <code class="literal">?=</code>
                   10039:        operator may be overridden by a package.</p>
                   10040: <p>Variables that are defined using the <code class="literal">=</code>
                   10041:        operator may be used read-only at run-time.</p>
                   10042: <p>Variables whose name starts with an underscore must not be
                   10043:        accessed outside the pkgsrc infrastructure at all. They may
                   10044:        change without further notice.</p>
                   10045: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   10046: <h3 class="title">Note</h3>
                   10047: <p>These conventions are currently not applied
                   10048:        consistently to the complete pkgsrc
                   10049:        infrastructure.</p>
                   10050: </div>
                   10051: </div>
                   10052: <div class="sect1" lang="en">
                   10053: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10054: <a name="infr.vardef.problems"></a>23.2. Avoiding problems before they arise</h2></div></div></div>
1.81      rillig   10055: <p>All variables that contain lists of things should default
                   10056:        to being empty. Two examples that do not follow this rule are
                   10057:        <code class="varname">USE_LANGUAGES</code> and
                   10058:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   10059:        modified using the <code class="literal">+=</code> operator in package
                   10060:        <code class="filename">Makefile</code>s (or other files included by
                   10061:        them), since there is no guarantee whether the variable is
                   10062:        already set or not, and what its value is. In the case of
                   10063:        <code class="varname">DISTFILES</code>, the packages &#8220;<span class="quote">know</span>&#8221;
                   10064:        the default value and just define it as in the following
                   10065:        example.</p>
                   10066: <pre class="programlisting">
                   10067:     DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
                   10068: </pre>
                   10069: <p>Because of the selection of this default value, the same
                   10070:        value appears in many package Makefiles. Similarly for
                   10071:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
                   10072:        value (&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;) is so short that it
                   10073:        doesn't stand out. Nevertheless it is mentioned in many
                   10074:        files.</p>
                   10075: </div>
                   10076: <div class="sect1" lang="en">
                   10077: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10078: <a name="infr.var"></a>23.3. Variable evaluation</h2></div></div></div>
1.75      rillig   10079: <div class="sect2" lang="en">
                   10080: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   10081: <a name="infr.var.load"></a>23.3.1. At load time</h3></div></div></div>
1.75      rillig   10082: <p>Variable evaluation takes place either at load time or at
                   10083:        runtime, depending on the context in which they occur. The
                   10084:        contexts where variables are evaluated at load time are:</p>
                   10085: <div class="itemizedlist"><ul type="disc">
                   10086: <li><p>The right hand side of the <code class="literal">:=</code>
                   10087:        and <code class="literal">!=</code> operators,</p></li>
                   10088: <li><p>Make directives like <code class="literal">.if</code> or
                   10089:        <code class="literal">.for</code>,</p></li>
                   10090: <li><p>Dependency lines.</p></li>
                   10091: </ul></div>
                   10092: <p>A special exception are references to the iteration
                   10093:        variables of <code class="literal">.for</code> loops, which are expanded
                   10094:        inline, no matter in which context they appear.</p>
                   10095: <p>As the values of variables may change during load time,
                   10096:        care must be taken not to evaluate them by accident. Typical
                   10097:        examples for variables that should not be evaluated at load time
                   10098:        are <code class="varname">DEPENDS</code> and
                   10099:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   10100:        clear, here is an example:</p>
                   10101: <pre class="programlisting">
                   10102:     CONFIGURE_ARGS=         # none
                   10103:     CFLAGS=                 -O
                   10104:     CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
1.1       grant    10105: 
1.75      rillig   10106:     CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
1.1       grant    10107: 
1.75      rillig   10108:     CFLAGS+=                -Wall
                   10109:        </pre>
                   10110: <p>This code shows how the use of the <code class="literal">:=</code>
                   10111:        operator can quickly lead to unexpected results. The first
                   10112:        paragraph is fairly common code. The second paragraph evaluates
                   10113:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   10114:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   10115:        <code class="literal">-Wall</code> is appended to the
                   10116:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   10117:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   10118:        paragraphs from above typically occur in completely unrelated
                   10119:        files.</p>
                   10120: </div>
                   10121: <div class="sect2" lang="en">
                   10122: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   10123: <a name="infr.var.run"></a>23.3.2. At runtime</h3></div></div></div>
1.75      rillig   10124: <p>After all the files have been loaded, the values of the
                   10125:        variables cannot be changed anymore. Variables that are used in
                   10126:        the shell commands are expanded at this point.</p>
                   10127: </div>
                   10128: </div>
                   10129: <div class="sect1" lang="en">
                   10130: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10131: <a name="infr.varspec"></a>23.4. How can variables be specified?</h2></div></div></div>
1.78      rillig   10132: <p>There are many ways in which the definition and use of a
                   10133:        variable can be restricted in order to detect bugs and
                   10134:        violations of the (mostly unwritten) policies. See the
                   10135:        <code class="literal">pkglint</code> developer's documentation for further
                   10136:        details.</p>
                   10137: </div>
                   10138: <div class="sect1" lang="en">
                   10139: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10140: <a name="infr.design.intf"></a>23.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76      rillig   10141: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75      rillig   10142:        of the following classes. Cases where a file falls into more
                   10143:        than one class should be avoided as it often leads to subtle
                   10144:        bugs.</p>
                   10145: <div class="sect2" lang="en">
                   10146: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   10147: <a name="infr.design.intf.proc"></a>23.5.1. Procedures with parameters</h3></div></div></div>
1.75      rillig   10148: <p>In a traditional imperative programming language some of
1.76      rillig   10149:        the <code class="filename">.mk</code> files could be described as
1.89      rillig   10150:        procedures. They take some input parameters and&mdash;after
                   10151:        inclusion&mdash;provide a result in output parameters. Since all
1.76      rillig   10152:        variables in <code class="filename">Makefile</code>s have global scope
1.75      rillig   10153:        care must be taken not to use parameter names that have already
                   10154:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   10155:        bad choice for a parameter name.</p>
                   10156: <p>Procedures are completely evaluated at preprocessing time.
                   10157:        That is, when calling a procedure all input parameters must be
                   10158:        completely resolvable. For example,
                   10159:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   10160:        parameter since it is very likely that further text will be
                   10161:        added after calling the procedure, which would effectively apply
                   10162:        the procedure to only a part of the variable. Also, references
                   10163:        to other variables wit will be modified after calling the
                   10164:        procedure.</p>
                   10165: <p>A procedure can declare its output parameters either as
                   10166:        suitable for use in preprocessing directives or as only
                   10167:        available at runtime. The latter alternative is for variables
                   10168:        that contain references to other runtime variables.</p>
                   10169: <p>Procedures shall be written such that it is possible to
                   10170:        call the procedure more than once. That is, the file must not
                   10171:        contain multiple-inclusion guards.</p>
                   10172: <p>Examples for procedures are
1.76      rillig   10173:        <code class="filename">mk/bsd.options.mk</code> and
                   10174:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75      rillig   10175:        that the parameters are evaluated at load time, they should be
                   10176:        assigned using the <code class="literal">:=</code> operator, which should
                   10177:        be used only for this purpose.</p>
                   10178: </div>
                   10179: <div class="sect2" lang="en">
                   10180: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   10181: <a name="infr.design.intf.action"></a>23.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75      rillig   10182: <p>Action files take some input parameters and may define
                   10183:        runtime variables. They shall not define loadtime variables.
                   10184:        There are action files that are included implicitly by the
                   10185:        pkgsrc infrastructure, while other must be included
                   10186:        explicitly.</p>
                   10187: <p>An example for action files is
1.76      rillig   10188:        <code class="filename">mk/subst.mk</code>.</p>
1.75      rillig   10189: </div>
                   10190: </div>
1.81      rillig   10191: <div class="sect1" lang="en">
                   10192: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10193: <a name="infr.order"></a>23.6. The order in which files are loaded</h2></div></div></div>
1.81      rillig   10194: <p>Package <code class="filename">Makefile</code>s usually consist of
                   10195:        a set of variable definitions, and include the file
                   10196:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   10197:        Before that, they may also include various other
                   10198:        <code class="filename">*.mk</code> files if they need to query the
                   10199:        availability of certain features like the type of compiler or
                   10200:        the X11 implementation. Due to the heavy use of preprocessor
                   10201:        directives like <code class="literal">.if</code> and
                   10202:        <code class="literal">.for</code>, the order in which the files are loaded
                   10203:        matters.</p>
                   10204: <p>This section describes at which point the various files
                   10205:        are loaded and gives reasons for that order.</p>
                   10206: <div class="sect2" lang="en">
                   10207: <div class="titlepage"><div><div><h3 class="title">
1.93      rillig   10208: <a name="infr.order.prefs"></a>23.6.1. The order in <code class="filename">bsd.prefs.mk</code>
                   10209: </h3></div></div></div>
                   10210: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81      rillig   10211:        is to define some essential variables like
                   10212:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   10213:        <code class="varname">MACHINE_ARCH</code>.</p>
                   10214: <p>Then, the user settings are loaded from the file specified
                   10215:        in <code class="varname">MAKECONF</code>. If the bmake command from pkgsrc
                   10216:        is used, <code class="varname">MAKECONF</code> defaults to
                   10217:        <code class="filename"><em class="replaceable"><code>${prefix}</code></em>/etc/mk.conf</code>.
                   10218:        With the native <a 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 on NetBSD, it defaults to
                   10219:        <code class="filename">/etc/mk.conf</code>. After that, those variables
                   10220:        that have not been overridden by the user are loaded from
                   10221:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   10222: <p>After the user settings, the system settings and platform
                   10223:        settings are loaded, which may override the user
                   10224:        settings.</p>
                   10225: <p>Then, the tool definitions are loaded. The tool wrappers
                   10226:        are not yet in effect. This only happens when building a
                   10227:        package, so the proper variables must be used instead of the
                   10228:        direct tool names.</p>
                   10229: <p>As the last steps, some essential variables from the
                   10230:        wrapper and the package system flavor are loaded, as well as the
                   10231:        variables that have been cached in earlier phases of a package
                   10232:        build.</p>
                   10233: </div>
                   10234: <div class="sect2" lang="en">
                   10235: <div class="titlepage"><div><div><h3 class="title">
1.93      rillig   10236: <a name="infr.order.pkg"></a>23.6.2. The order in <code class="filename">bsd.pkg.mk</code>
                   10237: </h3></div></div></div>
1.81      rillig   10238: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   10239: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   10240:        loaded, which fill default values for those variables that have
1.93      rillig   10241:        not been defined by the package. These variables may later
1.81      rillig   10242:        be used even in unrelated files.</p>
                   10243: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   10244:        provides the target <code class="literal">error-check</code> that is added
                   10245:        as a special dependency to all other targets that use
                   10246:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   10247:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   10248: <p>Then, the package-specific hacks from
                   10249:        <code class="filename">hacks.mk</code> are included.</p>
                   10250: <p>Then, various other files follow. Most of them don't have
                   10251:        any dependencies on what they need to have included before or
                   10252:        after them, though some do.</p>
                   10253: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   10254:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   10255:        restricts the use of these variables to all the files that have
                   10256:        been included before. Appearances in later files will be
                   10257:        silently ignored.</p>
                   10258: <p>Then, the files for the main targets are included, in the
                   10259:        order of later execution, though the actual order should not
                   10260:        matter.</p>
                   10261: <p>At last, some more files are included that don't set any
                   10262:        interesting variables but rather just define make targets to be
                   10263:        executed.</p>
                   10264: </div>
                   10265: </div>
1.75      rillig   10266: </div>
                   10267: <div class="chapter" lang="en">
                   10268: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   10269: <a name="regression"></a>Chapter 24. Regression tests</h2></div></div></div>
1.75      rillig   10270: <div class="toc">
                   10271: <p><b>Table of Contents</b></p>
                   10272: <dl>
1.90      rillig   10273: <dt><span class="sect1"><a href="#regression.descr">24.1. The regression tests framework</a></span></dt>
                   10274: <dt><span class="sect1"><a href="#regression.run">24.2. Running the regression tests</a></span></dt>
                   10275: <dt><span class="sect1"><a href="#regression.new">24.3. Adding a new regression test</a></span></dt>
1.75      rillig   10276: <dd><dl>
1.90      rillig   10277: <dt><span class="sect2"><a href="#regression.fun.override">24.3.1. Overridable functions</a></span></dt>
                   10278: <dt><span class="sect2"><a href="#regression.fun.helper">24.3.2. Helper functions</a></span></dt>
1.75      rillig   10279: </dl></dd>
                   10280: </dl>
                   10281: </div>
                   10282: <p>The pkgsrc infrastructure consists of a large codebase,
                   10283:        and there are many corners where every little bit of a file is
                   10284:        well thought out, making pkgsrc likely to fail as soon as
                   10285:        anything is changed near those parts. To prevent most changes
                   10286:        from breaking anything, a suite of regression tests should go
                   10287:        along with every important part of the pkgsrc infrastructure.
                   10288:        This chapter describes how regression tests work in pkgsrc and
                   10289:        how you can add new tests.</p>
                   10290: <div class="sect1" lang="en">
                   10291: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10292: <a name="regression.descr"></a>24.1. The regression tests framework</h2></div></div></div>
1.75      rillig   10293: <p></p>
                   10294: </div>
                   10295: <div class="sect1" lang="en">
                   10296: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10297: <a name="regression.run"></a>24.2. Running the regression tests</h2></div></div></div>
1.91      rillig   10298: <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.75      rillig   10299:        provides the <span><strong class="command">pkg_regress</strong></span> command. Then you
                   10300:        can simply run that command, which will run all tests in the
1.76      rillig   10301:        <code class="filename">regress</code> category.</p>
1.75      rillig   10302: </div>
                   10303: <div class="sect1" lang="en">
                   10304: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10305: <a name="regression.new"></a>24.3. Adding a new regression test</h2></div></div></div>
1.76      rillig   10306: <p>Every directory in the <code class="filename">regress</code>
                   10307:        category that contains a file called <code class="filename">spec</code>
1.75      rillig   10308:        is considered a regression test. This file is a shell program
                   10309:        that is included by the <span><strong class="command">pkg_regress</strong></span> command.
                   10310:        The following functions can be overridden to suit your
                   10311:        needs.</p>
                   10312: <div class="sect2" lang="en">
                   10313: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   10314: <a name="regression.fun.override"></a>24.3.1. Overridable functions</h3></div></div></div>
1.75      rillig   10315: <p>These functions do not take any parameters. They are all
                   10316:        called in &#8220;<span class="quote">set -e</span>&#8221; mode, so you should be careful
                   10317:        to check the exitcodes of any commands you run in the
                   10318:        test.</p>
                   10319: <div class="variablelist"><dl>
                   10320: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
                   10321: <dd><p>This function prepares the environment for the
                   10322:        test. By default it does nothing.</p></dd>
                   10323: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
                   10324: <dd><p>This function runs the actual test. By default,
                   10325:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   10326:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   10327:        error messages into the file
                   10328:        <code class="varname">TEST_OUTFILE</code>.</p></dd>
                   10329: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
                   10330: <dd><p>This function is run after the test and is
                   10331:        typically used to compare the actual output from the one that is
                   10332:        expected. It can make use of the various helper functions from
                   10333:        the next section.</p></dd>
                   10334: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
                   10335: <dd><p>This function cleans everything up after the
                   10336:        test has been run. By default it does nothing.</p></dd>
                   10337: </dl></div>
                   10338: </div>
                   10339: <div class="sect2" lang="en">
                   10340: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   10341: <a name="regression.fun.helper"></a>24.3.2. Helper functions</h3></div></div></div>
1.75      rillig   10342: <div class="variablelist"><dl>
                   10343: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
                   10344: <dd><p>This function compares the exitcode of the
                   10345:        <span><strong class="command">do_test()</strong></span> function with its first parameter.
                   10346:        If they differ, the test will fail.</p></dd>
                   10347: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
                   10348: <dd><p>This function checks for each of its parameters
                   10349:        if the output from <span><strong class="command">do_test()</strong></span> matches the
                   10350:        extended regular expression. If it does not, the test will
                   10351:        fail.</p></dd>
                   10352: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
                   10353: <dd><p>This function checks for each of its parameters
                   10354:        if the output from <span><strong class="command">do_test()</strong></span> does
                   10355:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   10356:        If any of the regular expressions matches, the test will
                   10357:        fail.</p></dd>
                   10358: </dl></div>
                   10359: </div>
                   10360: </div>
                   10361: </div>
                   10362: <div class="chapter" lang="en">
                   10363: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   10364: <a name="porting"></a>Chapter 25. Porting pkgsrc</h2></div></div></div>
1.75      rillig   10365: <div class="toc">
                   10366: <p><b>Table of Contents</b></p>
                   10367: <dl>
1.90      rillig   10368: <dt><span class="sect1"><a href="#porting.opsys">25.1. Porting pkgsrc to a new operating system</a></span></dt>
                   10369: <dt><span class="sect1"><a href="#porting.compiler">25.2. Adding support for a new compiler</a></span></dt>
1.75      rillig   10370: </dl>
                   10371: </div>
                   10372: <p>The pkgsrc system has already been ported to many
                   10373:        operating systems, hardware architectures and compilers. This
                   10374:        chapter explains the necessary steps to make pkgsrc even more
                   10375:        portable.</p>
                   10376: <div class="sect1" lang="en">
                   10377: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10378: <a name="porting.opsys"></a>25.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75      rillig   10379: <p>To port pkgsrc to a new operating system (called
                   10380:        <code class="literal">MyOS</code> in this example), you need to touch the
                   10381:        following files:</p>
                   10382: <div class="variablelist"><dl>
1.93      rillig   10383: <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   10384: <dd><p>This file contains some basic definitions, for
                   10385:        example the name of the C
                   10386:        compiler.</p></dd>
1.76      rillig   10387: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75      rillig   10388: <dd><p>Insert code that defines the variables
                   10389:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
                   10390:        <code class="varname">LOWER_OS_VERSION</code>,
                   10391:        <code class="varname">LOWER_VENDOR</code>,
                   10392:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   10393:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   10394:        appear in this file.</p></dd>
1.93      rillig   10395: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10396: <dd><p>This file contains the platform-specific
                   10397:        definitions that are used by pkgsrc. Start by copying one of the
                   10398:        other files and edit it to your
                   10399:        needs.</p></dd>
1.93      rillig   10400: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
1.75      rillig   10401: <dd><p>This file contains a list of directories,
                   10402:        together with their permission bits and ownership. These
                   10403:        directories will be created automatically with every package
                   10404:        that does not explicitly set <code class="varname">NO_MTREE</code>. There
                   10405:        have been some discussions about whether this file is needed at
                   10406:        all, but with no result.</p></dd>
1.93      rillig   10407: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
1.75      rillig   10408: <dd><p>Just copy one of the pre-existing x11.dist files
                   10409:        to your
1.76      rillig   10410:        <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
                   10411: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
1.75      rillig   10412: <dd><p>On some operating systems, the tools that are
                   10413:        provided with the base system are not good enough for pkgsrc.
                   10414:        For example, there are many versions of <a 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
                   10415:        narrow limit on the line length they can process. Therefore
                   10416:        pkgsrc brings its own tools, which can be enabled
                   10417:        here.</p></dd>
1.93      rillig   10418: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10419: <dd><p>This file defines the paths to all the tools
                   10420:        that are needed by one or the other package in pkgsrc, as well
                   10421:        as by pkgsrc itself. Find out where these tools are on your
                   10422:        platform and add them.</p></dd>
                   10423: </dl></div>
                   10424: <p>Now, you should be able to build some basic packages, like
1.91      rillig   10425:        <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   10426: </div>
                   10427: <div class="sect1" lang="en">
                   10428: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10429: <a name="porting.compiler"></a>25.2. Adding support for a new compiler</h2></div></div></div>
1.75      rillig   10430: <p>TODO</p>
                   10431: </div>
                   10432: </div>
                   10433: </div>
                   10434: <div class="appendix" lang="en">
                   10435: <div class="titlepage"><div><div><h2 class="title">
                   10436: <a name="examples"></a>Appendix A. A simple example package: bison</h2></div></div></div>
                   10437: <div class="toc">
                   10438: <p><b>Table of Contents</b></p>
                   10439: <dl>
                   10440: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   10441: <dd><dl>
                   10442: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   10443: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   10444: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
                   10445: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span><strong class="command">pkglint</strong></span></a></span></dt>
                   10446: </dl></dd>
                   10447: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   10448: </dl>
                   10449: </div>
                   10450: <p>We checked to find a piece of software that wasn't in the packages
                   10451:     collection, and picked GNU bison. Quite why someone would want to have
                   10452:     <span><strong class="command">bison</strong></span> when Berkeley <span><strong class="command">yacc</strong></span> is already
                   10453:     present in the tree is beyond us, but it's useful for the purposes of
                   10454:     this exercise.</p>
                   10455: <div class="sect1" lang="en">
                   10456: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10457: <a name="example-files"></a>A.1. files</h2></div></div></div>
                   10458: <div class="sect2" lang="en">
                   10459: <div class="titlepage"><div><div><h3 class="title">
                   10460: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
                   10461: <pre class="programlisting">
1.51      rillig   10462:     # $NetBSD$
                   10463:     #
1.1       grant    10464: 
1.51      rillig   10465:     DISTNAME=       bison-1.25
                   10466:     CATEGORIES=     devel
                   10467:     MASTER_SITES=   ${MASTER_SITE_GNU}
1.1       grant    10468: 
1.51      rillig   10469:     MAINTAINER=     thorpej@NetBSD.org
                   10470:     HOMEPAGE=       http://www.gnu.org/software/bison/bison.html
                   10471:     COMMENT=        GNU yacc clone
1.1       grant    10472: 
1.51      rillig   10473:     GNU_CONFIGURE=  yes
                   10474:     INFO_FILES=     bison.info
1.1       grant    10475: 
1.51      rillig   10476:     .include "../../mk/bsd.pkg.mk"
1.1       grant    10477: </pre>
1.75      rillig   10478: </div>
                   10479: <div class="sect2" lang="en">
                   10480: <div class="titlepage"><div><div><h3 class="title">
                   10481: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
                   10482: <pre class="programlisting">
1.51      rillig   10483:     GNU version of yacc.  Can make re-entrant parsers, and numerous other
1.75      rillig   10484:     improvements.  Why you would want this when Berkeley <a 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.51      rillig   10485:     of the NetBSD source tree is beyond me.
1.1       grant    10486: </pre>
1.75      rillig   10487: </div>
                   10488: <div class="sect2" lang="en">
                   10489: <div class="titlepage"><div><div><h3 class="title">
                   10490: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
                   10491: <pre class="programlisting">
1.51      rillig   10492:     @comment $NetBSD$
                   10493:     bin/bison
                   10494:     man/man1/bison.1.gz
                   10495:     share/bison.simple
                   10496:     share/bison.hairy
1.1       grant    10497: </pre>
1.75      rillig   10498: </div>
                   10499: <div class="sect2" lang="en">
                   10500: <div class="titlepage"><div><div><h3 class="title">
1.93      rillig   10501: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span><strong class="command">pkglint</strong></span>
                   10502: </h3></div></div></div>
1.75      rillig   10503: <p>The NetBSD package system comes with
1.91      rillig   10504:         <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   10505:        which helps to check the contents of these
                   10506:        files. After installation it is quite easy to use, just change to the
                   10507:        directory of the package you wish to examine and execute
                   10508:        <span><strong class="command">pkglint</strong></span>:</p>
                   10509: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
                   10510: looks fine.</pre>
                   10511: <p>Depending on the supplied command line arguments (see pkglint(1)),
                   10512:        more checks will be performed. Use e.g. <span><strong class="command">pkglint -Call
                   10513:        -Wall</strong></span> for a very thorough check.</p>
                   10514: </div>
                   10515: </div>
                   10516: <div class="sect1" lang="en">
                   10517: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10518: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
                   10519: <p>Create the directory where the package lives,
                   10520:       plus any auxiliary directories:</p>
                   10521: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   10522: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   10523: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   10524: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76      rillig   10525: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.90      rillig   10526:       <code class="filename">PLIST</code> (see <a href="#components" title="Chapter 10. Package components - files, directories and contents">Chapter 10, <i>Package components - files, directories and contents</i></a>)
1.75      rillig   10527:       then continue with fetching the distfile:</p>
                   10528: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1       grant    10529: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   10530: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   10531: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10532: ftp: Error retrieving file: 500 Internal error
                   10533: 
                   10534: &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   10535: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10536: ftp: Error retrieving file: 500 Internal error
                   10537: 
                   10538: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   10539: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75      rillig   10540: Successfully retrieved file.</pre>
                   10541: <p>Generate the checksum of the distfile into
1.76      rillig   10542:       <code class="filename">distinfo</code>:</p>
1.88      wiz      10543: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75      rillig   10544: <p>Now compile:</p>
                   10545: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10546: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10547: ===&gt;  Extracting for bison-1.25
                   10548: ===&gt;  Patching for bison-1.25
                   10549: ===&gt;   Ignoring empty patch directory
                   10550: ===&gt;  Configuring for bison-1.25
                   10551: creating cache ./config.cache
                   10552: checking for gcc... cc
                   10553: checking whether we are using GNU C... yes
                   10554: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   10555: checking how to run the C preprocessor... cc -E
                   10556: checking for minix/config.h... no
                   10557: checking for POSIXized ISC... no
                   10558: checking whether cross-compiling... no
                   10559: checking for ANSI C header files... yes
                   10560: checking for string.h... yes
                   10561: checking for stdlib.h... yes
                   10562: checking for memory.h... yes
                   10563: checking for working const... yes
                   10564: checking for working alloca.h... no
                   10565: checking for alloca... yes
                   10566: checking for strerror... yes
                   10567: updating cache ./config.cache
                   10568: creating ./config.status
                   10569: creating Makefile
                   10570: ===&gt;  Building for bison-1.25
                   10571: 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
                   10572: 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
                   10573: 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
                   10574: 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
                   10575: 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   10576: 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    10577: 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
                   10578: 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
                   10579: 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
                   10580: 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
                   10581: 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
                   10582: 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
                   10583: 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
                   10584: 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
                   10585: 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
                   10586: 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
                   10587: 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
                   10588: 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
                   10589: 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
                   10590: 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
                   10591: 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
                   10592: 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
                   10593: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   10594: rm -f bison.s1
1.75      rillig   10595: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   10596: <p>Everything seems OK, so install the files:</p>
                   10597: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10598: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10599: ===&gt;  Installing for bison-1.25
                   10600: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   10601: rm -f /usr/pkg/bin/bison
                   10602: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   10603: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   10604: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   10605: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   10606: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   10607: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   10608: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75      rillig   10609: ===&gt;  Registering installation for bison-1.25</pre>
                   10610: <p>You can now use bison, and also - if you decide so - remove it with
                   10611:       <span><strong class="command">pkg_delete bison</strong></span>. Should you decide that you want a
                   10612:       binary package, do this now:</p>
                   10613: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10614: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10615: ===&gt;  Building package for bison-1.25
                   10616: Creating package bison-1.25.tgz
                   10617: Registering depends:.
1.75      rillig   10618: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   10619: <p>Now that you don't need the source and object files
                   10620:       any more, clean up:</p>
                   10621: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   10622: ===&gt;  Cleaning for bison-1.25</pre>
                   10623: </div>
                   10624: </div>
                   10625: <div class="appendix" lang="en">
                   10626: <div class="titlepage"><div><div><h2 class="title">
                   10627: <a name="logs"></a>Appendix B. Build logs</h2></div></div></div>
                   10628: <div class="toc">
                   10629: <p><b>Table of Contents</b></p>
                   10630: <dl>
                   10631: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                   10632: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                   10633: </dl>
                   10634: </div>
                   10635: <div class="sect1" lang="en">
                   10636: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10637: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
                   10638: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10639: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10640: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   10641: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   10642: =&gt; [172219 bytes]
                   10643: Connected to ftp.plig.net.
                   10644: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   10645: 331 Guest login ok, send your complete e-mail address as password.
                   10646: 230-You are user #5 of 500 simultaneous users allowed.
                   10647: 230-
1.68      rillig   10648: 230-  ___ _             _ _
                   10649: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
1.1       grant    10650: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   10651: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   10652: 230-         |_|   |_|     |___|         |___|
                   10653: 230-
                   10654: 230-** Welcome to ftp.plig.org **
                   10655: 230-
                   10656: 230-Please note that all transfers from this FTP site are logged. If you
                   10657: 230-do not like this, please disconnect now.
                   10658: 230-
                   10659: 230-This arhive is available via
                   10660: 230-
                   10661: 230-HTTP:  http://ftp.plig.org/
                   10662: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   10663: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   10664: 230-
                   10665: 230-Please email comments, bug reports and requests for packages to be
1.68      rillig   10666: 230-mirrored to ftp-admin@plig.org.
1.1       grant    10667: 230-
                   10668: 230-
                   10669: 230 Logged in anonymously.
                   10670: Remote system type is UNIX.
                   10671: Using binary mode to transfer files.
                   10672: 200 Type okay.
                   10673: 250 "/pub" is new cwd.
                   10674: 250-"/pub/figlet" is new cwd.
                   10675: 250-
                   10676: 250-Welcome to the figlet archive at ftp.figlet.org
1.68      rillig   10677: 250-
1.75      rillig   10678: 250-   ftp://ftp.figlet.org/pub/figlet/
1.1       grant    10679: 250-
                   10680: 250-The official FIGlet web page is:
1.75      rillig   10681: 250-   http://www.figlet.org/
1.1       grant    10682: 250-
                   10683: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   10684: 250-contribute a font or something else, you can email us.
1.68      rillig   10685: 250
1.1       grant    10686: 250 "/pub/figlet/program" is new cwd.
                   10687: 250 "/pub/figlet/program/unix" is new cwd.
                   10688: local: figlet221.tar.gz remote: figlet221.tar.gz
                   10689: 502 Unimplemented command.
                   10690: 227 Entering Passive Mode (195,40,6,41,246,104)
                   10691: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   10692: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   10693: 226 Transfer completed.
                   10694: 172219 bytes received in 00:02 (75.99 KB/s)
                   10695: 221 Goodbye.
                   10696: =&gt; Checksum OK for figlet221.tar.gz.
                   10697: ===&gt; Extracting for figlet-2.2.1nb2
                   10698: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   10699: ===&gt; Patching for figlet-2.2.1nb2
                   10700: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   10701: ===&gt; Overriding tools for figlet-2.2.1nb2
                   10702: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   10703: ===&gt; Configuring for figlet-2.2.1nb2
                   10704: ===&gt; Building for figlet-2.2.1nb2
                   10705: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   10706: chmod a+x figlet
                   10707: gcc -O2 -o chkfont chkfont.c
                   10708: =&gt; Unwrapping files-to-be-installed.
1.14      xtraeme  10709: <code class="prompt">#</code>
1.75      rillig   10710: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10711: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10712: ===&gt; Installing for figlet-2.2.1nb2
                   10713: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   10714: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   10715: mkdir -p /usr/pkg/share/figlet
                   10716: cp figlet /usr/pkg/bin
                   10717: cp chkfont /usr/pkg/bin
                   10718: chmod 555 figlist showfigfonts
                   10719: cp figlist /usr/pkg/bin
                   10720: cp showfigfonts /usr/pkg/bin
                   10721: cp fonts/*.flf /usr/pkg/share/figlet
                   10722: cp fonts/*.flc /usr/pkg/share/figlet
                   10723: cp figlet.6 /usr/pkg/man/man6
                   10724: ===&gt; Registering installation for figlet-2.2.1nb2
1.75      rillig   10725: <code class="prompt">#</code></pre>
                   10726: </div>
                   10727: <div class="sect1" lang="en">
                   10728: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10729: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
                   10730: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10731: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10732: ===&gt; Packaging figlet-2.2.1nb2
                   10733: ===&gt; Building binary package for figlet-2.2.1nb2
                   10734: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   10735: Using SrcDir value of /usr/pkg
1.68      rillig   10736: Registering depends:.
1.75      rillig   10737: <code class="prompt">#</code></pre>
                   10738: </div>
                   10739: </div>
                   10740: <div class="appendix" lang="en">
                   10741: <div class="titlepage"><div><div><h2 class="title">
1.76      rillig   10742: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h2></div></div></div>
                   10743: <div class="toc">
                   10744: <p><b>Table of Contents</b></p>
                   10745: <dl>
                   10746: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</a></span></dt>
                   10747: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                   10748: <dt><span class="sect1"><a href="#ftp-iso">C.3. <code class="filename">iso</code>: Currently empty</a></span></dt>
                   10749: <dt><span class="sect1"><a href="#ftp-misc">C.4. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                   10750: <dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages*</code>: Binary packages</a></span></dt>
                   10751: <dt><span class="sect1"><a href="#ftp-source">C.6. <code class="filename">current</code>,
1.93      rillig   10752: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   10753: source packages</a></span></dt>
                   10754: </dl>
                   10755: </div>
                   10756: <p>As in other big projects, the directory layout of pkgsrc
                   10757:        is quite complex for newbies. This chapter explains where you
                   10758:        find things on the FTP server. The base directory on
1.89      rillig   10759:        <code class="filename">ftp.NetBSD.org</code> is <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top"><code class="filename">/pub/pkgsrc/</code></a>.
                   10760:        On other servers it may be different, but inside this directory,
                   10761:        everything should look the same, no matter on which server you
                   10762:        are. This directory contains some subdirectories, which are
                   10763:        explained below.</p>
1.76      rillig   10764: <div class="sect1" lang="en">
                   10765: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10766: <a name="ftp-bootstrap"></a>C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</h2></div></div></div>
                   10767: <p>For those who only want to manage binary packages on
                   10768:        systems other than NetBSD, we provide the package management
                   10769:        tools in a separate, small tar file.</p>
                   10770: </div>
                   10771: <div class="sect1" lang="en">
                   10772: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10773: <a name="ftp-distfiles"></a>C.2. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
                   10774: <p>The directory <code class="filename">distfiles</code> contains lots
                   10775:        of archive files from all pkgsrc packages, which are mirrored
                   10776:        here. The subdirectories are called after their package names
                   10777:        and are used when the distributed files have names that don't
                   10778:        explicitly contain a version number or are otherwise too generic
                   10779:        (for example <code class="filename">release.tar.gz</code>).</p>
                   10780: </div>
                   10781: <div class="sect1" lang="en">
                   10782: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10783: <a name="ftp-iso"></a>C.3. <code class="filename">iso</code>: Currently empty</h2></div></div></div>
                   10784: <p>This directory is currently not in use.</p>
                   10785: </div>
                   10786: <div class="sect1" lang="en">
                   10787: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10788: <a name="ftp-misc"></a>C.4. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
                   10789: <p>This directory contains things that individual pkgsrc
                   10790:        developers find worth publishing.</p>
                   10791: </div>
                   10792: <div class="sect1" lang="en">
                   10793: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10794: <a name="ftp-packages"></a>C.5. <code class="filename">packages*</code>: Binary packages</h2></div></div></div>
                   10795: <p>These directories contain binary packages. Those
                   10796:        directories that have a branch name
                   10797:        (200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em>)
                   10798:        contain packages from that particular branch. The directory
                   10799:        <code class="filename">packages</code> contains binary packages from
                   10800:        pkgsrc-current. (However, this does not necessarily mean that
                   10801:        the packages are still current anymore.)</p>
                   10802: <p>Below the <code class="filename">packages*</code> directories are
                   10803:        directories that distinguish the packages by operating system
                   10804:        and version, the next directory level specifies the hardware
                   10805:        architecture.</p>
                   10806: <p>In each of the platform-specific directories, there is a
                   10807:        whole binary packages collection. It has a directory called
                   10808:        <code class="filename">All</code> which contains all binary packages.
                   10809:        Besides that, there are various category directories that
                   10810:        contain symbolic links to the real binary packages.</p>
                   10811: </div>
                   10812: <div class="sect1" lang="en">
                   10813: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10814: <a name="ftp-source"></a>C.6. <code class="filename">current</code>,
1.93      rillig   10815: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   10816: source packages</h2></div></div></div>
                   10817: <p>These directories contain the &#8220;<span class="quote">real</span>&#8221; pkgsrc,
                   10818:        that is the files that define how to create binary packages from
                   10819:        source archives.</p>
                   10820: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89      rillig   10821:        snapshot of the CVS repository, which is updated regularly. The
                   10822:        file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
                   10823:        directory, ready to be downloaded as a whole.</p>
1.76      rillig   10824: <p>In the directories for the quarterly branches, there is an
                   10825:        additional file called
                   10826:        <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
                   10827:        which contains the state of pkgsrc when it was branched.</p>
                   10828: </div>
1.75      rillig   10829: </div>
                   10830: <div class="appendix" lang="en">
                   10831: <div class="titlepage"><div><div><h2 class="title">
                   10832: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h2></div></div></div>
                   10833: <div class="toc">
                   10834: <p><b>Table of Contents</b></p>
                   10835: <dl>
1.79      rillig   10836: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75      rillig   10837: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                   10838: </dl>
                   10839: </div>
1.79      rillig   10840: <p>This section contains information on editing the pkgsrc
                   10841:        guide itself.</p>
1.75      rillig   10842: <div class="sect1" lang="en">
                   10843: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79      rillig   10844: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
                   10845: <p>The pkgsrc guide's source code is stored in
                   10846:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   10847:        are created from it:</p>
                   10848: <div class="itemizedlist"><ul type="disc">
                   10849: <li><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   10850: <li><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
                   10851: <li><p><a href="http://www.NetBSD.org/Documentation/pkgsrc/" target="_top">http://www.NetBSD.org/Documentation/pkgsrc/</a></p></li>
                   10852: <li><p><a href="http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.pdf" target="_top">http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.pdf</a>:
                   10853:        The PDF version of the pkgsrc guide.</p></li>
                   10854: <li><p><a href="http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.ps" target="_top">http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.ps</a>:
                   10855:        PostScript version of the pkgsrc guide.</p></li>
1.75      rillig   10856: </ul></div>
                   10857: </div>
                   10858: <div class="sect1" lang="en">
                   10859: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10860: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79      rillig   10861: <p>The procedure to edit the pkgsrc guide is:</p>
                   10862: <div class="procedure"><ol type="1">
                   10863: <li><p>Make sure you have the packages needed to
1.83      wiz      10864:        regenerate the pkgsrc guide (and other XML-based NetBSD
1.91      rillig   10865:        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
                   10866:        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   10867:        PostScript and PDF versions. You will need both packages
                   10868:        installed, to make sure documentation is consistent across all
                   10869:        formats.</p></li>
                   10870: <li><p>Run <span><strong class="command">cd doc/guide</strong></span> to get to the
                   10871:        right directory. All further steps will take place
                   10872:        here.</p></li>
                   10873: <li><p>Edit the XML file(s) in
                   10874:        <code class="filename">files/</code>.</p></li>
                   10875: <li><p>Run <span><strong class="command">bmake</strong></span> to check the pkgsrc
                   10876:        guide for valid XML and to build the final output files. If you
                   10877:        get any errors at this stage, you can just edit the files, as
                   10878:        there are only symbolic links in the working directory, pointing
                   10879:        to the files in <code class="filename">files/</code>.</p></li>
                   10880: <li><p><span><strong class="command">(cd files &amp;&amp; cvs
                   10881:        commit)</strong></span></p></li>
                   10882: <li><p>Run <span><strong class="command">bmake clean &amp;&amp; bmake</strong></span> to
                   10883:        regenerate the output files with the proper RCS
                   10884:        Ids.</p></li>
1.91      rillig   10885: <li>
                   10886: <p>Run <span><strong class="command">bmake regen</strong></span> to install and
                   10887:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                   10888:        <code class="filename">htdocs</code>.</p>
                   10889: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   10890: <h3 class="title">Note</h3>
                   10891: <p>If you have added, removed or renamed some chapters,
1.83      wiz      10892:        you need to synchronize them using <span><strong class="command">cvs add</strong></span> or
                   10893:        <span><strong class="command">cvs delete</strong></span> in the htdocs
1.91      rillig   10894:        directory.</p>
                   10895: </div>
                   10896: </li>
1.79      rillig   10897: </ol></div>
1.75      rillig   10898: </div>
                   10899: </div>
                   10900: </div></body>
1.1       grant    10901: </html>

CVSweb <webmaster@jp.NetBSD.org>