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

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>
                     69: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via CVS</a></span></dt>
                     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>
                    207: <dt><span class="sect1"><a href="#makefile.variables">11.1. <code class="filename">Makefile</code> variables</a></span></dt>
                    208: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">11.1.1. Naming conventions</a></span></dt></dl></dd>
                    209: <dt><span class="sect1"><a href="#makefile.code">11.2. Code snippets</a></span></dt>
                    210: <dd><dl>
                    211: <dt><span class="sect2"><a href="#adding-to-list">11.2.1. Adding things to a list</a></span></dt>
                    212: <dt><span class="sect2"><a href="#converting-internal-to-external">11.2.2. Converting an internal list into an external list</a></span></dt>
                    213: <dt><span class="sect2"><a href="#passing-variable-to-shell">11.2.3. Passing variables to a shell command</a></span></dt>
                    214: <dt><span class="sect2"><a href="#quoting-guideline">11.2.4. Quoting guideline</a></span></dt>
                    215: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">11.2.5. Workaround for a bug in BSD Make</a></span></dt>
                    216: </dl></dd>
                    217: </dl></dd>
                    218: <dt><span class="chapter"><a href="#plist">12. PLIST issues</a></span></dt>
                    219: <dd><dl>
                    220: <dt><span class="sect1"><a href="#rcs-id">12.1. RCS ID</a></span></dt>
                    221: <dt><span class="sect1"><a href="#automatic-plist-generation">12.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                    222: <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>
                    223: <dt><span class="sect1"><a href="#plist.misc">12.4. Variable substitution in PLIST</a></span></dt>
                    224: <dt><span class="sect1"><a href="#manpage-compression">12.5. Man page compression</a></span></dt>
                    225: <dt><span class="sect1"><a href="#using-PLIST_SRC">12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                    226: <dt><span class="sect1"><a href="#platform-specific-plist">12.7. Platform-specific and differing PLISTs</a></span></dt>
                    227: <dt><span class="sect1"><a href="#faq.common-dirs">12.8. Sharing directories between packages</a></span></dt>
                    228: </dl></dd>
                    229: <dt><span class="chapter"><a href="#buildlink">13. Buildlink methodology</a></span></dt>
                    230: <dd><dl>
                    231: <dt><span class="sect1"><a href="#converting-to-buildlink3">13.1. Converting packages to use buildlink3</a></span></dt>
                    232: <dt><span class="sect1"><a href="#creating-buildlink3.mk">13.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
                    233: <dd><dl>
                    234: <dt><span class="sect2"><a href="#anatomy-of-bl3">13.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                    235: <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>
                    236: </dl></dd>
                    237: <dt><span class="sect1"><a href="#writing-builtin.mk">13.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
                    238: <dd><dl>
                    239: <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>
                    240: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">13.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                    241: </dl></dd>
                    242: </dl></dd>
                    243: <dt><span class="chapter"><a href="#pkginstall">14. The pkginstall framework</a></span></dt>
                    244: <dd><dl>
                    245: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">14.1. Files and directories outside the installation prefix</a></span></dt>
                    246: <dd><dl>
                    247: <dt><span class="sect2"><a href="#dirs-outside-prefix">14.1.1. Directory manipulation</a></span></dt>
                    248: <dt><span class="sect2"><a href="#files-outside-prefix">14.1.2. File manipulation</a></span></dt>
                    249: </dl></dd>
                    250: <dt><span class="sect1"><a href="#conf-files">14.2. Configuration files</a></span></dt>
                    251: <dd><dl>
                    252: <dt><span class="sect2"><a href="#conf-files-sysconfdir">14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                    253: <dt><span class="sect2"><a href="#conf-files-configure">14.2.2. Telling the software where configuration files are</a></span></dt>
                    254: <dt><span class="sect2"><a href="#conf-files-patching">14.2.3. Patching installations</a></span></dt>
                    255: <dt><span class="sect2"><a href="#conf-files-disable">14.2.4. Disabling handling of configuration files</a></span></dt>
                    256: </dl></dd>
                    257: <dt><span class="sect1"><a href="#rcd-scripts">14.3. System startup scripts</a></span></dt>
                    258: <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>
                    259: <dt><span class="sect1"><a href="#users-and-groups">14.4. System users and groups</a></span></dt>
                    260: <dt><span class="sect1"><a href="#shells">14.5. System shells</a></span></dt>
                    261: <dd><dl><dt><span class="sect2"><a href="#shells-disable">14.5.1. Disabling shell registration</a></span></dt></dl></dd>
                    262: <dt><span class="sect1"><a href="#fonts">14.6. Fonts</a></span></dt>
                    263: <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>
                    264: </dl></dd>
                    265: <dt><span class="chapter"><a href="#options">15. Options handling</a></span></dt>
                    266: <dd><dl>
                    267: <dt><span class="sect1"><a href="#global-default-options">15.1. Global default options</a></span></dt>
                    268: <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>
                    269: <dt><span class="sect1"><a href="#option-names">15.3. Option Names</a></span></dt>
                    270: </dl></dd>
                    271: <dt><span class="chapter"><a href="#build">16. The build process</a></span></dt>
                    272: <dd><dl>
                    273: <dt><span class="sect1"><a href="#build.intro">16.1. Introduction</a></span></dt>
                    274: <dt><span class="sect1"><a href="#build.prefix">16.2. Program location</a></span></dt>
                    275: <dt><span class="sect1"><a href="#build.builddirs">16.3. Directories used during the build process</a></span></dt>
                    276: <dt><span class="sect1"><a href="#build.running">16.4. Running a phase</a></span></dt>
                    277: <dt><span class="sect1"><a href="#build.fetch">16.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                    278: <dd><dl>
                    279: <dt><span class="sect2"><a href="#build.fetch.what">16.5.1. What to fetch and where to get it from</a></span></dt>
                    280: <dt><span class="sect2"><a href="#build.fetch.how">16.5.2. How are the files fetched?</a></span></dt>
                    281: </dl></dd>
                    282: <dt><span class="sect1"><a href="#build.checksum">16.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                    283: <dt><span class="sect1"><a href="#build.extract">16.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                    284: <dt><span class="sect1"><a href="#build.patch">16.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                    285: <dt><span class="sect1"><a href="#build.tools">16.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                    286: <dt><span class="sect1"><a href="#build.wrapper">16.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                    287: <dt><span class="sect1"><a href="#build.configure">16.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    288: <dt><span class="sect1"><a href="#build.build">16.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    289: <dt><span class="sect1"><a href="#build.test">16.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                    290: <dt><span class="sect1"><a href="#build.install">16.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    291: <dt><span class="sect1"><a href="#build.package">16.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                    292: <dt><span class="sect1"><a href="#build.clean">16.16. Cleaning up</a></span></dt>
                    293: <dt><span class="sect1"><a href="#build.helpful-targets">16.17. Other helpful targets</a></span></dt>
                    294: </dl></dd>
                    295: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
                    296: <dd><dl>
                    297: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                    298: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                    299: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
                    300: </dl></dd>
                    301: <dt><span class="chapter"><a href="#fixes">18. Making your package work</a></span></dt>
                    302: <dd><dl>
                    303: <dt><span class="sect1"><a href="#general-operation">18.1. General operation</a></span></dt>
                    304: <dd><dl>
                    305: <dt><span class="sect2"><a href="#portability-of-packages">18.1.1. Portability of packages</a></span></dt>
                    306: <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>
                    307: <dt><span class="sect2"><a href="#user-interaction">18.1.3. User interaction</a></span></dt>
                    308: <dt><span class="sect2"><a href="#handling-licenses">18.1.4. Handling licenses</a></span></dt>
                    309: <dt><span class="sect2"><a href="#restricted-packages">18.1.5. Restricted packages</a></span></dt>
                    310: <dt><span class="sect2"><a href="#dependencies">18.1.6. Handling dependencies</a></span></dt>
                    311: <dt><span class="sect2"><a href="#conflicts">18.1.7. Handling conflicts with other packages</a></span></dt>
                    312: <dt><span class="sect2"><a href="#not-building-packages">18.1.8. Packages that cannot or should not be built</a></span></dt>
                    313: <dt><span class="sect2"><a href="#undeletable-packages">18.1.9. Packages which should not be deleted, once installed</a></span></dt>
                    314: <dt><span class="sect2"><a href="#security-handling">18.1.10. Handling packages with security problems</a></span></dt>
                    315: <dt><span class="sect2"><a href="#bumping-pkgrevision">18.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                    316: <dt><span class="sect2"><a href="#fixes.subst">18.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                    317: </dl></dd>
                    318: <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>
                    319: <dd><dl>
                    320: <dt><span class="sect2"><a href="#no-plain-download">18.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                    321: <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>
                    322: </dl></dd>
                    323: <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>
                    324: <dd><dl>
                    325: <dt><span class="sect2"><a href="#fixes.libtool">18.3.1. Shared libraries - libtool</a></span></dt>
                    326: <dt><span class="sect2"><a href="#using-libtool">18.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                    327: <dt><span class="sect2"><a href="#autoconf-automake">18.3.3. GNU Autoconf/Automake</a></span></dt>
                    328: </dl></dd>
                    329: <dt><span class="sect1"><a href="#programming-languages">18.4. Programming languages</a></span></dt>
                    330: <dd><dl>
                    331: <dt><span class="sect2"><a href="#basic-programming-languages">18.4.1. C, C++, and Fortran</a></span></dt>
                    332: <dt><span class="sect2"><a href="#java-programming-language">18.4.2. Java</a></span></dt>
                    333: <dt><span class="sect2"><a href="#perl-scripts">18.4.3. Packages containing perl scripts</a></span></dt>
                    334: <dt><span class="sect2"><a href="#other-programming-languages">18.4.4. Other programming languages</a></span></dt>
                    335: </dl></dd>
                    336: <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>
                    337: <dd><dl>
                    338: <dt><span class="sect2"><a href="#fixes.build.cpp">18.5.1. Compiling C and C++ code conditionally</a></span></dt>
                    339: <dt><span class="sect2"><a href="#compiler-bugs">18.5.2. How to handle compiler bugs</a></span></dt>
                    340: <dt><span class="sect2"><a href="#undefined-reference">18.5.3. Undefined reference to &#8220;<span class="quote">...</span>&#8221;</a></span></dt>
                    341: <dt><span class="sect2"><a href="#out-of-memory">18.5.4. Running out of memory</a></span></dt>
                    342: </dl></dd>
                    343: <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>
                    344: <dd><dl>
                    345: <dt><span class="sect2"><a href="#install-scripts">18.6.1. Creating needed directories</a></span></dt>
                    346: <dt><span class="sect2"><a href="#where-to-install-documentation">18.6.2. Where to install documentation</a></span></dt>
                    347: <dt><span class="sect2"><a href="#installing-score-files">18.6.3. Installing score files</a></span></dt>
                    348: <dt><span class="sect2"><a href="#hardcoded-paths">18.6.4. Packages with hardcoded paths to other interpreters</a></span></dt>
                    349: <dt><span class="sect2"><a href="#perl-modules">18.6.5. Packages installing perl modules</a></span></dt>
                    350: <dt><span class="sect2"><a href="#faq.info-files">18.6.6. Packages installing info files</a></span></dt>
                    351: <dt><span class="sect2"><a href="#manpages">18.6.7. Packages installing man pages</a></span></dt>
                    352: <dt><span class="sect2"><a href="#gconf2-data-files">18.6.8. Packages installing GConf2 data files</a></span></dt>
                    353: <dt><span class="sect2"><a href="#scrollkeeper-data-files">18.6.9. Packages installing scrollkeeper data files</a></span></dt>
                    354: <dt><span class="sect2"><a href="#x11-fonts">18.6.10. Packages installing X11 fonts</a></span></dt>
                    355: <dt><span class="sect2"><a href="#gtk2-modules">18.6.11. Packages installing GTK2 modules</a></span></dt>
                    356: <dt><span class="sect2"><a href="#sgml-xml-data">18.6.12. Packages installing SGML or XML data</a></span></dt>
                    357: <dt><span class="sect2"><a href="#mime-database">18.6.13. Packages installing extensions to the MIME database</a></span></dt>
                    358: <dt><span class="sect2"><a href="#intltool">18.6.14. Packages using intltool</a></span></dt>
                    359: <dt><span class="sect2"><a href="#startup-scripts">18.6.15. Packages installing startup scripts</a></span></dt>
                    360: <dt><span class="sect2"><a href="#tex-packages">18.6.16. Packages installing TeX modules</a></span></dt>
                    361: <dt><span class="sect2"><a href="#emulation-packages">18.6.17. Packages supporting running binaries in
1.87      wiz       362:     emulation</a></span></dt>
1.90      rillig    363: <dt><span class="sect2"><a href="#hicolor-theme">18.6.18. Packages installing hicolor theme icons</a></span></dt>
                    364: <dt><span class="sect2"><a href="#desktop-files">18.6.19. Packages installing desktop files</a></span></dt>
1.77      rillig    365: </dl></dd>
1.90      rillig    366: <dt><span class="sect1"><a href="#punting">18.7. Marking packages as having problems</a></span></dt>
1.77      rillig    367: </dl></dd>
1.90      rillig    368: <dt><span class="chapter"><a href="#debug">19. Debugging</a></span></dt>
                    369: <dt><span class="chapter"><a href="#submit">20. Submitting and Committing</a></span></dt>
1.77      rillig    370: <dd><dl>
1.90      rillig    371: <dt><span class="sect1"><a href="#submitting-binary-packages">20.1. Submitting binary packages</a></span></dt>
                    372: <dt><span class="sect1"><a href="#submitting-your-package">20.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                    373: <dt><span class="sect1"><a href="#general-notes-for-changes">20.3. General notes when adding, updating, or removing packages</a></span></dt>
                    374: <dt><span class="sect1"><a href="#committing-importing">20.4. Committing: Importing a package into CVS</a></span></dt>
                    375: <dt><span class="sect1"><a href="#updating-package">20.5. Updating a package to a newer version</a></span></dt>
                    376: <dt><span class="sect1"><a href="#moving-package">20.6. Moving a package in pkgsrc</a></span></dt>
                    377: </dl></dd>
                    378: <dt><span class="chapter"><a href="#devfaq">21. Frequently Asked Questions</a></span></dt>
                    379: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
                    380: <dd><dl>
                    381: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                    382: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                    383: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                    384: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
1.85      jmmv      385: </dl></dd>
1.75      rillig    386: </dl></dd>
                    387: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
                    388: <dd><dl>
1.90      rillig    389: <dt><span class="chapter"><a href="#infr.design">23. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig    390: <dd><dl>
1.90      rillig    391: <dt><span class="sect1"><a href="#infr.vardef">23.1. The meaning of variable definitions</a></span></dt>
                    392: <dt><span class="sect1"><a href="#infr.vardef.problems">23.2. Avoiding problems before they arise</a></span></dt>
                    393: <dt><span class="sect1"><a href="#infr.var">23.3. Variable evaluation</a></span></dt>
1.81      rillig    394: <dd><dl>
1.90      rillig    395: <dt><span class="sect2"><a href="#infr.var.load">23.3.1. At load time</a></span></dt>
                    396: <dt><span class="sect2"><a href="#infr.var.run">23.3.2. At runtime</a></span></dt>
1.81      rillig    397: </dl></dd>
1.90      rillig    398: <dt><span class="sect1"><a href="#infr.varspec">23.4. How can variables be specified?</a></span></dt>
                    399: <dt><span class="sect1"><a href="#infr.design.intf">23.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig    400: <dd><dl>
1.90      rillig    401: <dt><span class="sect2"><a href="#infr.design.intf.proc">23.5.1. Procedures with parameters</a></span></dt>
                    402: <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    403: </dl></dd>
1.90      rillig    404: <dt><span class="sect1"><a href="#infr.order">23.6. The order in which files are loaded</a></span></dt>
1.75      rillig    405: <dd><dl>
1.90      rillig    406: <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>
                    407: <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    408: </dl></dd>
                    409: </dl></dd>
1.90      rillig    410: <dt><span class="chapter"><a href="#regression">24. Regression tests</a></span></dt>
1.75      rillig    411: <dd><dl>
1.90      rillig    412: <dt><span class="sect1"><a href="#regression.descr">24.1. The regression tests framework</a></span></dt>
                    413: <dt><span class="sect1"><a href="#regression.run">24.2. Running the regression tests</a></span></dt>
                    414: <dt><span class="sect1"><a href="#regression.new">24.3. Adding a new regression test</a></span></dt>
1.75      rillig    415: <dd><dl>
1.90      rillig    416: <dt><span class="sect2"><a href="#regression.fun.override">24.3.1. Overridable functions</a></span></dt>
                    417: <dt><span class="sect2"><a href="#regression.fun.helper">24.3.2. Helper functions</a></span></dt>
1.75      rillig    418: </dl></dd>
                    419: </dl></dd>
1.90      rillig    420: <dt><span class="chapter"><a href="#porting">25. Porting pkgsrc</a></span></dt>
1.75      rillig    421: <dd><dl>
1.90      rillig    422: <dt><span class="sect1"><a href="#porting.opsys">25.1. Porting pkgsrc to a new operating system</a></span></dt>
                    423: <dt><span class="sect1"><a href="#porting.compiler">25.2. Adding support for a new compiler</a></span></dt>
1.75      rillig    424: </dl></dd>
                    425: </dl></dd>
                    426: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
                    427: <dd><dl>
                    428: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                    429: <dd><dl>
                    430: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                    431: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                    432: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
                    433: <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>
                    434: </dl></dd>
                    435: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                    436: </dl></dd>
                    437: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
                    438: <dd><dl>
                    439: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                    440: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                    441: </dl></dd>
1.76      rillig    442: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
                    443: <dd><dl>
                    444: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</a></span></dt>
                    445: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                    446: <dt><span class="sect1"><a href="#ftp-iso">C.3. <code class="filename">iso</code>: Currently empty</a></span></dt>
                    447: <dt><span class="sect1"><a href="#ftp-misc">C.4. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                    448: <dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages*</code>: Binary packages</a></span></dt>
                    449: <dt><span class="sect1"><a href="#ftp-source">C.6. <code class="filename">current</code>,
1.93      rillig    450: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig    451: source packages</a></span></dt>
                    452: </dl></dd>
1.75      rillig    453: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
                    454: <dd><dl>
1.79      rillig    455: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75      rillig    456: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                    457: </dl></dd>
                    458: </dl>
                    459: </div>
1.82      rillig    460: <div class="list-of-tables">
                    461: <p><b>List of Tables</b></p>
                    462: <dl>
                    463: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
                    464: </dt>
                    465: <dt>3.1. <a href="#binary-kits">Binary kits and available packages</a>
                    466: </dt>
1.90      rillig    467: <dt>10.1. <a href="#patch-examples">Patching examples</a>
1.85      jmmv      468: </dt>
1.90      rillig    469: <dt>22.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85      jmmv      470: </dt>
1.82      rillig    471: </dl>
                    472: </div>
1.75      rillig    473: <div class="chapter" lang="en">
                    474: <div class="titlepage"><div><div><h2 class="title">
                    475: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h2></div></div></div>
                    476: <div class="toc">
                    477: <p><b>Table of Contents</b></p>
                    478: <dl>
                    479: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig    480: <dd><dl>
                    481: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                    482: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                    483: </dl></dd>
1.75      rillig    484: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                    485: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88      wiz       486: <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    487: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                    488: </dl>
                    489: </div>
                    490: <div class="sect1" lang="en">
                    491: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    492: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82      rillig    493: <p>There is a lot of software freely available for Unix-based
                    494: systems, which is usually available in form of the source code. Before
                    495: such software can be used, it needs to be configured to the local
                    496: system, compiled and installed, and this is exactly what The NetBSD
                    497: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
                    498: to handle binary packages, so that not every user has to build the
                    499: packages for himself, which is a time-costly task.</p>
1.75      rillig    500: <p>pkgsrc currently contains several thousand packages,
                    501:       including:</p>
                    502: <div class="itemizedlist"><ul type="disc">
1.91      rillig    503: <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    504:          web server</p></li>
1.91      rillig    505: <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    506:          web browser</p></li>
1.91      rillig    507: <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    508:          Desktop Environment</p></li>
1.91      rillig    509: <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    510:          Desktop Environment</p></li>
                    511: </ul></div>
                    512: <p>...just to name a few.</p>
                    513: <p>pkgsrc has built-in support for handling varying dependencies,
                    514:       such as pthreads and X11, and extended features such as IPv6 support on
                    515:       a range of platforms.</p>
1.82      rillig    516: <div class="sect2" lang="en">
                    517: <div class="titlepage"><div><div><h3 class="title">
                    518: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
                    519: <p>
                    520: pkgsrc provides the following key features:
                    521: </p>
                    522: <div class="itemizedlist"><ul type="disc">
                    523: <li><p>Easy building of software from source as well as the creation
                    524:   and installation of binary packages. The source and latest
                    525:   patches are retrieved from a master or mirror download site, checksum
                    526:   verified, then built on your system. Support for binary-only
                    527:   distributions is available for both native platforms and NetBSD
                    528:   emulated platforms.</p></li>
                    529: <li><p>All packages are installed in a consistent directory tree,
                    530:   including binaries, libraries, man pages and other
                    531:   documentation.</p></li>
                    532: <li><p>Package dependencies, including when performing package updates,
                    533:   are handled automatically. The configuration files of various
                    534:   packages are handled automatically during updates, so local changes
                    535:   are preserved.</p></li>
                    536: <li><p>Like NetBSD, pkgsrc is designed with portability in mind and
                    537:   consists of highly portable code. This allows the greatest speed of
                    538:   development when porting to new a platform. This portability also
                    539:   ensures that pkgsrc is <span class="emphasis"><em>consistent across all
                    540:   platforms</em></span>.</p></li>
                    541: <li><p>The installation prefix, acceptable software licenses,
                    542:   international encryption requirements and build-time options for a
                    543:   large number of packages are all set in a simple, central
                    544:   configuration file.</p></li>
                    545: <li><p>The entire source (not including the distribution files) is
                    546:   freely available under a BSD license, so you may extend and adapt
                    547:   pkgsrc to your needs. Support for local packages and patches is
                    548:   available right out of the box, so you can configure it specifically
                    549:   for your environment.</p></li>
                    550: </ul></div>
1.91      rillig    551: <p>The following principles are basic to pkgsrc:</p>
                    552: <div class="itemizedlist"><ul type="disc">
                    553: <li><p>&#8220;<span class="quote">It should only work if it's right.</span>&#8221;
                    554: &mdash; That means, if a package contains bugs, it's better to find
                    555: them and to complain about them rather than to just install the package
                    556: and hope that it works. There are numerous checks in pkgsrc that try to
                    557: 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
                    558: of shell scripts), and post-installation checks (installed files,
                    559: references to shared libraries, script interpreters).</p></li>
                    560: <li><p>&#8220;<span class="quote">If it works, it should work everywhere</span>&#8221;
                    561: &mdash; Like NetBSD has been ported to many hardware architectures,
                    562: pkgsrc has been ported to many operating systems. Care is taken that
                    563: packages behave the same on all platforms.</p></li>
                    564: </ul></div>
1.82      rillig    565: </div>
                    566: <div class="sect2" lang="en">
                    567: <div class="titlepage"><div><div><h3 class="title">
                    568: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
                    569: <p>pkgsrc consists of both a source distribution and a binary
                    570: distribution for these operating systems. After retrieving the required
                    571: source or binaries, you can be up and running with pkgsrc in just
                    572: minutes!</p>
1.75      rillig    573: <p>pkgsrc was derived from FreeBSD's ports system, and
                    574:       initially developed for NetBSD only. Since then, pkgsrc has
                    575:       grown a lot, and now supports the following platforms:</p>
1.82      rillig    576: <div class="table">
                    577: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.91      rillig    578: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
1.82      rillig    579: <colgroup>
                    580: <col>
                    581: <col>
                    582: </colgroup>
                    583: <thead><tr>
                    584: <th>Platform</th>
                    585: <th>Date Support Added</th>
                    586: </tr></thead>
                    587: <tbody>
                    588: <tr>
                    589: <td><a href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
                    590: <td align="center">Aug 1997</td>
                    591: </tr>
                    592: <tr>
                    593: <td><a href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
                    594: <td align="center">Mar 1999</td>
                    595: </tr>
                    596: <tr>
                    597: <td><a href="http://www.kernel.org/" target="_top">Linux</a></td>
                    598: <td align="center">Jun 1999</td>
                    599: </tr>
                    600: <tr>
                    601: <td>
                    602:           <a href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
                    603:           (<a href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
                    604:         </td>
                    605: <td align="center">Oct 2001</td>
                    606: </tr>
                    607: <tr>
                    608: <td><a href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
                    609: <td align="center">Nov 2002</td>
                    610: </tr>
                    611: <tr>
                    612: <td><a href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
                    613: <td align="center">Nov 2002</td>
                    614: </tr>
                    615: <tr>
                    616: <td><a href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
                    617: <td align="center">Dec 2002</td>
                    618: </tr>
                    619: <tr>
                    620: <td>BSD/OS</td>
                    621: <td align="center">Dec 2003</td>
                    622: </tr>
                    623: <tr>
                    624: <td><a href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
                    625: <td align="center">Dec 2003</td>
                    626: </tr>
                    627: <tr>
                    628: <td>
                    629:           <a href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
                    630:           (Microsoft Windows Services for Unix)
                    631:         </td>
                    632: <td align="center">Mar 2004</td>
                    633: </tr>
                    634: <tr>
                    635: <td><a href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
                    636: <td align="center">Oct 2004</td>
                    637: </tr>
                    638: <tr>
                    639: <td><a href="http://www.tru64.org/" target="_top">OSF/1</a></td>
                    640: <td align="center">Nov 2004</td>
                    641: </tr>
                    642: </tbody>
1.91      rillig    643: </table></div>
1.82      rillig    644: </div>
1.91      rillig    645: <br class="table-break">
1.82      rillig    646: </div>
1.75      rillig    647: </div>
                    648: <div class="sect1" lang="en">
                    649: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    650: <a name="overview"></a>1.2. Overview</h2></div></div></div>
                    651: <p>This document is divided into three parts. The first,
                    652:        <a href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
                    653:        describes how one can use one of the packages in the Package
                    654:        Collection, either by installing a precompiled binary package,
1.93      rillig    655:        or by building one's own copy using the NetBSD package system.
1.75      rillig    656:        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
                    657:        package so it can be easily built by other NetBSD users without
                    658:        knowing about the package's building details. The third part,
                    659:        <a href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
                    660:        is intended for those who want to understand how pkgsrc is
                    661:        implemented.</p>
                    662: <p>This document is available in various formats:
                    663:        <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>
                    664: </div>
                    665: <div class="sect1" lang="en">
                    666: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    667: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
                    668: <p>There has been a lot of talk about &#8220;<span class="quote">ports</span>&#8221;,
                    669:       &#8220;<span class="quote">packages</span>&#8221;, etc. so far. Here is a description of all the
                    670:       terminology used within this document.</p>
                    671: <div class="variablelist"><dl>
                    672: <dt><span class="term">Package</span></dt>
                    673: <dd><p>A set of files and building instructions
                    674:            that describe what's necessary
                    675:            to build a certain piece of software using
                    676:             pkgsrc. Packages are traditionally stored under
1.76      rillig    677:            <code class="filename">/usr/pkgsrc</code>.</p></dd>
1.75      rillig    678: <dt><span class="term">The NetBSD package system</span></dt>
1.87      wiz       679: <dd><p>This is the former name of &#8220;<span class="quote">pkgsrc</span>&#8221;.  It
                    680:          is part of the NetBSD operating system and can be bootstrapped
                    681:          to run on non-NetBSD operating systems as well.  It handles
                    682:          building (compiling), installing, and removing of
                    683:          packages.</p></dd>
1.75      rillig    684: <dt><span class="term">Distfile</span></dt>
                    685: <dd><p>This term describes the file or files that are
                    686:            provided by the author of the piece of software to
                    687:            distribute his work. All the changes necessary to build on
                    688:            NetBSD are reflected in the corresponding package. Usually
                    689:            the distfile is in the form of a compressed tar-archive,
                    690:            but other types are possible, too. Distfiles are usually
                    691:            stored below
1.76      rillig    692:            <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75      rillig    693: <dt><span class="term">Port</span></dt>
                    694: <dd><p>This is the term used by FreeBSD and OpenBSD people
                    695:            for what we call a package.
                    696:            In NetBSD terminology, &#8220;<span class="quote">port</span>&#8221; refers to a different
                    697:            architecture.</p></dd>
                    698: <dt><span class="term">Precompiled/binary package</span></dt>
                    699: <dd>
                    700: <p>A set of binaries built with pkgsrc from a distfile
1.76      rillig    701:            and stuffed together in a single <code class="filename">.tgz</code>
1.75      rillig    702:            file so it can be installed on machines of the same
                    703:            machine architecture without the need to
                    704:            recompile. Packages are usually generated in
1.76      rillig    705:            <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.75      rillig    706:            an archive on <a href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/" target="_top">ftp.NetBSD.org</a>.</p>
                    707: <p>Sometimes, this is referred to by the term &#8220;<span class="quote">package</span>&#8221; too,
                    708:            especially in the context of precompiled packages.</p>
                    709: </dd>
                    710: <dt><span class="term">Program</span></dt>
1.88      wiz       711: <dd><p>The piece of software to be installed which will be
                    712:          constructed from all the files in the distfile by the
                    713:          actions defined in the corresponding package.</p></dd>
1.75      rillig    714: </dl></div>
                    715: <div class="sect2" lang="en">
                    716: <div class="titlepage"><div><div><h3 class="title">
1.88      wiz       717: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.75      rillig    718: <div class="variablelist"><dl>
                    719: <dt><span class="term">pkgsrc users</span></dt>
                    720: <dd>
                    721: <p>The
                    722:        pkgsrc users are people who use the packages provided by pkgsrc.
                    723:        Typically they are system administrators. The people using the
                    724:        software that is inside the packages (maybe called &#8220;<span class="quote">end
                    725:        users</span>&#8221;) are not covered by the pkgsrc guide.</p>
                    726: <p>There are two kinds of pkgsrc users: Some only want to
                    727:        install pre-built binary packages. Others build the pkgsrc
                    728:        packages from source, either for installing them directly or for
                    729:        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
                    730:        documentation.</p>
                    731: </dd>
                    732: <dt><span class="term">package maintainers</span></dt>
                    733: <dd><p>A
                    734:        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>
                    735: <dt><span class="term">infrastructure developers</span></dt>
                    736: <dd><p>These people are involved in all those files
1.76      rillig    737:        that live in the <code class="filename">mk/</code> directory and below.
1.75      rillig    738:        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,
                    739:        too.</p></dd>
                    740: </dl></div>
                    741: </div>
                    742: </div>
                    743: <div class="sect1" lang="en">
                    744: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    745: <a name="typography"></a>1.4. Typography</h2></div></div></div>
                    746: <p>When giving examples for commands, shell prompts are used to
                    747:       show if the command should/can be issued as root, or if
                    748:       &#8220;<span class="quote">normal</span>&#8221; user privileges are sufficient. We use a
                    749:       <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
                    750:       shell prompt, assuming they use the C-shell or tcsh.</p>
                    751: </div>
                    752: </div>
                    753: <div class="part" lang="en">
                    754: <div class="titlepage"><div><div><h1 class="title">
                    755: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
                    756: <div class="toc">
                    757: <p><b>Table of Contents</b></p>
                    758: <dl>
                    759: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
                    760: <dd><dl>
                    761: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    762: <dd><dl>
                    763: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
                    764: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
                    765: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via CVS</a></span></dt>
                    766: </dl></dd>
                    767: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    768: <dd><dl>
                    769: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    770: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    771: </dl></dd>
                    772: </dl></dd>
                    773: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
                    774: <dd><dl>
1.82      rillig    775: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                    776: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                    777: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                    778: <dd><dl>
                    779: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
                    780: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
                    781: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
                    782: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
                    783: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
                    784: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
                    785: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75      rillig    786: </dl></dd>
                    787: </dl></dd>
                    788: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                    789: <dd><dl>
                    790: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                    791: <dd><dl>
                    792: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                    793: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig    794: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                    795: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                    796: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    797: <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>
                    798: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                    799: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75      rillig    800: </dl></dd>
                    801: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                    802: <dd><dl>
                    803: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                    804: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                    805: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                    806: </dl></dd>
                    807: </dl></dd>
                    808: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    809: <dd><dl>
                    810: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    811: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.78      rillig    812: <dt><span class="sect1"><a href="#conf.compiler">5.3. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       813: <dd><dl>
1.89      rillig    814: <dt><span class="sect2"><a href="#selecting-the-compiler">5.3.1. Selecting the compiler</a></span></dt>
                    815: <dt><span class="sect2"><a href="#conf.cflags">5.3.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    816: <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       817: </dl></dd>
1.78      rillig    818: <dt><span class="sect1"><a href="#developer-advanced-settings">5.4. Developer/advanced settings</a></span></dt>
                    819: <dt><span class="sect1"><a href="#selecting-build-options">5.5. Selecting Build Options</a></span></dt>
1.75      rillig    820: </dl></dd>
                    821: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    822: <dd><dl>
                    823: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    824: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
                    825: <dt><span class="sect1"><a href="#bulkbuild">6.3. Doing a bulk build of all packages</a></span></dt>
                    826: <dd><dl>
                    827: <dt><span class="sect2"><a href="#binary.configuration">6.3.1. Configuration</a></span></dt>
                    828: <dt><span class="sect2"><a href="#other-environmental-considerations">6.3.2. Other environmental considerations</a></span></dt>
                    829: <dt><span class="sect2"><a href="#operation">6.3.3. Operation</a></span></dt>
                    830: <dt><span class="sect2"><a href="#what-it-does">6.3.4. What it does</a></span></dt>
                    831: <dt><span class="sect2"><a href="#disk-space-requirements">6.3.5. Disk space requirements</a></span></dt>
                    832: <dt><span class="sect2"><a href="#setting-up-a-sandbox">6.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                    833: <dt><span class="sect2"><a href="#building-a-partial-set">6.3.7. Building a partial set of packages</a></span></dt>
                    834: <dt><span class="sect2"><a href="#bulk-upload">6.3.8. Uploading results of a bulk build</a></span></dt>
                    835: </dl></dd>
                    836: <dt><span class="sect1"><a href="#creating-cdroms">6.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                    837: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">6.4.1. Example of cdpack</a></span></dt></dl></dd>
                    838: </dl></dd>
1.90      rillig    839: <dt><span class="chapter"><a href="#files">7. Directory layout of the installed files</a></span></dt>
                    840: <dd><dl>
1.91      rillig    841: <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    842: <dt><span class="sect1"><a href="#files.varbase">7.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
                    843: </dl></dd>
                    844: <dt><span class="chapter"><a href="#faq">8. Frequently Asked Questions</a></span></dt>
1.75      rillig    845: <dd><dl>
1.90      rillig    846: <dt><span class="sect1"><a href="#mailing-list-pointers">8.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    847: <dt><span class="sect1"><a href="#pkgviews-docs">8.2. Where's the pkgviews documentation?</a></span></dt>
                    848: <dt><span class="sect1"><a href="#faq-pkgtools">8.3. Utilities for package management (pkgtools)</a></span></dt>
                    849: <dt><span class="sect1"><a href="#non-root-pkgsrc">8.4. How to use pkgsrc as non-root</a></span></dt>
                    850: <dt><span class="sect1"><a href="#resume-transfers">8.5. How to resume transfers when fetching distfiles?</a></span></dt>
                    851: <dt><span class="sect1"><a href="#XFree86-from-pkgsrc">8.6. How can I install/use XFree86 from pkgsrc?</a></span></dt>
                    852: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">8.7. How can I install/use X.org from pkgsrc?</a></span></dt>
                    853: <dt><span class="sect1"><a href="#fetch-behind-firewall">8.8. How to fetch files from behind a firewall</a></span></dt>
                    854: <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>
                    855: <dt><span class="sect1"><a href="#fetching-all-distfiles">8.10. How to fetch all distfiles at once</a></span></dt>
                    856: <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    857: /usr/share/tmac/tmac.andoc</span>&#8221; mean?</a></span></dt>
1.90      rillig    858: <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>
                    859: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">8.13. Using 'sudo' with pkgsrc</a></span></dt>
                    860: <dt><span class="sect1"><a href="#faq.conf">8.14. How do I change the location of configuration files?</a></span></dt>
                    861: <dt><span class="sect1"><a href="#audit-packages">8.15. Automated security checks</a></span></dt>
                    862: <dt><span class="sect1"><a href="#ufaq-cflags">8.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    863: <dt><span class="sect1"><a href="#ufaq-fail">8.17. A package does not build.  What shall I do?</a></span></dt>
                    864: <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    865: </dl></dd>
                    866: </dl>
                    867: </div>
                    868: <div class="chapter" lang="en">
                    869: <div class="titlepage"><div><div><h2 class="title">
                    870: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
                    871: <div class="toc">
                    872: <p><b>Table of Contents</b></p>
                    873: <dl>
                    874: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    875: <dd><dl>
                    876: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
                    877: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
                    878: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via CVS</a></span></dt>
                    879: </dl></dd>
                    880: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    881: <dd><dl>
                    882: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    883: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    884: </dl></dd>
                    885: </dl>
                    886: </div>
1.91      rillig    887: <p>Before you download and extract the files, you need to decide
                    888: where you want to extract them. When using pkgsrc as root user, pkgsrc
                    889: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
                    890: free to install the sources and binary packages wherever you want in
                    891: your filesystem, provided that the pathname does not contain white-space
                    892: or other characters that are interpreted specially by the shell and some
                    893: other programs. A safe bet is to use only letters, digits, underscores
                    894: and dashes.</p>
1.75      rillig    895: <div class="sect1" lang="en">
                    896: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    897: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
                    898: <p>Before you download any pkgsrc files, you should decide
                    899:        whether you want the <span class="emphasis"><em>current</em></span> branch or the
                    900:        <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
                    901:        quarterly basis from the current branch and only gets modified
                    902:        for security updates. The names of the stable branches are built
                    903:        from the year and the quarter, for example
1.93      rillig    904:        <code class="literal">2006Q3</code>.</p>
1.75      rillig    905: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
                    906:        want to download pkgsrc. You can get it as a tar file, via SUP,
                    907:        or via CVS. All three ways are described here.</p>
                    908: <div class="sect2" lang="en">
                    909: <div class="titlepage"><div><div><h3 class="title">
                    910: <a name="getting-via-tar"></a>2.1.1. As tar file</h3></div></div></div>
                    911: <p>The primary download location for all pkgsrc files is
                    912:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>. There are a
                    913:        number of subdirectories for different purposes, which are
1.76      rillig    914:        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    915: <p>The tar file for the current branch is in the directory
1.76      rillig    916:        <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    917:        It is autogenerated daily.</p>
1.93      rillig    918: <p>The tar file for the stable branch 2006Q3 is in the
                    919:        directory <code class="filename">pkgsrc-2006Q3</code> and is also called <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2006Q3/pkgsrc-2006Q3.tar.gz" target="_top"><code class="filename">pkgsrc-2006Q3.tar.gz</code></a>.</p>
1.75      rillig    920: <p>After downloading the tar file, change to the directory
                    921:        where you want to have pkgsrc. This is usually
1.91      rillig    922:        <code class="filename">/usr</code>. Then, run <span><strong class="command">gzcat
                    923:        pkgsrc.tar.gz | tar xf -</strong></span> to extract the files.</p>
1.75      rillig    924: </div>
                    925: <div class="sect2" lang="en">
                    926: <div class="titlepage"><div><div><h3 class="title">
                    927: <a name="getting-via-sup"></a>2.1.2. Via SUP</h3></div></div></div>
                    928: <p>As an alternative to the tar file, you can get pkgsrc via
                    929:        the Software Update Protocol, SUP. To do so, make sure your
                    930:        supfile has a line
1.1       grant     931: 
1.75      rillig    932: </p>
                    933: <pre class="programlisting">
1.51      rillig    934:     release=pkgsrc
1.1       grant     935: </pre>
1.75      rillig    936: <p>
1.1       grant     937: 
1.75      rillig    938:        in it, see the examples in
1.76      rillig    939:        <code class="filename">/usr/share/examples/supfiles</code>, and that the
                    940:        <code class="filename">/usr/pkgsrc</code> directory exists. Then, simply
1.75      rillig    941:        run <span><strong class="command">sup -v
                    942:        <em class="replaceable"><code>/path/to/your/supfile</code></em></strong></span>.</p>
                    943: </div>
                    944: <div class="sect2" lang="en">
                    945: <div class="titlepage"><div><div><h3 class="title">
                    946: <a name="getting-via-cvs"></a>2.1.3. Via CVS</h3></div></div></div>
                    947: <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>
                    948:        installed. To do an initial (full) checkout of pkgsrc, you first
                    949:        have to set some environment variables. For the C-Shell,
                    950:        type:</p>
                    951: <pre class="screen">
                    952:     <code class="prompt">%</code> <strong class="userinput"><code>setenv CVSROOT anoncvs@anoncvs.NetBSD.org:/cvsroot</code></strong>
                    953:     <code class="prompt">%</code> <strong class="userinput"><code>setenv CVS_RSH ssh</code></strong>
                    954: </pre>
                    955: <p>Or, the same for the bourne shell:</p>
                    956: <pre class="screen">
                    957:     <code class="prompt">$</code> <strong class="userinput"><code>CVSROOT="anoncvs@anoncvs.NetBSD.org:/cvsroot"</code></strong>
                    958:     <code class="prompt">$</code> <strong class="userinput"><code>CVS_RSH="ssh"</code></strong>
                    959:     <code class="prompt">$</code> <strong class="userinput"><code>export CVSROOT CVS_RSH</code></strong>
                    960: </pre>
                    961: <p>Then, you change to the directory where you want to have
                    962:        your copy of pkgsrc. In most cases this is
1.76      rillig    963:        <code class="filename">/usr</code>. In that directory you run the
1.75      rillig    964:        checkout command, which is <span><strong class="command">cvs -q checkout -P
                    965:        pkgsrc</strong></span> for the current branch and <span><strong class="command">cvs -q
1.93      rillig    966:        checkout -rpkgsrc-2006Q3 -P pkgsrc</strong></span> for the stable
1.75      rillig    967:        branch. This command will create a directory called
1.76      rillig    968:        <code class="filename">pkgsrc</code> with all the pkgsrc files in
1.75      rillig    969:        it.</p>
                    970: </div>
                    971: </div>
                    972: <div class="sect1" lang="en">
                    973: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    974: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
                    975: <p>The preferred way to keep pkgsrc up-to-date is via CVS
                    976:        (which also works if you have first installed it via a tar
                    977:        file). It saves bandwidth and hard disk activity, compared to
                    978:        downloading the tar file again.</p>
                    979: <div class="sect2" lang="en">
                    980: <div class="titlepage"><div><div><h3 class="title">
                    981: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
                    982: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
                    983: <h3 class="title">Warning</h3>
1.77      rillig    984: <p>When updating from a tar file, you first need to
                    985:        completely remove the old pkgsrc directory. Otherwise those
                    986:        files that have been removed from pkgsrc in the mean time will
                    987:        not be removed on your local disk, resulting in inconsistencies.
                    988:        When removing the old files, any changes that you have done to
                    989:        the pkgsrc files will be lost after updating. Therefore updating
                    990:        via CVS is strongly recommended.</p>
1.75      rillig    991: </div>
1.82      rillig    992: <p>Note that by default the distfiles and the binary packages
                    993:        are saved in the pkgsrc tree, so don't forget to rescue them
                    994:        before updating. You can also configure pkgsrc to use other than
                    995:        the default directories by setting the
                    996:        <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
                    997:        variables. See <a href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1.75      rillig    998: <p>To update pkgsrc from a tar file, download the tar file as
                    999:        explained above. Then, make sure that you have not made any
                   1000:        changes to the files in the pkgsrc directory. Remove the pkgsrc
                   1001:        directory and extract the new tar file. Done.</p>
                   1002: </div>
                   1003: <div class="sect2" lang="en">
                   1004: <div class="titlepage"><div><div><h3 class="title">
                   1005: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
                   1006: <p>To update pkgsrc via CVS, make sure the environment
                   1007:        variable <code class="varname">CVS_RSH</code> is set as above. Then,
                   1008:        change to the pkgsrc directory and run <span><strong class="command">cvs -q update
1.77      rillig   1009:        -dP</strong></span>.</p>
1.75      rillig   1010: <div class="sect3" lang="en">
                   1011: <div class="titlepage"><div><div><h4 class="title">
                   1012: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
                   1013: <p>When updating pkgsrc, the CVS program keeps track of the
                   1014:        branch you selected. But if you, for whatever reason, want to
                   1015:        switch from the stable branch to the current one, you can do it
                   1016:        by adding the option &#8220;<span class="quote">-A</span>&#8221; after the
                   1017:        &#8220;<span class="quote">update</span>&#8221; keyword. To switch from the current branch
                   1018:        back to the stable branch, add the
1.93      rillig   1019:        &#8220;<span class="quote">-rpkgsrc-2006Q3</span>&#8221; option.</p>
1.75      rillig   1020: </div>
                   1021: <div class="sect3" lang="en">
                   1022: <div class="titlepage"><div><div><h4 class="title">
                   1023: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
                   1024: <p>When you update pkgsrc, the CVS program will only touch
                   1025:        those files that are registered in the CVS repository. That
                   1026:        means that any packages that you created on your own will stay
                   1027:        unmodified. If you change files that are managed by CVS, later
                   1028:        updates will try to merge your changes with those that have been
                   1029:        done by others. See the CVS manual, chapter
                   1030:        &#8220;<span class="quote">update</span>&#8221; for details.</p>
                   1031: </div>
                   1032: </div>
                   1033: </div>
                   1034: </div>
                   1035: <div class="chapter" lang="en">
                   1036: <div class="titlepage"><div><div><h2 class="title">
                   1037: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
                   1038: <div class="toc">
                   1039: <p><b>Table of Contents</b></p>
                   1040: <dl>
1.82      rillig   1041: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                   1042: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                   1043: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                   1044: <dd><dl>
                   1045: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
                   1046: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
                   1047: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
                   1048: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
                   1049: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
                   1050: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
                   1051: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75      rillig   1052: </dl></dd>
                   1053: </dl>
                   1054: </div>
                   1055: <div class="sect1" lang="en">
                   1056: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82      rillig   1057: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
                   1058: <p>
                   1059: We provide a bootstrap kit in both source and binary form for other
                   1060: platforms than NetBSD, consisting of the pkg administration tools and other
                   1061: tools required to use pkgsrc and build packages.
                   1062: </p>
                   1063: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1064: <h3 class="title">Note</h3>
                   1065: <p>
                   1066: Older binary snapshots are available in the
                   1067: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/archive/" target="_top">bootstrap-pkgsrc/archive</a>
                   1068: directory on ftp.NetBSD.org.</p>
                   1069: </div>
                   1070: <div class="table">
                   1071: <a name="binary-kits"></a><p class="title"><b>Table 3.1. Binary kits and available packages</b></p>
1.91      rillig   1072: <div class="table-contents"><table summary="Binary kits and available packages" border="1">
1.82      rillig   1073: <colgroup>
                   1074: <col>
                   1075: <col>
                   1076: <col>
                   1077: <col>
                   1078: </colgroup>
                   1079: <thead><tr>
                   1080: <th>Platform</th>
                   1081: <th>Latest snapshot</th>
                   1082: <th>Binary kit</th>
                   1083: <th>Binary packages</th>
                   1084: </tr></thead>
                   1085: <tbody>
                   1086: <tr>
                   1087: <td class="osname">Darwin 5.5/powerpc (Mac OS X 10.1.5)</td>
                   1088: <td class="date">20021209</td>
                   1089: <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>
                   1090: <td class="binary-pkgs-url"> </td>
                   1091: </tr>
                   1092: <tr>
                   1093: <td class="osname">Darwin 6.6/powerpc (Mac OS X 10.2.6)</td>
                   1094: <td class="date">20030623</td>
                   1095: <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>
                   1096: <td class="binary-pkgs-url"> </td>
                   1097: </tr>
                   1098: <tr>
                   1099: <td class="osname">Darwin 7.6/powerpc (Mac OS X 10.3.6)</td>
                   1100: <td class="date">20041219</td>
                   1101: <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>
                   1102: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/Darwin-7.6/" target="_top">binary packages</a></td>
                   1103: </tr>
                   1104: <tr>
                   1105: <td class="osname">Darwin 7.8/powerpc (Mac OS X 10.3.8)</td>
                   1106: <td class="date">20050320</td>
                   1107: <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>
                   1108: <td class="binary-pkgs-url"> </td>
                   1109: </tr>
                   1110: <tr>
                   1111: <td class="osname">Darwin 8.1/powerpc (Mac OS X 10.4.1)</td>
                   1112: <td class="date">20050625</td>
                   1113: <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>
                   1114: <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>
                   1115: </tr>
                   1116: <tr>
                   1117: <td class="osname">Debian GNU Linux/i386</td>
                   1118: <td class="date">20031023</td>
                   1119: <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>
                   1120: <td class="binary-pkgs-url"> </td>
                   1121: </tr>
                   1122: <tr>
                   1123: <td class="osname">Fedora Core 2 Linux/i386</td>
                   1124: <td class="date">20050618</td>
                   1125: <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>
                   1126: <td class="binary-pkgs-url"> </td>
                   1127: </tr>
                   1128: <tr>
                   1129: <td class="osname">Fedora Core 4 Linux/i386</td>
                   1130: <td class="date">20060105</td>
                   1131: <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>
                   1132: <td class="binary-pkgs-url"> </td>
                   1133: </tr>
                   1134: <tr>
                   1135: <td class="osname">FreeBSD 3.5/i386</td>
                   1136: <td class="date">20030411</td>
                   1137: <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>
                   1138: <td class="binary-pkgs-url"> </td>
                   1139: </tr>
                   1140: <tr>
                   1141: <td class="osname">FreeBSD 4.7/i386</td>
                   1142: <td class="date">20021211</td>
                   1143: <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>
                   1144: <td class="binary-pkgs-url"> </td>
                   1145: </tr>
                   1146: <tr>
                   1147: <td class="osname">FreeBSD 5.0/i386</td>
                   1148: <td class="date">20030411</td>
                   1149: <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>
                   1150: <td class="binary-pkgs-url"> </td>
                   1151: </tr>
                   1152: <tr>
                   1153: <td class="osname">FreeBSD 5.1/i386</td>
                   1154: <td class="date">20030630</td>
                   1155: <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>
                   1156: <td class="binary-pkgs-url"> </td>
                   1157: </tr>
                   1158: <tr>
                   1159: <td class="osname">FreeBSD 5.2.1/i386</td>
                   1160: <td class="date">20040227</td>
                   1161: <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>
                   1162: <td class="binary-pkgs-url"> </td>
                   1163: </tr>
                   1164: <tr>
                   1165: <td class="osname">FreeBSD 5.3/i386</td>
                   1166: <td class="date">20050119</td>
                   1167: <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>
                   1168: <td class="binary-pkgs-url"> </td>
                   1169: </tr>
                   1170: <tr>
                   1171: <td class="osname">Interix 3.5</td>
1.93      rillig   1172: <td class="date">20061106</td>
                   1173: <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>
                   1174: <td class="binary-pkgs-url"> </td>
1.82      rillig   1175: </tr>
                   1176: <tr>
                   1177: <td class="osname">IRIX 6.5 n32-bit ABI</td>
                   1178: <td class="date">20040911</td>
                   1179: <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>
                   1180: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/IRIX-6.5/n32/" target="_top">binary packages</a></td>
                   1181: </tr>
                   1182: <tr>
                   1183: <td class="osname">IRIX 6.5 64-bit ABI</td>
                   1184: <td class="date">20040912</td>
                   1185: <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>
                   1186: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/IRIX-6.5/64/" target="_top">binary packages</a></td>
                   1187: </tr>
                   1188: <tr>
                   1189: <td class="osname">OpenBSD 3.2/i386</td>
                   1190: <td class="date">20030420</td>
                   1191: <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>
                   1192: <td class="binary-pkgs-url"> </td>
                   1193: </tr>
                   1194: <tr>
                   1195: <td class="osname">OpenBSD 3.3/i386</td>
                   1196: <td class="date">20030503</td>
                   1197: <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>
                   1198: <td class="binary-pkgs-url"> </td>
                   1199: </tr>
                   1200: <tr>
                   1201: <td class="osname">OpenBSD 3.5/i386</td>
1.93      rillig   1202: <td class="date">20040703</td>
1.82      rillig   1203: <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>
                   1204: <td class="binary-pkgs-url"> </td>
                   1205: </tr>
                   1206: <tr>
                   1207: <td class="osname">Slackware Linux 8.1/i386</td>
                   1208: <td class="date">20030417</td>
                   1209: <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>
                   1210: <td class="binary-pkgs-url"> </td>
                   1211: </tr>
                   1212: <tr>
                   1213: <td class="osname">Slackware Linux 9/i386</td>
1.93      rillig   1214: <td class="date">20040703</td>
1.82      rillig   1215: <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>
                   1216: <td class="binary-pkgs-url"> </td>
                   1217: </tr>
                   1218: <tr>
                   1219: <td class="osname">Solaris 8/sparc</td>
                   1220: <td class="date">20050220</td>
                   1221: <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>
                   1222: <td class="binary-pkgs-url"> </td>
                   1223: </tr>
                   1224: <tr>
                   1225: <td class="osname">Solaris 8/i386</td>
                   1226: <td class="date">20050220</td>
                   1227: <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>
                   1228: <td class="binary-pkgs-url"> </td>
                   1229: </tr>
                   1230: <tr>
                   1231: <td class="osname">Solaris 9/sparc</td>
1.93      rillig   1232: <td class="date">20060713</td>
                   1233: <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>
                   1234: <td class="binary-pkgs-url"> </td>
1.82      rillig   1235: </tr>
                   1236: <tr>
                   1237: <td class="osname">Solaris 9/i386</td>
                   1238: <td class="date">20030411</td>
                   1239: <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>
                   1240: <td class="binary-pkgs-url"> </td>
                   1241: </tr>
                   1242: </tbody>
1.91      rillig   1243: </table></div>
1.82      rillig   1244: </div>
1.91      rillig   1245: <br class="table-break"><p>
1.82      rillig   1246: Simply download the binary kit for your platform, and extract it into
                   1247: <code class="filename">/</code> e.g.
                   1248: </p>
                   1249: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   1250: <code class="prompt">#</code> <strong class="userinput"><code>gzip -c -d /tmp/bootstrap-pkgsrc-SunOS-5.9-sparc-20031023.tar.gz \
                   1251:   | tar -xpf -</code></strong></pre>
                   1252: <p>
                   1253: Of course, as with any binary distributions, you should verify the
                   1254: checksum against the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/SUM" target="_top">SUM</a>
                   1255: or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/CKSUM" target="_top">CKSUM</a>
                   1256: file and inspect the contents before extracting it.
                   1257: </p>
                   1258: </div>
                   1259: <div class="sect1" lang="en">
                   1260: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1261: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
                   1262: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75      rillig   1263: <pre class="screen">
                   1264: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc</code></strong>
                   1265: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87      wiz      1266: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
                   1267:     </pre>
1.75      rillig   1268: <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      1269:     pkgsrc before bootstrapping. The given
                   1270:     <span><strong class="command">bootstrap</strong></span> command will use the defaults of
                   1271:     <code class="filename">/usr/pkg</code> for the
                   1272:     <span class="emphasis"><em>prefix</em></span> where programs will be installed in,
                   1273:     and <code class="filename">/var/db/pkg</code> for the package database
                   1274:     directory where pkgsrc will do its internal bookkeeping.
                   1275:     However, these can also be set using command-line
                   1276:     arguments.</p>
1.75      rillig   1277: <p>Binary packages for the pkgsrc tools and an initial set of packages is
1.87      wiz      1278:     available for supported platforms. An up-to-date list of these can be
                   1279:     found on <a href="http://www.pkgsrc.org/" target="_top">www.pkgsrc.org</a>.
                   1280:     Note that this only works for privileged builds that install
                   1281:     into <code class="filename">/usr/pkg</code>.</p>
1.75      rillig   1282: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1283: <h3 class="title">Note</h3>
                   1284: <p>The bootstrap installs a <span><strong class="command">bmake</strong></span> tool.
1.87      wiz      1285:       Use this <span><strong class="command">bmake</strong></span> when building via pkgsrc.
                   1286:       For examples in this guide, use <span><strong class="command">bmake</strong></span>
                   1287:       instead of &#8220;<span class="quote">make</span>&#8221;.</p>
1.75      rillig   1288: </div>
                   1289: </div>
                   1290: <div class="sect1" lang="en">
                   1291: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82      rillig   1292: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1.75      rillig   1293: <p>Here are some platform-specific notes you should be aware of.</p>
                   1294: <div class="sect2" lang="en">
                   1295: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1296: <a name="darwin"></a>3.3.1. Darwin (Mac OS X)</h3></div></div></div>
1.85      jmmv     1297: <p>Darwin 5.x and up are supported. There are two methods of using
1.82      rillig   1298:        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   1299:          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   1300:          partition</a>.</p>
                   1301: <p>Before you start, you will need to download and install the Mac OS X Developer
1.87      wiz      1302:       Tools from Apple's Developer Connection.  See <a href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
                   1303:       for details.  Also, make sure you install X11 for Mac OS X and the X11 SDK
                   1304:       from <a href="http://www.apple.com/macosx/x11/download/" target="_top">http://www.apple.com/macosx/x11/download/</a>
                   1305:       if you intend to build packages that use the X11 Window System.</p>
1.89      rillig   1306: <p>If you already have a UFS or HFSX partition, or have a spare partition
                   1307:       that you can format as UFS or HFSX, it is recommended to use that instead of
1.87      wiz      1308:       the disk image. It'll be somewhat faster and will mount automatically
                   1309:       at boot time, where you must manually mount a disk image.</p>
1.75      rillig   1310: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1311: <h3 class="title">Note</h3>
1.85      jmmv     1312: <p>You cannot use an ordinary HFS+ file system for pkgsrc, because pkgsrc currently
1.89      rillig   1313:          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   1314: </div>
                   1315: <div class="sect3" lang="en">
                   1316: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1317: <a name="platform.osx-image"></a>3.3.1.1. Using a disk image</h4></div></div></div>
1.75      rillig   1318: <p>Create the disk image:</p>
                   1319: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.95    ! tron     1320: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage create ~/Documents/NetBSD 1024</code></strong> # megabytes - season to taste
1.85      jmmv     1321: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage mount ~/Documents/NetBSD</code></strong>
1.75      rillig   1322: <code class="prompt">#</code> <strong class="userinput"><code>sudo chown `id -u`:`id -g` /Volumes/NetBSD</code></strong></pre>
1.85      jmmv     1323: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1324: <h3 class="title">Note</h3>
1.89      rillig   1325: <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     1326: </div>
1.89      rillig   1327: <p>Allow suid:</p>
                   1328: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sudo mount -u -o suid /Volumes/NetBSD</code></strong></pre>
1.75      rillig   1329: </div>
                   1330: <div class="sect3" lang="en">
                   1331: <div class="titlepage"><div><div><h4 class="title">
1.89      rillig   1332: <a name="platform.osx-part"></a>3.3.1.2. Using a UFS or HFSX partition</h4></div></div></div>
1.76      rillig   1333: <p>By default, <code class="filename">/usr</code> will be on your root file
1.87      wiz      1334:        system, normally HFS+. It is possible to use the default
                   1335:        <span class="emphasis"><em>prefix</em></span> of <code class="filename">/usr/pkg</code>
                   1336:        by symlinking <code class="filename">/usr/pkg</code> to a directory on a UFS
1.89      rillig   1337:        or HFSX file system. Obviously, another symlink is required if you want to
1.87      wiz      1338:        place the package database directory outside the
                   1339:        <span class="emphasis"><em>prefix</em></span>. e.g.</p>
1.75      rillig   1340: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --pkgdbdir /usr/pkg/pkgdb</code></strong></pre>
                   1341: <p>If you created your partitions at the time of installing Mac OS X
1.89      rillig   1342:        and formatted the target partition as UFS or HFSX, it should automatically
1.87      wiz      1343:        mount on <code class="filename">/Volumes/&lt;volume name&gt;</code> when the
1.89      rillig   1344:        machine boots. If you are (re)formatting a partition as UFS or HFSX, you need
1.87      wiz      1345:        to ensure that the partition map correctly reflects
1.89      rillig   1346:        &#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   1347: <p>The problem is that none of the disk tools will let you touch a
1.87      wiz      1348:        disk that is booted from. You can unmount the partition, but even if
                   1349:        you newfs it, the partition type will be incorrect and the
                   1350:        automounter won't mount it. It can be mounted manually, but it won't
                   1351:        appear in Finder.</p>
1.75      rillig   1352: <p>You'll need to boot off of the OS X Installation (User) CD.  When
1.87      wiz      1353:        the Installation program starts, go up to the menu and select Disk
                   1354:        Utility.  Now, you will be able to select the partition you want
1.89      rillig   1355:        to be UFS or HFSX, and Format it Apple UFS or HFSX. Quit the Disk Utility, quit the
                   1356:        installer which will reboot your machine. The new UFS or HFSX file system
1.87      wiz      1357:        will appear in Finder.</p>
1.75      rillig   1358: <p>Be aware that the permissions on the new file system will be writable
1.87      wiz      1359:        by root only.</p>
1.75      rillig   1360: <p>This note is as of 10.2 (Jaguar) and applies to earlier versions.
1.87      wiz      1361:        Hopefully Apple will fix Disk Utility in 10.3 (Panther).</p>
1.75      rillig   1362: </div>
                   1363: </div>
                   1364: <div class="sect2" lang="en">
                   1365: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1366: <a name="freebsd"></a>3.3.2. FreeBSD</h3></div></div></div>
1.87      wiz      1367: <p>FreeBSD 4.7 and 5.0 have been tested and are supported,
                   1368:       other versions may work.</p>
1.75      rillig   1369: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87      wiz      1370:       with the FreeBSD userland tools. There are several steps:</p>
1.75      rillig   1371: <div class="orderedlist"><ol type="1">
                   1372: <li><p>FreeBSD stores its ports pkg database in
1.87      wiz      1373:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1374:          recommended that you choose a different location (e.g.
                   1375:          <code class="filename">/usr/pkgdb</code>) by
                   1376:          using the --pkgdbdir option to the bootstrap script.</p></li>
1.75      rillig   1377: <li>
                   1378: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1.87      wiz      1379:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1380: <pre class="screen">
                   1381: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75      rillig   1382: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1383: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1384: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87      wiz      1385: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1386:          </pre>
1.75      rillig   1387: </li>
1.76      rillig   1388: <li><p>An example <code class="filename">/etc/mk.conf</code> file will be placed in
1.87      wiz      1389:          <code class="filename">/etc/mk.conf.example</code> file
                   1390:          when you use the bootstrap script.</p></li>
1.75      rillig   1391: </ol></div>
                   1392: </div>
                   1393: <div class="sect2" lang="en">
                   1394: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1395: <a name="interix"></a>3.3.3. Interix</h3></div></div></div>
1.75      rillig   1396: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1.87      wiz      1397:       providing a Unix-like environment with a tighter kernel integration than
                   1398:       available with Cygwin.  It is part of the Windows Services for Unix
                   1399:       package, available for free for any licensed copy of Windows 2000, XP
                   1400:       (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   1401: <p>Services for Unix 3.5 has been tested.  3.0 or 3.1 may work, but
                   1402:       are not officially supported.  (The main difference in 3.0/3.1 is lack
                   1403:       of pthreads, but other parts of libc may also be lacking.)</p>
                   1404: <p>Services for Unix Applications (aka SUA) is an integrated component
                   1405:       of Windows Server 2003 R2 and Windows Vista.  As of this writing, SUA's
1.95    ! tron     1406:       Interix 5.x subsystem has not yet been tested with pkgsrc.</p>
1.75      rillig   1407: <div class="sect3" lang="en">
                   1408: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1409: <a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
1.75      rillig   1410: <p>At an absolute minimum, the following packages must be installed from
1.87      wiz      1411:        the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.75      rillig   1412: <div class="itemizedlist"><ul type="disc">
                   1413: <li><p>Utilities -&gt; Base Utilities</p></li>
                   1414: <li><p>Interix GNU Components -&gt; (all)</p></li>
                   1415: <li><p>Remote Connectivity</p></li>
                   1416: <li><p>Interix SDK</p></li>
                   1417: </ul></div>
                   1418: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1.87      wiz      1419:        "UNIX Perl".  That is Perl 5.6 without shared module support, installed to
                   1420:        /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
                   1421:        pkgsrc (or from a binary package).</p>
1.75      rillig   1422: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1.87      wiz      1423:        not need to be installed, but Remote Connectivity itself should be
                   1424:        installed in order to have a working inetd.</p>
1.75      rillig   1425: <p>During installation you may be asked whether to enable setuid
1.87      wiz      1426:        behavior for Interix programs, and whether to make pathnames default to
                   1427:        case-sensitive.  Setuid should be enabled, and case-sensitivity MUST be
                   1428:        enabled.  (Without case-sensitivity, a large number of packages including
                   1429:        perl will not build.)</p>
1.75      rillig   1430: <p>NOTE:  Newer Windows service packs change the way binary execution
1.87      wiz      1431:        works (via the Data Execution Prevention feature).  In order to use
                   1432:        pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
                   1433:        POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
                   1434:        must be installed.  Hotfixes are available from Microsoft through a
                   1435:        support contract; however, a NetBSD developer has made most Interix
                   1436:        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   1437: <p>In addition to the hotfix noted above, it may be necessary to
                   1438:        disable Data Execution Prevention entirely to make Interix functional.
                   1439:        This may happen only with certain types of CPUs; the cause is not fully
                   1440:        understood at this time.  If gcc or other applications still segfault
                   1441:        repeatedly after installing one of the hotfixes note above, the
                   1442:        following option can be added to the appropriate "boot.ini" line on the
                   1443:        Windows boot drive:  /NoExecute=AlwaysOff
                   1444:        (WARNING, this will disable DEP completely, which may be a security
                   1445:        risk if applications are often run as a user in the Administrators
                   1446:        group!)</p>
1.75      rillig   1447: </div>
                   1448: <div class="sect3" lang="en">
                   1449: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1450: <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   1451: <p>If SFU is already installed and you wish to alter these settings to work
1.87      wiz      1452:        with pkgsrc, note the following things.</p>
1.75      rillig   1453: <div class="itemizedlist"><ul type="disc">
                   1454: <li><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.87      wiz      1455:            Windows Services for UNIX, then click Change.  In the installer, choose
                   1456:            Add or Remove, then uncheck Utilities-&gt;UNIX Perl.</p></li>
1.75      rillig   1457: <li>
                   1458: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1.87      wiz      1459:            change the following registry key:</p>
1.75      rillig   1460: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
                   1461: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
                   1462: </li>
                   1463: <li>
                   1464: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1.87      wiz      1465:            following registry key:</p>
1.75      rillig   1466: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
                   1467: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
                   1468: </li>
                   1469: </ul></div>
                   1470: </div>
                   1471: <div class="sect3" lang="en">
                   1472: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1473: <a name="platform.interix-notes"></a>3.3.3.3. Important notes for using pkgsrc</h4></div></div></div>
1.75      rillig   1474: <p>The package manager (either the pkgsrc "su" user, or the user
1.87      wiz      1475:        running "pkg_add") must be a member of the local Administrators
                   1476:        group.  Such a user must also be used to run the bootstrap.  This is
                   1477:        slightly relaxed from the normal pkgsrc requirement of "root".</p>
1.75      rillig   1478: <p>The package manager should use a umask of 002.  "make install" will
1.87      wiz      1479:        automatically complain if this is not the case.  This ensures that
                   1480:        directories written in /var/db/pkg are Administrators-group writeable.</p>
1.75      rillig   1481: <p>The popular Interix binary packages from http://www.interopsystems.com/
1.87      wiz      1482:        use an older version of pkgsrc's pkg_* tools.  Ideally, these should
                   1483:        NOT be used in conjunction with pkgsrc.  If you choose to use them at
                   1484:        the same time as the pkgsrc packages, ensure that you use the proper
                   1485:        pkg_* tools for each type of binary package.</p>
1.75      rillig   1486: <p>The TERM setting used for DOS-type console windows (including those
1.87      wiz      1487:        invoked by the csh and ksh startup shortcuts) is "interix".  Most systems
                   1488:        don't have a termcap/terminfo entry for it, but the following .termcap
                   1489:        entry provides adequate emulation in most cases:</p>
1.75      rillig   1490: <pre class="programlisting">
1.87      wiz      1491:          interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
                   1492:        </pre>
1.75      rillig   1493: </div>
                   1494: <div class="sect3" lang="en">
                   1495: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1496: <a name="platform.interix-limits"></a>3.3.3.4. Limitations of the Interix platform</h4></div></div></div>
1.75      rillig   1497: <p>Though Interix suffices as a familiar and flexible substitute
1.87      wiz      1498:        for a full Unix-like platform, it has some drawbacks that should
                   1499:        be noted for those desiring to make the most of Interix.</p>
1.75      rillig   1500: <div class="itemizedlist"><ul type="disc">
                   1501: <li>
                   1502: <p><span class="strong"><strong>X11:</strong></span></p>
                   1503: <p>Interix comes with the standard set of X11R6 client libraries,
1.87      wiz      1504:          and can run X11 based applications, but it does
                   1505:          <span class="emphasis"><em>not</em></span> come with an X server.  Some options are
                   1506:          <a href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
                   1507:          <a href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
                   1508:          (available in a trimmed version for Interix from Interop Systems as the
                   1509:          <a href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
                   1510:          and the free X11 server included with
                   1511:          <a href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.75      rillig   1512: </li>
                   1513: <li>
                   1514: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
                   1515: <p>Because Interix runs in a completely different NT subsystem from
1.87      wiz      1516:          Win32 applications, it does not currently support various X11
                   1517:          protocol extensions for acceleration (such as MIT-SHM or DGA).
                   1518:          Most interactive applications to a local X server will run
                   1519:          reasonably fast, but full motion video and other graphics
                   1520:          intensive applications may require a faster-than-expected CPU.</p>
1.75      rillig   1521: </li>
                   1522: <li>
                   1523: <p><span class="strong"><strong>Audio:</strong></span></p>
                   1524: <p>Interix has no native support for audio output.  For audio
1.87      wiz      1525:          support, pkgsrc uses the <span><strong class="command">esound</strong></span> client/server
                   1526:          audio system on Interix.  Unlike on most platforms, the
1.91      rillig   1527:          <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      1528:          <span class="emphasis"><em>not</em></span> contain the <span><strong class="command">esd</strong></span>
                   1529:          server component.  To output audio via an Interix host, the
1.91      rillig   1530:          <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      1531:          must also be installed.</p>
1.75      rillig   1532: </li>
                   1533: <li>
                   1534: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
                   1535: <p>Direct device access is not currently supported in Interix, so it
1.87      wiz      1536:          is not currently possible to access CD/DVD drives, USB devices,
                   1537:          or SCSI devices through non-filesystem means.  Among other things,
                   1538:          this makes it impossible to use Interix directly for CD/DVD
                   1539:          burning.</p>
1.75      rillig   1540: </li>
                   1541: <li>
                   1542: <p><span class="strong"><strong>Tape drives:</strong></span></p>
                   1543: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1.87      wiz      1544:          drives are also not directly accessible in Interix.  However,
                   1545:          support is in work to make tape drive access possible by using
                   1546:          Cygwin as a bridge (similarly to audio bridged via Cygwin's
                   1547:          esound server).</p>
1.75      rillig   1548: </li>
                   1549: </ul></div>
                   1550: </div>
                   1551: <div class="sect3" lang="en">
                   1552: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1553: <a name="platform.interix-knownissues"></a>3.3.3.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.75      rillig   1554: <p>It is not necessary, in general, to have a "root" user on the
1.87      wiz      1555:        Windows system; any member of the local Administrators group will
                   1556:        suffice.  However, some packages currently assume that the user
                   1557:        named "root" is the privileged user.  To accommodate these, you
                   1558:        may create such a user; make sure it is in the local group
                   1559:        Administrators (or your language equivalent).</p>
                   1560: <p><span><strong class="command">pkg_add</strong></span> creates directories of mode
                   1561:        0755, not 0775, in <code class="filename">$PKG_DBDIR</code>.  For the
                   1562:        time being, install packages as the local Administrator (or
                   1563:        your language equivalent), or run the following command after
                   1564:        installing a package to work around the issue:</p>
1.75      rillig   1565: <pre class="screen">
1.87      wiz      1566: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
                   1567:        </pre>
1.75      rillig   1568: </div>
                   1569: </div>
                   1570: <div class="sect2" lang="en">
                   1571: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1572: <a name="irix"></a>3.3.4. IRIX</h3></div></div></div>
1.75      rillig   1573: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1.87      wiz      1574:       compiler (cc/c89).  Please set the <code class="varname">CC</code> environment variable
                   1575:       according to your preference.  If you do not have a license for the MIPSpro
                   1576:       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   1577: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.87      wiz      1578:       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>,
                   1579:       etc.</p>
1.86      schwarz  1580: <p>At this point in time, pkgsrc only supports one ABI at a time.  That is, you cannot
1.75      rillig   1581:        switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI.  If
                   1582:        you start out using "abi=n32", that's what all your packages will be built
                   1583:        with.</p>
                   1584: <p>Therefore, please make sure that you have no conflicting
1.87      wiz      1585:       <code class="varname">CFLAGS</code> in your environment or the
                   1586:       <code class="filename">/etc/mk.conf</code>.  Particularly, make sure that you do not
                   1587:       try to link n32 object files with lib64 or vice versa.  Check your
                   1588:       <code class="filename">/etc/compiler.defaults</code>!</p>
1.75      rillig   1589: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1.87      wiz      1590:       please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
                   1591:       as it appears that IRIX linker occasionally runs into issues when trying to
                   1592:       link over a network-mounted file system.</p>
1.75      rillig   1593: <p>The bootstrapping process should set all the right options for programs such
1.87      wiz      1594:       as imake(1), but you may want to set some options depending on your local
                   1595:       setup.  Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
                   1596:       course, your compiler's man pages for details.</p>
1.75      rillig   1597: <p>If you are using SGI's MIPSPro compiler, please set
1.1       grant    1598: 
1.87      wiz      1599:       </p>
1.75      rillig   1600: <pre class="programlisting">
1.87      wiz      1601:        PKGSRC_COMPILER=        mipspro
                   1602:       </pre>
1.75      rillig   1603: <p>
1.1       grant    1604: 
1.87      wiz      1605:       in <code class="filename">/etc/mk.conf</code>.  Otherwise, pkgsrc will assume you
                   1606:       are using gcc and may end up passing invalid flags to the compiler.  Note that
                   1607:       bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
                   1608:       default.</p>
1.75      rillig   1609: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1.93      rillig   1610:       but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1.87      wiz      1611:       to <span class="emphasis"><em>not</em></span> include the location of gcc (often
                   1612:       <code class="filename">/usr/freeware/bin</code>), and (important) pass the
                   1613:       '--preserve-path' flag.</p>
1.75      rillig   1614: </div>
                   1615: <div class="sect2" lang="en">
                   1616: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1617: <a name="linux"></a>3.3.5. Linux</h3></div></div></div>
1.87      wiz      1618: <p>Some versions of Linux (for example Debian GNU/Linux) need
                   1619:       either libtermcap or libcurses (libncurses).  Installing the
                   1620:       distributions libncurses-dev package (or equivalent) should fix
                   1621:       the problem.</p>
                   1622: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
                   1623:       (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
                   1624:       i386 have been tested.</p>
1.75      rillig   1625: <p>To bootstrap using icc, assuming the default icc installation
1.87      wiz      1626:       directory:</p>
1.75      rillig   1627: <pre class="programlisting">
1.87      wiz      1628:        env CC=/opt/intel_cc_80/bin/icc LDFLAGS=-static-libcxa \
                   1629:        ac_cv___attribute__=yes ./bootstrap
                   1630:       </pre>
1.75      rillig   1631: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1632: <h3 class="title">Note</h3>
                   1633: <p>icc 8.1 needs the `-i-static' argument instead of -static-libcxa.</p>
                   1634: </div>
                   1635: <p>icc supports __attribute__, but the GNU configure test uses a nested
1.87      wiz      1636:       function, which icc does not support. #undef'ing __attribute__ has the
                   1637:       unfortunate side-effect of breaking many of the Linux header files, which
                   1638:       cannot be compiled properly without __attribute__. The test must be
                   1639:       overridden so that __attribute__ is assumed supported by the
                   1640:       compiler.</p>
1.75      rillig   1641: <p>After bootstrapping, you should set <code class="varname">PKGSRC_COMPILER</code>
1.87      wiz      1642:       in <code class="filename">/etc/mk.conf</code>:</p>
1.75      rillig   1643: <pre class="programlisting">
1.87      wiz      1644:        PKGSRC_COMPILER=        icc
                   1645:       </pre>
1.75      rillig   1646: <p>The default installation directory for icc is
1.87      wiz      1647:       <code class="filename">/opt/intel_cc_80</code>, which
                   1648:       is also the pkgsrc default. If you have installed it into a different
                   1649:       directory, set <code class="varname">ICCBASE</code> in
                   1650:       <code class="filename">/etc/mk.conf</code>:</p>
1.75      rillig   1651: <pre class="programlisting">
1.87      wiz      1652:        ICCBASE=                /opt/icc
                   1653:       </pre>
1.75      rillig   1654: <p>pkgsrc uses the static linking method of the runtime libraries
1.87      wiz      1655:       provided by icc, so binaries can be run on other systems which do not
                   1656:       have the shared libraries installed.</p>
                   1657: <p>Libtool, however, extracts a list of libraries from the
                   1658:       <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
                   1659:       records it, throwing away the -Bstatic and -Bdynamic options
                   1660:       interspersed between the libraries.  This means that
                   1661:       libtool-linked C++ shared libraries will have a runtime
                   1662:       dependency on the icc libraries until this is fixed in
                   1663:       libtool.</p>
1.75      rillig   1664: </div>
                   1665: <div class="sect2" lang="en">
                   1666: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1667: <a name="openbsd"></a>3.3.6. OpenBSD</h3></div></div></div>
1.75      rillig   1668: <p>OpenBSD 3.0 and 3.2 are tested and supported.</p>
                   1669: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87      wiz      1670:       with the OpenBSD userland tools. There are several steps:</p>
1.75      rillig   1671: <div class="orderedlist"><ol type="1">
                   1672: <li><p>OpenBSD stores its ports pkg database in
1.87      wiz      1673:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1674:          recommended that you choose a different location (e.g.
                   1675:          <code class="filename">/usr/pkgdb</code>) by
                   1676:          using the --pkgdbdir option to the bootstrap script.</p></li>
1.75      rillig   1677: <li>
                   1678: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1.87      wiz      1679:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1680: <pre class="screen">
                   1681: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75      rillig   1682: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1683: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1684: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87      wiz      1685: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1686:          </pre>
1.75      rillig   1687: </li>
                   1688: <li>
1.76      rillig   1689: <p>An example <code class="filename">/etc/mk.conf</code> file will be placed in
1.87      wiz      1690:          <code class="filename">/etc/mk.conf.example</code> file
                   1691:          when you use the bootstrap script. OpenBSD's make program uses
                   1692:          <code class="filename">/etc/mk.conf</code>
                   1693:          as well. You can work around this by enclosing all the pkgsrc-specific parts
                   1694:          of the file with:</p>
                   1695: <pre class="programlisting">
                   1696:            .ifdef BSD_PKG_MK
                   1697:            # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
                   1698:            .else
                   1699:            # OpenBSD stuff
                   1700:            .endif
                   1701:          </pre>
1.75      rillig   1702: </li>
                   1703: </ol></div>
                   1704: </div>
                   1705: <div class="sect2" lang="en">
                   1706: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1707: <a name="solaris"></a>3.3.7. Solaris</h3></div></div></div>
1.75      rillig   1708: <p>Solaris 2.6 through 9 are supported on both x86 and sparc.
1.87      wiz      1709:       You will need a working C compiler. Both gcc 2.95.3 and
                   1710:       Sun WorkShop 5 have been tested.</p>
1.75      rillig   1711: <p>The following packages are required on Solaris 8 for the bootstrap
1.87      wiz      1712:       process and to build packages.</p>
1.75      rillig   1713: <div class="itemizedlist"><ul type="disc">
                   1714: <li><p>SUNWsprot</p></li>
                   1715: <li><p>SUNWarc</p></li>
                   1716: <li><p>SUNWbtool</p></li>
                   1717: <li><p>SUNWtoo</p></li>
                   1718: <li><p>SUNWlibm</p></li>
                   1719: </ul></div>
1.78      rillig   1720: <p>Please note that the use of GNU binutils on Solaris is
1.87      wiz      1721:       <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1.75      rillig   1722: <p>Whichever compiler you use, please ensure the compiler tools and
1.87      wiz      1723:       your $prefix are in your <code class="varname">PATH</code>. This includes
                   1724:       <code class="filename">/usr/ccs/{bin,lib}</code>
                   1725:       and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.75      rillig   1726: <div class="sect3" lang="en">
                   1727: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1728: <a name="solaris-gcc-note"></a>3.3.7.1. If you are using gcc</h4></div></div></div>
1.75      rillig   1729: <p>It makes life much simpler if you only use the same gcc consistently
1.87      wiz      1730:        for building all packages.</p>
1.75      rillig   1731: <p>It is recommended that an external gcc be used only for bootstrapping,
1.87      wiz      1732:        then either build gcc from
1.91      rillig   1733:        <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      1734:        package, then remove gcc used during bootstrapping.</p>
1.93      rillig   1735: <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   1736: </div>
                   1737: <div class="sect3" lang="en">
                   1738: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1739: <a name="solaris-sun-workshop-note"></a>3.3.7.2. If you are using Sun WorkShop</h4></div></div></div>
1.75      rillig   1740: <p>You will need at least the following packages installed (from WorkShop
1.87      wiz      1741:        5.0)</p>
1.75      rillig   1742: <div class="itemizedlist"><ul type="disc">
                   1743: <li><p>SPROcc
1.87      wiz      1744:          - Sun WorkShop Compiler C 5.0</p></li>
1.75      rillig   1745: <li><p>SPROcpl
1.87      wiz      1746:          - Sun WorkShop Compiler C++ 5.0</p></li>
1.75      rillig   1747: <li><p>SPROild
1.87      wiz      1748:          - Sun WorkShop Incremental Linker</p></li>
1.75      rillig   1749: <li><p>SPROlang
1.87      wiz      1750:          - Sun WorkShop Compilers common components</p></li>
1.75      rillig   1751: </ul></div>
                   1752: <p>You should set <code class="varname">CC</code>, <code class="varname">CXX</code> and
1.87      wiz      1753:        optionally, <code class="varname">CPP</code> in <code class="filename">/etc/mk.conf</code>,
                   1754:        e.g.:</p>
1.75      rillig   1755: <pre class="programlisting">
1.87      wiz      1756:          CC=     cc
                   1757:          CXX=    CC
                   1758:          CPP=    /usr/ccs/lib/cpp
                   1759:        </pre>
1.75      rillig   1760: </div>
                   1761: <div class="sect3" lang="en">
                   1762: <div class="titlepage"><div><div><h4 class="title">
1.93      rillig   1763: <a name="solaris-sunpro-64"></a>3.3.7.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.75      rillig   1764: <p>Building 64-bit binaries is a little trickier. First, you
                   1765:        need to bootstrap pkgsrc in 64-bit mode. One problem here is
                   1766:        that while building one of the programs in the bootstrap kit
1.76      rillig   1767:        (<code class="filename">bmake</code>), the <code class="varname">CFLAGS</code>
1.75      rillig   1768:        variable is not honored, even if it is set in the environment.
                   1769:        To work around this bug, you can create a simple shell script
1.76      rillig   1770:        called <code class="filename">cc64</code> and put it somewhere in the
1.75      rillig   1771:        <code class="varname">PATH</code>:</p>
                   1772: <pre class="programlisting">
1.87      wiz      1773:          #! /bin/sh
                   1774:          exec /opt/SUNWspro/bin/cc -xtarget=ultra -xarch=v9 ${1+"$@"}
                   1775:        </pre>
1.75      rillig   1776: <p>Then, pass the definition for <code class="varname">CC</code> in the
                   1777:        environment of the <span><strong class="command">bootstrap</strong></span> command:</p>
                   1778: <pre class="programlisting">
1.87      wiz      1779:          <code class="prompt">$</code> <strong class="userinput"><code>cd bootstrap</code></strong>
                   1780:          <code class="prompt">$</code> <strong class="userinput"><code>CC=cc64 ./bootstrap</code></strong>
                   1781:        </pre>
1.75      rillig   1782: <p>After bootstrapping, there are two alternative ways,
                   1783:        depending on whether you want to find bugs in packages or get
                   1784:        your system ready quickly. If you just want a running system,
1.76      rillig   1785:        add the following lines to your <code class="filename">mk.conf</code>
1.75      rillig   1786:        file:</p>
                   1787: <pre class="programlisting">
1.87      wiz      1788:          CC=                     cc64
                   1789:          CXX=                    CC64
                   1790:          PKGSRC_COMPILER=        sunpro
                   1791:        </pre>
1.75      rillig   1792: <p>This way, all calls to the compiler will be intercepted by
                   1793:        the above wrapper and therefore get the necessary ABI options
                   1794:        automatically. (Don't forget to create the shell script
1.76      rillig   1795:        <code class="filename">CC64</code>, too.)</p>
1.75      rillig   1796: <p>To find packages that ignore the user-specified
                   1797:        <code class="varname">CFLAGS</code> and <code class="varname">CXXFLAGS</code>, add
1.76      rillig   1798:        the following lines to your <code class="filename">mk.conf</code>
1.75      rillig   1799:        file:</p>
                   1800: <pre class="programlisting">
1.87      wiz      1801:          CC=                     cc
                   1802:          CXX=                    CC
                   1803:          PKGSRC_COMPILER=        sunpro
                   1804:          CFLAGS=                 -xtarget=ultra -xarch=v9
                   1805:          CXXFLAGS=               -xtarget=ultra -xarch=v9
                   1806:          LDFLAGS=                -xtarget=ultra -xarch=v9
                   1807:        </pre>
1.75      rillig   1808: <p>Packages that don't use the flags provided in the
                   1809:        configuration file will try to build 32-bit binaries and fail
                   1810:        during linking. Detecting this is useful to prevent bugs on
                   1811:        other platforms where the error would not show up but pass
                   1812:        silently.</p>
                   1813: </div>
                   1814: <div class="sect3" lang="en">
                   1815: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1816: <a name="plat.sunos.problems"></a>3.3.7.4. Common problems</h4></div></div></div>
1.75      rillig   1817: <p>Sometimes, when using <span><strong class="command">libtool</strong></span>,
1.87      wiz      1818:       <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
                   1819:       The workaround is to use another shell for the configure
1.91      rillig   1820:       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      1821:       to your <code class="filename">mk.conf</code>:</p>
                   1822: <pre class="programlisting">
                   1823:        CONFIG_SHELL=   ${LOCALBASE}/bin/bash
                   1824:        WRAPPER_SHELL=  ${LOCALBASE}/bin/bash
                   1825:       </pre>
1.91      rillig   1826: <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   1827: </div>
                   1828: </div>
                   1829: </div>
                   1830: </div>
                   1831: <div class="chapter" lang="en">
                   1832: <div class="titlepage"><div><div><h2 class="title">
                   1833: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
                   1834: <div class="toc">
                   1835: <p><b>Table of Contents</b></p>
                   1836: <dl>
                   1837: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                   1838: <dd><dl>
                   1839: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                   1840: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig   1841: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                   1842: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                   1843: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                   1844: <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>
                   1845: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                   1846: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75      rillig   1847: </dl></dd>
                   1848: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                   1849: <dd><dl>
                   1850: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                   1851: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                   1852: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                   1853: </dl></dd>
                   1854: </dl>
                   1855: </div>
                   1856: <p>Basically, there are two ways of using pkgsrc. The first
1.88      wiz      1857: is to only install the package tools and to use binary packages
                   1858: that someone else has prepared. This is the &#8220;<span class="quote">pkg</span>&#8221;
                   1859: in pkgsrc. The second way is to install the &#8220;<span class="quote">src</span>&#8221;
                   1860: of pkgsrc, too. Then you are able to build your own packages,
                   1861: and you can still use binary packages from someone else.</p>
1.75      rillig   1862: <div class="sect1" lang="en">
                   1863: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1864: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
                   1865: <p>To use binary packages, you need some tools to manage
1.88      wiz      1866:   them. On NetBSD, these tools are already installed. On all other
                   1867:   operating systems, you need to install them first. For the
                   1868:   following platforms, prebuilt versions of the package tools
                   1869:   are available and can simply be downloaded and unpacked in the
                   1870:   <code class="filename">/</code> directory:</p>
1.75      rillig   1871: <div class="informaltable">
                   1872: <a name="binary-bootstrap-kits"></a><table border="1">
                   1873: <colgroup>
                   1874: <col>
                   1875: <col>
                   1876: </colgroup>
                   1877: <thead><tr>
                   1878: <th>Platform</th>
                   1879: <th>URL</th>
                   1880: </tr></thead>
                   1881: <tbody>
                   1882: <tr>
                   1883: <td>Solaris 9</td>
1.76      rillig   1884: <td><code class="filename">ftp://ftp0.mh.bbc.co.uk/pub/pkgsrc/packages/bootstrap-pkgsrc/</code></td>
1.75      rillig   1885: </tr>
                   1886: <tr>
                   1887: <td>Solaris 10</td>
1.76      rillig   1888: <td><code class="filename">http://public.enst.fr/pkgsrc/packages/bootstrap-pkgsrc/</code></td>
1.75      rillig   1889: </tr>
                   1890: </tbody>
                   1891: </table>
                   1892: </div>
1.82      rillig   1893: <p>These pre-built package tools use
1.88      wiz      1894:   <code class="filename">/usr/pkg</code> for the base directory, and
                   1895:   <code class="filename">/var/db/pkg</code> for the database of installed
                   1896:   packages. If you cannot use these directories for whatever
                   1897:   reasons (maybe because you're not root), you have to build the
                   1898:   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   1899: <div class="sect2" lang="en">
                   1900: <div class="titlepage"><div><div><h3 class="title">
                   1901: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
                   1902: <p>To install binary packages, you first need to know from
1.88      wiz      1903:     where to get them. You can get them on CD-ROMs, DVDs, or via FTP
                   1904:     or HTTP.</p>
1.81      rillig   1905: <p>The binary packages can be found at the following
1.88      wiz      1906:     locations.</p>
1.75      rillig   1907: <div class="informaltable">
                   1908: <a name="binary-packages"></a><table border="1">
                   1909: <colgroup>
                   1910: <col>
                   1911: <col>
                   1912: </colgroup>
                   1913: <thead><tr>
                   1914: <th>Platform</th>
                   1915: <th>URL</th>
                   1916: </tr></thead>
                   1917: <tbody>
                   1918: <tr>
1.81      rillig   1919: <td>NetBSD</td>
                   1920: <td><code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/</code></td>
                   1921: </tr>
                   1922: <tr>
1.75      rillig   1923: <td>Solaris 9</td>
1.76      rillig   1924: <td><code class="filename">ftp://ftp0.mh.bbc.co.uk/pub/pkgsrc/packages/</code></td>
1.75      rillig   1925: </tr>
                   1926: <tr>
                   1927: <td>Solaris 10</td>
1.76      rillig   1928: <td><code class="filename">http://public.enst.fr/pkgsrc/packages/</code></td>
1.75      rillig   1929: </tr>
                   1930: </tbody>
                   1931: </table>
                   1932: </div>
1.81      rillig   1933: <p>Most of these directories contain binary packages for
1.88      wiz      1934:     multiple platforms. Select the appropriate subdirectories,
                   1935:     according to your machine architecture and operating system,
                   1936:     until you find a directory called <code class="filename">All</code>. This
                   1937:     directory contains all the binary packages. Further, there are
                   1938:     subdirectories for categories that contain symbolic links that
                   1939:     point to the actual binary package in
                   1940:     <code class="filename">../All</code>. This directory layout is used for
                   1941:     all package repositories, no matter if they are accessed via
                   1942:     HTTP, FTP, NFS, CD-ROM, or the local filesystem.</p>
1.75      rillig   1943: </div>
                   1944: <div class="sect2" lang="en">
                   1945: <div class="titlepage"><div><div><h3 class="title">
                   1946: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.87      wiz      1947: <p>If you have the files on a CD-ROM or downloaded them to
1.88      wiz      1948:     your hard disk, you can install them with the following command
                   1949:     (be sure to <span><strong class="command">su</strong></span> to root first):</p>
1.75      rillig   1950: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add /path/to/package.tgz</code></strong></pre>
1.87      wiz      1951: <p>If you have FTP access and you don't want to download the
1.88      wiz      1952:     packages via FTP prior to installation, you can do this
                   1953:     automatically by giving <span><strong class="command">pkg_add</strong></span> an FTP URL:</p>
1.82      rillig   1954: <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   1955: <p>Note that any prerequisite packages needed to run the
1.88      wiz      1956:     package in question will be installed, too, assuming they are
                   1957:     present where you install from.</p>
1.75      rillig   1958: <p>To save some typing, you can set the
1.88      wiz      1959:     <code class="varname">PKG_PATH</code> environment variable to a semicolon-separated
                   1960:     list of paths (including remote URLs); trailing slashes are not allowed.
                   1961:     </p>
1.76      rillig   1962: <p>Additionally to the <code class="filename">All</code> directory
1.88      wiz      1963:     there exists a <code class="filename">vulnerable</code> directory to
                   1964:     which binary packages with known vulnerabilities are
                   1965:     moved, since removing them could cause missing dependencies. To
                   1966:     use these packages, add the <code class="filename">vulnerable</code>
                   1967:     directory to your <code class="varname">PKG_PATH</code>. However, you should run
1.91      rillig   1968:     <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      1969:     especially after installing new packages, and verify that the
                   1970:     vulnerabilities are acceptable for your configuration. An example
                   1971:     <code class="varname">PKG_PATH</code> would be:
                   1972:     <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>
                   1973:     Please note that semicolon (';') is a shell meta-character, so
                   1974:     you'll probably have to quote it.</p>
1.75      rillig   1975: <p>After you've installed packages, be sure to have
1.88      wiz      1976:     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
                   1977:     <code class="varname">PATH</code> so you can actually start the just
                   1978:     installed program.</p>
1.75      rillig   1979: </div>
                   1980: <div class="sect2" lang="en">
                   1981: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1982: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
                   1983: <p>To deinstall a package, it does not matter whether it was
1.88      wiz      1984:     installed from source code or from a binary package. The
                   1985:     <span><strong class="command">pkg_delete</strong></span> command does not know it anyway.
                   1986:     To delete a package, you can just run <span><strong class="command">pkg_delete
                   1987:     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
                   1988:     name can be given with or without version number. Wildcards can
                   1989:     also be used to deinstall a set of packages, for example
                   1990:     <code class="literal">*emacs*</code>. Be sure to include them in quotes,
                   1991:     so that the shell does not expand them before
                   1992:     <code class="literal">pkg_delete</code> sees them.</p>
1.82      rillig   1993: <p>The <code class="option">-r</code> option is very powerful: it
1.88      wiz      1994:     removes all the packages that require the package in question
                   1995:     and then removes the package itself. For example:
1.82      rillig   1996: 
1.88      wiz      1997:     </p>
1.82      rillig   1998: <pre class="screen">
1.88      wiz      1999: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
                   2000:     </pre>
1.82      rillig   2001: <p>
                   2002: 
1.88      wiz      2003:     will remove jpeg and all the packages that used it; this allows
                   2004:     upgrading the jpeg package.</p>
1.82      rillig   2005: </div>
                   2006: <div class="sect2" lang="en">
                   2007: <div class="titlepage"><div><div><h3 class="title">
                   2008: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
                   2009: <p>The <span><strong class="command">pkg_info</strong></span> shows information about
1.88      wiz      2010:     installed packages or binary package files.</p>
1.82      rillig   2011: </div>
                   2012: <div class="sect2" lang="en">
                   2013: <div class="titlepage"><div><div><h3 class="title">
                   2014: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
                   2015: <p>
1.88      wiz      2016:       The NetBSD Security-Officer and Packages Groups maintain a list of
                   2017:       known security vulnerabilities to packages which are (or have been)
                   2018:       included in pkgsrc.  The list is available from the NetBSD
                   2019:       FTP site at <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
                   2020:     </p>
1.82      rillig   2021: <p>
1.93      rillig   2022:       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      2023:       this list can be downloaded
                   2024:       automatically, and a security audit of all packages installed on a system
                   2025:       can take place.
                   2026:     </p>
1.82      rillig   2027: <p>
1.93      rillig   2028:       There are two components to
1.91      rillig   2029:       <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      2030:       component, &#8220;<span class="quote">download-vulnerability-list</span>&#8221;, is for downloading
                   2031:       the list of vulnerabilities from the NetBSD FTP site.  The second
                   2032:       component, &#8220;<span class="quote">audit-packages</span>&#8221;, checks to see if any of your
                   2033:       installed packages are vulnerable.  If a package is vulnerable, you
                   2034:       will see output similar to the following:
                   2035:     </p>
1.82      rillig   2036: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88      wiz      2037:     http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82      rillig   2038: <p>
1.91      rillig   2039:       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      2040:       <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
                   2041:       file daily, and include a package audit in the daily security script.
                   2042:       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   2043:       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      2044:     </p>
1.82      rillig   2045: </div>
                   2046: <div class="sect2" lang="en">
                   2047: <div class="titlepage"><div><div><h3 class="title">
                   2048: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
                   2049: <p>
1.93      rillig   2050:       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      2051:       <span><strong class="command">lintpkgsrc</strong></span> with the &#8220;<span class="quote">-i</span>&#8221;
                   2052:       argument to check if your packages are up-to-date, e.g.
                   2053:     </p>
                   2054: <pre class="screen">
                   2055: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82      rillig   2056: ...
1.88      wiz      2057: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   2058:     </pre>
1.82      rillig   2059: <p>You can then use <span><strong class="command">make update</strong></span> to update the
1.88      wiz      2060:     package on your system and rebuild any dependencies.
                   2061:     </p>
1.82      rillig   2062: </div>
                   2063: <div class="sect2" lang="en">
                   2064: <div class="titlepage"><div><div><h3 class="title">
                   2065: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
                   2066: <p>The <span><strong class="command">pkg_admin</strong></span> executes various
1.88      wiz      2067:     administrative functions on the package system.</p>
1.82      rillig   2068: </div>
                   2069: <div class="sect2" lang="en">
                   2070: <div class="titlepage"><div><div><h3 class="title">
                   2071: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1.75      rillig   2072: <p>Please pay very careful attention to the warnings
1.88      wiz      2073:     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
                   2074:     inherent dangers of installing binary packages which you did
                   2075:     not create yourself, and the security holes that can be
                   2076:     introduced onto your system by indiscriminate adding of such
                   2077:     files.</p>
1.75      rillig   2078: <p>The same warning of course applies to every package you
1.88      wiz      2079:     install from source when you haven't completely read and
                   2080:     understood the source code of the package, the compiler that
                   2081:     is used to build the package and all the other tools that are
                   2082:     involved.</p>
1.75      rillig   2083: </div>
                   2084: </div>
                   2085: <div class="sect1" lang="en">
                   2086: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2087: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88      wiz      2088: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
                   2089:   directory now contains a set of packages, organized into
                   2090:   categories. You can browse the online index of packages, or run
                   2091:   <span><strong class="command">make readme</strong></span> from the <code class="filename">pkgsrc</code>
                   2092:   directory to build local <code class="filename">README.html</code> files for
1.91      rillig   2093:   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      2094: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
                   2095:   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
                   2096:   should do so by setting <code class="varname">LOCALBASE</code> in
                   2097:   <code class="filename">mk.conf</code>. You should not try to use multiple
                   2098:   different <code class="varname">LOCALBASE</code> definitions on the same
                   2099:   system (inside a chroot is an exception). </p>
                   2100: <p>The rest of this chapter assumes that the package is already
                   2101:   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
                   2102:   instructions how to create your own packages.</p>
1.75      rillig   2103: <div class="sect2" lang="en">
                   2104: <div class="titlepage"><div><div><h3 class="title">
                   2105: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82      rillig   2106: <p>To build packages from source, you need a working C
1.88      wiz      2107:     compiler. On NetBSD, you need to install the
                   2108:     &#8220;<span class="quote">comp</span>&#8221; and the &#8220;<span class="quote">text</span>&#8221; distribution
                   2109:     sets. If you want to build X11-related packages, the
                   2110:     &#8220;<span class="quote">xbase</span>&#8221; and &#8220;<span class="quote">xcomp</span>&#8221; distribution
                   2111:     sets are required, too.</p>
1.75      rillig   2112: </div>
                   2113: <div class="sect2" lang="en">
                   2114: <div class="titlepage"><div><div><h3 class="title">
                   2115: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
                   2116: <p>The first step for building a package is downloading the
1.88      wiz      2117:     distfiles (i.e. the unmodified source). If they have not yet been
                   2118:     downloaded, pkgsrc will fetch them automatically.</p>
                   2119: <p>If you have all files that you need in the
                   2120:     <code class="filename">distfiles</code> directory,
                   2121:     you don't need to connect. If the distfiles are on CD-ROM, you can
                   2122:     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
                   2123:     </p>
1.82      rillig   2124: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
                   2125: <p>
1.88      wiz      2126:     to your <code class="filename">mk.conf</code>.</p>
1.91      rillig   2127: <p>By default a list of distribution sites will be randomly
                   2128:     intermixed to prevent huge load on servers which holding popular
                   2129:     packages (for example, SourceForge.net mirrors). Thus, every
                   2130:     time when you need to fetch yet another distfile all the mirrors
                   2131:     will be tried in new (random) order. You can turn this feature
                   2132:     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
                   2133:     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88      wiz      2134: <p>You can overwrite some of the major distribution sites to
                   2135:     fit to sites that are close to your own.  By setting one or two
                   2136:     variables you can modify the order in which the master sites are
                   2137:     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
                   2138:     delimited list of domain suffixes.
                   2139:     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
                   2140:     contains a whitespace delimited list of regular expressions.  It
                   2141:     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
                   2142:     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
                   2143:     some examples.  This may save some of your bandwidth and
                   2144:     time.</p>
1.75      rillig   2145: <p>You can change these settings either in your shell's environment, or,
1.88      wiz      2146:     if you want to keep the settings, by editing the
                   2147:     <code class="filename">/etc/mk.conf</code> file,
                   2148:     and adding the definitions there.</p>
1.82      rillig   2149: <p>
1.88      wiz      2150:       If a package depends on many other packages (such as
1.93      rillig   2151:       <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      2152:       alternate between periods of
                   2153:       downloading source, and compiling. To ensure you have all the source
                   2154:       downloaded initially you can run the command:
                   2155:       </p>
1.82      rillig   2156: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
                   2157: <p>
1.88      wiz      2158:       which will output and run a set of shell commands to fetch the
                   2159:       necessary files into the <code class="filename">distfiles</code> directory.  You can
                   2160:       also choose to download the files manually.
                   2161:     </p>
1.75      rillig   2162: </div>
                   2163: <div class="sect2" lang="en">
                   2164: <div class="titlepage"><div><div><h3 class="title">
                   2165: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82      rillig   2166: <p>
1.88      wiz      2167:       Once the software has downloaded, any patches will be applied, then it
                   2168:       will be compiled for you. This may take some time depending on your
                   2169:       computer, and how many other packages the software depends on and their
                   2170:       compile time.
                   2171:     </p>
1.75      rillig   2172: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2173: <h3 class="title">Note</h3>
                   2174: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.88      wiz      2175:     use the pkgsrc <span><strong class="command">bmake</strong></span> command instead of
                   2176:     &#8220;<span class="quote">make</span>&#8221; in the examples in this guide.</p>
1.75      rillig   2177: </div>
1.87      wiz      2178: <p>For example, type</p>
1.88      wiz      2179: <pre class="screen">
                   2180: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2181: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   2182:     </pre>
1.75      rillig   2183: <p>at the shell prompt to build the various components of the
1.88      wiz      2184:     package.</p>
1.82      rillig   2185: <p>The next stage is to actually install the newly compiled
1.88      wiz      2186:     program onto your system. Do this by entering:
1.82      rillig   2187: 
1.88      wiz      2188:     </p>
1.82      rillig   2189: <pre class="screen">
1.88      wiz      2190: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
                   2191:     </pre>
1.82      rillig   2192: <p>
                   2193: 
1.88      wiz      2194:     while you are still in the directory for whatever package you
                   2195:     are installing.</p>
1.82      rillig   2196: <p>Installing the package on your system may require you to
1.88      wiz      2197:     be root.  However, pkgsrc has a
                   2198:     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
                   2199:     to only become root for the actual installation step.</p>
1.82      rillig   2200: <p>That's it, the software should now be installed and setup for use.
1.88      wiz      2201:     You can now enter:
1.82      rillig   2202: 
1.88      wiz      2203:     </p>
1.82      rillig   2204: <pre class="screen">
1.88      wiz      2205: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
                   2206:     </pre>
1.82      rillig   2207: <p>
                   2208: 
1.88      wiz      2209:     to remove the compiled files in the work directory, as you shouldn't need
                   2210:     them any more. If other packages were also added to your system
                   2211:     (dependencies) to allow your program to compile, you can tidy these up
                   2212:     also with the command:</p>
1.82      rillig   2213: <pre class="screen">
1.88      wiz      2214: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
                   2215:     </pre>
1.75      rillig   2216: <p>Taking the figlet utility as an example, we can install it on our
1.88      wiz      2217:     system by building as shown in <a href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
                   2218: <p>The program is installed under the default root of the
                   2219:     packages tree - <code class="filename">/usr/pkg</code>. Should this not
                   2220:     conform to your tastes, set the <code class="varname">LOCALBASE</code>
                   2221:     variable in your environment, and it will use that value as the
                   2222:     root of your packages tree. So, to use
                   2223:     <code class="filename">/usr/local</code>, set
                   2224:     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
                   2225:     Please note that you should use a directory which is dedicated to
                   2226:     packages and not shared with other programs (i.e., do not try and
                   2227:     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
                   2228:     to add any of your own files or directories (such as
                   2229:     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
                   2230:     <code class="filename">pkgsrc/</code>) below the
                   2231:     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
                   2232:     conflicts between programs and other files installed by the
                   2233:     package system and whatever else may have been installed
                   2234:     there.</p>
                   2235: <p>Some packages look in <code class="filename">/etc/mk.conf</code> to
                   2236:     alter some configuration options at build time.  Have a look at
                   2237:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
                   2238:     of what will be set there by default.  Environment variables such
                   2239:     as <code class="varname">LOCALBASE</code> can be set in
                   2240:     <code class="filename">/etc/mk.conf</code> to save having to remember to
                   2241:     set them each time you want to use pkgsrc.</p>
                   2242: <p>Occasionally, people want to &#8220;<span class="quote">look under the
                   2243:     covers</span>&#8221; to see what is going on when a package is building
                   2244:     or being installed. This may be for debugging purposes, or out of
                   2245:     simple curiosity. A number of utility values have been added to
                   2246:     help with this.</p>
1.75      rillig   2247: <div class="orderedlist"><ol type="1">
                   2248: <li>
1.88      wiz      2249: <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
                   2250:        <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
                   2251:        information will be displayed. For example,</p>
1.75      rillig   2252: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88      wiz      2253: <p>will show all the commands that are invoked, up to and
                   2254:        including the &#8220;<span class="quote">patch</span>&#8221; stage.</p>
1.75      rillig   2255: </li>
                   2256: <li>
1.88      wiz      2257: <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>
                   2258:        definition, then the <code class="varname">VARNAME</code> definition
                   2259:        should be used, in conjunction with the show-var
                   2260:        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>
                   2261:        variable <code class="varname">LOCALBASE</code>:</p>
                   2262: <pre class="screen">
                   2263: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75      rillig   2264: /usr/pkg
                   2265: <code class="prompt">%</code>
1.88      wiz      2266:        </pre>
1.75      rillig   2267: </li>
                   2268: </ol></div>
                   2269: <p>If you want to install a binary package that you've either
1.88      wiz      2270:     created yourself (see next section), that you put into
                   2271:     pkgsrc/packages manually or that is located on a remote FTP
                   2272:     server, you can use the "bin-install" target. This target will
                   2273:     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>,
                   2274:     else do a <span><strong class="command">make package</strong></span>.  The list of remote FTP
                   2275:     sites searched is kept in the variable
                   2276:     <code class="varname">BINPKG_SITES</code>, which defaults to
                   2277:     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>
                   2278:     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
                   2279:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
                   2280:     details.</p>
                   2281: <p>A final word of warning: If you set up a system that has a
                   2282:     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
                   2283:     set that before any packages are installed, as you cannot use
                   2284:     several directories for the same purpose. Doing so will result in
                   2285:     pkgsrc not being able to properly detect your installed packages,
                   2286:     and fail miserably. Note also that precompiled binary packages are
                   2287:     usually built with the default <code class="varname">LOCALBASE</code> of
                   2288:     <code class="filename">/usr/pkg</code>, and that you should
                   2289:     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
                   2290:     <code class="varname">LOCALBASE</code>.</p>
1.75      rillig   2291: </div>
                   2292: </div>
                   2293: </div>
                   2294: <div class="chapter" lang="en">
                   2295: <div class="titlepage"><div><div><h2 class="title">
                   2296: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
                   2297: <div class="toc">
                   2298: <p><b>Table of Contents</b></p>
                   2299: <dl>
                   2300: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                   2301: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.78      rillig   2302: <dt><span class="sect1"><a href="#conf.compiler">5.3. Selecting and configuring the compiler</a></span></dt>
1.88      wiz      2303: <dd><dl>
1.89      rillig   2304: <dt><span class="sect2"><a href="#selecting-the-compiler">5.3.1. Selecting the compiler</a></span></dt>
                   2305: <dt><span class="sect2"><a href="#conf.cflags">5.3.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                   2306: <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      2307: </dl></dd>
1.78      rillig   2308: <dt><span class="sect1"><a href="#developer-advanced-settings">5.4. Developer/advanced settings</a></span></dt>
                   2309: <dt><span class="sect1"><a href="#selecting-build-options">5.5. Selecting Build Options</a></span></dt>
1.75      rillig   2310: </dl>
                   2311: </div>
1.89      rillig   2312: <p>The whole pkgsrc system is configured in a single file, usually
                   2313: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
                   2314: that file depends on the installation. On NetBSD, when you use
                   2315: <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
                   2316: <code class="filename">/etc/</code>. In all other cases the default location is
                   2317: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
                   2318: bootstrap program to install the binary packages.</p>
                   2319: <p>During the bootstrap, an example configuration file is created. To
                   2320: use that, you have to create the directory
                   2321: <code class="filename">${PREFIX}/etc</code> and copy the example file
                   2322: there.</p>
                   2323: <p>The format of the configuration file is that of the usual
                   2324: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
                   2325: is done by setting variables in this file. Note that you can define all
                   2326: kinds of variables, and no special error checking (for example for
                   2327: spelling mistakes) takes place, so you have to try it out to see if it
                   2328: works.</p>
1.75      rillig   2329: <div class="sect1" lang="en">
                   2330: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2331: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
                   2332: <p>In this section, you can find some variables that apply to all
1.89      rillig   2333:     pkgsrc packages. A complete list of the variables that can be
                   2334:     configured by the user is available in
                   2335:     <code class="filename">mk/defaults/mk.conf</code>, together with some
                   2336:     comments that describe each variable's intent.</p>
1.75      rillig   2337: <div class="itemizedlist"><ul type="disc">
                   2338: <li><p><code class="varname">LOCALBASE</code>: Where
                   2339:            packages will be installed. The default is
1.76      rillig   2340:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75      rillig   2341:            with different <code class="varname">LOCALBASE</code>s!</p></li>
                   2342: <li><p><code class="varname">CROSSBASE</code>: Where
                   2343:            &#8220;<span class="quote">cross</span>&#8221; category packages will be
                   2344:            installed. The default is
1.76      rillig   2345:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.75      rillig   2346: <li><p><code class="varname">X11BASE</code>: Where
                   2347:            X11 is installed on the system. The default is
1.76      rillig   2348:            <code class="filename">/usr/X11R6</code>.</p></li>
1.75      rillig   2349: <li><p><code class="varname">DISTDIR</code>: Where to store the
                   2350:            downloaded copies of the original source distributions used
                   2351:            for building pkgsrc packages. The default is
1.76      rillig   2352:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.75      rillig   2353: <li><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
                   2354:            If set, override the packages'
                   2355:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
                   2356: <li><p><code class="varname">MASTER_SITE_BACKUP</code>:
                   2357:            Backup location(s) for distribution files and patch files
                   2358:            if not found locally or in
1.76      rillig   2359:            <code class="filename">${MASTER_SITES}</code> or
                   2360:            <code class="filename">${PATCH_SITES}</code> respectively.
1.75      rillig   2361:            The defaults are
1.76      rillig   2362:            <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}/</code>
1.75      rillig   2363:            and
1.76      rillig   2364:            <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.75      rillig   2365: <li><p><code class="varname">BINPKG_SITES</code>:
1.93      rillig   2366:            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
                   2367:            <em class="replaceable"><code>arch</code></em> are replaced with OS
                   2368:            release (&#8220;<span class="quote">2.0</span>&#8221;, etc.) and architecture
                   2369:            (&#8220;<span class="quote">mipsel</span>&#8221;, etc.).</p></li>
1.82      rillig   2370: <li><p><code class="varname">ACCEPTABLE_LICENSES</code>:
                   2371:            List of acceptable licenses. Whenever you try to build a package
                   2372:            whose license is not in this list, you will get an error message
                   2373:            that includes instructions on how to change this variable.</p></li>
1.75      rillig   2374: </ul></div>
                   2375: </div>
                   2376: <div class="sect1" lang="en">
                   2377: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2378: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
                   2379: <p>XXX
                   2380:       </p>
                   2381: <div class="itemizedlist"><ul type="disc">
                   2382: <li><p><code class="varname">PACKAGES</code>: The top level
                   2383:            directory for the binary packages. The default is
1.76      rillig   2384:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.75      rillig   2385: <li><p><code class="varname">WRKOBJDIR</code>:
                   2386:            The top level directory where, if defined, the separate
                   2387:            working directories will get created, and symbolically
1.76      rillig   2388:            linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75      rillig   2389:            This is useful for building packages on several
1.76      rillig   2390:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                   2391:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75      rillig   2392:            is local to every architecture. (It should be noted that
                   2393:            <code class="varname">PKGSRCDIR</code> should not be set by the user
1.89      rillig   2394:            &mdash; it is an internal definition which refers to the
1.75      rillig   2395:            root of the pkgsrc tree. It is possible to have many
                   2396:            pkgsrc tree instances.)</p></li>
                   2397: <li><p><code class="varname">LOCALPATCHES</code>:
                   2398:            Directory for local patches that aren't part of pkgsrc.
1.90      rillig   2399:            See <a href="#components.patches" title="10.3. patches/*">Section 10.3, &#8220;patches/*&#8221;</a> for more
1.93      rillig   2400:            information.</p></li>
1.75      rillig   2401: <li><p><code class="varname">PKGMAKECONF</code>: Location of
1.76      rillig   2402:            the <code class="filename">mk.conf</code> file used by a package's
1.75      rillig   2403:            BSD-style Makefile. If this is not set,
                   2404:            <code class="varname">MAKECONF</code> is set to
1.76      rillig   2405:            <code class="filename">/dev/null</code> to avoid picking up
                   2406:            settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.82      rillig   2407: <li><p><code class="varname">DEPENDS_TARGET</code>:
                   2408:            By default, dependencies are only installed, and no binary
                   2409:            package is created for them. You can set this variable to
                   2410:            <code class="literal">package</code> to automatically create binary
                   2411:            packages after installing dependencies.</p></li>
1.75      rillig   2412: </ul></div>
                   2413: </div>
                   2414: <div class="sect1" lang="en">
                   2415: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.78      rillig   2416: <a name="conf.compiler"></a>5.3. Selecting and configuring the compiler</h2></div></div></div>
                   2417: <div class="sect2" lang="en">
                   2418: <div class="titlepage"><div><div><h3 class="title">
1.89      rillig   2419: <a name="selecting-the-compiler"></a>5.3.1. Selecting the compiler</h3></div></div></div>
                   2420: <p>By default, pkgsrc will use GCC to build packages.  This may be
                   2421:     overridden by setting the following variables in /etc/mk.conf:</p>
                   2422: <div class="variablelist"><dl>
                   2423: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
                   2424: <dd>
                   2425: <p>This is a list of values specifying the chain of
                   2426:          compilers to invoke when building packages.  Valid values
                   2427:          are:</p>
                   2428: <div class="itemizedlist"><ul type="disc">
                   2429: <li><p><code class="varname">distcc</code>:
                   2430:            distributed C/C++ (chainable)</p></li>
                   2431: <li><p><code class="varname">ccache</code>:
                   2432:            compiler cache (chainable)</p></li>
                   2433: <li><p><code class="varname">gcc</code>:
                   2434:            GNU C/C++ Compiler</p></li>
                   2435: <li><p><code class="varname">mipspro</code>:
                   2436:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
                   2437: <li><p><code class="varname">mipspro</code>:
                   2438:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
                   2439: <li><p><code class="varname">sunpro</code>:
                   2440:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
                   2441: </ul></div>
                   2442: <p>The default is
                   2443:          &#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;.  You can use
                   2444:          <code class="varname">ccache</code> and/or
                   2445:          <code class="varname">distcc</code> with an appropriate
                   2446:          <code class="varname">PKGSRC_COMPILER</code> setting,
                   2447:          e.g. &#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;.  This
1.94      dmcmahil 2448:          variable should always be terminated with a value for
                   2449:          a real compiler.  Note that only one real compiler
                   2450:          should be listed (e.g. &#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;
                   2451:          is not allowed).</p>
1.89      rillig   2452: </dd>
                   2453: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
                   2454: <dd><p>This specifies the minimum version of GCC to use
                   2455:          when building packages.  If the system GCC doesn't
                   2456:          satisfy this requirement, then pkgsrc will build and
                   2457:          install one of the GCC packages to use instead.</p></dd>
                   2458: </dl></div>
                   2459: </div>
                   2460: <div class="sect2" lang="en">
                   2461: <div class="titlepage"><div><div><h3 class="title">
                   2462: <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   2463: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
                   2464:        please make sure to use the <code class="literal">+=</code> operator
                   2465:        instead of the <code class="literal">=</code> operator:</p>
                   2466: <pre class="programlisting">
                   2467:     CFLAGS+=        -your -flags
                   2468: </pre>
                   2469: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
                   2470:        &#8220;<span class="quote">+</span>&#8221;) may lead to problems with packages that need
                   2471:        to add their own flags.  Also, you may want to take a look at
1.91      rillig   2472:        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   2473:        you're interested in optimization for the current CPU.</p>
                   2474: </div>
1.88      wiz      2475: <div class="sect2" lang="en">
                   2476: <div class="titlepage"><div><div><h3 class="title">
1.89      rillig   2477: <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      2478: <p>If you want to pass flags to the linker, both in the configure
                   2479: step and the build step, you can do this in two ways.  Either set
                   2480: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
                   2481: between the two is that <code class="varname">LIBS</code> will be appended to
                   2482: the command line, while <code class="varname">LDFLAGS</code> come earlier.
                   2483: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
                   2484: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
                   2485: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
                   2486: <code class="varname">CFLAGS</code>, if you do not wish to override these
                   2487: settings, use the <code class="literal">+=</code> operator:</p>
                   2488: <pre class="programlisting">
                   2489:     LDFLAGS+=        -your -linkerflags
                   2490: </pre>
                   2491: </div>
1.78      rillig   2492: </div>
                   2493: <div class="sect1" lang="en">
                   2494: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2495: <a name="developer-advanced-settings"></a>5.4. Developer/advanced settings</h2></div></div></div>
1.75      rillig   2496: <p>XXX
                   2497:       </p>
                   2498: <div class="itemizedlist"><ul type="disc">
                   2499: <li>
                   2500: <p><code class="varname">PKG_DEVELOPER</code>:
                   2501:            Run some sanity checks that package developers want:
                   2502:            </p>
                   2503: <div class="itemizedlist"><ul type="circle">
1.88      wiz      2504: <li><p>make sure patches apply with zero
                   2505:              fuzz</p></li>
                   2506: <li><p>run check-shlibs to see that all
                   2507:              binaries will find their shared libs.</p></li>
1.75      rillig   2508: </ul></div>
                   2509: <p>
1.87      wiz      2510:        </p>
1.75      rillig   2511: </li>
1.88      wiz      2512: <li><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
                   2513:        of debugging output which is displayed whilst making and
                   2514:        installing the package.  The default value for this is 0,
                   2515:        which will not display the commands as they are executed
                   2516:        (normal, default, quiet operation); the value 1 will display
                   2517:        all shell commands before their invocation, and the value 2
                   2518:        will display both the shell commands before their invocation,
                   2519:        and their actual execution progress with <span><strong class="command">set
                   2520:        -x</strong></span> will be displayed.</p></li>
1.75      rillig   2521: </ul></div>
                   2522: <p>
                   2523:     </p>
                   2524: </div>
                   2525: <div class="sect1" lang="en">
                   2526: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.78      rillig   2527: <a name="selecting-build-options"></a>5.5. Selecting Build Options</h2></div></div></div>
1.88      wiz      2528: <p>Some packages have build time options, usually to select
                   2529:     between different dependencies, enable optional support for big
                   2530:     dependencies or enable experimental features.</p>
1.75      rillig   2531: <p>To see which options, if any, a package supports, and which
1.88      wiz      2532:     options are mutually exclusive, run <span><strong class="command">make
                   2533:     show-options</strong></span>, for example:</p>
1.75      rillig   2534: <pre class="programlisting">
                   2535:     The following options are supported by this package:
                   2536:         ssl      Enable SSL support.
                   2537:     Exactly one of the following gecko options is required:
                   2538:         firefox  Use firefox as gecko rendering engine.
                   2539:         mozilla  Use mozilla as gecko rendering engine.
                   2540:     At most one of the following database options may be selected:
                   2541:         mysql    Enable support for MySQL database.
                   2542:         pgsql    Enable support for PostgreSQL database.
1.1       grant    2543: 
1.75      rillig   2544:     These options are enabled by default: firefox
                   2545:     These options are currently enabled: mozilla ssl
1.1       grant    2546: </pre>
1.75      rillig   2547: <p>The following variables can be defined in
1.88      wiz      2548:     <code class="filename">/etc/mk.conf</code> to select which options to
                   2549:     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
                   2550:     which can be used to select or disable options for all packages
                   2551:     that support them, and
                   2552:     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
                   2553:     which can be used to select or disable options specifically for
                   2554:     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
                   2555:     these variables are selected, options preceded by &#8220;<span class="quote">-</span>&#8221;
                   2556:     are disabled. A few examples:</p>
1.75      rillig   2557: <pre class="screen">
                   2558: <code class="prompt">$</code> <span><strong class="command">grep "PKG.*OPTION" /etc/mk.conf</strong></span>
                   2559: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   2560: PKG_OPTIONS.kdebase=    debug -sasl
                   2561: PKG_OPTIONS.apache=     suexec </pre>
1.88      wiz      2562: <p>The following settings are consulted in the order given, and
                   2563:     the last setting that selects or disables an option is
                   2564:     used:</p>
1.75      rillig   2565: <div class="orderedlist"><ol type="1">
                   2566: <li><p>the default options as suggested by the package
1.88      wiz      2567:       maintainer</p></li>
1.75      rillig   2568: <li><p>the options implied by the settings of legacy
1.88      wiz      2569:       variables (see below)</p></li>
1.75      rillig   2570: <li><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
                   2571: <li><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
                   2572: </ol></div>
                   2573: <p>For groups of mutually exclusive options, the last option
1.88      wiz      2574:     selected is used, all others are automatically disabled.  If an
                   2575:     option of the group is explicitly disabled, the previously
                   2576:     selected option, if any, is used.  It is an error if no option
                   2577:     from a required group of options is selected, and building the
                   2578:     package will fail.</p>
                   2579: <p>Before the options framework was introduced, build options
                   2580:     were selected by setting a variable (often named
                   2581:     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
                   2582:     <code class="filename">/etc/mk.conf</code> for each option.  To ease
                   2583:     transition to the options framework for the user, these legacy
                   2584:     variables are converted to the appropriate options setting
                   2585:     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
                   2586:     automatically.  A warning is issued to prompt the user to update
                   2587:     <code class="filename">/etc/mk.conf</code> to use the options framework
                   2588:     directly.  Support for the legacy variables will be removed
                   2589:     eventually.</p>
1.75      rillig   2590: </div>
                   2591: </div>
                   2592: <div class="chapter" lang="en">
                   2593: <div class="titlepage"><div><div><h2 class="title">
                   2594: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
                   2595: <div class="toc">
                   2596: <p><b>Table of Contents</b></p>
                   2597: <dl>
                   2598: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                   2599: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
                   2600: <dt><span class="sect1"><a href="#bulkbuild">6.3. Doing a bulk build of all packages</a></span></dt>
                   2601: <dd><dl>
                   2602: <dt><span class="sect2"><a href="#binary.configuration">6.3.1. Configuration</a></span></dt>
                   2603: <dt><span class="sect2"><a href="#other-environmental-considerations">6.3.2. Other environmental considerations</a></span></dt>
                   2604: <dt><span class="sect2"><a href="#operation">6.3.3. Operation</a></span></dt>
                   2605: <dt><span class="sect2"><a href="#what-it-does">6.3.4. What it does</a></span></dt>
                   2606: <dt><span class="sect2"><a href="#disk-space-requirements">6.3.5. Disk space requirements</a></span></dt>
                   2607: <dt><span class="sect2"><a href="#setting-up-a-sandbox">6.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                   2608: <dt><span class="sect2"><a href="#building-a-partial-set">6.3.7. Building a partial set of packages</a></span></dt>
                   2609: <dt><span class="sect2"><a href="#bulk-upload">6.3.8. Uploading results of a bulk build</a></span></dt>
                   2610: </dl></dd>
                   2611: <dt><span class="sect1"><a href="#creating-cdroms">6.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                   2612: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">6.4.1. Example of cdpack</a></span></dt></dl></dd>
                   2613: </dl>
                   2614: </div>
                   2615: <div class="sect1" lang="en">
                   2616: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2617: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87      wiz      2618: <p>Once you have built and installed a package, you can create
                   2619:     a <span class="emphasis"><em>binary package</em></span> which can be installed on
                   2620:     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
                   2621:     the same package on a group of hosts and wasting CPU time. It also
                   2622:     provides a simple means for others to install your package, should
                   2623:     you distribute it.</p>
                   2624: <p>To create a binary package, change into the appropriate
                   2625:     directory in pkgsrc, and run <span><strong class="command">make
                   2626:     package</strong></span>:</p>
                   2627: <pre class="screen">
                   2628: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2629: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   2630:     </pre>
                   2631: <p>This will build and install your package (if not already done),
                   2632:     and then build a binary package from what was installed. You can
                   2633:     then use the <span><strong class="command">pkg_*</strong></span> tools to manipulate
                   2634:     it. Binary packages are created by default in
                   2635:     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
                   2636:     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   2637:     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   2638: <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      2639:     such a binary package.</p>
1.75      rillig   2640: </div>
                   2641: <div class="sect1" lang="en">
                   2642: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2643: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.90      rillig   2644: <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   2645: </div>
                   2646: <div class="sect1" lang="en">
                   2647: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2648: <a name="bulkbuild"></a>6.3. Doing a bulk build of all packages</h2></div></div></div>
                   2649: <p>If you want to get a full set of precompiled binary
1.87      wiz      2650:     packages, this section describes how to get them. Beware that
                   2651:     the bulk build will remove all currently installed packages from
                   2652:     your system!</p>
1.75      rillig   2653: <p>Having an FTP server configured either on the
1.87      wiz      2654:     machine doing the bulk builds or on a nearby NFS server can help
                   2655:     to make the packages available to other machines that can then
                   2656:     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
                   2657:     more information. If you use a remote NFS server's storage, be
                   2658:     sure to not actually compile on NFS storage, as this slows
                   2659:     things down a lot.</p>
1.75      rillig   2660: <div class="sect2" lang="en">
                   2661: <div class="titlepage"><div><div><h3 class="title">
                   2662: <a name="binary.configuration"></a>6.3.1. Configuration</h3></div></div></div>
                   2663: <div class="sect3" lang="en">
                   2664: <div class="titlepage"><div><div><h4 class="title">
1.93      rillig   2665: <a name="binary.bulk.build.conf"></a>6.3.1.1. <code class="filename">build.conf</code>
                   2666: </h4></div></div></div>
1.76      rillig   2667: <p>The <code class="filename">build.conf</code> file is the main
1.87      wiz      2668:        configuration file for bulk builds. You can configure how your
                   2669:        copy of pkgsrc is kept up to date, how the distfiles are
                   2670:        downloaded, how the packages are built and how the report is
                   2671:        generated. You can find an annotated example file in
                   2672:        <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
                   2673:        it, copy <code class="filename">build.conf-example</code> to
                   2674:        <code class="filename">build.conf</code> and edit it, following the
                   2675:        comments in that file.</p>
1.75      rillig   2676: </div>
                   2677: <div class="sect3" lang="en">
                   2678: <div class="titlepage"><div><div><h4 class="title">
                   2679: <a name="binary.mk.conf"></a>6.3.1.2. /etc/mk.conf</h4></div></div></div>
                   2680: <p>You may want to set variables in
1.87      wiz      2681:        <code class="filename">/etc/mk.conf</code>.
                   2682:        Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
                   2683:        details of the default settings. You will want to ensure that
                   2684:        <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
                   2685:        As used in this example, <code class="varname">_ACCEPTABLE=yes</code>
                   2686:        accepts <span class="emphasis"><em>all</em></span> licenses.</p>
                   2687: <pre class="programlisting">
                   2688:          PACKAGES?=      ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
                   2689:          WRKOBJDIR?=     /usr/tmp/pkgsrc   # build here instead of in pkgsrc
                   2690:          BSDSRCDIR=      /usr/src
                   2691:          BSDXSRCDIR=     /usr/xsrc         # for x11/xservers
                   2692:          OBJHOSTNAME?=   yes               # use work.`hostname`
                   2693:          FAILOVER_FETCH= yes               # insist on the correct checksum
                   2694:          PKG_DEVELOPER?= yes
                   2695:          _ACCEPTABLE=    yes
                   2696:        </pre>
1.75      rillig   2697: <p>Some options that are especially useful for bulk builds
                   2698:        can be found at the top lines of the file
1.76      rillig   2699:        <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
1.75      rillig   2700:        options of these are briefly described here.</p>
                   2701: <div class="itemizedlist"><ul type="disc">
                   2702: <li><p>If you are on a slow machine, you may want to
1.87      wiz      2703:          set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
                   2704:          &#8220;<span class="quote">no</span>&#8221;.</p></li>
1.75      rillig   2705: <li><p>If you are doing bulk builds from a read-only
1.87      wiz      2706:          copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
                   2707:          to the directory where all log files are created. Otherwise the
                   2708:          log files are created in the pkgsrc directory.</p></li>
1.75      rillig   2709: <li><p>Another important variable is
1.87      wiz      2710:          <code class="varname">BULK_PREREQ</code>, which is a list of packages that
                   2711:          should be always available while building other
                   2712:          packages.</p></li>
1.75      rillig   2713: </ul></div>
                   2714: <p>Some other options are scattered in the pkgsrc
                   2715:        infrastructure:</p>
                   2716: <div class="itemizedlist"><ul type="disc">
                   2717: <li><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
1.87      wiz      2718:          should be set to <code class="literal">yes</code>. The purpose of the bulk
                   2719:          builds is creating binary packages, no matter if they are
                   2720:          vulnerable or not. When uploading the packages to a public
                   2721:          server, the vulnerable packages will be put into a directory of
                   2722:          their own. Leaving this variable unset would prevent the bulk
                   2723:          build system from even trying to build them, so possible
                   2724:          building errors would not show up.</p></li>
1.75      rillig   2725: <li><p><code class="varname">CHECK_FILES</code>
1.93      rillig   2726:          (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
1.87      wiz      2727:          &#8220;<span class="quote">yes</span>&#8221; to check that the installed set of files
                   2728:          matches the <code class="filename">PLIST</code>.</p></li>
1.75      rillig   2729: <li><p><code class="varname">CHECK_INTERPRETER</code>
1.93      rillig   2730:          (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
1.87      wiz      2731:          &#8220;<span class="quote">yes</span>&#8221; to check that the installed
                   2732:          &#8220;<span class="quote">#!</span>&#8221;-scripts will find their
                   2733:          interpreter.</p></li>
1.91      rillig   2734: <li><p><code class="varname">PKGSRC_RUN_TEST</code> can be
                   2735:          set to &#8220;<span class="quote"><code class="literal">yes</code></span>&#8221; to run each
                   2736:          package's self-test before installing it. Note that some
                   2737:          packages make heavy use of &#8220;<span class="quote">good</span>&#8221; random
                   2738:          numbers, so you need to assure that the machine on which you
                   2739:          are doing the bulk builds is not completely idle. Otherwise
                   2740:          some test programs will seem to hang, while they are just
                   2741:          waiting for new random data to be
                   2742:          available.</p></li>
1.75      rillig   2743: </ul></div>
                   2744: </div>
                   2745: <div class="sect3" lang="en">
                   2746: <div class="titlepage"><div><div><h4 class="title">
1.93      rillig   2747: <a name="pre-build.local"></a>6.3.1.3. <code class="filename">pre-build.local</code>
                   2748: </h4></div></div></div>
1.75      rillig   2749: <p>It is possible to configure the bulk build to perform
1.87      wiz      2750:        certain site-specific tasks at the end of the pre-build
                   2751:        stage.  If the file
                   2752:        <code class="filename">pre-build.local</code> exists in
                   2753:        <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
                   2754:        (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
                   2755:        stage.  An example use of
                   2756:        <code class="filename">pre-build.local</code> is to have the line:</p>
1.75      rillig   2757: <pre class="screen">echo "I do not have enough disk space to build this pig." \
1.87      wiz      2758:        &gt; misc/openoffice/$BROKENF</pre>
1.75      rillig   2759: <p>to prevent the system from trying to build a particular package
1.87      wiz      2760:        which requires nearly 3 GB of disk space.</p>
1.75      rillig   2761: </div>
                   2762: </div>
                   2763: <div class="sect2" lang="en">
                   2764: <div class="titlepage"><div><div><h3 class="title">
                   2765: <a name="other-environmental-considerations"></a>6.3.2. Other environmental considerations</h3></div></div></div>
1.76      rillig   2766: <p>As <code class="filename">/usr/pkg</code> will be completely
1.87      wiz      2767:       deleted at the start of bulk builds, make sure your login
                   2768:       shell is placed somewhere else. Either drop it into
                   2769:       <code class="filename">/usr/local/bin</code> (and adjust your login
                   2770:       shell in the passwd file), or (re-)install it via
                   2771:       <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
                   2772:       you can login after a reboot (remember that your current
                   2773:       process won't die if the package is removed, you just can't
                   2774:       start any new instances of the shell any more).  Also, if you
                   2775:       use NetBSD earlier than 1.5, or you still want to use the pkgsrc
                   2776:       version of ssh for some reason, be sure to install ssh before
                   2777:       starting it from <code class="filename">rc.local</code>:</p>
                   2778: <pre class="programlisting">
                   2779:        ( cd /usr/pkgsrc/security/ssh ; make bulk-install )
                   2780:        if [ -f /usr/pkg/etc/rc.d/sshd ]; then
                   2781:        /usr/pkg/etc/rc.d/sshd
                   2782:        fi
                   2783:       </pre>
1.75      rillig   2784: <p>Not doing so will result in you being not able to log in
1.87      wiz      2785:       via ssh after the bulk build is finished or if the machine
                   2786:       gets rebooted or crashes. You have been warned! :)</p>
1.75      rillig   2787: </div>
                   2788: <div class="sect2" lang="en">
                   2789: <div class="titlepage"><div><div><h3 class="title">
                   2790: <a name="operation"></a>6.3.3. Operation</h3></div></div></div>
                   2791: <p>Make sure you don't need any of the packages still
1.87      wiz      2792:       installed.</p>
1.75      rillig   2793: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2794: <h3 class="title">Warning</h3>
                   2795: <p>During the bulk build, <span class="emphasis"><em>all packages will be
1.87      wiz      2796:        removed!</em></span></p>
1.75      rillig   2797: </div>
                   2798: <p>Be sure to remove all other things that might
1.87      wiz      2799:       interfere with builds, like some libs installed in
                   2800:       <code class="filename">/usr/local</code>, etc. then become root and type:</p>
                   2801: <pre class="screen">
                   2802: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   2803: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
                   2804:       </pre>
1.75      rillig   2805: <p>If for some reason your last build didn't complete (power
1.87      wiz      2806:       failure, system panic, ...), you can continue it by
                   2807:       running:</p>
1.75      rillig   2808: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
1.87      wiz      2809: <p>At the end of the bulk build, you will get a summary via mail,
                   2810:       and find build logs in the directory specified by
                   2811:       <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
                   2812:       file.</p>
1.75      rillig   2813: </div>
                   2814: <div class="sect2" lang="en">
                   2815: <div class="titlepage"><div><div><h3 class="title">
                   2816: <a name="what-it-does"></a>6.3.4. What it does</h3></div></div></div>
                   2817: <p>The bulk builds consist of three steps:</p>
                   2818: <div class="variablelist"><dl>
                   2819: <dt><span class="term">1. pre-build</span></dt>
1.87      wiz      2820: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
                   2821:            cleans out any broken distfiles, and removes all
                   2822:            packages installed.</p></dd>
1.75      rillig   2823: <dt><span class="term">2. the bulk build</span></dt>
1.87      wiz      2824: <dd><p>This is basically &#8220;<span class="quote">make bulk-package</span>&#8221; with
                   2825:            an optimised order in which packages will be
                   2826:            built. Packages that don't require other packages will
                   2827:            be built first, and packages with many dependencies will
                   2828:            be built later.</p></dd>
1.75      rillig   2829: <dt><span class="term">3. post-build</span></dt>
1.87      wiz      2830: <dd><p>Generates a report that's placed in the directory
                   2831:            specified in the <code class="filename">build.conf</code> file
                   2832:            named <code class="filename">broken.html</code>, a short version
                   2833:            of that report will also be mailed to the build's
                   2834:            admin.</p></dd>
1.75      rillig   2835: </dl></div>
1.87      wiz      2836: <p>During the build, a list of broken packages will be compiled
                   2837:       in <code class="filename">/usr/pkgsrc/.broken</code> (or
                   2838:       <code class="filename">.../.broken.${MACHINE}</code> if
                   2839:       <code class="varname">OBJMACHINE</code> is set), individual build logs
                   2840:       of broken builds can be found in the package's
                   2841:       directory. These files are used by the bulk-targets to mark
                   2842:       broken builds to not waste time trying to rebuild them, and
                   2843:       they can be used to debug these broken package builds
                   2844:       later.</p>
1.75      rillig   2845: </div>
                   2846: <div class="sect2" lang="en">
                   2847: <div class="titlepage"><div><div><h3 class="title">
                   2848: <a name="disk-space-requirements"></a>6.3.5. Disk space requirements</h3></div></div></div>
                   2849: <p>Currently, roughly the following requirements are valid for
1.87      wiz      2850:       NetBSD 2.0/i386:</p>
1.75      rillig   2851: <div class="itemizedlist"><ul type="disc">
1.87      wiz      2852: <li><p>10 GB - distfiles (NFS ok)</p></li>
                   2853: <li><p>8 GB - full set of all binaries (NFS ok)</p></li>
                   2854: <li><p>5 GB - temp space for compiling (local disk recommended)</p></li>
                   2855: </ul></div>
                   2856: <p>Note that all pkgs will be de-installed as soon as they are
                   2857:       turned into a binary package, and that sources are removed,
                   2858:       so there is no excessively huge demand to disk
                   2859:       space. Afterwards, if the package is needed again, it will
                   2860:       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
                   2861:       there are no cycles wasted by recompiling.</p>
1.75      rillig   2862: </div>
                   2863: <div class="sect2" lang="en">
                   2864: <div class="titlepage"><div><div><h3 class="title">
                   2865: <a name="setting-up-a-sandbox"></a>6.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.87      wiz      2866: <p>If you don't want all the packages nuked from a machine
                   2867:       (rendering it useless for anything but pkg compiling), there
                   2868:       is the possibility of doing the package bulk build inside a
                   2869:       chroot environment.</p>
                   2870: <p>The first step is to set up a chroot sandbox,
                   2871:       e.g. <code class="filename">/usr/sandbox</code>.  This can be done by
                   2872:       using null mounts, or manually.</p>
                   2873: <p>There is a shell script called
                   2874:       <code class="filename">pkgsrc/mk/bulk/mksandbox</code> which will set
                   2875:       up the sandbox environment using null mounts. It will also
                   2876:       create a script called <code class="filename">sandbox</code> in the
                   2877:       root of the sandbox environment, which will allow the null
                   2878:       mounts to be activated using the <span><strong class="command">sandbox
                   2879:       mount</strong></span> command and deactivated using the
                   2880:       <span><strong class="command">sandbox umount</strong></span> command.</p>
                   2881: <p>To set up a sandbox environment by hand, after extracting all
                   2882:       the sets from a NetBSD installation or doing a <span><strong class="command">make
                   2883:       distribution DESTDIR=/usr/sandbox</strong></span> in
                   2884:       <code class="filename">/usr/src/etc</code>, be sure the following items
                   2885:       are present and properly configured:</p>
1.75      rillig   2886: <div class="procedure"><ol type="1">
                   2887: <li>
                   2888: <p>Kernel</p>
                   2889: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
                   2890: </li>
                   2891: <li>
1.76      rillig   2892: <p><code class="filename">/dev/*</code></p>
1.75      rillig   2893: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
                   2894: </li>
                   2895: <li>
1.91      rillig   2896: <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   2897: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
                   2898: </li>
                   2899: <li>
                   2900: <p>Working(!) mail config (hostname, sendmail.cf):</p>
                   2901: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
                   2902: </li>
                   2903: <li>
1.91      rillig   2904: <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   2905: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
                   2906: </li>
                   2907: <li>
1.76      rillig   2908: <p><code class="filename">/usr/src</code> (system sources,
1.91      rillig   2909:          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   2910: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
1.87      wiz      2911:          <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
1.75      rillig   2912: </li>
                   2913: <li>
1.76      rillig   2914: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
1.75      rillig   2915: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
                   2916: </li>
                   2917: <li>
1.76      rillig   2918: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
1.75      rillig   2919: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
                   2920: </li>
                   2921: <li>
                   2922: <p>Checkout pkgsrc via cvs into
1.87      wiz      2923:          <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
                   2924: <pre class="screen">
                   2925: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
                   2926: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
                   2927:          </pre>
1.75      rillig   2928: <p>Do not mount/link this to the copy of your pkgsrc tree
1.87      wiz      2929:          you do development in, as this will likely cause problems!</p>
1.75      rillig   2930: </li>
                   2931: <li><p>Make
1.87      wiz      2932:          <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
                   2933:          <code class="filename">.../distfiles</code> point somewhere
                   2934:          appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.76      rillig   2935: <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>
                   2936: <li><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
1.75      rillig   2937: </ol></div>
                   2938: <p>When the chroot sandbox is set up, you can start
1.87      wiz      2939:       the build with the following steps:</p>
                   2940: <pre class="screen">
                   2941: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
                   2942: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
                   2943:       </pre>
                   2944: <p>This will just jump inside the sandbox and start building.  At
                   2945:        the end of the build, mail will be sent with the results of
                   2946:        the build. Created binary pkgs will be in
                   2947:        <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
                   2948:       (wherever that points/mounts to/from).</p>
1.75      rillig   2949: </div>
                   2950: <div class="sect2" lang="en">
                   2951: <div class="titlepage"><div><div><h3 class="title">
                   2952: <a name="building-a-partial-set"></a>6.3.7. Building a partial set of packages</h3></div></div></div>
1.87      wiz      2953: <p>In addition to building a complete set of all packages in
                   2954:       pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
                   2955:       may be used to build a subset of the packages contained in
                   2956:       pkgsrc.  By setting <code class="varname">SPECIFIC_PKGS</code>
                   2957:       in <code class="filename">/etc/mk.conf</code>, the variables</p>
1.75      rillig   2958: <div class="itemizedlist"><ul type="disc">
                   2959: <li><p>SITE_SPECIFIC_PKGS</p></li>
                   2960: <li><p>HOST_SPECIFIC_PKGS</p></li>
                   2961: <li><p>GROUP_SPECIFIC_PKGS</p></li>
                   2962: <li><p>USER_SPECIFIC_PKGS</p></li>
                   2963: </ul></div>
1.87      wiz      2964: <p>will define the set of packages which should be built.
                   2965:       The bulk build code will also include any packages which are
                   2966:       needed as dependencies for the explicitly listed packages.</p>
                   2967: <p>One use of this is to do a bulk build with
                   2968:       <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
                   2969:       periodically to have a complete set of the binary packages
                   2970:       needed for your site available without the overhead of
                   2971:       building extra packages that are not needed.</p>
1.75      rillig   2972: </div>
                   2973: <div class="sect2" lang="en">
                   2974: <div class="titlepage"><div><div><h3 class="title">
                   2975: <a name="bulk-upload"></a>6.3.8. Uploading results of a bulk build</h3></div></div></div>
1.87      wiz      2976: <p>This section describes how pkgsrc developers can upload binary
                   2977:       pkgs built by bulk builds to ftp.NetBSD.org.</p>
                   2978: <p>If you would like to automatically create checksum files for the
                   2979:       binary packages you intend to upload, remember to set
                   2980:       <code class="varname">MKSUMS=yes</code> in your
                   2981:       <code class="filename">mk/bulk/build.conf</code>.</p>
                   2982: <p>If you would like to PGP sign the checksum files (highly
                   2983:       recommended!), remember to set
                   2984:       <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
                   2985:       <code class="filename">mk/bulk/build.conf</code>.  This will prompt you for
                   2986:       your GPG password to sign the files before uploading everything.</p>
                   2987: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
                   2988:       set properly in your <code class="filename">mk/bulk/build.conf</code>
                   2989:       file, i.e. adjust it to something like one of the following:</p>
1.93      rillig   2990: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload </pre>
                   2991: <p>Please use appropriate values for "packages-200xQy",
1.87      wiz      2992:       "NetBSD-a.b.c" and "arch" here. If your login on ftp.NetBSD.org
                   2993:       is different from your local login, write your login directly
                   2994:       into the variable, e.g. my local account is "feyrer", but for my
                   2995:       login "hubertf", I use:</p>
1.93      rillig   2996: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload</pre>
1.87      wiz      2997: <p>A separate <code class="filename">upload</code> directory is used
                   2998:       here to allow "closing" the directory during upload. To do
                   2999:       so, run the following command on ftp.NetBSD.org next:</p>
1.93      rillig   3000: <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      3001: <p>Please note that <code class="filename">/pub/NetBSD/packages</code> is
                   3002:       only appropriate for packages for the NetBSD operating
                   3003:       system. Binary packages for other operating systems should go
                   3004:       into <code class="filename">/pub/pkgsrc</code>.</p>
                   3005: <p>Before uploading the binary pkgs, ssh authentication needs
                   3006:       to be set up. This example shows how to set up temporary keys
                   3007:       for the root account <span class="emphasis"><em>inside the sandbox</em></span>
                   3008:       (assuming that no keys should be present there usually):</p>
                   3009: <pre class="screen">
                   3010: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
1.75      rillig   3011: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
                   3012: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t dsa</code></strong>
1.87      wiz      3013: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-dsa.pub</code></strong>
                   3014:       </pre>
                   3015: <p>Now take the output of <code class="filename">id-dsa.pub</code> and
                   3016:       append it to your <code class="filename">~/.ssh/authorized_keys</code>
                   3017:       file on ftp.NetBSD.org. You can remove the key after the
                   3018:       upload is done!</p>
                   3019: <p>Next, test if your ssh connection really works:</p>
1.75      rillig   3020: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
1.87      wiz      3021: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
                   3022: <p>Now after all this works, you can exit the sandbox and start
                   3023:       the upload:</p>
                   3024: <pre class="screen">
                   3025: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
1.75      rillig   3026: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
1.87      wiz      3027: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
                   3028:       </pre>
                   3029: <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
                   3030:       <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
                   3031:       upload. The upload script will take care of not uploading
                   3032:       restricted packages and putting vulnerable packages into the
                   3033:       <code class="filename">vulnerable</code> subdirectory.</p>
                   3034: <p>After the upload has ended, first thing is to revoke ssh access:</p>
1.75      rillig   3035: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
1.87      wiz      3036:       Gdd:x! </pre>
                   3037: <p>Use whatever is needed to remove the key you've entered
                   3038:       before! Last, move the uploaded packages out of the
                   3039:       <code class="filename">upload</code> directory to have them accessible
                   3040:       to everyone:</p>
                   3041: <pre class="screen">
1.93      rillig   3042: nbftp% <strong class="userinput"><code>cd /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch</code></strong>
1.75      rillig   3043: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
                   3044: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
1.87      wiz      3045: nbftp% <strong class="userinput"><code>chmod 755 .</code></strong>
                   3046:       </pre>
1.75      rillig   3047: </div>
                   3048: </div>
                   3049: <div class="sect1" lang="en">
                   3050: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3051: <a name="creating-cdroms"></a>6.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87      wiz      3052: <p>After your pkgsrc bulk-build has completed, you may wish to
                   3053:     create a CD-ROM set of the resulting binary packages to assist
                   3054:     in installing packages on other machines.  The
1.91      rillig   3055:     <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      3056:     a simple tool for creating the ISO 9660 images.
                   3057:     <span><strong class="command">cdpack</strong></span> arranges the packages on the CD-ROMs in a
                   3058:     way that keeps all the dependencies for a given package on the same
                   3059:     CD as that package.</p>
1.75      rillig   3060: <div class="sect2" lang="en">
                   3061: <div class="titlepage"><div><div><h3 class="title">
                   3062: <a name="cdpack-example"></a>6.4.1. Example of cdpack</h3></div></div></div>
1.87      wiz      3063: <p>Complete documentation for cdpack is found in the cdpack(1)
                   3064:       man page. The following short example assumes that the binary
                   3065:       packages are left in
                   3066:       <code class="filename">/usr/pkgsrc/packages/All</code> and that
                   3067:       sufficient disk space exists in <code class="filename">/u2</code> to
                   3068:       hold the ISO 9660 images.</p>
                   3069: <pre class="screen">
                   3070: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75      rillig   3071: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87      wiz      3072: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
                   3073:       </pre>
                   3074: <p>If you wish to include a common set of files
                   3075:       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
                   3076:       etc.) on each CD in the collection, then you need to create a
                   3077:       directory which contains these files. e.g.</p>
                   3078: <pre class="screen">
                   3079: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75      rillig   3080: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
                   3081: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
                   3082: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
                   3083: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
                   3084: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
1.87      wiz      3085: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
                   3086:       </pre>
1.75      rillig   3087: <p>Now create the images:</p>
                   3088: <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   3089: <p>Each image will contain <code class="filename">README</code>,
1.87      wiz      3090:       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
                   3091:       in their root directories.</p>
1.75      rillig   3092: </div>
                   3093: </div>
                   3094: </div>
                   3095: <div class="chapter" lang="en">
                   3096: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   3097: <a name="files"></a>Chapter 7. Directory layout of the installed files</h2></div></div></div>
                   3098: <div class="toc">
                   3099: <p><b>Table of Contents</b></p>
                   3100: <dl>
1.91      rillig   3101: <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   3102: <dt><span class="sect1"><a href="#files.varbase">7.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
                   3103: </dl>
                   3104: </div>
                   3105: <p>The files that are installed by pkgsrc are organized in a way that
                   3106: is similar to what you find in the <code class="filename">/usr</code> directory
                   3107: of the base system. But some details are different. This is because
                   3108: pkgsrc initially came from FreeBSD and had adopted its file system
                   3109: hierarchy. Later it was largely influenced by NetBSD. But no matter
                   3110: which operating system you are using pkgsrc with, you can expect the
                   3111: same layout for pkgsrc.</p>
1.91      rillig   3112: <p>There are mainly four root directories for pkgsrc, which are all
                   3113: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
                   3114: When pkgsrc has been installed as root, the default locations
                   3115: are:</p>
                   3116: <pre class="programlisting">
                   3117:     LOCALBASE=              /usr/pkg
                   3118:     PKG_SYSCONFBASE=        /usr/pkg/etc
                   3119:     VARBASE=                /var
1.93      rillig   3120:     PKG_DBDIR=              /var/db/pkg
1.91      rillig   3121: </pre>
                   3122: <p>In unprivileged mode (when pkgsrc has been installed as any other
                   3123: user), the default locations are:</p>
                   3124: <pre class="programlisting">
                   3125:     LOCALBASE=              ${HOME}/pkg
                   3126:     PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   3127:     VARBASE=                ${HOME}/pkg/var
1.93      rillig   3128:     PKG_DBDIR=              ${HOME}/pkg/var/db/pkg
1.91      rillig   3129: </pre>
                   3130: <p>What these four directories are for, and what they look like is
                   3131: explained below.</p>
1.90      rillig   3132: <div class="itemizedlist"><ul type="disc">
                   3133: <li><p><code class="varname">LOCALBASE</code> corresponds to the
                   3134: <code class="filename">/usr</code> directory in the base system. It is the
                   3135: &#8220;<span class="quote">main</span>&#8221; directory where the files are installed and contains
                   3136: the well-known subdirectories like <code class="filename">bin</code>,
                   3137: <code class="filename">include</code>, <code class="filename">lib</code>,
                   3138: <code class="filename">share</code> and
                   3139: <code class="filename">sbin</code>.</p></li>
                   3140: <li><p><code class="varname">VARBASE</code> corresponds to
                   3141: <code class="filename">/var</code> in the base system. Some programs (especially
                   3142: games, network daemons) need write access to it during normal
                   3143: operation.</p></li>
                   3144: <li><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
                   3145: <code class="filename">/etc</code> in the base system. It contains configuration
                   3146: files of the packages, as well as pkgsrc's <code class="filename">mk.conf</code>
                   3147: itself.</p></li>
                   3148: </ul></div>
                   3149: <div class="sect1" lang="en">
                   3150: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   3151: <a name="files.localbase"></a>7.1. File system layout in <code class="literal">${LOCALBASE}</code>
                   3152: </h2></div></div></div>
1.90      rillig   3153: <p>The following directories exist in a typical pkgsrc installation
1.91      rillig   3154: in <code class="filename">${LOCALBASE}</code>.</p>
1.90      rillig   3155: <div class="variablelist"><dl>
                   3156: <dt><span class="term"><code class="filename">bin</code></span></dt>
                   3157: <dd><p>Contains executable programs that are intended to be
                   3158: directly used by the end user.</p></dd>
                   3159: <dt><span class="term"><code class="filename">emul</code></span></dt>
                   3160: <dd><p>Contains files for the emulation layers of various other
                   3161: operating systems, especially for
                   3162: NetBSD.</p></dd>
                   3163: <dt><span class="term"><code class="filename">etc</code> (the usual location of
                   3164: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
                   3165: <dd><p>Contains
                   3166: the configuration files.</p></dd>
                   3167: <dt><span class="term"><code class="filename">include</code></span></dt>
                   3168: <dd><p>Contains headers for the C and C++ programming
                   3169: languages.</p></dd>
                   3170: <dt><span class="term"><code class="filename">info</code></span></dt>
                   3171: <dd><p>Contains GNU info files of various
                   3172: packages.</p></dd>
                   3173: <dt><span class="term"><code class="filename">lib</code></span></dt>
                   3174: <dd><p>Contains shared and static
                   3175: libraries.</p></dd>
                   3176: <dt><span class="term"><code class="filename">libdata</code></span></dt>
                   3177: <dd><p>Contains data files that don't change after
                   3178: installation. Other data files belong into
                   3179: <code class="filename">${VARBASE}</code>.</p></dd>
                   3180: <dt><span class="term"><code class="filename">libexec</code></span></dt>
                   3181: <dd><p>Contains programs that are not intended to be used by
                   3182: end users, such as helper programs or network
                   3183: daemons.</p></dd>
                   3184: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
                   3185: <dd><p>Contains programs that are intended to be executed as
                   3186: CGI scripts by a web server.</p></dd>
                   3187: <dt><span class="term"><code class="filename">man</code> (the usual value of
                   3188: <code class="filename">${PKGMANDIR}</code>)</span></dt>
                   3189: <dd><p>Contains brief
                   3190: documentation in form of manual pages.</p></dd>
                   3191: <dt><span class="term"><code class="filename">sbin</code></span></dt>
                   3192: <dd><p>Contains programs that are intended to be used only by
                   3193: the super-user.</p></dd>
                   3194: <dt><span class="term"><code class="filename">share</code></span></dt>
                   3195: <dd><p>Contains platform-independent data files that don't
                   3196: change after installation.</p></dd>
                   3197: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
                   3198: <dd><p>Contains documentation files provided by the
                   3199: packages.</p></dd>
                   3200: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
                   3201: <dd><p>Contains example files provided by the packages. Among
                   3202: others, the original configuration files are saved here and copied to
                   3203: <code class="filename">${PKG_SYSCONFDIR}</code> during
                   3204: installation.</p></dd>
                   3205: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
                   3206: <dd><p>Contains the original files for rc.d
                   3207: scripts.</p></dd>
                   3208: <dt><span class="term"><code class="filename">var</code> (the usual location of
                   3209: <code class="filename">${VARBASE}</code>)</span></dt>
                   3210: <dd><p>Contains files
                   3211: that may be modified after
                   3212: installation.</p></dd>
                   3213: </dl></div>
                   3214: </div>
                   3215: <div class="sect1" lang="en">
                   3216: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   3217: <a name="files.varbase"></a>7.2. File system layout in <code class="literal">${VARBASE}</code>
                   3218: </h2></div></div></div>
1.90      rillig   3219: <div class="variablelist"><dl>
                   3220: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
                   3221: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
                   3222: <dd><p>Contains
                   3223: information about the currently installed
                   3224: packages.</p></dd>
                   3225: <dt><span class="term"><code class="filename">games</code></span></dt>
                   3226: <dd><p>Contains highscore
                   3227: files.</p></dd>
                   3228: <dt><span class="term"><code class="filename">log</code></span></dt>
                   3229: <dd><p>Contains log files.</p></dd>
                   3230: <dt><span class="term"><code class="filename">run</code></span></dt>
                   3231: <dd><p>Contains informational files about daemons that are
                   3232: currently running.</p></dd>
                   3233: </dl></div>
                   3234: </div>
                   3235: </div>
                   3236: <div class="chapter" lang="en">
                   3237: <div class="titlepage"><div><div><h2 class="title">
                   3238: <a name="faq"></a>Chapter 8. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   3239: <div class="toc">
                   3240: <p><b>Table of Contents</b></p>
                   3241: <dl>
1.90      rillig   3242: <dt><span class="sect1"><a href="#mailing-list-pointers">8.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                   3243: <dt><span class="sect1"><a href="#pkgviews-docs">8.2. Where's the pkgviews documentation?</a></span></dt>
                   3244: <dt><span class="sect1"><a href="#faq-pkgtools">8.3. Utilities for package management (pkgtools)</a></span></dt>
                   3245: <dt><span class="sect1"><a href="#non-root-pkgsrc">8.4. How to use pkgsrc as non-root</a></span></dt>
                   3246: <dt><span class="sect1"><a href="#resume-transfers">8.5. How to resume transfers when fetching distfiles?</a></span></dt>
                   3247: <dt><span class="sect1"><a href="#XFree86-from-pkgsrc">8.6. How can I install/use XFree86 from pkgsrc?</a></span></dt>
                   3248: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">8.7. How can I install/use X.org from pkgsrc?</a></span></dt>
                   3249: <dt><span class="sect1"><a href="#fetch-behind-firewall">8.8. How to fetch files from behind a firewall</a></span></dt>
                   3250: <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>
                   3251: <dt><span class="sect1"><a href="#fetching-all-distfiles">8.10. How to fetch all distfiles at once</a></span></dt>
                   3252: <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   3253: /usr/share/tmac/tmac.andoc</span>&#8221; mean?</a></span></dt>
1.90      rillig   3254: <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>
                   3255: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">8.13. Using 'sudo' with pkgsrc</a></span></dt>
                   3256: <dt><span class="sect1"><a href="#faq.conf">8.14. How do I change the location of configuration files?</a></span></dt>
                   3257: <dt><span class="sect1"><a href="#audit-packages">8.15. Automated security checks</a></span></dt>
                   3258: <dt><span class="sect1"><a href="#ufaq-cflags">8.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                   3259: <dt><span class="sect1"><a href="#ufaq-fail">8.17. A package does not build.  What shall I do?</a></span></dt>
                   3260: <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   3261: </dl>
                   3262: </div>
                   3263: <p>This section contains hints, tips &amp; tricks on special things in
                   3264: pkgsrc that we didn't find a better place for in the previous chapters, and
                   3265: it contains items for both pkgsrc users and developers.</p>
                   3266: <div class="sect1" lang="en">
                   3267: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3268: <a name="mailing-list-pointers"></a>8.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75      rillig   3269: <p>The following mailing lists may be of interest to pkgsrc users:</p>
                   3270: <div class="itemizedlist"><ul type="disc">
1.78      rillig   3271: <li><p><a href="http://www.NetBSD.org/MailingLists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
                   3272:          This is a general purpose list for most issues regarding
                   3273:          pkgsrc, regardless of platform, e.g. soliciting user help
                   3274:          for pkgsrc configuration, unexpected build failures, using
                   3275:          particular packages, upgrading pkgsrc installations,
                   3276:          questions regarding the pkgsrc release branches, etc.  General announcements or
                   3277:          proposals for changes that impact the pkgsrc user community,
                   3278:          e.g. major infrastructure changes, new features, package
                   3279:          removals, etc., may also be posted.</p></li>
1.75      rillig   3280: <li><p><a href="http://www.NetBSD.org/MailingLists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
                   3281:          A list where the results of pkgsrc bulk builds are sent and
                   3282:          discussed.</p></li>
                   3283: <li><p><a href="http://www.NetBSD.org/MailingLists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
                   3284:          This list is for those who are interested in getting a
                   3285:          commit message for every change committed to pkgsrc. It is
                   3286:          also available in digest form, meaning one daily message
                   3287:          containing all commit messages for changes to the package
                   3288:          source tree in that 24 hour period.</p></li>
                   3289: </ul></div>
                   3290: <p>To subscribe, do:</p>
                   3291: <pre class="programlisting">
                   3292:     <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
                   3293: </pre>
                   3294: <p>Archives for all these mailing lists are available from
                   3295: <a href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
                   3296: </div>
                   3297: <div class="sect1" lang="en">
                   3298: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3299: <a name="pkgviews-docs"></a>8.2. Where's the pkgviews documentation?</h2></div></div></div>
1.75      rillig   3300: <p>Pkgviews is tightly integrated with buildlink.  You can find a
                   3301: pkgviews User's guide in
1.76      rillig   3302: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
1.75      rillig   3303: </div>
                   3304: <div class="sect1" lang="en">
                   3305: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3306: <a name="faq-pkgtools"></a>8.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.80      rillig   3307: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75      rillig   3308: a number of useful utilities for both users and developers of pkgsrc.  This
                   3309: section attempts only to make the reader aware of the utilities and when
                   3310: they might be useful, and not to duplicate the documentation that comes
                   3311: with each package.</p>
                   3312: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.91      rillig   3313: <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   3314:       Symlinks for use by buildlink.</p></li></ul></div>
                   3315: <p>OS tool augmentation (automatically installed when needed):</p>
                   3316: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3317: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/README.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.75      rillig   3318:       Calculates various kinds of checksums (including SHA1).</p></li>
1.91      rillig   3319: <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   3320:       Compatibility library for pkgsrc tools.</p></li>
1.91      rillig   3321: <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      3322:       non-BSD systems due to lack of native mtree.</p></li>
1.91      rillig   3323: <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   3324:       Up-to-date replacement for
1.76      rillig   3325:       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75      rillig   3326:       systems where pkg_install is not present.</p></li>
                   3327: </ul></div>
                   3328: <p>Utilities used by pkgsrc (not automatically installed):</p>
                   3329: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3330: <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   3331:       Create a binary package from an
                   3332:       already-installed package.  Used by <span><strong class="command">make replace</strong></span> to
                   3333:       save the old package.</p></li>
1.91      rillig   3334: <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   3335:       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
                   3336:       from multiple locations. It currently supports the following
                   3337:       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.91      rillig   3338: <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   3339:       packages someplace else (enabled by default).</p></li>
1.91      rillig   3340: <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   3341:       best compiler flags to optimise code for your current CPU and
                   3342:       compiler.</p></li>
                   3343: </ul></div>
                   3344: <p>Utilities for keeping track of installed packages, being up to date,
                   3345: etc:</p>
                   3346: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3347: <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   3348:       packages whose installed versions do not match the latest pkgsrc
                   3349:       entries.</p></li>
1.91      rillig   3350: <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   3351:       dependency graphs of packages, to aid in choosing a strategy for
                   3352:       updating.</p></li>
1.91      rillig   3353: <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
                   3354:       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>
                   3355: <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   3356:       pkglint(1) program checks a pkgsrc entry for errors, lintpkgsrc(1)
                   3357:       does various checks on the complete pkgsrc system.</p></li>
1.91      rillig   3358: <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   3359:       packages you have installed.</p></li>
                   3360: </ul></div>
                   3361: <p>Utilities for people maintaining or creating individual packages:</p>
                   3362: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3363: <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   3364:       making and maintaining patches for a package (includes pkgdiff,
                   3365:       pkgvi, mkpatches, etc.).</p></li>
1.91      rillig   3366: <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>,
                   3367:       <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   3368:       converting to pkgsrc.</p></li>
1.91      rillig   3369: <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   3370:       pkgsrc to a Solaris package.</p></li>
                   3371: </ul></div>
                   3372: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
                   3373: utilities)</p>
                   3374: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3375: <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   3376:       packages in a chrooted area.</p></li>
1.91      rillig   3377: <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   3378:       kernel version for chrooted cross builds.</p></li>
                   3379: </ul></div>
                   3380: </div>
                   3381: <div class="sect1" lang="en">
                   3382: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3383: <a name="non-root-pkgsrc"></a>8.4. How to use pkgsrc as non-root</h2></div></div></div>
1.75      rillig   3384: <p>If you want to use pkgsrc as non-root user, you can set some
                   3385: variables to make pkgsrc work under these conditions.  At the very least,
                   3386: you need to set <code class="varname">UNPRIVILEGED</code> to &#8220;<span class="quote">yes</span>&#8221;; this
                   3387: will turn on unprivileged mode and set multiple related variables to allow
                   3388: installation of packages as non-root.</p>
                   3389: <p>In case the defaults are not enough, you may want to tune some other
                   3390: variables used.  For example, if the automatic user/group detection leads
                   3391: to incorrect values (or not the ones you would like to use), you can change
                   3392: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
                   3393: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
                   3394: <p>As regards bootstrapping, please note that the
                   3395: <span><strong class="command">bootstrap</strong></span> script will ease non-root configuration when
                   3396: given the &#8220;<span class="quote">--ignore-user-check</span>&#8221; flag, as it will choose and
1.76      rillig   3397: use multiple default directories under <code class="filename">~/pkg</code> as the
1.93      rillig   3398: installation targets.  These directories can be overridden by the
1.75      rillig   3399: &#8220;<span class="quote">--prefix</span>&#8221; flag provided by the script, as well as some others
                   3400: that allow finer tuning of the tree layout.</p>
                   3401: </div>
                   3402: <div class="sect1" lang="en">
                   3403: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3404: <a name="resume-transfers"></a>8.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75      rillig   3405: <p>By default, resuming transfers in pkgsrc is disabled, but you can
                   3406: enable this feature by adding the option
                   3407: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.76      rillig   3408: <code class="filename">/etc/mk.conf</code>.  If, during a fetch step, an incomplete
1.75      rillig   3409: distfile is found, pkgsrc will try to resume it.</p>
                   3410: <p>You can also
                   3411: 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
                   3412: <code class="varname">FETCH_CMD</code> variable.  Don't forget to set
                   3413: <code class="varname">FETCH_RESUME_ARGS</code> and
                   3414: <code class="varname">FETCH_OUTPUT_ARGS</code> if you are not using default
                   3415: values.</p>
                   3416: <p>For example, if you want to use
1.76      rillig   3417: <code class="filename">wget</code> to resume downloads, you'll have to use something
1.75      rillig   3418: like:</p>
                   3419: <pre class="programlisting">
                   3420:     FETCH_CMD=             wget
                   3421:     FETCH_BEFORE_ARGS=     --passive-ftp
                   3422:     FETCH_RESUME_ARGS=     -c
                   3423:     FETCH_OUTPUT_ARGS=     -O
1.1       grant    3424: </pre>
1.75      rillig   3425: </div>
                   3426: <div class="sect1" lang="en">
                   3427: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3428: <a name="XFree86-from-pkgsrc"></a>8.6. How can I install/use XFree86 from pkgsrc?</h2></div></div></div>
1.75      rillig   3429: <p>If you want to use XFree86 from pkgsrc instead of your system's own
1.76      rillig   3430: X11 (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>,
1.75      rillig   3431: ...), you will have to add the following line into
1.76      rillig   3432: <code class="filename">/etc/mk.conf</code>:</p>
1.75      rillig   3433: <pre class="programlisting">
                   3434:     X11_TYPE=XFree86
1.1       grant    3435: </pre>
1.75      rillig   3436: </div>
                   3437: <div class="sect1" lang="en">
                   3438: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3439: <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   3440: <p>If you want to use X.org from pkgsrc instead of your system's own X11
1.76      rillig   3441: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75      rillig   3442: you will have to add the following line into
1.76      rillig   3443: <code class="filename">/etc/mk.conf</code>:</p>
1.75      rillig   3444: <pre class="programlisting">
                   3445:     X11_TYPE=xorg
1.1       grant    3446: </pre>
1.75      rillig   3447: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   3448: <h3 class="title">Note</h3>
                   3449: <p>The DragonFly operating system defaults to using
1.87      wiz      3450: this X.org X11 implementation from pkgsrc.</p>
1.75      rillig   3451: </div>
                   3452: </div>
                   3453: <div class="sect1" lang="en">
                   3454: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3455: <a name="fetch-behind-firewall"></a>8.8. How to fetch files from behind a firewall</h2></div></div></div>
1.75      rillig   3456: <p>If you are sitting behind a firewall which does not allow direct
                   3457: connections to Internet hosts (i.e. non-NAT), you may specify the
                   3458: relevant proxy hosts.  This is done using an environment variable in the
                   3459: form of a URL, e.g. in Amdahl, the machine
                   3460: &#8220;<span class="quote">orpheus.amdahl.com</span>&#8221; is one of the firewalls, and it uses
                   3461: port 80 as the proxy port number.  So the proxy environment variables
                   3462: are:</p>
                   3463: <pre class="programlisting">
                   3464:     ftp_proxy=ftp://orpheus.amdahl.com:80/
                   3465:     http_proxy=http://orpheus.amdahl.com:80/
1.1       grant    3466: </pre>
1.75      rillig   3467: </div>
                   3468: <div class="sect1" lang="en">
                   3469: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3470: <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   3471: <p>This depends on which utility is used to retrieve distfiles.  From
1.76      rillig   3472: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75      rillig   3473: the first available command from the following list:</p>
                   3474: <div class="itemizedlist"><ul type="disc">
1.76      rillig   3475: <li><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
                   3476: <li><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75      rillig   3477: </ul></div>
                   3478: <p>On a default NetBSD installation, this will be
1.76      rillig   3479: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75      rillig   3480: connections first, and falls back to active connections if the server
                   3481: refuses to do passive.  For the other tools, add the following to your
1.76      rillig   3482: <code class="filename">/etc/mk.conf</code> file:
1.75      rillig   3483: <code class="varname">PASSIVE_FETCH=1</code>.</p>
                   3484: <p>Having that option present will prevent
1.76      rillig   3485: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75      rillig   3486: transfers.</p>
                   3487: </div>
                   3488: <div class="sect1" lang="en">
                   3489: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3490: <a name="fetching-all-distfiles"></a>8.10. How to fetch all distfiles at once</h2></div></div></div>
1.88      wiz      3491: <p>You would like to download all the distfiles in a single batch
                   3492: from work or university, where you can't run a <span><strong class="command">make
                   3493: 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   3494: but downloading the entire directory may not be appropriate.</p>
                   3495: <p>The answer here is to do a <span><strong class="command">make fetch-list</strong></span> in
1.76      rillig   3496: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75      rillig   3497: resulting list to your machine at work/school and use it there.  If you
                   3498: 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
                   3499: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
                   3500: URL:</p>
                   3501: <p>At home:</p>
                   3502: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   3503: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
                   3504: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
                   3505: <p>At work:</p>
                   3506: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76      rillig   3507: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75      rillig   3508: home.</p>
                   3509: <p>If you have a machine running NetBSD, and you want to get
1.88      wiz      3510: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
                   3511: machine architecture), you can do so by using the above-mentioned
                   3512: <span><strong class="command">make fetch-list</strong></span> approach, or fetch the distfiles
                   3513: directly by running:</p>
1.75      rillig   3514: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
                   3515: <p>If you even decide to ignore
                   3516: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
                   3517: by running:</p>
                   3518: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
                   3519: </div>
                   3520: <div class="sect1" lang="en">
                   3521: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3522: <a name="tmac.andoc-missing"></a>8.11. What does &#8220;<span class="quote">Don't know how to make
1.75      rillig   3523: /usr/share/tmac/tmac.andoc</span>&#8221; mean?</h2></div></div></div>
1.91      rillig   3524: <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   3525: package, you get the error from make that it doesn't know how to make
1.76      rillig   3526: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.75      rillig   3527: you don't have installed the &#8220;<span class="quote">text</span>&#8221; set (nroff, ...) from
                   3528: the NetBSD base distribution on your machine.  It is recommended to do
                   3529: that to format man pages.</p>
1.91      rillig   3530: <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   3531: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.76      rillig   3532: environment or in <code class="filename">/etc/mk.conf</code>.</p>
1.75      rillig   3533: </div>
                   3534: <div class="sect1" lang="en">
                   3535: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3536: <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      3537: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75      rillig   3538: when you installed your NetBSD machine.  Please get and install it, by
1.76      rillig   3539: extracting it in <code class="filename">/</code>:</p>
1.75      rillig   3540: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   3541: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76      rillig   3542: <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
1.75      rillig   3543: the one that corresponds to your release (determine via <span><strong class="command">uname
                   3544: -r</strong></span>).</p>
                   3545: </div>
                   3546: <div class="sect1" lang="en">
                   3547: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3548: <a name="using-sudo-with-pkgsrc"></a>8.13. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75      rillig   3549: <p>When installing packages as non-root user and using the just-in-time
                   3550: <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
                   3551: password for each required package installed.  To avoid this, the sudo
                   3552: package can be used, which does password caching over a limited time.  To
                   3553: use it, install sudo (either as binary package or from
1.91      rillig   3554: <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   3555: into your <code class="filename">/etc/mk.conf</code>:</p>
1.75      rillig   3556: <pre class="programlisting">
                   3557:     .if exists(${LOCALBASE}/bin/sudo)
                   3558:     SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
                   3559:     .endif
1.1       grant    3560: </pre>
1.75      rillig   3561: </div>
                   3562: <div class="sect1" lang="en">
                   3563: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3564: <a name="faq.conf"></a>8.14. How do I change the location of configuration files?</h2></div></div></div>
1.75      rillig   3565: <p>As the system administrator, you can choose where configuration files
                   3566: are installed.  The default settings make all these files go into
1.76      rillig   3567: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75      rillig   3568: be suboptimal depending on your expectations (e.g., a read-only,
                   3569: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
                   3570: configuration of the provided packages).</p>
                   3571: <p>In order to change the defaults, you can modify the
                   3572: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.76      rillig   3573: <code class="filename">/etc/mk.conf</code>) to point to your preferred configuration
                   3574: directory; some common examples include <code class="filename">/etc</code> or
                   3575: <code class="filename">/etc/pkg</code>.</p>
1.75      rillig   3576: <p>Furthermore, you can change this value on a per-package basis by
                   3577: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
                   3578: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
                   3579: package you would like to modify, that is, the contents of
                   3580: <code class="varname">PKGBASE</code>.</p>
                   3581: <p>Note that after changing these settings, you must rebuild and
                   3582: reinstall any affected packages.</p>
                   3583: </div>
                   3584: <div class="sect1" lang="en">
                   3585: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3586: <a name="audit-packages"></a>8.15. Automated security checks</h2></div></div></div>
1.75      rillig   3587: <p>Please be aware that there can often be bugs in third-party software,
                   3588: and some of these bugs can leave a machine vulnerable to exploitation by
                   3589: attackers.  In an effort to lessen the exposure, the NetBSD packages team
                   3590: maintains a database of known-exploits to packages which have at one time
                   3591: been included in pkgsrc.  The database can be downloaded automatically, and
                   3592: a security audit of all packages installed on a system can take place.  To
1.91      rillig   3593: 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   3594: components:</p>
                   3595: <div class="orderedlist"><ol type="1">
                   3596: <li>
                   3597: <p><span><strong class="command">download-vulnerability-list</strong></span>, an easy way to
                   3598:     download a list of the security vulnerabilities information.  This list
                   3599:     is kept up to date by the NetBSD security officer and the NetBSD
                   3600:     packages team, and is distributed from the NetBSD ftp server:</p>
                   3601: <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>
                   3602: </li>
                   3603: <li><p><span><strong class="command">audit-packages</strong></span>, an easy way to audit the
                   3604:     current machine, checking each vulnerability which is known.  If a
                   3605:     vulnerable package is installed, it will be shown by output to stdout,
                   3606:     including a description of the type of vulnerability, and a URL
                   3607:     containing more information.</p></li>
                   3608: </ol></div>
1.91      rillig   3609: <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   3610: package is strongly recommended!  After
                   3611: &#8220;<span class="quote">audit-packages</span>&#8221; is installed, please read
                   3612: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
                   3613: audit-packages</code></strong>.</p>
1.87      wiz      3614: <p>If this package is installed, pkgsrc builds will use it to
                   3615: 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
                   3616: check.</p>
1.75      rillig   3617: </div>
                   3618: <div class="sect1" lang="en">
                   3619: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3620: <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   3621: <p>When you add your own preferences to the
                   3622:        <code class="varname">CFLAGS</code> variable in your
1.76      rillig   3623:        <code class="filename">mk.conf</code>, these flags are passed in
                   3624:        environment variables to the <code class="filename">./configure</code>
1.75      rillig   3625:        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
                   3626:        <code class="varname">CFLAGS</code> from the environment variable by
1.76      rillig   3627:        overriding them in the <code class="filename">Makefile</code>s of their
1.75      rillig   3628:        package.</p>
                   3629: <p>Currently there is no solution to this problem. If you
                   3630:        really need the package to use your <code class="varname">CFLAGS</code>
                   3631:        you should run <span><strong class="command">make patch</strong></span> in the package
1.76      rillig   3632:        directory and then inspect any <code class="filename">Makefile</code> and
                   3633:        <code class="filename">Makefile.in</code> for whether they define
1.75      rillig   3634:        <code class="varname">CFLAGS</code> explicitly. Usually you can remove
                   3635:        these lines. But be aware that some &#8220;<span class="quote">smart</span>&#8221;
                   3636:        programmers write so bad code that it only works for the
                   3637:        specific combination of <code class="varname">CFLAGS</code> they have
                   3638:        chosen.</p>
                   3639: </div>
1.80      rillig   3640: <div class="sect1" lang="en">
                   3641: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3642: <a name="ufaq-fail"></a>8.17. A package does not build.  What shall I do?</h2></div></div></div>
1.80      rillig   3643: <div class="procedure"><ol type="1">
                   3644: <li><p>Make sure that your copy of pkgsrc is consistent. A
                   3645:        case that occurs often is that people only update pkgsrc in
                   3646:        parts, because of performance reasons. Since pkgsrc is one large
                   3647:        system, not a collection of many small systems, there are
                   3648:        sometimes changes that only work when the whole pkgsrc tree is
                   3649:        updated.</p></li>
                   3650: <li><p>Make sure that you don't have any CVS conflicts.
                   3651:        Search for &#8220;<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>&#8221; or
                   3652:        &#8220;<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>&#8221; in all your pkgsrc
                   3653:        files.</p></li>
                   3654: <li><p>Make sure that you don't have old copies of the packages
                   3655:        extracted. Run <span><strong class="command">make clean clean-depends</strong></span> to
                   3656:        verify this.</p></li>
                   3657: <li><p>If the problem still exists, write a mail to the
                   3658:        <code class="literal">pkgsrc-users</code> mailing list.</p></li>
                   3659: </ol></div>
                   3660: </div>
1.88      wiz      3661: <div class="sect1" lang="en">
                   3662: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3663: <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   3664: <p>You have modified a file from pkgsrc, and someone else has
                   3665: modified that same file afterwards in the CVS repository. Both changes
                   3666: are in the same region of the file, so when you updated pkgsrc, the
                   3667: <code class="literal">cvs</code> command marked the conflicting changes in the
                   3668: file. Because of these markers, the file is no longer a valid
                   3669: <code class="filename">Makefile</code>.</p>
                   3670: <p>Have a look at that file, and if you don't need your local changes
                   3671: anymore, you can remove that file and run <span><strong class="command">cvs -q update
                   3672: -dP</strong></span> in that directory to download the current version.</p>
                   3673: </div>
1.75      rillig   3674: </div>
                   3675: </div>
                   3676: <div class="part" lang="en">
                   3677: <div class="titlepage"><div><div><h1 class="title">
                   3678: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.77      rillig   3679: <div class="partintro" lang="en">
                   3680: <div></div>
                   3681: <p>This part of the book deals with creating and
                   3682:        modifying packages. It starts with a &#8220;<span class="quote">HOWTO</span>&#8221;-like
                   3683:        guide on creating a new package. The remaining chapters are more
                   3684:        like a reference manual for pkgsrc.</p>
1.75      rillig   3685: <div class="toc">
                   3686: <p><b>Table of Contents</b></p>
                   3687: <dl>
1.90      rillig   3688: <dt><span class="chapter"><a href="#creating">9. Creating a new pkgsrc package from scratch</a></span></dt>
1.91      rillig   3689: <dd><dl>
                   3690: <dt><span class="sect1"><a href="#creating.common">9.1. Common types of packages</a></span></dt>
                   3691: <dd><dl>
                   3692: <dt><span class="sect2"><a href="#creating.perl-module">9.1.1. Perl modules</a></span></dt>
                   3693: <dt><span class="sect2"><a href="#creating.kde-app">9.1.2. KDE applications</a></span></dt>
                   3694: </dl></dd>
                   3695: <dt><span class="sect1"><a href="#creating.examples">9.2. Examples</a></span></dt>
                   3696: <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>
                   3697: </dl></dd>
1.90      rillig   3698: <dt><span class="chapter"><a href="#components">10. Package components - files, directories and contents</a></span></dt>
1.75      rillig   3699: <dd><dl>
1.90      rillig   3700: <dt><span class="sect1"><a href="#components.Makefile">10.1. <code class="filename">Makefile</code></a></span></dt>
                   3701: <dt><span class="sect1"><a href="#components.distinfo">10.2. <code class="filename">distinfo</code></a></span></dt>
                   3702: <dt><span class="sect1"><a href="#components.patches">10.3. patches/*</a></span></dt>
                   3703: <dd><dl>
1.93      rillig   3704: <dt><span class="sect2"><a href="#components.patch.structure">10.3.1. Structure of a single patch file</a></span></dt>
                   3705: <dt><span class="sect2"><a href="#components.patches.caveats">10.3.2. Creating patch files</a></span></dt>
                   3706: <dt><span class="sect2"><a href="#components.patches.sources">10.3.3. Sources where the patch files come from</a></span></dt>
                   3707: <dt><span class="sect2"><a href="#components.patches.guidelines">10.3.4. Patching guidelines</a></span></dt>
                   3708: <dt><span class="sect2"><a href="#components.patches.feedback">10.3.5. Feedback to the author</a></span></dt>
1.90      rillig   3709: </dl></dd>
                   3710: <dt><span class="sect1"><a href="#other-mandatory-files">10.4. Other mandatory files</a></span></dt>
                   3711: <dt><span class="sect1"><a href="#components.optional">10.5. Optional files</a></span></dt>
                   3712: <dd><dl>
                   3713: <dt><span class="sect2"><a href="#components.optional.bin">10.5.1. Files affecting the binary package</a></span></dt>
                   3714: <dt><span class="sect2"><a href="#components.optional.build">10.5.2. Files affecting the build process</a></span></dt>
                   3715: <dt><span class="sect2"><a href="#components.optional.none">10.5.3. Files affecting nothing at all</a></span></dt>
                   3716: </dl></dd>
                   3717: <dt><span class="sect1"><a href="#work-dir">10.6. <code class="filename">work*</code></a></span></dt>
                   3718: <dt><span class="sect1"><a href="#files-dir">10.7. <code class="filename">files/*</code></a></span></dt>
                   3719: </dl></dd>
                   3720: <dt><span class="chapter"><a href="#makefile">11. Programming in <code class="filename">Makefile</code>s</a></span></dt>
                   3721: <dd><dl>
                   3722: <dt><span class="sect1"><a href="#makefile.variables">11.1. <code class="filename">Makefile</code> variables</a></span></dt>
                   3723: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">11.1.1. Naming conventions</a></span></dt></dl></dd>
                   3724: <dt><span class="sect1"><a href="#makefile.code">11.2. Code snippets</a></span></dt>
                   3725: <dd><dl>
                   3726: <dt><span class="sect2"><a href="#adding-to-list">11.2.1. Adding things to a list</a></span></dt>
                   3727: <dt><span class="sect2"><a href="#converting-internal-to-external">11.2.2. Converting an internal list into an external list</a></span></dt>
                   3728: <dt><span class="sect2"><a href="#passing-variable-to-shell">11.2.3. Passing variables to a shell command</a></span></dt>
                   3729: <dt><span class="sect2"><a href="#quoting-guideline">11.2.4. Quoting guideline</a></span></dt>
                   3730: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">11.2.5. Workaround for a bug in BSD Make</a></span></dt>
                   3731: </dl></dd>
                   3732: </dl></dd>
                   3733: <dt><span class="chapter"><a href="#plist">12. PLIST issues</a></span></dt>
                   3734: <dd><dl>
                   3735: <dt><span class="sect1"><a href="#rcs-id">12.1. RCS ID</a></span></dt>
                   3736: <dt><span class="sect1"><a href="#automatic-plist-generation">12.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   3737: <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>
                   3738: <dt><span class="sect1"><a href="#plist.misc">12.4. Variable substitution in PLIST</a></span></dt>
                   3739: <dt><span class="sect1"><a href="#manpage-compression">12.5. Man page compression</a></span></dt>
                   3740: <dt><span class="sect1"><a href="#using-PLIST_SRC">12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   3741: <dt><span class="sect1"><a href="#platform-specific-plist">12.7. Platform-specific and differing PLISTs</a></span></dt>
                   3742: <dt><span class="sect1"><a href="#faq.common-dirs">12.8. Sharing directories between packages</a></span></dt>
                   3743: </dl></dd>
                   3744: <dt><span class="chapter"><a href="#buildlink">13. Buildlink methodology</a></span></dt>
                   3745: <dd><dl>
                   3746: <dt><span class="sect1"><a href="#converting-to-buildlink3">13.1. Converting packages to use buildlink3</a></span></dt>
                   3747: <dt><span class="sect1"><a href="#creating-buildlink3.mk">13.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
                   3748: <dd><dl>
                   3749: <dt><span class="sect2"><a href="#anatomy-of-bl3">13.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   3750: <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>
                   3751: </dl></dd>
                   3752: <dt><span class="sect1"><a href="#writing-builtin.mk">13.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
                   3753: <dd><dl>
                   3754: <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>
                   3755: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">13.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                   3756: </dl></dd>
                   3757: </dl></dd>
                   3758: <dt><span class="chapter"><a href="#pkginstall">14. The pkginstall framework</a></span></dt>
                   3759: <dd><dl>
                   3760: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">14.1. Files and directories outside the installation prefix</a></span></dt>
                   3761: <dd><dl>
                   3762: <dt><span class="sect2"><a href="#dirs-outside-prefix">14.1.1. Directory manipulation</a></span></dt>
                   3763: <dt><span class="sect2"><a href="#files-outside-prefix">14.1.2. File manipulation</a></span></dt>
                   3764: </dl></dd>
                   3765: <dt><span class="sect1"><a href="#conf-files">14.2. Configuration files</a></span></dt>
                   3766: <dd><dl>
                   3767: <dt><span class="sect2"><a href="#conf-files-sysconfdir">14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   3768: <dt><span class="sect2"><a href="#conf-files-configure">14.2.2. Telling the software where configuration files are</a></span></dt>
                   3769: <dt><span class="sect2"><a href="#conf-files-patching">14.2.3. Patching installations</a></span></dt>
                   3770: <dt><span class="sect2"><a href="#conf-files-disable">14.2.4. Disabling handling of configuration files</a></span></dt>
                   3771: </dl></dd>
                   3772: <dt><span class="sect1"><a href="#rcd-scripts">14.3. System startup scripts</a></span></dt>
                   3773: <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>
                   3774: <dt><span class="sect1"><a href="#users-and-groups">14.4. System users and groups</a></span></dt>
                   3775: <dt><span class="sect1"><a href="#shells">14.5. System shells</a></span></dt>
                   3776: <dd><dl><dt><span class="sect2"><a href="#shells-disable">14.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   3777: <dt><span class="sect1"><a href="#fonts">14.6. Fonts</a></span></dt>
                   3778: <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>
                   3779: </dl></dd>
                   3780: <dt><span class="chapter"><a href="#options">15. Options handling</a></span></dt>
                   3781: <dd><dl>
                   3782: <dt><span class="sect1"><a href="#global-default-options">15.1. Global default options</a></span></dt>
                   3783: <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>
                   3784: <dt><span class="sect1"><a href="#option-names">15.3. Option Names</a></span></dt>
                   3785: </dl></dd>
                   3786: <dt><span class="chapter"><a href="#build">16. The build process</a></span></dt>
                   3787: <dd><dl>
                   3788: <dt><span class="sect1"><a href="#build.intro">16.1. Introduction</a></span></dt>
                   3789: <dt><span class="sect1"><a href="#build.prefix">16.2. Program location</a></span></dt>
                   3790: <dt><span class="sect1"><a href="#build.builddirs">16.3. Directories used during the build process</a></span></dt>
                   3791: <dt><span class="sect1"><a href="#build.running">16.4. Running a phase</a></span></dt>
                   3792: <dt><span class="sect1"><a href="#build.fetch">16.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   3793: <dd><dl>
                   3794: <dt><span class="sect2"><a href="#build.fetch.what">16.5.1. What to fetch and where to get it from</a></span></dt>
                   3795: <dt><span class="sect2"><a href="#build.fetch.how">16.5.2. How are the files fetched?</a></span></dt>
                   3796: </dl></dd>
                   3797: <dt><span class="sect1"><a href="#build.checksum">16.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   3798: <dt><span class="sect1"><a href="#build.extract">16.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   3799: <dt><span class="sect1"><a href="#build.patch">16.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   3800: <dt><span class="sect1"><a href="#build.tools">16.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   3801: <dt><span class="sect1"><a href="#build.wrapper">16.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   3802: <dt><span class="sect1"><a href="#build.configure">16.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   3803: <dt><span class="sect1"><a href="#build.build">16.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   3804: <dt><span class="sect1"><a href="#build.test">16.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   3805: <dt><span class="sect1"><a href="#build.install">16.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   3806: <dt><span class="sect1"><a href="#build.package">16.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   3807: <dt><span class="sect1"><a href="#build.clean">16.16. Cleaning up</a></span></dt>
                   3808: <dt><span class="sect1"><a href="#build.helpful-targets">16.17. Other helpful targets</a></span></dt>
                   3809: </dl></dd>
                   3810: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
                   3811: <dd><dl>
                   3812: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                   3813: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                   3814: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
                   3815: </dl></dd>
                   3816: <dt><span class="chapter"><a href="#fixes">18. Making your package work</a></span></dt>
                   3817: <dd><dl>
                   3818: <dt><span class="sect1"><a href="#general-operation">18.1. General operation</a></span></dt>
                   3819: <dd><dl>
                   3820: <dt><span class="sect2"><a href="#portability-of-packages">18.1.1. Portability of packages</a></span></dt>
                   3821: <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>
                   3822: <dt><span class="sect2"><a href="#user-interaction">18.1.3. User interaction</a></span></dt>
                   3823: <dt><span class="sect2"><a href="#handling-licenses">18.1.4. Handling licenses</a></span></dt>
                   3824: <dt><span class="sect2"><a href="#restricted-packages">18.1.5. Restricted packages</a></span></dt>
                   3825: <dt><span class="sect2"><a href="#dependencies">18.1.6. Handling dependencies</a></span></dt>
                   3826: <dt><span class="sect2"><a href="#conflicts">18.1.7. Handling conflicts with other packages</a></span></dt>
                   3827: <dt><span class="sect2"><a href="#not-building-packages">18.1.8. Packages that cannot or should not be built</a></span></dt>
                   3828: <dt><span class="sect2"><a href="#undeletable-packages">18.1.9. Packages which should not be deleted, once installed</a></span></dt>
                   3829: <dt><span class="sect2"><a href="#security-handling">18.1.10. Handling packages with security problems</a></span></dt>
                   3830: <dt><span class="sect2"><a href="#bumping-pkgrevision">18.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   3831: <dt><span class="sect2"><a href="#fixes.subst">18.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   3832: </dl></dd>
                   3833: <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>
                   3834: <dd><dl>
                   3835: <dt><span class="sect2"><a href="#no-plain-download">18.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   3836: <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>
                   3837: </dl></dd>
                   3838: <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>
                   3839: <dd><dl>
                   3840: <dt><span class="sect2"><a href="#fixes.libtool">18.3.1. Shared libraries - libtool</a></span></dt>
                   3841: <dt><span class="sect2"><a href="#using-libtool">18.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   3842: <dt><span class="sect2"><a href="#autoconf-automake">18.3.3. GNU Autoconf/Automake</a></span></dt>
                   3843: </dl></dd>
                   3844: <dt><span class="sect1"><a href="#programming-languages">18.4. Programming languages</a></span></dt>
                   3845: <dd><dl>
                   3846: <dt><span class="sect2"><a href="#basic-programming-languages">18.4.1. C, C++, and Fortran</a></span></dt>
                   3847: <dt><span class="sect2"><a href="#java-programming-language">18.4.2. Java</a></span></dt>
                   3848: <dt><span class="sect2"><a href="#perl-scripts">18.4.3. Packages containing perl scripts</a></span></dt>
                   3849: <dt><span class="sect2"><a href="#other-programming-languages">18.4.4. Other programming languages</a></span></dt>
                   3850: </dl></dd>
                   3851: <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>
                   3852: <dd><dl>
                   3853: <dt><span class="sect2"><a href="#fixes.build.cpp">18.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   3854: <dt><span class="sect2"><a href="#compiler-bugs">18.5.2. How to handle compiler bugs</a></span></dt>
                   3855: <dt><span class="sect2"><a href="#undefined-reference">18.5.3. Undefined reference to &#8220;<span class="quote">...</span>&#8221;</a></span></dt>
                   3856: <dt><span class="sect2"><a href="#out-of-memory">18.5.4. Running out of memory</a></span></dt>
                   3857: </dl></dd>
                   3858: <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>
                   3859: <dd><dl>
                   3860: <dt><span class="sect2"><a href="#install-scripts">18.6.1. Creating needed directories</a></span></dt>
                   3861: <dt><span class="sect2"><a href="#where-to-install-documentation">18.6.2. Where to install documentation</a></span></dt>
                   3862: <dt><span class="sect2"><a href="#installing-score-files">18.6.3. Installing score files</a></span></dt>
                   3863: <dt><span class="sect2"><a href="#hardcoded-paths">18.6.4. Packages with hardcoded paths to other interpreters</a></span></dt>
                   3864: <dt><span class="sect2"><a href="#perl-modules">18.6.5. Packages installing perl modules</a></span></dt>
                   3865: <dt><span class="sect2"><a href="#faq.info-files">18.6.6. Packages installing info files</a></span></dt>
                   3866: <dt><span class="sect2"><a href="#manpages">18.6.7. Packages installing man pages</a></span></dt>
                   3867: <dt><span class="sect2"><a href="#gconf2-data-files">18.6.8. Packages installing GConf2 data files</a></span></dt>
                   3868: <dt><span class="sect2"><a href="#scrollkeeper-data-files">18.6.9. Packages installing scrollkeeper data files</a></span></dt>
                   3869: <dt><span class="sect2"><a href="#x11-fonts">18.6.10. Packages installing X11 fonts</a></span></dt>
                   3870: <dt><span class="sect2"><a href="#gtk2-modules">18.6.11. Packages installing GTK2 modules</a></span></dt>
                   3871: <dt><span class="sect2"><a href="#sgml-xml-data">18.6.12. Packages installing SGML or XML data</a></span></dt>
                   3872: <dt><span class="sect2"><a href="#mime-database">18.6.13. Packages installing extensions to the MIME database</a></span></dt>
                   3873: <dt><span class="sect2"><a href="#intltool">18.6.14. Packages using intltool</a></span></dt>
                   3874: <dt><span class="sect2"><a href="#startup-scripts">18.6.15. Packages installing startup scripts</a></span></dt>
                   3875: <dt><span class="sect2"><a href="#tex-packages">18.6.16. Packages installing TeX modules</a></span></dt>
                   3876: <dt><span class="sect2"><a href="#emulation-packages">18.6.17. Packages supporting running binaries in
1.87      wiz      3877:     emulation</a></span></dt>
1.90      rillig   3878: <dt><span class="sect2"><a href="#hicolor-theme">18.6.18. Packages installing hicolor theme icons</a></span></dt>
                   3879: <dt><span class="sect2"><a href="#desktop-files">18.6.19. Packages installing desktop files</a></span></dt>
1.77      rillig   3880: </dl></dd>
1.90      rillig   3881: <dt><span class="sect1"><a href="#punting">18.7. Marking packages as having problems</a></span></dt>
1.77      rillig   3882: </dl></dd>
1.90      rillig   3883: <dt><span class="chapter"><a href="#debug">19. Debugging</a></span></dt>
                   3884: <dt><span class="chapter"><a href="#submit">20. Submitting and Committing</a></span></dt>
1.77      rillig   3885: <dd><dl>
1.90      rillig   3886: <dt><span class="sect1"><a href="#submitting-binary-packages">20.1. Submitting binary packages</a></span></dt>
                   3887: <dt><span class="sect1"><a href="#submitting-your-package">20.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   3888: <dt><span class="sect1"><a href="#general-notes-for-changes">20.3. General notes when adding, updating, or removing packages</a></span></dt>
                   3889: <dt><span class="sect1"><a href="#committing-importing">20.4. Committing: Importing a package into CVS</a></span></dt>
                   3890: <dt><span class="sect1"><a href="#updating-package">20.5. Updating a package to a newer version</a></span></dt>
                   3891: <dt><span class="sect1"><a href="#moving-package">20.6. Moving a package in pkgsrc</a></span></dt>
                   3892: </dl></dd>
                   3893: <dt><span class="chapter"><a href="#devfaq">21. Frequently Asked Questions</a></span></dt>
                   3894: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
                   3895: <dd><dl>
                   3896: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                   3897: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                   3898: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                   3899: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
1.85      jmmv     3900: </dl></dd>
1.75      rillig   3901: </dl>
                   3902: </div>
1.77      rillig   3903: </div>
                   3904: <div class="chapter" lang="en">
                   3905: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   3906: <a name="creating"></a>Chapter 9. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91      rillig   3907: <div class="toc">
                   3908: <p><b>Table of Contents</b></p>
                   3909: <dl>
                   3910: <dt><span class="sect1"><a href="#creating.common">9.1. Common types of packages</a></span></dt>
                   3911: <dd><dl>
                   3912: <dt><span class="sect2"><a href="#creating.perl-module">9.1.1. Perl modules</a></span></dt>
                   3913: <dt><span class="sect2"><a href="#creating.kde-app">9.1.2. KDE applications</a></span></dt>
                   3914: </dl></dd>
                   3915: <dt><span class="sect1"><a href="#creating.examples">9.2. Examples</a></span></dt>
                   3916: <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>
                   3917: </dl>
                   3918: </div>
1.77      rillig   3919: <p>When you find a package that is not yet in pkgsrc, you
1.91      rillig   3920: most likely have a URL from where you can download the source
                   3921: code. Starting with this URL, creating a package involves only a
                   3922: few steps.</p>
1.77      rillig   3923: <div class="procedure"><ol type="1">
1.91      rillig   3924: <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   3925: <li><p>Then, choose one of the top-level directories as the
1.91      rillig   3926: category in which you want to place your package. You can also create a
                   3927: directory of your own (maybe called <code class="filename">local</code>). In that
                   3928: category directory, create another directory for your package and change
                   3929: into it.</p></li>
                   3930: <li><p>Run the program <span><strong class="command">url2pkg</strong></span>, which will ask
                   3931: you for a URL. Enter the URL of the distribution file (in most cases a
                   3932: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
                   3933: of your package are created automatically. The distribution file is
                   3934: extracted automatically to fill in some details in the
                   3935: <code class="filename">Makefile</code> that would otherwise have to be done
                   3936: manually.</p></li>
                   3937: <li>
                   3938: <p>Examine the extracted files to determine the dependencies of
                   3939: your package. Ideally, this is mentioned in some
                   3940: <code class="filename">README</code> file, but things may differ. For each of
                   3941: these dependencies, look where it exists in pkgsrc, and if there is a
                   3942: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   3943: line to your package <code class="filename">Makefile</code> which includes that
                   3944: file just before the last line. If the
                   3945: <code class="filename">buildlink3.mk</code> file does not exist, add a
                   3946: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   3947: version of the dependency and where it can be found in pkgsrc. This line
                   3948: should be placed in the third paragraph. If the dependency is only
                   3949: needed for building the package, but not when using it, use
                   3950: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
                   3951: Your package may then look like this:</p>
1.77      rillig   3952: <pre class="programlisting">
                   3953:     [...]
                   3954: 
                   3955:     BUILD_DEPENDS+= lua&gt;=5.0:../../lang/lua
                   3956:     DEPENDS+=       screen-[0-9]*:../../misc/screen
                   3957:     DEPENDS+=       screen&gt;=4.0:../../misc/screen
                   3958: 
                   3959:     [...]
                   3960: 
                   3961:     .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
                   3962:     .include "../../devel/glib2/buildlink3.mk"
                   3963:     .include "../../mk/bsd.pkg.mk"
                   3964: </pre>
                   3965: </li>
1.91      rillig   3966: <li><p>Run <span><strong class="command">pkglint</strong></span> to see what things still need
                   3967: to be done to make your package a &#8220;<span class="quote">good</span>&#8221; one. If you don't
                   3968: know what pkglint's warnings want to tell you, try <span><strong class="command">pkglint
                   3969: --explain</strong></span> or <span><strong class="command">pkglint
                   3970: -e</strong></span>, which outputs additional
                   3971: explanations.</p></li>
                   3972: <li><p>In many cases the package is not yet ready to build. You can
                   3973: 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
                   3974: over there, you can hopefully continue here.</p></li>
                   3975: <li><p>Run <span><strong class="command">bmake clean</strong></span> to clean the working
                   3976: directory from the extracted files. Besides these files, a lot of cache
                   3977: files and other system information has been saved in the working
                   3978: directory, which may become wrong after you edited the
                   3979: <code class="filename">Makefile</code>.</p></li>
                   3980: <li><p>Now, run <span><strong class="command">bmake</strong></span> to build the package. For
                   3981: 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>
                   3982: <li><p>When the package builds fine, the next step is to install
                   3983: the package. Run <span><strong class="command">bmake install</strong></span> and hope that
                   3984: everything works.</p></li>
                   3985: <li><p>Up to now, the file <code class="filename">PLIST</code>, which
                   3986: contains a list of the files that are installed by the package, is
                   3987: nearly empty. Run <span><strong class="command">bmake print-PLIST
                   3988: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   3989: the file using your preferred text editor to see if the list of
                   3990: files looks plausible.</p></li>
                   3991: <li><p>Run <span><strong class="command">pkglint</strong></span> again to see if the generated
                   3992: <code class="filename">PLIST</code> contains garbage or not.</p></li>
                   3993: <li><p>When you ran <span><strong class="command">bmake install</strong></span>, the package
                   3994: has been registered in the database of installed files, but with an
                   3995: empty list of files. To fix this, run <span><strong class="command">bmake deinstall</strong></span>
                   3996: and <span><strong class="command">bmake install</strong></span> again. Now the package is
                   3997: registered with the list of files from
                   3998: <code class="filename">PLIST</code>.</p></li>
                   3999: <li><p>Run <span><strong class="command">bmake package</strong></span> to create a binary
                   4000: package from the set of installed files.</p></li>
1.77      rillig   4001: </ol></div>
1.91      rillig   4002: <div class="sect1" lang="en">
                   4003: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4004: <a name="creating.common"></a>9.1. Common types of packages</h2></div></div></div>
                   4005: <div class="sect2" lang="en">
                   4006: <div class="titlepage"><div><div><h3 class="title">
                   4007: <a name="creating.perl-module"></a>9.1.1. Perl modules</h3></div></div></div>
                   4008: <p>Simple Perl modules are handled automatically by
                   4009: <span><strong class="command">url2pkg</strong></span>, including dependencies.</p>
                   4010: </div>
                   4011: <div class="sect2" lang="en">
                   4012: <div class="titlepage"><div><div><h3 class="title">
                   4013: <a name="creating.kde-app"></a>9.1.2. KDE applications</h3></div></div></div>
                   4014: <p>KDE applications should always include
                   4015: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
                   4016: settings that are typical of KDE packages.</p>
                   4017: </div>
                   4018: </div>
                   4019: <div class="sect1" lang="en">
                   4020: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4021: <a name="creating.examples"></a>9.2. Examples</h2></div></div></div>
                   4022: <div class="sect2" lang="en">
                   4023: <div class="titlepage"><div><div><h3 class="title">
                   4024: <a name="creating.nvu"></a>9.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
                   4025: <div class="sect3" lang="en">
                   4026: <div class="titlepage"><div><div><h4 class="title">
                   4027: <a name="creating.nvu.init"></a>9.2.1.1. The initial package</h4></div></div></div>
                   4028: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
                   4029: that the &#8220;<span class="quote">nvu</span>&#8221; package has not yet been imported into
                   4030: pkgsrc. As the description says it has to do with the web, the obvious
                   4031: choice for the category is &#8220;<span class="quote">www</span>&#8221;.</p>
                   4032: <pre class="programlisting">
                   4033:     <code class="prompt">$</code> mkdir www/nvu
                   4034:     <code class="prompt">$</code> cd www/nvu
                   4035: </pre>
                   4036: <p>The web site says that the sources are available as a tar file, so
                   4037: I fed that URL to the <span><strong class="command">url2pkg</strong></span> program:</p>
                   4038: <pre class="programlisting">
                   4039:     <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   4040: </pre>
                   4041: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   4042: below the <code class="varname">DISTNAME</code> line, as the package name should
                   4043: not have the word &#8220;<span class="quote">sources</span>&#8221; in it. I also filled in the
                   4044: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   4045: <code class="varname">COMMENT</code> fields. Then the package
                   4046: <code class="filename">Makefile</code> looked like that:</p>
                   4047: <pre class="programlisting">
                   4048:     # $NetBSD$
                   4049:     #
                   4050: 
                   4051:     DISTNAME=       nvu-1.0-sources
                   4052:     PKGNAME=        nvu-1.0
                   4053:     CATEGORIES=     www
                   4054:     MASTER_SITES=   http://cvs.nvu.com/download/
                   4055:     EXTRACT_SUFX=   .tar.bz2
                   4056: 
                   4057:     MAINTAINER=     rillig@NetBSD.org
                   4058:     HOMEPAGE=       http://cvs.nvu.com/
                   4059:     COMMENT=        Web Authoring System
                   4060: 
                   4061:     # url2pkg-marker (please do not remove this line.)
                   4062:     .include "../../mk/bsd.pkg.mk"
                   4063: </pre>
                   4064: <p>Then, I quit the editor and watched pkgsrc downloading a large
                   4065: source archive:</p>
                   4066: <pre class="programlisting">
                   4067:     url2pkg&gt; Running "make makesum" ...
                   4068:     =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4069:     =&gt; Fetching nvu-1.0-sources.tar.bz2
                   4070:     Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   4071:     100% |*************************************| 28992 KB  150.77 KB/s    00:00 ETA
                   4072:     29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   4073:     url2pkg&gt; Running "make extract" ...
                   4074:     =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4075:     =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   4076:     =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   4077:     work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
                   4078:     ===&gt; Installing dependencies for nvu-1.0
                   4079:     ===&gt; Overriding tools for nvu-1.0
                   4080:     ===&gt; Extracting for nvu-1.0
                   4081:     url2pkg&gt; Adjusting the Makefile.
                   4082: 
                   4083:     Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
                   4084: 
                   4085:     Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
                   4086: </pre>
                   4087: </div>
                   4088: <div class="sect3" lang="en">
                   4089: <div class="titlepage"><div><div><h4 class="title">
                   4090: <a name="creating.nvu.problems"></a>9.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
                   4091: <p>Now that the package has been extracted, let's see what's inside
                   4092: it. The package has a <code class="filename">README.txt</code>, but that only
                   4093: says something about mozilla, so it's probably useless for seeing what
                   4094: dependencies this package has. But since there is a GNU configure script
                   4095: in the package, let's hope that it will complain about everything it
                   4096: needs.</p>
                   4097: <pre class="programlisting">
                   4098:     <code class="prompt">$</code> bmake
                   4099:     =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4100:     =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   4101:     =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   4102:     ===&gt; Patching for nvu-1.0
                   4103:     ===&gt; Creating toolchain wrappers for nvu-1.0
                   4104:     ===&gt; Configuring for nvu-1.0
                   4105:     [...]
                   4106:     configure: error: Perl 5.004 or higher is required.
                   4107:     [...]
                   4108:     WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   4109:     [...]
                   4110: </pre>
                   4111: <p>That worked quite well. So I opened the package Makefile in my
                   4112: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
                   4113: just appended &#8220;<span class="quote">perl</span>&#8221; to it. Since the dependencies of the
                   4114: package have changed now, and since a perl wrapper is automatically
                   4115: installed in the &#8220;<span class="quote">tools</span>&#8221; phase, I need to build the package
                   4116: from scratch.</p>
                   4117: <pre class="programlisting">
                   4118:     <code class="prompt">$</code> bmake clean
                   4119:     ===&gt; Cleaning for nvu-1.0
                   4120:     <code class="prompt">$</code> bmake
                   4121:     [...]
                   4122:     *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   4123:     GNU Make.  You will not be able to build Mozilla without GNU Make.
                   4124:     [...]
                   4125: </pre>
                   4126: <p>So I added &#8220;<span class="quote">gmake</span>&#8221; to the
                   4127: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
                   4128: <pre class="programlisting">
                   4129:     [...]
                   4130:     checking for GTK - version &gt;= 1.2.0... no
                   4131:     *** Could not run GTK test program, checking why...
                   4132:     [...]
                   4133: </pre>
                   4134: <p>Now to the other dependencies. The first question is: Where is the
                   4135: GTK package hidden in pkgsrc?</p>
                   4136: <pre class="programlisting">
                   4137:     <code class="prompt">$</code> echo ../../*/gtk*
                   4138:     [many packages ...]
                   4139:     <code class="prompt">$</code> echo ../../*/gtk
                   4140:     ../../x11/gtk
                   4141:     <code class="prompt">$</code> echo ../../*/gtk2
                   4142:     ../../x11/gtk2
                   4143:     <code class="prompt">$</code> echo ../../*/gtk2/bui*
                   4144:     ../../x11/gtk2/buildlink3.mk
                   4145: </pre>
                   4146: <p>The first try was definitely too broad. The second one had exactly
                   4147: one result, which is very good. But there is one pitfall with GNOME
                   4148: packages. Before GNOME 2 had been released, there were already many
                   4149: GNOME 1 packages in pkgsrc. To be able to continue to use these
                   4150: packages, the GNOME 2 packages were imported as separate packages, and
                   4151: their names usually have a &#8220;<span class="quote">2</span>&#8221; appended. So I checked
                   4152: whether this was the case here, and indeed it was.</p>
                   4153: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
                   4154: file, adding the dependency is very easy. I just inserted an
                   4155: <code class="literal">.include</code> line before the last line of the package
                   4156: <code class="filename">Makefile</code>, so that it now looks like this:</p>
                   4157: <pre class="programlisting">
                   4158:     [...]
                   4159:     .include "../../x11/gtk2/buildlink3.mk"
                   4160:     .include "../../mk/bsd.pkg.mk
                   4161: </pre>
                   4162: <p>After another <span><strong class="command">bmake clean &amp;&amp; bmake</strong></span>, the answer
                   4163: was:</p>
                   4164: <pre class="programlisting">
                   4165:     [...]
                   4166:     checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   4167:     checking for GTK - version &gt;= 1.2.0... no
                   4168:     *** Could not run GTK test program, checking why...
                   4169:     *** The test program failed to compile or link. See the file config.log for the
                   4170:     *** exact error that occured. This usually means GTK was incorrectly installed
                   4171:     *** or that you have moved GTK since it was installed. In the latter case, you
                   4172:     *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   4173:     configure: error: Test for GTK failed.
                   4174:     [...]
                   4175: </pre>
                   4176: <p>In this particular case, the assumption that &#8220;<span class="quote">every package
                   4177: prefers GNOME 2</span>&#8221; had been wrong. The first of the lines above
                   4178: told me that this package really wanted to have the GNOME 1 version of
                   4179: GTK. If the package had looked for GTK2, it would have looked for
                   4180: <span><strong class="command">pkg-config</strong></span> instead of <span><strong class="command">gtk-config</strong></span>.
                   4181: So I changed the <code class="literal">x11/gtk2</code> to
                   4182: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
                   4183: and tried again.</p>
                   4184: <pre class="programlisting">
                   4185:     [...]
                   4186:     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
                   4187:     In file included from xpidl.c:42:
                   4188:     xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   4189:     In file included from xpidl.c:42:
                   4190:     xpidl.h:132: error: parse error before "IDL_ns"
                   4191:     [...]
                   4192: </pre>
                   4193: <p>The package still does not find all of its dependencies. Now the
                   4194: question is: Which package provides the
                   4195: <code class="filename">libIDL/IDL.h</code> header file?</p>
                   4196: <pre class="programlisting">
                   4197:     <code class="prompt">$</code> echo ../../*/*idl*
                   4198:     ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   4199:     <code class="prompt">$</code> echo ../../*/*IDL*
                   4200:     ../../net/libIDL
                   4201: </pre>
                   4202: <p>Let's take the one from the second try. So I included the
                   4203: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
                   4204: again. But the error didn't change. After digging through some of the
                   4205: code, I concluded that the build process of the package was broken and
                   4206: couldn't have ever worked, but since the Mozilla source tree is quite
                   4207: large, I didn't want to fix it. So I added the following to the package
                   4208: <code class="filename">Makefile</code> and tried again:</p>
                   4209: <pre class="programlisting">
                   4210:     CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
                   4211:     BUILDLINK_TRANSFORM+=   -l:IDL:IDL-2
                   4212: </pre>
                   4213: <p>The latter line is needed because the package expects the library
                   4214: <code class="filename">libIDL.so</code>, but only
                   4215: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
                   4216: wrapper to rewrite that on the fly.</p>
                   4217: <p>The next problem was related to a recent change of the FreeType
                   4218: 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>
                   4219: which patch files were relevant for this issue and copied them to the
                   4220: <code class="filename">patches</code> directory. Then I retried, fixed the
                   4221: patches so that they applied cleanly and retried again. This time,
                   4222: everything worked.</p>
                   4223: </div>
                   4224: <div class="sect3" lang="en">
                   4225: <div class="titlepage"><div><div><h4 class="title">
                   4226: <a name="creating.nvu.inst"></a>9.2.1.3. Installing the package</h4></div></div></div>
                   4227: <pre class="programlisting">
                   4228:     <code class="prompt">$</code> bmake CHECK_FILES=no install
                   4229:     [...]
                   4230:     <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
                   4231:     <code class="prompt">$</code> bmake deinstall
                   4232:     <code class="prompt">$</code> bmake install
                   4233: </pre>
                   4234: </div>
                   4235: </div>
                   4236: </div>
1.77      rillig   4237: </div>
1.75      rillig   4238: <div class="chapter" lang="en">
                   4239: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   4240: <a name="components"></a>Chapter 10. Package components - files, directories and contents</h2></div></div></div>
1.75      rillig   4241: <div class="toc">
                   4242: <p><b>Table of Contents</b></p>
                   4243: <dl>
1.90      rillig   4244: <dt><span class="sect1"><a href="#components.Makefile">10.1. <code class="filename">Makefile</code></a></span></dt>
                   4245: <dt><span class="sect1"><a href="#components.distinfo">10.2. <code class="filename">distinfo</code></a></span></dt>
                   4246: <dt><span class="sect1"><a href="#components.patches">10.3. patches/*</a></span></dt>
                   4247: <dd><dl>
1.93      rillig   4248: <dt><span class="sect2"><a href="#components.patch.structure">10.3.1. Structure of a single patch file</a></span></dt>
                   4249: <dt><span class="sect2"><a href="#components.patches.caveats">10.3.2. Creating patch files</a></span></dt>
                   4250: <dt><span class="sect2"><a href="#components.patches.sources">10.3.3. Sources where the patch files come from</a></span></dt>
                   4251: <dt><span class="sect2"><a href="#components.patches.guidelines">10.3.4. Patching guidelines</a></span></dt>
                   4252: <dt><span class="sect2"><a href="#components.patches.feedback">10.3.5. Feedback to the author</a></span></dt>
1.90      rillig   4253: </dl></dd>
                   4254: <dt><span class="sect1"><a href="#other-mandatory-files">10.4. Other mandatory files</a></span></dt>
                   4255: <dt><span class="sect1"><a href="#components.optional">10.5. Optional files</a></span></dt>
                   4256: <dd><dl>
                   4257: <dt><span class="sect2"><a href="#components.optional.bin">10.5.1. Files affecting the binary package</a></span></dt>
                   4258: <dt><span class="sect2"><a href="#components.optional.build">10.5.2. Files affecting the build process</a></span></dt>
                   4259: <dt><span class="sect2"><a href="#components.optional.none">10.5.3. Files affecting nothing at all</a></span></dt>
1.78      rillig   4260: </dl></dd>
1.90      rillig   4261: <dt><span class="sect1"><a href="#work-dir">10.6. <code class="filename">work*</code></a></span></dt>
                   4262: <dt><span class="sect1"><a href="#files-dir">10.7. <code class="filename">files/*</code></a></span></dt>
1.75      rillig   4263: </dl>
                   4264: </div>
1.87      wiz      4265: <p>Whenever you're preparing a package, there are a number of
                   4266: files involved which are described in the following
                   4267: sections.</p>
1.75      rillig   4268: <div class="sect1" lang="en">
                   4269: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   4270: <a name="components.Makefile"></a>10.1. <code class="filename">Makefile</code>
                   4271: </h2></div></div></div>
1.75      rillig   4272: <p>Building, installation and creation of a binary package are all
1.87      wiz      4273:   controlled by the package's <code class="filename">Makefile</code>.
                   4274:   The <code class="filename">Makefile</code> describes various things about
                   4275:   a package, for example from where to get it, how to configure,
                   4276:   build, and install it.</p>
1.76      rillig   4277: <p>A package <code class="filename">Makefile</code> contains several
1.87      wiz      4278:   sections that describe the package.</p>
1.75      rillig   4279: <p>In the first section there are the following variables, which
1.87      wiz      4280:   should appear exactly in the order given here.  The order and
                   4281:   grouping of the variables is mostly historical and has no further
                   4282:   meaning.</p>
1.75      rillig   4283: <div class="itemizedlist"><ul type="disc">
                   4284: <li><p><code class="varname">DISTNAME</code> is the basename of the
1.87      wiz      4285:     distribution file to be downloaded from the package's
                   4286:     website.</p></li>
1.75      rillig   4287: <li><p><code class="varname">PKGNAME</code> is the name of the
1.87      wiz      4288:     package, as used by pkgsrc. You only need to provide it if
                   4289:     <code class="varname">DISTNAME</code> (which is the default) is not a good
                   4290:     name for the package in pkgsrc.  Usually it is the pkgsrc
                   4291:     directory name together with the version number. It must match the
                   4292:     regular expression
                   4293:     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
                   4294:     starts with a letter or digit, and contains only letters, digits,
                   4295:     dashes, underscores, dots and plus signs.</p></li>
                   4296: <li><p><code class="varname">SVR4_PKGNAME</code> is the name of
                   4297:     the package file to create if the <code class="varname">PKGNAME</code>
                   4298:     isn't unique on a SVR4 system. The default is
                   4299:     <code class="varname">PKGNAME</code>, which may be shortened when you use
1.91      rillig   4300:     <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      4301:     <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
                   4302:     does not produce an unique package name on a SVR4 system.
                   4303:     The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
                   4304:     characters.</p></li>
1.75      rillig   4305: <li>
                   4306: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87      wiz      4307:     which the package fits in. You can choose any of the top-level
                   4308:     directories of pkgsrc for it.</p>
1.75      rillig   4309: <p>Currently the following values are available for
1.87      wiz      4310:     <code class="varname">CATEGORIES</code>. If more than
                   4311:     one is used, they need to be separated by spaces:</p>
1.75      rillig   4312: <pre class="programlisting">
1.87      wiz      4313:       archivers     cross         geography     meta-pkgs     security
                   4314:       audio         databases     graphics      misc          shells
                   4315:       benchmarks    devel         ham           multimedia    sysutils
                   4316:       biology       editors       inputmethod   net           textproc
                   4317:       cad           emulators     lang          news          time
                   4318:       chat          finance       mail          parallel      wm
                   4319:       comms         fonts         math          pkgtools      www
                   4320:       converters    games         mbone         print         x11
                   4321:     </pre>
1.75      rillig   4322: </li>
1.81      rillig   4323: <li><p><code class="varname">MASTER_SITES</code>,
1.87      wiz      4324:     <code class="varname">DYNAMIC_MASTER_SITES</code>,
                   4325:     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
                   4326:     and <code class="varname">DISTFILES</code> are discussed in detail in
1.90      rillig   4327:     <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   4328: </ul></div>
                   4329: <p>The second section contains information about separately
1.87      wiz      4330:   downloaded patches, if any.
                   4331:   </p>
1.75      rillig   4332: <div class="itemizedlist"><ul type="disc">
                   4333: <li><p><code class="varname">PATCHFILES:</code>
1.87      wiz      4334:     Name(s) of additional files that contain distribution patches.
                   4335:     There is no default. pkgsrc will look for them at
                   4336:     <code class="varname">PATCH_SITES</code>.
                   4337:     They will automatically be uncompressed before patching if
                   4338:     the names end with <code class="filename">.gz</code> or
                   4339:     <code class="filename">.Z</code>.</p></li>
1.75      rillig   4340: <li><p><code class="varname">PATCH_SITES</code>:
1.87      wiz      4341:     Primary location(s) for distribution patch files (see
                   4342:     <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
1.75      rillig   4343: </ul></div>
                   4344: <p>The third section contains the following variables.
1.87      wiz      4345:   </p>
1.75      rillig   4346: <div class="itemizedlist"><ul type="disc">
                   4347: <li><p><code class="varname">MAINTAINER</code> is the email address
1.87      wiz      4348:     of the person who feels responsible for this package, and who is
                   4349:     most likely to look at problems or questions regarding this
                   4350:     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
                   4351:     developers should contact the <code class="varname">MAINTAINER</code> before
                   4352:     making major changes to the package. When packaging a new program,
                   4353:     set <code class="varname">MAINTAINER</code> to yourself. If you really can't
                   4354:     maintain the package for future updates, set it to
                   4355:     <code class="email">&lt;<a href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>&gt;</code>.</p></li>
1.75      rillig   4356: <li><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87      wiz      4357:     find more information about the package.</p></li>
1.75      rillig   4358: <li><p><code class="varname">COMMENT</code> is a one-line
1.87      wiz      4359:     description of the package (should not include the package
                   4360:     name).</p></li>
1.75      rillig   4361: </ul></div>
                   4362: <p>Other variables that affect the build:
1.87      wiz      4363:   </p>
1.75      rillig   4364: <div class="itemizedlist"><ul type="disc"><li>
                   4365: <p><code class="varname">WRKSRC</code>: The directory where the
1.87      wiz      4366:       interesting distribution files of the package are found. The
                   4367:       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
                   4368:       works for most packages.</p>
1.75      rillig   4369: <p>If a package doesn't create a subdirectory for itself
1.87      wiz      4370:       (most GNU software does, for instance), but extracts itself in
                   4371:       the current directory, you should set
                   4372:       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
                   4373: <p>If a package doesn't create a subdirectory with the
                   4374:       name of <code class="varname">DISTNAME</code> but some different name,
                   4375:       set <code class="varname">WRKSRC</code> to point to the proper name in
                   4376:       <code class="filename">${WRKDIR}</code>, for example
                   4377:       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.91      rillig   4378:       <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   4379: <p>The name of the working directory created by pkgsrc is
1.87      wiz      4380:       taken from the <code class="varname">WRKDIR_BASENAME</code>
                   4381:       variable. By default, its value is
                   4382:       <code class="filename">work</code>. If you want to use the same
                   4383:       pkgsrc tree for building different kinds of binary packages,
                   4384:       you can change the variable according to your needs. Two
                   4385:       other variables handle common cases of setting
                   4386:       <code class="varname">WRKDIR_BASENAME</code> individually. If
                   4387:       <code class="varname">OBJHOSTNAME</code> is defined in
                   4388:       <code class="filename">/etc/mk.conf</code>, the first component of
                   4389:       the host's name is attached to the directory name. If
                   4390:       <code class="varname">OBJMACHINE</code> is defined, the platform name
                   4391:       is attached, which might look like
                   4392:       <code class="filename">work.i386</code> or
                   4393:       <code class="filename">work.sparc</code>.</p>
1.75      rillig   4394: </li></ul></div>
                   4395: <p>Please pay attention to the following gotchas:</p>
                   4396: <div class="itemizedlist"><ul type="disc">
1.87      wiz      4397: <li><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88      wiz      4398:       installed in compressed form by the package.  For packages using
                   4399:       BSD-style makefiles which honor MANZ, there is
                   4400:       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.76      rillig   4401: <li><p>Replace <code class="filename">/usr/local</code> with
1.88      wiz      4402:       &#8220;<span class="quote">${PREFIX}</span>&#8221; in all files (see patches,
                   4403:       below).</p></li>
1.90      rillig   4404: <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   4405: </ul></div>
                   4406: </div>
                   4407: <div class="sect1" lang="en">
                   4408: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   4409: <a name="components.distinfo"></a>10.2. <code class="filename">distinfo</code>
                   4410: </h2></div></div></div>
1.76      rillig   4411: <p>The <code class="filename">distinfo</code> file contains the message
1.87      wiz      4412:   digest, or checksum, of each distfile needed for the package. This
                   4413:   ensures that the distfiles retrieved from the Internet have not been
                   4414:   corrupted during transfer or altered by a malign force to introduce
                   4415:   a security hole. Due to recent rumor about weaknesses of digest
                   4416:   algorithms, all distfiles are protected using both SHA1 and RMD160
                   4417:   message digests, as well as the file size.</p>
1.76      rillig   4418: <p>The <code class="filename">distinfo</code> file also contains the
1.87      wiz      4419:   checksums for all the patches found in the
1.90      rillig   4420:   <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   4421: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.87      wiz      4422:   <span><strong class="command">make makedistinfo</strong></span> or <span><strong class="command">make mdi</strong></span>
                   4423:   command.</p>
1.75      rillig   4424: <p>Some packages have different sets of distfiles depending on
1.91      rillig   4425:   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      4426:   <code class="filename">distinfo</code> file and care should be taken when
                   4427:   upgrading such a package to ensure distfile information is not
                   4428:   lost.</p>
1.75      rillig   4429: </div>
                   4430: <div class="sect1" lang="en">
                   4431: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   4432: <a name="components.patches"></a>10.3. patches/*</h2></div></div></div>
1.93      rillig   4433: <p>Many packages still don't work out-of-the box on the various
                   4434:   platforms that are supported by pkgsrc. Therefore, a number of custom
                   4435:   patch files are needed to make the package work. These patch files are
                   4436:   found in the <code class="filename">patches/</code> directory.</p>
                   4437: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
                   4438:   applied to the files in <code class="varname">WRKSRC</code> directory after
                   4439:   extracting them, in <a href="http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_13_03" target="_top">alphabetic
                   4440:   order</a>, so <code class="filename">patch-aa</code> is applied before
1.87      wiz      4441:   <code class="filename">patch-ab</code>, etc.</p>
1.93      rillig   4442: <div class="sect2" lang="en">
                   4443: <div class="titlepage"><div><div><h3 class="title">
                   4444: <a name="components.patch.structure"></a>10.3.1. Structure of a single patch file</h3></div></div></div>
1.76      rillig   4445: <p>The <code class="filename">patch-*</code> files should be in
1.87      wiz      4446:   <span><strong class="command">diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93      rillig   4447:   problems. (To force patches to apply with fuzz you can set
                   4448:   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94      dmcmahil 4449:   should contain only changes for a single file, and no file should be
1.93      rillig   4450:   patched by more than one patch file. This helps to keep future
                   4451:   modifications simple.</p>
                   4452: <p>Each patch file is structured as follows: In the first line,
                   4453:   there is the RCS Id of the patch itself. The second line should be
                   4454:   empty for aesthetic reasons. After that, there should be a comment for
                   4455:   each change that the patch does. There are a number of standard
                   4456:   cases:</p>
                   4457: <div class="itemizedlist"><ul type="disc">
                   4458: <li><p>Patches that replace the <code class="literal">==</code>
                   4459:   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
                   4460:   should contain a reference to , to avoid
                   4461:   redundant explanations.</p></li>
                   4462: <li><p>Patches for commonly known vulnerabilities should
                   4463:   mention the vulnerability ID (CAN, CVE).</p></li>
                   4464: <li><p>Patches that change source code should mention the
                   4465:   platform and other environment (for example, the compiler) that the
                   4466:   patch is needed for.</p></li>
                   4467: </ul></div>
                   4468: <p>In all other cases, the patch should be commented so that any
                   4469:   developer who knows the code of the application can make some use of
                   4470:   the patch. Special care should be taken for the upstream developers,
                   4471:   since we generally want that they accept our patches, so we have less
                   4472:   work in the future.</p>
                   4473: </div>
                   4474: <div class="sect2" lang="en">
                   4475: <div class="titlepage"><div><div><h3 class="title">
                   4476: <a name="components.patches.caveats"></a>10.3.2. Creating patch files</h3></div></div></div>
                   4477: <p>One important thing to mention is to pay attention that no RCS
                   4478:   IDs get stored in the patch files, as these will cause problems when
1.87      wiz      4479:   later checked into the NetBSD CVS tree. Use the
1.93      rillig   4480:   <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
                   4481:   problems.</p>
1.87      wiz      4482: <p>For even more automation, we recommend using
                   4483:   <span><strong class="command">mkpatches</strong></span> from the same package to make a
                   4484:   whole set of patches. You just have to backup files before you
                   4485:   edit them to <code class="filename">filename.orig</code>, e.g. with
                   4486:   <span><strong class="command">cp -p filename filename.orig</strong></span> or, easier, by
                   4487:   using <span><strong class="command">pkgvi</strong></span> again from the same package. If
                   4488:   you upgrade a package this way, you can easily compare the new
                   4489:   set of patches with the previously existing one with
                   4490:   <span><strong class="command">patchdiff</strong></span>. Copy the patches you want to use
                   4491:   or update from the <code class="filename">work/.newpatches</code>
                   4492:   directory to <code class="filename">patches/</code>.</p>
                   4493: <p>When you have finished a package, remember to generate
                   4494:   the checksums for the patch files by using the <span><strong class="command">make
1.90      rillig   4495:   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      4496: <p>When adding a patch that corrects a problem in the
                   4497:   distfile (rather than e.g. enforcing pkgsrc's view of where
                   4498:   man pages should go), send the patch as a bug report to the
                   4499:   maintainer.  This benefits non-pkgsrc users of the package,
                   4500:   and usually makes it possible to remove the patch in future
                   4501:   version.</p>
1.93      rillig   4502: </div>
                   4503: <div class="sect2" lang="en">
                   4504: <div class="titlepage"><div><div><h3 class="title">
                   4505: <a name="components.patches.sources"></a>10.3.3. Sources where the patch files come from</h3></div></div></div>
1.87      wiz      4506: <p>If you want to share patches between multiple packages
                   4507:   in pkgsrc, e.g. because they use the same distfiles, set
                   4508:   <code class="varname">PATCHDIR</code> to the path where the patch files
                   4509:   can be found, e.g.:</p>
                   4510: <pre class="programlisting">
                   4511:     PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93      rillig   4512: </pre>
1.75      rillig   4513: <p>Patch files that are distributed by the author or other
1.87      wiz      4514:     maintainers can be listed in
                   4515:     <code class="varname">PATCHFILES</code>.</p>
                   4516: <p>If it is desired to store any patches that should not be
                   4517:     committed into pkgsrc, they can be kept outside the pkgsrc
                   4518:     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
                   4519:     directory tree there is expected to have the same
                   4520:     &#8220;<span class="quote">category/package</span>&#8221; structure as pkgsrc, and
                   4521:     patches are expected to be stored inside these dirs (also
                   4522:     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
                   4523:     example, if you want to keep a private patch for
                   4524:     <code class="filename">pkgsrc/graphics/png</code>, keep it in
                   4525:     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
                   4526:     files in the named directory are expected to be patch files,
                   4527:     and <span class="emphasis"><em>they are applied after pkgsrc patches are
                   4528:     applied</em></span>.</p>
1.93      rillig   4529: </div>
1.85      jmmv     4530: <div class="sect2" lang="en">
                   4531: <div class="titlepage"><div><div><h3 class="title">
1.93      rillig   4532: <a name="components.patches.guidelines"></a>10.3.4. Patching guidelines</h3></div></div></div>
1.85      jmmv     4533: <p>When fixing a portability issue in the code do not use
                   4534:       preprocessor magic to check for the current operating system nor
                   4535:       platform.  Doing so hurts portability to other platforms because
                   4536:       the OS-specific details are not abstracted appropriately.</p>
                   4537: <p>The general rule to follow is: instead of checking for the
                   4538:       operating system the application is being built on, check for the
                   4539:       specific <span class="emphasis"><em>features</em></span> you need.  For example,
                   4540:       instead of assuming that kqueue is available under NetBSD and
                   4541:       using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.89      rillig   4542:       kqueue support, add a check that detects kqueue itself &mdash;
1.85      jmmv     4543:       yes, this generally involves patching the
                   4544:       <span><strong class="command">configure</strong></span> script.  There is absolutely nothing
                   4545:       that prevents some OSes from adopting interfaces from other OSes
                   4546:       (e.g. Linux implementing kqueue), something that the above checks
                   4547:       cannot take into account.</p>
                   4548: <p>Of course, checking for features generally involves more
                   4549:       work on the developer's side, but the resulting changes are
1.87      wiz      4550:       cleaner and there are chances they will work on many other
1.85      jmmv     4551:       platforms.  Not to mention that there are higher chances of being
                   4552:       later integrated into the mainstream sources.  Remember:
                   4553:       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
                   4554: <p>Some typical examples:</p>
                   4555: <div class="table">
1.90      rillig   4556: <a name="patch-examples"></a><p class="title"><b>Table 10.1. Patching examples</b></p>
1.91      rillig   4557: <div class="table-contents"><table summary="Patching examples" border="1">
1.85      jmmv     4558: <colgroup>
                   4559: <col>
                   4560: <col>
                   4561: <col>
                   4562: </colgroup>
                   4563: <thead><tr>
                   4564: <th>Where</th>
                   4565: <th>Incorrect</th>
                   4566: <th>Correct</th>
                   4567: </tr></thead>
                   4568: <tbody>
                   4569: <tr>
                   4570: <td>configure script</td>
                   4571: <td>
                   4572:                <pre class="programlisting">case ${target_os} in
1.87      wiz      4573:                netbsd*) have_kvm=yes ;;
                   4574:                *)       have_kvm=no  ;;
                   4575:                esac</pre>
1.85      jmmv     4576:              </td>
                   4577: <td>
                   4578:                <pre class="programlisting">AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)</pre>
                   4579:              </td>
                   4580: </tr>
                   4581: <tr>
                   4582: <td>C source file</td>
                   4583: <td>
                   4584:                <pre class="programlisting">#if defined(__NetBSD__)
1.87      wiz      4585:                #  include &lt;sys/event.h&gt;
                   4586:                #endif</pre>
1.85      jmmv     4587:              </td>
                   4588: <td>
                   4589:                <pre class="programlisting">#if defined(HAVE_SYS_EVENT_H)
1.87      wiz      4590:                #  include &lt;sys/event.h&gt;
                   4591:                #endif</pre>
1.85      jmmv     4592:              </td>
                   4593: </tr>
                   4594: <tr>
                   4595: <td>C source file</td>
                   4596: <td>
                   4597: <pre class="programlisting">int
1.87      wiz      4598:              monitor_file(...)
                   4599:              {
                   4600:              #if defined(__NetBSD__)
                   4601:              int fd = kqueue();
                   4602:              ...
                   4603:              #else
                   4604:              ...
                   4605:              #endif
                   4606:              }</pre>
1.85      jmmv     4607:              </td>
                   4608: <td>
                   4609:                <pre class="programlisting">int
1.87      wiz      4610:                monitor_file(...)
                   4611:                {
                   4612:                #if defined(HAVE_KQUEUE)
                   4613:                int fd = kqueue();
                   4614:                ...
                   4615:                #else
                   4616:                ...
                   4617:                #endif
                   4618:                }</pre>
1.85      jmmv     4619:              </td>
                   4620: </tr>
                   4621: </tbody>
1.91      rillig   4622: </table></div>
1.85      jmmv     4623: </div>
1.91      rillig   4624: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.85      jmmv     4625:       packager-friendly software</em></span> article (<a href="http://www.onlamp.com/pub/a/onlamp/2005/03/31/packaging.html" target="_top">part
                   4626:       1</a>, <a href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
                   4627:       2</a>).  It summarizes multiple details on how to make
                   4628:       software easier to package; all the suggestions in it were
                   4629:       collected from our experience in pkgsrc work, so they are possibly
                   4630:       helpful when creating patches too.</p>
                   4631: </div>
                   4632: <div class="sect2" lang="en">
                   4633: <div class="titlepage"><div><div><h3 class="title">
1.93      rillig   4634: <a name="components.patches.feedback"></a>10.3.5. Feedback to the author</h3></div></div></div>
1.85      jmmv     4635: <p>Always, always, <span class="strong"><strong>always</strong></span>
                   4636:       feed back any <span class="emphasis"><em>portability fixes</em></span> or
                   4637:       improvements you do to a package to the mainstream developers.
                   4638:       This is the only way to get their attention on portability issues
                   4639:       and to ensure that future versions can be built out-of-the box on
                   4640:       NetBSD.  Furthermore, any user that gets newer distfiles will get
                   4641:       the fixes straight from the packaged code.</p>
1.93      rillig   4642: <p>This generally involves cleaning up the patches
                   4643:       (because sometimes the patches that are
1.85      jmmv     4644:       added to pkgsrc are quick hacks), filling bug reports in the
                   4645:       appropriate trackers for the projects and working with the
                   4646:       mainstream authors to accept your changes.  It is
                   4647:       <span class="emphasis"><em>extremely important</em></span> that you do it so that
                   4648:       the packages in pkgsrc are kept simple and thus further changes
                   4649:       can be done without much hassle.</p>
                   4650: <p>Support the idea of free software!</p>
                   4651: </div>
1.75      rillig   4652: </div>
                   4653: <div class="sect1" lang="en">
                   4654: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   4655: <a name="other-mandatory-files"></a>10.4. Other mandatory files</h2></div></div></div>
1.75      rillig   4656: <div class="variablelist"><dl>
1.76      rillig   4657: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75      rillig   4658: <dd><p>A multi-line description of the piece of software.  This should include
1.87      wiz      4659:          any credits where they are due.  Please bear in mind that others do not
                   4660:          share your sense of humour (or spelling idiosyncrasies), and that others
                   4661:          will read everything that you write here.</p></dd>
1.76      rillig   4662: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87      wiz      4663: <dd><p>This file governs the files that are installed on your
                   4664:          system: all the binaries, manual pages, etc. There are other
                   4665:          directives which may be entered in this file, to control the
                   4666:          creation and deletion of directories, and the location of
1.90      rillig   4667:          inserted files.  See <a href="#plist" title="Chapter 12. PLIST issues">Chapter 12, <i>PLIST issues</i></a> for more
1.87      wiz      4668:          information.</p></dd>
1.75      rillig   4669: </dl></div>
                   4670: </div>
                   4671: <div class="sect1" lang="en">
                   4672: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   4673: <a name="components.optional"></a>10.5. Optional files</h2></div></div></div>
1.78      rillig   4674: <div class="sect2" lang="en">
                   4675: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   4676: <a name="components.optional.bin"></a>10.5.1. Files affecting the binary package</h3></div></div></div>
1.75      rillig   4677: <div class="variablelist"><dl>
1.76      rillig   4678: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.75      rillig   4679: <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      4680:            First time after package extraction and before files are
                   4681:            moved in place, the second time after the files to install
                   4682:            are moved in place. This can be used to do any custom
                   4683:            procedures not possible with @exec commands in
                   4684:            <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   4685:            <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   4686: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75      rillig   4687: <dd><p>This script is executed before and after any files are removed.  It is
1.87      wiz      4688:            this script's responsibility to clean up any additional messy details
                   4689:            around the package's installation, since all pkg_delete knows is how to
                   4690:            delete the files created in the original distribution.
                   4691:            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>
                   4692:            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   4693: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75      rillig   4694: <dd>
                   4695: <p>This file is displayed after installation of the package.
1.87      wiz      4696:            Useful for things like legal notices on almost-free
                   4697:            software and hints for updating config files after
                   4698:            installing modules for apache, PHP etc.
                   4699:            Please note that you can modify variables in it easily by using
                   4700:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   4701:            <code class="filename">Makefile</code>:</p>
1.75      rillig   4702: <pre class="programlisting">
1.87      wiz      4703:              MESSAGE_SUBST+=  SOMEVAR="somevalue"
                   4704:            </pre>
1.75      rillig   4705: <p>replaces "${SOMEVAR}" with &#8220;<span class="quote">somevalue</span>&#8221; in
1.87      wiz      4706:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   4707:            performed for <code class="varname">PKGNAME</code>,
                   4708:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
                   4709:            <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
                   4710:            <code class="varname">X11BASE</code>,
                   4711:            <code class="varname">PKG_SYSCONFDIR</code>,
                   4712:            <code class="varname">ROOT_GROUP</code>, and
                   4713:            <code class="varname">ROOT_GROUP</code>.</p>
                   4714: <p>You can display a different or additional files by
                   4715:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   4716:            default is <code class="filename">MESSAGE</code>, if the file
                   4717:            exists.</p>
1.75      rillig   4718: </dd>
1.78      rillig   4719: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
                   4720: <dd><p>FIXME: There is no documentation on the
                   4721:        alternatives framework.</p></dd>
                   4722: </dl></div>
                   4723: </div>
                   4724: <div class="sect2" lang="en">
                   4725: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   4726: <a name="components.optional.build"></a>10.5.2. Files affecting the build process</h3></div></div></div>
1.78      rillig   4727: <div class="variablelist"><dl>
                   4728: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   4729: <dd><p>This file contains arbitrary things that could
                   4730:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   4731:        to be used by more than one package. This file should only be
                   4732:        used when the packages that will use the file are known in
                   4733:        advance. For other purposes it is often better to write a
                   4734:        <code class="filename">*.mk</code> file and give it a good name that
                   4735:        describes what it does.</p></dd>
                   4736: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   4737: <dd><p>This file contains the dependency information
1.90      rillig   4738:        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   4739: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   4740: <dd><p>This file contains workarounds for compiler bugs
                   4741:        and similar things. It is included automatically by the pkgsrc
                   4742:        infrastructure, so you don't need an extra
                   4743:        <code class="literal">.include</code> line for
                   4744:        it.</p></dd>
                   4745: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   4746: <dd><p>This file contains the code for the
1.90      rillig   4747:        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   4748:        selected by the user. If a package has only one or two options,
                   4749:        it is equally acceptable to put the code directly into the
                   4750:        <code class="filename">Makefile</code>.</p></dd>
                   4751: </dl></div>
                   4752: </div>
                   4753: <div class="sect2" lang="en">
                   4754: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   4755: <a name="components.optional.none"></a>10.5.3. Files affecting nothing at all</h3></div></div></div>
1.78      rillig   4756: <div class="variablelist"><dl>
                   4757: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   4758: <dd><p>These files do not take place in the creation of
                   4759:        a package and thus are purely informative to the package
                   4760:        developer.</p></dd>
                   4761: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   4762: <dd><p>This file contains things that need to be done
                   4763:        to make the package even
                   4764:        better.</p></dd>
1.75      rillig   4765: </dl></div>
                   4766: </div>
1.78      rillig   4767: </div>
1.75      rillig   4768: <div class="sect1" lang="en">
                   4769: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   4770: <a name="work-dir"></a>10.6. <code class="filename">work*</code>
                   4771: </h2></div></div></div>
1.75      rillig   4772: <p>When you type <span><strong class="command">make</strong></span>, the distribution files are
1.87      wiz      4773:     unpacked into the directory denoted by
                   4774:     <code class="varname">WRKDIR</code>. It can be removed by running
                   4775:     <span><strong class="command">make clean</strong></span>. Besides the sources, this
                   4776:     directory is also used to keep various timestamp files.
                   4777:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   4778:     The default is <code class="filename">${.CURDIR}/work</code>
                   4779:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   4780:     if <code class="varname">OBJMACHINE</code> is set.</p>
1.75      rillig   4781: </div>
                   4782: <div class="sect1" lang="en">
                   4783: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   4784: <a name="files-dir"></a>10.7. <code class="filename">files/*</code>
                   4785: </h2></div></div></div>
1.75      rillig   4786: <p>If you have any files that you wish to be placed in the package prior
1.87      wiz      4787:     to configuration or building, you could place these files here and use
                   4788:     a <span><strong class="command">${CP}</strong></span> command in the
                   4789:     &#8220;<span class="quote">pre-configure</span>&#8221; target to achieve
                   4790:     this. Alternatively, you could simply diff the file against
                   4791:     <code class="filename">/dev/null</code> and use the patch mechanism to manage
                   4792:     the creation of this file.</p>
                   4793: <p>If you want to share files in this way with other
                   4794:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   4795:     to the other package's <code class="filename">files</code> directory,
                   4796:     e.g.:</p>
                   4797: <pre class="programlisting">
                   4798:       FILESDIR=${.CURDIR}/../xemacs/files
                   4799:     </pre>
1.75      rillig   4800: </div>
                   4801: </div>
                   4802: <div class="chapter" lang="en">
                   4803: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   4804: <a name="makefile"></a>Chapter 11. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75      rillig   4805: <div class="toc">
                   4806: <p><b>Table of Contents</b></p>
                   4807: <dl>
1.90      rillig   4808: <dt><span class="sect1"><a href="#makefile.variables">11.1. <code class="filename">Makefile</code> variables</a></span></dt>
                   4809: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">11.1.1. Naming conventions</a></span></dt></dl></dd>
                   4810: <dt><span class="sect1"><a href="#makefile.code">11.2. Code snippets</a></span></dt>
                   4811: <dd><dl>
                   4812: <dt><span class="sect2"><a href="#adding-to-list">11.2.1. Adding things to a list</a></span></dt>
                   4813: <dt><span class="sect2"><a href="#converting-internal-to-external">11.2.2. Converting an internal list into an external list</a></span></dt>
                   4814: <dt><span class="sect2"><a href="#passing-variable-to-shell">11.2.3. Passing variables to a shell command</a></span></dt>
                   4815: <dt><span class="sect2"><a href="#quoting-guideline">11.2.4. Quoting guideline</a></span></dt>
                   4816: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">11.2.5. Workaround for a bug in BSD Make</a></span></dt>
1.75      rillig   4817: </dl></dd>
                   4818: </dl>
                   4819: </div>
1.76      rillig   4820: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75      rillig   4821:   each of which forms a well-defined part of the pkgsrc system. Using
                   4822:   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
                   4823:   like pkgsrc requires some discipline to keep the code correct and
                   4824:   understandable.</p>
1.76      rillig   4825: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75      rillig   4826:   programming are variables (which are actually macros) and shell
                   4827:   commands. Among these shell commands may even be more complex ones
                   4828:   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
                   4829:   as intended it is necessary to quote all variables correctly when they
                   4830:   are used.</p>
                   4831: <p>This chapter describes some patterns, that appear quite often in
1.76      rillig   4832:   <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75      rillig   4833:   with them.</p>
                   4834: <div class="sect1" lang="en">
                   4835: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   4836: <a name="makefile.variables"></a>11.1. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76      rillig   4837: <p><code class="filename">Makefile</code> variables contain strings that
1.75      rillig   4838:     can be processed using the five operators ``='', ``+='', ``?='',
                   4839:     ``:='', 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
                   4840:     page.</p>
                   4841: <p>When a variable's value is parsed from a
1.76      rillig   4842:     <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75      rillig   4843:     backslash character ``\'' are handled specially. If a backslash is
                   4844:     followed by a newline, any whitespace immediately in front of the
                   4845:     backslash, the backslash, the newline, and any whitespace
                   4846:     immediately behind the newline are replaced with a single space. A
                   4847:     backslash character and an immediately following hash character are
                   4848:     replaced with a single hash character. Otherwise, the backslash is
                   4849:     passed as is. In a variable assignment, any hash character that is
                   4850:     not preceded by a backslash starts a comment that continues upto the
                   4851:     end of the logical line.</p>
                   4852: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
                   4853:     the only way to create a variable consisting of a single backslash
                   4854:     is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
                   4855: <p>So far for defining variables. The other thing you can do with
                   4856:     variables is evaluating them. A variable is evaluated when it is
                   4857:     part of the right side of the ``:='' or the ``!='' operator, or
                   4858:     directly before executing a shell command which the variable is part
                   4859:     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
                   4860:     is, variables are not evaluated until there's no other way. The
                   4861:     ``modifiers'' mentioned in the man page also evaluate the
                   4862:     variable.</p>
                   4863: <p>Some of the modifiers split the string into words and then
                   4864:     operate on the words, others operate on the string as a whole. When
                   4865:     a string is split into words, it is split as you would expect
                   4866:     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   4867: <p>No rule without exception&mdash;the <span><strong class="command">.for</strong></span>
1.75      rillig   4868:     loop does not follow the shell quoting rules but splits at sequences
                   4869:     of whitespace.</p>
                   4870: <p>There are several types of variables that should be handled
                   4871:     differently. Strings and two types of lists.</p>
                   4872: <div class="itemizedlist"><ul type="disc">
                   4873: <li><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
                   4874:       characters. Nevertheless, you should restrict yourself to only
                   4875:       using printable characters. Examples are
                   4876:       <code class="varname">PREFIX</code> and
                   4877:       <code class="varname">COMMENT</code>.</p></li>
                   4878: <li><p><span class="emphasis"><em>Internal lists</em></span> are lists that
                   4879:       are never exported to any shell command. Their elements are
                   4880:       separated by whitespace. Therefore, the elements themselves cannot
                   4881:       have embedded whitespace. Any other characters are allowed.
                   4882:       Internal lists can be used in <span><strong class="command">.for</strong></span> loops.
                   4883:       Examples are <code class="varname">DEPENDS</code> and
                   4884:       <code class="varname">BUILD_DEPENDS</code>.</p></li>
                   4885: <li><p><span class="emphasis"><em>External lists</em></span> are lists that
                   4886:       may be exported to a shell command. Their elements can contain any
                   4887:       characters, including whitespace. That's why they cannot be used
                   4888:       in <span><strong class="command">.for</strong></span> loops. Examples are
                   4889:       <code class="varname">DISTFILES</code> and
                   4890:       <code class="varname">MASTER_SITES</code>.</p></li>
                   4891: </ul></div>
                   4892: <div class="sect2" lang="en">
                   4893: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   4894: <a name="makefile.variables.names"></a>11.1.1. Naming conventions</h3></div></div></div>
1.75      rillig   4895: <div class="itemizedlist"><ul type="disc">
                   4896: <li><p>All variable names starting with an underscore
                   4897:        are reserved for use by the pkgsrc infrastructure. They shall
                   4898:        not be used by package
1.76      rillig   4899:        <code class="filename">Makefile</code>s.</p></li>
1.75      rillig   4900: <li><p>In <span><strong class="command">.for</strong></span> loops you should use
                   4901:        lowercase variable names for the iteration
                   4902:        variables.</p></li>
                   4903: <li><p>All list variables should have a ``plural''
                   4904:        name, e.g. <code class="varname">PKG_OPTIONS</code> or
                   4905:        <code class="varname">DISTFILES</code>.</p></li>
                   4906: </ul></div>
                   4907: </div>
                   4908: </div>
                   4909: <div class="sect1" lang="en">
                   4910: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   4911: <a name="makefile.code"></a>11.2. Code snippets</h2></div></div></div>
1.75      rillig   4912: <p>This section presents you with some code snippets you should
                   4913:     use in your own code. If you don't find anything appropriate here,
                   4914:     you should test your code and add it here.</p>
                   4915: <div class="sect2" lang="en">
                   4916: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   4917: <a name="adding-to-list"></a>11.2.1. Adding things to a list</h3></div></div></div>
1.75      rillig   4918: <pre class="programlisting">
                   4919:     STRING=                 foo * bar `date`
                   4920:     INT_LIST=               # empty
                   4921:     ANOTHER_INT_LIST=       apache-[0-9]*:../../www/apache
                   4922:     EXT_LIST=               # empty
                   4923:     ANOTHER_EXT_LIST=       a=b c=d
1.1       grant    4924: 
1.75      rillig   4925:     INT_LIST+=              ${STRING}               # 1
                   4926:     INT_LIST+=              ${ANOTHER_INT_LIST}     # 2
                   4927:     EXT_LIST+=              ${STRING:Q}             # 3
                   4928:     EXT_LIST+=              ${ANOTHER_EXT_LIST}     # 4
1.1       grant    4929: </pre>
1.75      rillig   4930: <p>When you add a string to an external list (example 3), it
                   4931:       must be quoted. In all other cases, you must not add a quoting
                   4932:       level. You must not merge internal and external lists, unless you
                   4933:       are sure that all entries are correctly interpreted in both
                   4934:       lists.</p>
                   4935: </div>
                   4936: <div class="sect2" lang="en">
                   4937: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   4938: <a name="converting-internal-to-external"></a>11.2.2. Converting an internal list into an external list</h3></div></div></div>
1.75      rillig   4939: <pre class="programlisting">
                   4940:     EXT_LIST=       # empty
                   4941:     .for i in ${INT_LIST}
                   4942:     EXT_LIST+=      ${i:Q}""
                   4943:     .endfor
1.1       grant    4944: </pre>
1.75      rillig   4945: <p>This code converts the internal list
                   4946:       <code class="varname">INT_LIST</code> into the external list
                   4947:       <code class="varname">EXT_LIST</code>. As the elements of an internal list
                   4948:       are unquoted they must be quoted here. The reason for appending
                   4949:       <code class="varname">""</code> is explained below.</p>
                   4950: </div>
                   4951: <div class="sect2" lang="en">
                   4952: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   4953: <a name="passing-variable-to-shell"></a>11.2.3. Passing variables to a shell command</h3></div></div></div>
1.79      rillig   4954: <p>Sometimes you may want to print an arbitrary string. There
                   4955:        are many ways to get it wrong and only few that can handle every
                   4956:        nastiness.</p>
1.75      rillig   4957: <pre class="programlisting">
                   4958:     STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
                   4959:     EXT_LIST=       string=${STRING:Q} x=second\ item
1.1       grant    4960: 
1.75      rillig   4961:     all:
                   4962:             echo ${STRING}                  # 1
                   4963:             echo "${STRING}"                # 2
                   4964:             echo "${STRING:Q}"              # 3
                   4965:             echo ${STRING:Q}                # 4
                   4966:             echo x${STRING:Q} | sed 1s,.,,  # 5
1.79      rillig   4967:             printf "%s\\n" ${STRING:Q}""    # 6
1.75      rillig   4968:             env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
1.1       grant    4969: </pre>
1.75      rillig   4970: <p>Example 1 leads to a syntax error in the shell, as the
                   4971:       characters are just copied.</p>
                   4972: <p>Example 2 leads to a syntax error too, and if you leave out
                   4973:       the last " character from <code class="varname">${STRING}</code>,
                   4974:       <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
                   4975:       variable would be evaluated, too.</p>
                   4976: <p>Example 3 outputs each space character preceded by a
                   4977:       backslash (or not), depending on the implementation of the
                   4978:       <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>
                   4979: <p>Example 4 handles correctly every string that does not start
                   4980:       with a dash. In that case, the result depends on the
                   4981:       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
                   4982:       guarantee that your input does not start with a dash, this form is
                   4983:       appropriate.</p>
                   4984: <p>Example 5 handles even the case of a leading dash
                   4985:       correctly.</p>
1.79      rillig   4986: <p>Example 6 also works with every string and is the
                   4987:       light-weight solution, since it does not involve a pipe, which has
                   4988:       its own problems.</p>
1.75      rillig   4989: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
                   4990:       because the quoting has already been done when adding elements to
                   4991:       the list.</p>
                   4992: <p>As internal lists shall not be passed to the shell, there is
                   4993:       no example for it.</p>
                   4994: </div>
                   4995: <div class="sect2" lang="en">
                   4996: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   4997: <a name="quoting-guideline"></a>11.2.4. Quoting guideline</h3></div></div></div>
1.75      rillig   4998: <p>There are many possible sources of wrongly quoted variables.
                   4999:       This section lists some of the commonly known ones.</p>
                   5000: <div class="itemizedlist"><ul type="disc">
                   5001: <li>
                   5002: <p>Whenever you use the value of a list, think
                   5003:        about what happens to leading or trailing whitespace. If the
                   5004:        list is a well-formed shell expression, you can apply the
                   5005:        <code class="varname">:M*</code> modifier to strip leading and trailing
                   5006:        whitespace from each word. The <code class="varname">:M</code> operator
                   5007:        first splits its argument according to the rules of the shell,
                   5008:        and then creates a new list consisting of all words that match
                   5009:        the shell glob expression <code class="varname">*</code>, that is: all.
                   5010:        One class of situations where this is needed is when adding a
                   5011:        variable like <code class="varname">CPPFLAGS</code> to
                   5012:        <code class="varname">CONFIGURE_ARGS</code>. If the configure script
                   5013:        invokes other configure scripts, it strips the leading and
                   5014:        trailing whitespace from the variable and then passes it to the
                   5015:        other configure scripts. But these configure scripts expect the
                   5016:        (child) <code class="varname">CPPFLAGS</code> variable to be the same as
                   5017:        the parent <code class="varname">CPPFLAGS</code>. That's why we better
                   5018:        pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
                   5019:        here is how we do it:</p>
                   5020: <pre class="programlisting">
                   5021:     CPPFLAGS=               # empty
                   5022:     CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX:Q}\"
                   5023:     CPPFLAGS+=              ${MY_CPPFLAGS}
1.1       grant    5024: 
1.75      rillig   5025:     CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
1.1       grant    5026: 
1.75      rillig   5027:     all:
                   5028:             echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
                   5029:             echo x${CONFIGURE_ARGS}x        # properly trimmed
1.1       grant    5030: </pre>
1.75      rillig   5031: </li>
                   5032: <li><p>The example above contains one bug: The
                   5033:        <code class="varname">${PREFIX}</code> is a properly quoted shell
                   5034:        expression, but there is the C compiler after it, which also
                   5035:        expects a properly quoted string (this time in C syntax). The
                   5036:        version above is therefore only correct if
                   5037:        <code class="varname">${PREFIX}</code> does not have embedded backslashes
                   5038:        or double quotes. If you want to allow these, you have to add
                   5039:        another layer of quoting to each variable that is used as a C
                   5040:        string literal. You cannot use the <code class="varname">:Q</code>
                   5041:        operator for it, as this operator only works for the
                   5042:        shell.</p></li>
                   5043: <li>
                   5044: <p>Whenever a variable can be empty, the
                   5045:        <code class="varname">:Q</code> operator can have surprising results. Here
                   5046:        are two completely different cases which can be solved with the
                   5047:        same trick.</p>
                   5048: <pre class="programlisting">
                   5049:     EMPTY=                  # empty
                   5050:     empty_test:
                   5051:             for i in a ${EMPTY:Q} c; do \
                   5052:                     echo "$$i"; \
                   5053:             done
1.1       grant    5054: 
1.75      rillig   5055:     for_test:
                   5056:     .for i in a:\ a:\test.txt
                   5057:             echo ${i:Q}
                   5058:             echo "foo"
                   5059:     .endfor
1.1       grant    5060: </pre>
1.75      rillig   5061: <p>The first example will only print two of the three lines
                   5062:        we might have expected. This is because
                   5063:        <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
                   5064:        the shell cannot see. The workaround is to write
                   5065:        <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
                   5066:        as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
                   5067:        -f ${FNAME:Q}</code> (both of these are wrong).</p>
                   5068: <p>The second example will only print three lines instead of
                   5069:        four. The first line looks like <code class="varname">a:\ echo foo</code>.
                   5070:        This is because the backslash of the value
                   5071:        <code class="varname">a:\</code> is interpreted as a line-continuation by
                   5072:        <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
                   5073:        <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
                   5074:        <code class="varname">${i:Q}""</code>.</p>
                   5075: </li>
                   5076: </ul></div>
                   5077: </div>
                   5078: <div class="sect2" lang="en">
                   5079: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   5080: <a name="bsd-make-bug-workaround"></a>11.2.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.75      rillig   5081: <p>The pkgsrc bmake program does not handle the following
                   5082:       assignment correctly. In case <code class="varname">_othervar_</code>
                   5083:       contains a ``-'' character, one of the closing braces is included
                   5084:       in <code class="varname">${VAR}</code> after this code executes.</p>
                   5085: <pre class="programlisting">
                   5086:     VAR:=   ${VAR:N${_othervar_:C/-//}}
1.1       grant    5087: </pre>
1.75      rillig   5088: <p>For a more complex code snippet and a workaround, see the
1.91      rillig   5089:       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   5090:       <code class="varname">bug1</code>.</p>
                   5091: </div>
                   5092: </div>
                   5093: </div>
                   5094: <div class="chapter" lang="en">
                   5095: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   5096: <a name="plist"></a>Chapter 12. PLIST issues</h2></div></div></div>
1.75      rillig   5097: <div class="toc">
                   5098: <p><b>Table of Contents</b></p>
                   5099: <dl>
1.90      rillig   5100: <dt><span class="sect1"><a href="#rcs-id">12.1. RCS ID</a></span></dt>
                   5101: <dt><span class="sect1"><a href="#automatic-plist-generation">12.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   5102: <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>
                   5103: <dt><span class="sect1"><a href="#plist.misc">12.4. Variable substitution in PLIST</a></span></dt>
                   5104: <dt><span class="sect1"><a href="#manpage-compression">12.5. Man page compression</a></span></dt>
                   5105: <dt><span class="sect1"><a href="#using-PLIST_SRC">12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   5106: <dt><span class="sect1"><a href="#platform-specific-plist">12.7. Platform-specific and differing PLISTs</a></span></dt>
                   5107: <dt><span class="sect1"><a href="#faq.common-dirs">12.8. Sharing directories between packages</a></span></dt>
1.75      rillig   5108: </dl>
                   5109: </div>
1.87      wiz      5110: <p>The <code class="filename">PLIST</code> file contains a package's
                   5111:   &#8220;<span class="quote">packing list</span>&#8221;, i.e. a list of files that belong to
                   5112:   the package (relative to the <code class="filename">${PREFIX}</code>
                   5113:   directory it's been installed in) plus some additional statements
                   5114:   - 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.
                   5115:   This chapter addresses some issues that need attention when
                   5116:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   5117:   below!).</p>
1.75      rillig   5118: <div class="sect1" lang="en">
                   5119: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5120: <a name="rcs-id"></a>12.1. RCS ID</h2></div></div></div>
1.87      wiz      5121: <p>Be sure to add a RCS ID line as the first thing in any
                   5122:     <code class="filename">PLIST</code> file you write:</p>
1.75      rillig   5123: <pre class="programlisting">
1.87      wiz      5124:       @comment $NetBSD$
                   5125:     </pre>
1.75      rillig   5126: </div>
                   5127: <div class="sect1" lang="en">
                   5128: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5129: <a name="automatic-plist-generation"></a>12.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.75      rillig   5130: <p>You can use the <span><strong class="command">make print-PLIST</strong></span> command
1.87      wiz      5131:     to output a PLIST that matches any new files since the package
1.90      rillig   5132:     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      5133:     more information on this target.</p>
1.75      rillig   5134: </div>
                   5135: <div class="sect1" lang="en">
                   5136: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   5137: <a name="print-PLIST"></a>12.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span>
                   5138: </h2></div></div></div>
1.87      wiz      5139: <p>If you have used any of the *-dirs packages, as explained in
1.90      rillig   5140:     <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      5141:     <span><strong class="command">make print-PLIST</strong></span> outputs a set of
                   5142:     <code class="varname">@comment</code>s instead of real
                   5143:     <code class="varname">@dirrm</code> lines.  You can also do this for
                   5144:     specific directories and files, so that the results of that
                   5145:     command are very close to reality. This helps <span class="emphasis"><em>a
                   5146:     lot</em></span> during the update of packages.</p>
                   5147: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   5148:     of AWK patterns and actions that are used to filter the output of
                   5149:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   5150:     scripting you like to it, but be careful with quoting.</p>
                   5151: <p>For example, to get all files inside the
                   5152:     <code class="filename">libdata/foo</code> directory removed from the
                   5153:     resulting PLIST:</p>
                   5154: <pre class="programlisting">
                   5155:       PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
                   5156:     </pre>
                   5157: <p>And to get all the <code class="varname">@dirrm</code> lines referring
                   5158:     to a specific (shared) directory converted to
                   5159:     <code class="varname">@comment</code>s:</p>
1.75      rillig   5160: <pre class="programlisting">
1.87      wiz      5161:       PRINT_PLIST_AWK+=       /^@dirrm share\/specific/ { print "@comment " $$0; next; }
                   5162:     </pre>
1.75      rillig   5163: </div>
                   5164: <div class="sect1" lang="en">
                   5165: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5166: <a name="plist.misc"></a>12.4. Variable substitution in PLIST</h2></div></div></div>
1.87      wiz      5167: <p>A number of variables are substituted automatically in
                   5168:     PLISTs when a package is installed on a system. This includes the
                   5169:     following variables:</p>
1.75      rillig   5170: <div class="variablelist"><dl>
                   5171: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   5172: <dd>
                   5173: <p>Some packages like emacs and perl embed information
1.87      wiz      5174:          about which architecture they were built on into the
                   5175:          pathnames where they install their files. To handle this
                   5176:          case, PLIST will be preprocessed before actually used, and
                   5177:          the symbol
                   5178:          &#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221; will be
                   5179:          replaced by what <span><strong class="command">uname -p</strong></span> gives. The
                   5180:          same is done if the string
                   5181:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   5182:          PLIST somewhere - use this on packages that have GNU
                   5183:          autoconf-created configure scripts.</p>
1.75      rillig   5184: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   5185: <h3 class="title">Legacy note</h3>
                   5186: <p>There used to be a symbol
1.87      wiz      5187:            &#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221; that
                   5188:            was replaced by the output of <span><strong class="command">uname
                   5189:            -m</strong></span>, but that's no longer supported and has
                   5190:            been removed.</p>
1.75      rillig   5191: </div>
                   5192: </dd>
                   5193: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   5194: <dd>
                   5195: <p>Some packages want to embed the OS name and version
1.87      wiz      5196:          into some paths.  To do this, use these variables in the
                   5197:          <code class="filename">PLIST</code>:
                   5198:          </p>
1.75      rillig   5199: <div class="itemizedlist"><ul type="disc">
                   5200: <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>
                   5201: <li><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. &#8220;<span class="quote">solaris</span>&#8221;)</p></li>
                   5202: <li><p><code class="varname">${OS_VERSION}</code> - &#8220;<span class="quote"><span><strong class="command">uname -r</strong></span></span>&#8221;</p></li>
                   5203: </ul></div>
                   5204: </dd>
                   5205: </dl></div>
1.87      wiz      5206: <p>For a complete list of values which are replaced by
                   5207:     default, please look in <code class="filename">bsd.pkg.mk</code> (and
                   5208:     search for <code class="varname">PLIST_SUBST</code>).</p>
                   5209: <p>If you want to change other variables not listed above, you
                   5210:     can add variables and their expansions to this variable in the
1.90      rillig   5211:     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   5212: <pre class="programlisting">
1.87      wiz      5213:       PLIST_SUBST+=   SOMEVAR="somevalue"
                   5214:     </pre>
1.75      rillig   5215: <p>This replaces all occurrences of &#8220;<span class="quote">${SOMEVAR}</span>&#8221;
1.87      wiz      5216:     in the <code class="filename">PLIST</code> with
                   5217:     &#8220;<span class="quote">somevalue</span>&#8221;.</p>
1.75      rillig   5218: </div>
                   5219: <div class="sect1" lang="en">
                   5220: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5221: <a name="manpage-compression"></a>12.5. Man page compression</h2></div></div></div>
1.75      rillig   5222: <p>Man pages should be installed in compressed form if
1.87      wiz      5223:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   5224:     and uncompressed otherwise. To handle this in the
                   5225:     <code class="filename">PLIST</code> file, the suffix &#8220;<span class="quote">.gz</span>&#8221; is
                   5226:     appended/removed automatically for man pages according to
                   5227:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   5228:     or not, see above for details. This modification of the
                   5229:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   5230:     <code class="filename">PLIST</code> itself.</p>
1.75      rillig   5231: </div>
                   5232: <div class="sect1" lang="en">
                   5233: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   5234: <a name="using-PLIST_SRC"></a>12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
                   5235: </h2></div></div></div>
1.76      rillig   5236: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87      wiz      5237:     in generating the binary package, set the variable
                   5238:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
                   5239:     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
                   5240:     important. The default for <code class="varname">PLIST_SRC</code> is
                   5241:     <code class="filename">${PKGDIR}/PLIST</code>.</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.90      rillig   5245: <a name="platform-specific-plist"></a>12.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75      rillig   5246: <p>Some packages decide to install a different set of files based on
1.87      wiz      5247:     the operating system being used. These differences can be
                   5248:     automatically handled by using the following files:</p>
1.75      rillig   5249: <div class="itemizedlist"><ul type="disc">
1.76      rillig   5250: <li><p><code class="filename">PLIST.common</code></p></li>
                   5251: <li><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   5252: <li><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   5253: <li><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   5254: <li><p><code class="filename">PLIST.common_end</code></p></li>
1.75      rillig   5255: </ul></div>
                   5256: </div>
                   5257: <div class="sect1" lang="en">
                   5258: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5259: <a name="faq.common-dirs"></a>12.8. Sharing directories between packages</h2></div></div></div>
1.87      wiz      5260: <p>A &#8220;<span class="quote">shared directory</span>&#8221; is a directory where
                   5261:     multiple (and unrelated) packages install files.  These
                   5262:     directories are problematic because you have to add special tricks
                   5263:     in the PLIST to conditionally remove them, or have some
                   5264:     centralized package handle them.</p>
                   5265: <p>Within pkgsrc, you'll find both approaches.  If a directory
                   5266:     is shared by a few unrelated packages, it's often not worth to add
                   5267:     an extra package to remove it.  Therefore, one simply does:</p>
                   5268: <pre class="programlisting">
                   5269:       @unexec ${RMDIR} %D/path/to/shared/directory 2&gt;/dev/null || ${TRUE}
                   5270:     </pre>
                   5271: <p>in the PLISTs of all affected packages, instead of the
                   5272:     regular "@dirrm" line.</p>
                   5273: <p>However, if the directory is shared across many packages, two
                   5274:     different solutions are available:</p>
1.75      rillig   5275: <div class="orderedlist"><ol type="1">
1.87      wiz      5276: <li><p>If the packages have a common dependency, the directory
                   5277:        can be removed in that.  For example, see
1.91      rillig   5278:        <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      5279:        removes the shared directory
                   5280:        <code class="filename">share/omf</code>.</p></li>
                   5281: <li><p>If the packages using the directory are not related at
                   5282:        all (they have no common dependencies), a *-dirs package is
                   5283:        used.</p></li>
1.75      rillig   5284: </ol></div>
1.87      wiz      5285: <p>From now on, we'll discuss the second solution.  To get an
                   5286:     idea of the *-dirs packages available, issue:</p>
1.75      rillig   5287: <pre class="programlisting">
1.87      wiz      5288:       <code class="prompt">%</code> cd .../pkgsrc
                   5289:       <code class="prompt">%</code> ls -d */*-dirs
                   5290:     </pre>
                   5291: <p>Their use from other packages is very simple.  The
                   5292:     <code class="varname">USE_DIRS</code> variable takes a list of package names
                   5293:     (without the &#8220;<span class="quote">-dirs</span>&#8221; part) together with the required
                   5294:     version number (always pick the latest one when writing new
                   5295:     packages).</p>
                   5296: <p>For example, if a package installs files under
                   5297:     <code class="filename">share/applications</code>, it should have the
                   5298:     following line in it:</p>
                   5299: <pre class="programlisting">
                   5300:       USE_DIRS+=      xdg-1.1
                   5301:     </pre>
                   5302: <p>After regenerating the PLIST using <span><strong class="command">make
                   5303:     print-PLIST</strong></span>, you should get the right (commented out)
                   5304:     lines.</p>
                   5305: <p>Note that even if your package is using
                   5306:     <code class="filename">$X11BASE</code>, it must not depend on the
                   5307:     *-x11-dirs packages.  Just specify the name without that part and
                   5308:     pkgsrc (in particular, <code class="filename">mk/dirs.mk</code>) will take
                   5309:     care of it.</p>
1.75      rillig   5310: </div>
                   5311: </div>
                   5312: <div class="chapter" lang="en">
                   5313: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   5314: <a name="buildlink"></a>Chapter 13. Buildlink methodology</h2></div></div></div>
1.75      rillig   5315: <div class="toc">
                   5316: <p><b>Table of Contents</b></p>
                   5317: <dl>
1.90      rillig   5318: <dt><span class="sect1"><a href="#converting-to-buildlink3">13.1. Converting packages to use buildlink3</a></span></dt>
                   5319: <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   5320: <dd><dl>
1.90      rillig   5321: <dt><span class="sect2"><a href="#anatomy-of-bl3">13.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   5322: <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   5323: </dl></dd>
1.90      rillig   5324: <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   5325: <dd><dl>
1.90      rillig   5326: <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>
                   5327: <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   5328: </dl></dd>
                   5329: </dl>
                   5330: </div>
                   5331: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87      wiz      5332:   are seen by a package's configure and build processes.  This is implemented
                   5333:   in a two step process:</p>
1.75      rillig   5334: <div class="orderedlist"><ol type="1">
                   5335: <li><p>Symlink headers and libraries for dependencies into
1.87      wiz      5336:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   5337:       of <code class="varname">WRKDIR</code>.</p></li>
1.75      rillig   5338: <li><p>Create wrapper scripts that are used in place of the normal compiler
1.87      wiz      5339:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   5340:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   5341:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   5342:       native compiler on some operating systems look like GCC, so that
                   5343:       packages that expect GCC won't require modifications to build with
                   5344:       those native compilers.</p></li>
1.75      rillig   5345: </ol></div>
                   5346: <p>This normalizes the environment in which a package is built so that the
1.87      wiz      5347:   package may be built consistently despite what other software may be
                   5348:   installed. Please note that the normal system header and library paths,
                   5349:   e.g. <code class="filename">/usr/include</code>,
                   5350:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   5351:   designed to insulate the package build from non-system-supplied
                   5352:   software.</p>
1.75      rillig   5353: <div class="sect1" lang="en">
                   5354: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5355: <a name="converting-to-buildlink3"></a>13.1. Converting packages to use buildlink3</h2></div></div></div>
1.75      rillig   5356: <p>The process of converting packages to use the buildlink3
1.87      wiz      5357:     framework (&#8220;<span class="quote">bl3ifying</span>&#8221;) is fairly straightforward.
                   5358:     The things to keep in mind are:</p>
1.75      rillig   5359: <div class="orderedlist"><ol type="1">
1.87      wiz      5360: <li><p>Ensure that the build always calls the wrapper scripts
                   5361:        instead of the actual toolchain.  Some packages are tricky,
                   5362:        and the only way to know for sure is the check
                   5363:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   5364:        wrappers are being invoked.</p></li>
                   5365: <li><p>Don't override <code class="varname">PREFIX</code> from within
                   5366:        the package Makefile, e.g. Java VMs, standalone shells,
                   5367:        etc., because the code to symlink files into
                   5368:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
                   5369:        relative to &#8220;<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>&#8221;.
                   5370:        </p></li>
                   5371: <li><p>Remember that <span class="emphasis"><em>only</em></span> the
                   5372:        <code class="filename">buildlink3.mk</code> files that you list in a
                   5373:        package's Makefile are added as dependencies for that package.
                   5374:        </p></li>
1.75      rillig   5375: </ol></div>
1.87      wiz      5376: <p>If a dependency on a particular package is required for its libraries and
                   5377:     headers, then we replace:</p>
1.75      rillig   5378: <pre class="programlisting">
1.87      wiz      5379:       DEPENDS+=   foo&gt;=1.1.0:../../category/foo
                   5380:     </pre>
1.75      rillig   5381: <p>with</p>
                   5382: <pre class="programlisting">
1.87      wiz      5383:       .include "../../category/foo/buildlink3.mk"
                   5384:     </pre>
1.75      rillig   5385: <p>The buildlink3.mk files usually define the required dependencies.
                   5386:     If you need a newer version of the dependency when using buildlink3.mk
1.87      wiz      5387:     files, then you can define it in your Makefile; for example:</p>
1.75      rillig   5388: <pre class="programlisting">
1.87      wiz      5389:       BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
                   5390:       .include "../../category/foo/buildlink3.mk"
                   5391:     </pre>
1.76      rillig   5392: <p>There are several <code class="filename">buildlink3.mk</code>
1.87      wiz      5393:     files in <code class="filename">pkgsrc/mk</code>
                   5394:     that handle special package issues:</p>
1.75      rillig   5395: <div class="itemizedlist"><ul type="disc">
1.76      rillig   5396: <li><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87      wiz      5397:        the native or a pkgsrc Berkeley DB implementation based on
                   5398:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   5399:        <code class="varname">BDB_DEFAULT</code>.</p></li>
1.76      rillig   5400: <li><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87      wiz      5401:        comes with neither Curses nor NCurses, this will take care
1.91      rillig   5402:        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   5403: <li><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87      wiz      5404:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   5405:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   5406:        require a Kerberos 5 implementation.</p></li>
1.88      wiz      5407: <li><p><code class="filename">motif.buildlink3.mk</code> checks for a
                   5408:        system-provided Motif installation or adds a dependency on
1.91      rillig   5409:        <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      5410:        <code class="varname">MOTIF_TYPE</code> to &#8220;<span class="quote">dt</span>&#8221;,
                   5411:        &#8220;<span class="quote">lesstif</span>&#8221;, or &#8220;<span class="quote">openmotif</span>&#8221; to choose
                   5412:        which Motif version will be used.</p></li>
1.76      rillig   5413: <li><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87      wiz      5414:        variables that may be used by packages that use the
                   5415:        Open Sound System (OSS) API.</p></li>
1.76      rillig   5416: <li><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.93      rillig   5417:        either Postgres 8.0, 8.1, or 8.2, whichever is found installed. See
1.87      wiz      5418:        the file for more information.</p></li>
1.76      rillig   5419: <li><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87      wiz      5420:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.91      rillig   5421:        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   5422: <li><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87      wiz      5423:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   5424:        library.</p></li>
1.75      rillig   5425: </ul></div>
1.76      rillig   5426: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87      wiz      5427:     files provide a more complete
                   5428:     description of how to use them properly.</p>
1.75      rillig   5429: </div>
                   5430: <div class="sect1" lang="en">
                   5431: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5432: <a name="creating-buildlink3.mk"></a>13.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.87      wiz      5433: <p>A package's <code class="filename">buildlink3.mk</code> file is
                   5434:     included by Makefiles to indicate the need to compile and link
                   5435:     against header files and libraries provided by the package.  A
                   5436:     <code class="filename">buildlink3.mk</code> file should always provide
                   5437:     enough information to add the correct type of dependency
                   5438:     relationship and include any other
                   5439:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   5440:     headers and libraries that it needs in turn.</p>
                   5441: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.91      rillig   5442:     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      5443:     package is highly recommended.  For most packages, the following
                   5444:     command will generate a good starting point for
                   5445:     <code class="filename">buildlink3.mk</code> files:</p>
                   5446: <pre class="screen">
                   5447: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   5448: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   5449:     </pre>
1.75      rillig   5450: <div class="sect2" lang="en">
                   5451: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   5452: <a name="anatomy-of-bl3"></a>13.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75      rillig   5453: <p>The following real-life example
1.87      wiz      5454:       <code class="filename">buildlink3.mk</code> is taken
                   5455:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75      rillig   5456: <pre class="programlisting">
1.87      wiz      5457:        # $NetBSD: buildlink3.mk,v 1.7 2004/03/18 09:12:12 jlam Exp $
1.1       grant    5458: 
1.87      wiz      5459:        BUILDLINK_DEPTH:=       ${BUILDLINK_DEPTH}+
                   5460:        TIFF_BUILDLINK3_MK:=    ${TIFF_BUILDLINK3_MK}+
1.1       grant    5461: 
1.87      wiz      5462:        .if !empty(BUILDLINK_DEPTH:M+)
                   5463:        BUILDLINK_DEPENDS+=     tiff
                   5464:        .endif
                   5465: 
                   5466:        BUILDLINK_PACKAGES:=    ${BUILDLINK_PACKAGES:Ntiff}
                   5467:        BUILDLINK_PACKAGES+=    tiff
                   5468: 
                   5469:        .if !empty(TIFF_BUILDLINK3_MK:M+)
                   5470:        BUILDLINK_API_DEPENDS.tiff+=        tiff&gt;=3.6.1
                   5471:        BUILDLINK_PKGSRCDIR.tiff?=      ../../graphics/tiff
                   5472:        .endif  # TIFF_BUILDLINK3_MK
                   5473: 
                   5474:        .include "../../devel/zlib/buildlink3.mk"
                   5475:        .include "../../graphics/jpeg/buildlink3.mk"
                   5476: 
                   5477:        BUILDLINK_DEPTH:=       ${BUILDLINK_DEPTH:S/+$//}
                   5478:       </pre>
                   5479: <p>The header and footer manipulate
                   5480:       <code class="varname">BUILDLINK_DEPTH</code>, which is common across all
                   5481:       <code class="filename">buildlink3.mk</code> files and is used to track
                   5482:       at what depth we are including
                   5483:       <code class="filename">buildlink3.mk</code> files.</p>
                   5484: <p>The first section controls if the dependency on
                   5485:       <em class="replaceable"><code>pkg</code></em> is added.
                   5486:       <code class="varname">BUILDLINK_DEPENDS</code> is the global list of
                   5487:       packages for which dependencies are added by
                   5488:       buildlink3.</p>
                   5489: <p>The second section advises pkgsrc that the
                   5490:       <code class="filename">buildlink3.mk</code> file for
                   5491:       <em class="replaceable"><code>pkg</code></em> has been included at some point.
                   5492:       <code class="varname">BUILDLINK_PACKAGES</code> is the global list of
                   5493:       packages for which <code class="filename">buildlink3.mk</code> files
                   5494:       have been included.  It must <span class="emphasis"><em>always</em></span> be
                   5495:       appended to within a <code class="filename">buildlink3.mk</code>
                   5496:       file.</p>
                   5497: <p>The third section is protected from multiple inclusion
                   5498:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   5499:       added.  Several important variables are set in the section:</p>
                   5500: <div class="itemizedlist"><ul type="disc">
                   5501: <li><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5502:          is the actual dependency recorded in the installed
                   5503:          package; this should always be set using
                   5504:          <span><strong class="command">+=</strong></span> to ensure that
                   5505:          we're appending to any pre-existing list of values.  This
                   5506:          variable should be set to the first version of the
                   5507:          package that had an API change.
                   5508:          </p></li>
                   5509: <li><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
                   5510:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   5511:          pkgsrc directory.</p></li>
                   5512: <li><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   5513:          (not shown above) controls whether we use
                   5514:          <code class="varname">BUILD_DEPENDS</code> or
                   5515:          <code class="varname">DEPENDS</code> to add the dependency on
                   5516:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   5517:          selected by setting
                   5518:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   5519:          to &#8220;<span class="quote">build</span>&#8221;.  By default, the full dependency is
                   5520:          used.</p></li>
                   5521: <li><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5522:            and
                   5523:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   5524:            (not shown above) are lists of subdirectories of
1.76      rillig   5525:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   5526:            to add to the header and library search paths.  These
                   5527:            default to &#8220;<span class="quote">include</span>&#8221; and &#8220;<span class="quote">lib</span>&#8221;
1.87      wiz      5528:          respectively.</p></li>
                   5529: <li><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5530:            (not shown above) is the list of preprocessor flags to add
                   5531:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
                   5532:            configure and build phases.  The &#8220;<span class="quote">-I</span>&#8221; option
                   5533:            should be avoided and instead be handled using
                   5534:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87      wiz      5535:          above.</p></li>
1.75      rillig   5536: </ul></div>
1.87      wiz      5537: <p>The following variables are all optionally defined within
                   5538:       this second section (protected against multiple inclusion) and
                   5539:       control which package files are symlinked into
                   5540:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   5541:       transformed during the symlinking:</p>
1.75      rillig   5542: <div class="itemizedlist"><ul type="disc">
1.87      wiz      5543: <li><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5544:            (not shown above) is a shell glob pattern relative to
1.76      rillig   5545:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   5546:            to be symlinked into
1.76      rillig   5547:            <code class="filename">${BUILDLINK_DIR}</code>,
1.87      wiz      5548:          e.g. <code class="filename">include/*.h</code>.</p></li>
                   5549: <li><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
                   5550:            (not shown above) is a shell pipeline that
                   5551:            outputs to stdout a list of files relative to
                   5552:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   5553:            The resulting files are to be symlinked
                   5554:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   5555:            this takes the <code class="filename">+CONTENTS</code> of a
                   5556:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   5557:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
                   5558: <li><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5559:            (not shown above) is a filter command that filters
1.76      rillig   5560:            <code class="filename">+CONTENTS</code> input into a list of files
1.75      rillig   5561:            relative to
1.76      rillig   5562:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   5563:            on stdout.  By default for overwrite packages,
                   5564:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76      rillig   5565:            outputs the contents of the <code class="filename">include</code>
                   5566:            and <code class="filename">lib</code> directories in the package
                   5567:            <code class="filename">+CONTENTS</code>, and for pkgviews packages,
1.75      rillig   5568:            it outputs any libtool archives in
1.87      wiz      5569:            <code class="filename">lib</code> directories.</p></li>
1.95    ! tron     5570: <li><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5571:            (not shown above) is a list of sed arguments used to
                   5572:            transform the name of the source filename into a
                   5573:            destination filename, e.g. <span><strong class="command">-e
1.87      wiz      5574:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75      rillig   5575: </ul></div>
1.87      wiz      5576: <p>The last section includes any
                   5577:       <code class="filename">buildlink3.mk</code> needed for
                   5578:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   5579:       Including these <code class="filename">buildlink3.mk</code> files
                   5580:       means that the headers and libraries for these
                   5581:       dependencies are also symlinked into
                   5582:       <code class="filename">${BUILDLINK_DIR}</code>
                   5583:       whenever the <em class="replaceable"><code>pkg</code></em>
                   5584:       <code class="filename">buildlink3.mk</code>
                   5585:       file is included.</p>
1.75      rillig   5586: </div>
                   5587: <div class="sect2" lang="en">
                   5588: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   5589: <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      5590: <p>The situation that requires increasing the dependency listed in
1.75      rillig   5591:        <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5592:        after a package update is when the API or interface to the
1.87      wiz      5593:       header files change.</p>
                   5594: <p>In this case,
                   5595:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5596:       should be adjusted to require at least the new package
                   5597:       version.  In some cases, the packages that depend on this new
                   5598:       version may need their <code class="varname">PKGREVISION</code>s
                   5599:       increased and, if they have <code class="filename">buildlink3.mk</code>
                   5600:       files, their
                   5601:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5602:       adjusted, too.  This is needed so pkgsrc will require the
                   5603:       correct package dependency and not settle for an older one
                   5604:       when building the source.</p>
                   5605: <p><code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5606:        should be increased when the binary interface or sonames
                   5607:        (major number of the library version) of any installed
                   5608:        shared libraries change.  This is needed so that binary
                   5609:        packages made using it will require the correct package
                   5610:        dependency and not settle for an older one which will not
1.87      wiz      5611:       contain the necessary shared libraries.</p>
1.90      rillig   5612: <p>See <a href="#dependencies" title="18.1.6. Handling dependencies">Section 18.1.6, &#8220;Handling dependencies&#8221;</a> for
1.75      rillig   5613:        more information about dependencies on other packages,
                   5614:        including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87      wiz      5615:       <code class="varname">ABI_DEPENDS</code> definitions.</p>
                   5616: <p>Please take careful consideration before adjusting
                   5617:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5618:       or
                   5619:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5620:       as we don't want to cause unneeded package deletions and
                   5621:       rebuilds.  In many cases, new versions of packages work just
                   5622:       fine with older dependencies.</p>
                   5623: <p>Also it is not needed to set
1.75      rillig   5624:        <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5625:        when it is identical to
1.87      wiz      5626:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.        </p>
1.75      rillig   5627: </div>
                   5628: </div>
                   5629: <div class="sect1" lang="en">
                   5630: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5631: <a name="writing-builtin.mk"></a>13.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87      wiz      5632: <p>Some packages in pkgsrc install headers and libraries that
1.75      rillig   5633:       coincide with headers and libraries present in the base system.
1.76      rillig   5634:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   5635:       packages should also include a <code class="filename">builtin.mk</code>
1.75      rillig   5636:       file that includes the necessary checks to decide whether using
                   5637:       the built-in software or the pkgsrc software is
1.87      wiz      5638:     appropriate.</p>
                   5639: <p>The only requirements of a builtin.mk file for
                   5640:     <em class="replaceable"><code>pkg</code></em> are:</p>
1.75      rillig   5641: <div class="orderedlist"><ol type="1">
1.87      wiz      5642: <li><p>It should set
                   5643:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5644:        to either &#8220;<span class="quote">yes</span>&#8221; or &#8220;<span class="quote">no</span>&#8221;
                   5645:        after it is included.</p></li>
                   5646: <li><p>It should <span class="emphasis"><em>not</em></span> override any
                   5647:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5648:        which is already set before the
                   5649:        <code class="filename">builtin.mk</code> file is included.</p></li>
                   5650: <li><p>It should be written to allow multiple inclusion.  This
                   5651:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   5652:        attention to <code class="filename">Makefile</code> coding.</p></li>
1.75      rillig   5653: </ol></div>
                   5654: <div class="sect2" lang="en">
                   5655: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   5656: <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   5657: <p>The following is the recommended template for builtin.mk
1.87      wiz      5658:       files:</p>
1.75      rillig   5659: <pre class="programlisting">
1.87      wiz      5660:        .if !defined(IS_BUILTIN.foo)
                   5661:        #
                   5662:        # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   5663:        # genuinely exists in the system or not.
                   5664:        #
                   5665:        IS_BUILTIN.foo?=        no
                   5666: 
                   5667:        # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   5668:        # version can be determined.
                   5669:        #
                   5670:        .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   5671:        BUILTIN_PKG.foo?=       foo-1.0
                   5672:        .  endif
                   5673:        .endif  # IS_BUILTIN.foo
                   5674: 
                   5675:        .if !defined(USE_BUILTIN.foo)
                   5676:        USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   5677:        .  if defined(BUILTIN_PKG.foo)
                   5678:        .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   5679:        .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   5680:        USE_BUILTIN.foo!=                                                       \
                   5681:        if ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}; then     \
                   5682:        ${ECHO} "yes";                                            \
                   5683:        else                                                              \
                   5684:        ${ECHO} "no";                                             \
                   5685:        fi
                   5686:        .      endif
                   5687:        .    endfor
                   5688:        .  endif
                   5689:        .endif  # USE_BUILTIN.foo
                   5690: 
                   5691:        CHECK_BUILTIN.foo?=     no
                   5692:        .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   5693:        #
                   5694:        # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   5695:        # "yes" or "no".
                   5696:        #
                   5697:        .endif  # CHECK_BUILTIN.foo
                   5698:       </pre>
                   5699: <p>The first section sets
                   5700:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5701:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   5702:       in the base system.  This should not be a base system software
                   5703:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
                   5704:       it should only be &#8220;<span class="quote">yes</span>&#8221; if the actual package is
                   5705:       included as part of the base system.  This variable is only
                   5706:       used internally within the <code class="filename">builtin.mk</code>
                   5707:       file.</p>
                   5708: <p>The second section sets
                   5709:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5710:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   5711:       system if it exists (if
                   5712:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5713:       is &#8220;<span class="quote">yes</span>&#8221;).  This variable is only used internally
                   5714:       within the <code class="filename">builtin.mk</code> file.</p>
                   5715: <p>The third section sets
                   5716:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5717:       and is <span class="emphasis"><em>required</em></span> in all
                   5718:       <code class="filename">builtin.mk</code> files.  The code in this
                   5719:       section must make the determination whether the built-in
                   5720:       software is adequate to satisfy the dependencies listed in
                   5721:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5722:       This is typically done by comparing
                   5723:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5724:       against each of the dependencies in
                   5725:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5726:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5727:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   5728:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   5729:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5730:       may be &#8220;<span class="quote">yes</span>&#8221; even if
                   5731:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5732:       is &#8220;<span class="quote">no</span>&#8221; because we may make the determination
                   5733:       that the built-in version of the software is similar enough to
                   5734:       be used as a replacement.</p>
                   5735: <p>The last section is guarded by
                   5736:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   5737:       and includes code that uses the value of
                   5738:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5739:       set in the previous section.  This typically includes, e.g.,
                   5740:       adding additional dependency restrictions and listing additional
                   5741:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   5742:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75      rillig   5743: </div>
                   5744: <div class="sect2" lang="en">
                   5745: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   5746: <a name="native-or-pkgsrc-preference"></a>13.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87      wiz      5747: <p>When building packages, it's possible to choose whether to set
                   5748:        a global preference for using either the built-in (native)
                   5749:        version or the pkgsrc version of software to satisfy a
                   5750:        dependency.  This is controlled by setting
                   5751:        <code class="varname">PREFER_PKGSRC</code> and
                   5752:        <code class="varname">PREFER_NATIVE</code>.  These variables take values
                   5753:        of either &#8220;<span class="quote">yes</span>&#8221;, &#8220;<span class="quote">no</span>&#8221;, or a list of
                   5754:        packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
                   5755:        use the pkgsrc versions of software, while
                   5756:        <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
                   5757:        built-in versions.  Preferences are determined by the most
                   5758:        specific instance of the package in either
                   5759:        <code class="varname">PREFER_PKGSRC</code> or
                   5760:        <code class="varname">PREFER_NATIVE</code>.  If a package is specified
                   5761:        in neither or in both variables, then
                   5762:        <code class="varname">PREFER_PKGSRC</code> has precedence over
                   5763:        <code class="varname">PREFER_NATIVE</code>.  For example, to require
                   5764:        using pkgsrc versions of software for all but the most basic
                   5765:       bits on a NetBSD system, you can set:</p>
                   5766: <pre class="programlisting">
                   5767:        PREFER_PKGSRC=  yes
                   5768:        PREFER_NATIVE=  getopt skey tcp_wrappers
                   5769:       </pre>
                   5770: <p>A package <span class="emphasis"><em>must</em></span> have a
                   5771:       <code class="filename">builtin.mk</code>
                   5772:       file to be listed in <code class="varname">PREFER_NATIVE</code>,
                   5773:       otherwise it is simply ignored in that list.</p>
1.75      rillig   5774: </div>
                   5775: </div>
                   5776: </div>
                   5777: <div class="chapter" lang="en">
                   5778: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   5779: <a name="pkginstall"></a>Chapter 14. The pkginstall framework</h2></div></div></div>
1.75      rillig   5780: <div class="toc">
                   5781: <p><b>Table of Contents</b></p>
                   5782: <dl>
1.90      rillig   5783: <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   5784: <dd><dl>
1.90      rillig   5785: <dt><span class="sect2"><a href="#dirs-outside-prefix">14.1.1. Directory manipulation</a></span></dt>
                   5786: <dt><span class="sect2"><a href="#files-outside-prefix">14.1.2. File manipulation</a></span></dt>
1.75      rillig   5787: </dl></dd>
1.90      rillig   5788: <dt><span class="sect1"><a href="#conf-files">14.2. Configuration files</a></span></dt>
1.75      rillig   5789: <dd><dl>
1.90      rillig   5790: <dt><span class="sect2"><a href="#conf-files-sysconfdir">14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   5791: <dt><span class="sect2"><a href="#conf-files-configure">14.2.2. Telling the software where configuration files are</a></span></dt>
                   5792: <dt><span class="sect2"><a href="#conf-files-patching">14.2.3. Patching installations</a></span></dt>
                   5793: <dt><span class="sect2"><a href="#conf-files-disable">14.2.4. Disabling handling of configuration files</a></span></dt>
                   5794: </dl></dd>
                   5795: <dt><span class="sect1"><a href="#rcd-scripts">14.3. System startup scripts</a></span></dt>
                   5796: <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>
                   5797: <dt><span class="sect1"><a href="#users-and-groups">14.4. System users and groups</a></span></dt>
                   5798: <dt><span class="sect1"><a href="#shells">14.5. System shells</a></span></dt>
                   5799: <dd><dl><dt><span class="sect2"><a href="#shells-disable">14.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   5800: <dt><span class="sect1"><a href="#fonts">14.6. Fonts</a></span></dt>
                   5801: <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   5802: </dl>
                   5803: </div>
                   5804: <p>This chapter describes the framework known as
                   5805: <code class="literal">pkginstall</code>, whose key features are:</p>
                   5806: <div class="itemizedlist"><ul type="disc">
                   5807: <li><p>Generic installation and manipulation of directories and files
                   5808:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
                   5809: <li><p>Automatic handling of configuration files during installation,
                   5810:     provided that packages are correctly designed.</p></li>
                   5811: <li><p>Generation and installation of system startup scripts.</p></li>
                   5812: <li><p>Registration of system users and groups.</p></li>
                   5813: <li><p>Registration of system shells.</p></li>
                   5814: <li><p>Automatic updating of fonts databases.</p></li>
                   5815: </ul></div>
                   5816: <p>The following sections inspect each of the above points in detail.</p>
                   5817: <p>You may be thinking that many of the things described here could be
                   5818: easily done with simple code in the package's post-installation target
                   5819: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   5820: as the code in them is only executed when building from source.  Machines
                   5821: using binary packages could not benefit from it at all (as the code itself
                   5822: could be unavailable).  Therefore, the only way to achieve any of the items
                   5823: described above is by means of the installation scripts, which are
                   5824: automatically generated by pkginstall.</p>
                   5825: <div class="sect1" lang="en">
                   5826: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5827: <a name="files-and-dirs-outside-prefix"></a>14.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76      rillig   5828: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75      rillig   5829: of files and directories that belong to a package.  The names used in it
1.76      rillig   5830: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75      rillig   5831: which means that it cannot register files outside this directory (absolute
                   5832: path names are not allowed).  Despite this restriction, some packages need
                   5833: to install files outside this location; e.g., under
1.76      rillig   5834: <code class="filename">${VARBASE}</code> or
1.87      wiz      5835: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   5836: is to create such files during installation time by using
                   5837: installation scripts.</p>
                   5838: <p>The generic installation scripts are shell scripts that can
                   5839: contain arbitrary code.  The list of scripts to execute is taken from
                   5840: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   5841: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   5842: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   5843: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   5844: commands, so they have the potential to create and manage files
                   5845: anywhere in the file system.</p>
                   5846: <p>Using these general installation files is not recommended, but
                   5847: may be needed in some special cases.  One reason for avoiding them is
                   5848: that the user has to trust the packager that there is no unwanted or
                   5849: simply erroneous code included in the installation script. Also,
                   5850: previously there were many similar scripts for the same functionality,
                   5851: and fixing a common error involved finding and changing all of
                   5852: them.</p>
                   5853: <p>The pkginstall framework offers another, standardized way.  It
                   5854: provides generic scripts to abstract the manipulation of such files
                   5855: and directories based on variables set in the package's
                   5856: <code class="filename">Makefile</code>.  The rest of this section describes
                   5857: these variables.</p>
1.75      rillig   5858: <div class="sect2" lang="en">
                   5859: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   5860: <a name="dirs-outside-prefix"></a>14.1.1. Directory manipulation</h3></div></div></div>
1.75      rillig   5861: <p>The following variables can be set to request the creation of
                   5862: directories anywhere in the file system:</p>
                   5863: <div class="itemizedlist"><ul type="disc">
                   5864: <li><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
                   5865:     contain a list of directories that should be created and should attempt
                   5866:     to be destroyed by the installation scripts.  The difference between
                   5867:     the two is that the latter prompts the administrator to remove any
                   5868:     directories that may be left after deinstallation (because they were
                   5869:     not empty), while the former does not.</p></li>
                   5870: <li>
                   5871: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   5872:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   5873:     which directories should be created and should attempt to be destroyed
                   5874:     by the installation scripts.  Each tuple holds the following values,
                   5875:     separated by spaces: the directory name, its owner, its group and its
                   5876:     numerical mode.  For example:</p>
                   5877: <pre class="programlisting">
                   5878:     MAKE_DIRS_PERMS+=         ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
1.1       grant    5879: </pre>
1.75      rillig   5880: <p>The difference between the two is exactly the same as their
                   5881:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5882: </li>
                   5883: </ul></div>
                   5884: </div>
                   5885: <div class="sect2" lang="en">
                   5886: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   5887: <a name="files-outside-prefix"></a>14.1.2. File manipulation</h3></div></div></div>
1.75      rillig   5888: <p>Creating non-empty files outside the installation prefix is tricky
1.76      rillig   5889: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75      rillig   5890: To overcome this problem, the only solution is to extract the file in the
                   5891: known place (i.e., inside the installation prefix) and copy it to the
                   5892: appropriate location during installation (done by the installation scripts
                   5893: generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
                   5894: file</em></span> in the following paragraphs, which describe the variables
                   5895: that can be used to automatically and consistently handle files outside the
                   5896: installation prefix:</p>
                   5897: <div class="itemizedlist"><ul type="disc">
                   5898: <li>
                   5899: <p><code class="varname">CONF_FILES</code> and
                   5900:     <code class="varname">SUPPORT_FILES</code> are pairs of master and target files.
                   5901:     During installation time, the master file is copied to the target one
                   5902:     if and only if the latter does not exist.  Upon deinstallation, the
                   5903:     target file is removed provided that it was not modified by the
                   5904:     installation.</p>
                   5905: <p>The difference between the two is that the latter prompts the
                   5906:     administrator to remove any files that may be left after
                   5907:     deinstallation (because they were not empty), while the former does
                   5908:     not.</p>
                   5909: </li>
                   5910: <li>
                   5911: <p><code class="varname">CONF_FILES_PERMS</code> and
                   5912:     <code class="varname">SUPPORT_FILES_PERMS</code> contain tuples describing master
                   5913:     files as well as their target locations.  For each of them, it also
                   5914:     specifies their owner, their group and their numeric permissions, in
                   5915:     this order.  For example:</p>
                   5916: <pre class="programlisting">
                   5917:     SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1       grant    5918: </pre>
1.75      rillig   5919: <p>The difference between the two is exactly the same as their
                   5920:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5921: </li>
                   5922: </ul></div>
                   5923: </div>
                   5924: </div>
                   5925: <div class="sect1" lang="en">
                   5926: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5927: <a name="conf-files"></a>14.2. Configuration files</h2></div></div></div>
1.75      rillig   5928: <p>Configuration files are special in the sense that they are installed
                   5929: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
                   5930: need special treatment during installation (most of which is automated by
                   5931: pkginstall).  The main concept you must bear in mind is that files marked
                   5932: as configuration files are automatically copied to the right place (somewhere
                   5933: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
                   5934: and only if</em></span> they didn't exist before.  Similarly, they will not
                   5935: be removed if they have local modifications.  This ensures that
                   5936: administrators never lose any custom changes they may have made.</p>
                   5937: <div class="sect2" lang="en">
                   5938: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   5939: <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   5940: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   5941: specifies where configuration files shall be installed.  Its contents are
                   5942: set based upon the following variables:</p>
                   5943: <div class="itemizedlist"><ul type="disc">
                   5944: <li><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76      rillig   5945:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75      rillig   5946:     be overridden by the user to point to his preferred location (e.g.,
1.76      rillig   5947:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75      rillig   5948:     Packages must not use it directly.</p></li>
                   5949: <li>
                   5950: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   5951:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   5952:     for the package being built shall be installed.  The definition of this
                   5953:     variable only makes sense in the package's
1.76      rillig   5954:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75      rillig   5955: <p>As an example, consider the Apache package,
1.91      rillig   5956:     <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   5957:     configuration files under the
1.76      rillig   5958:     <code class="filename">httpd/</code> subdirectory of
1.75      rillig   5959:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   5960:     Makefile.</p>
                   5961: </li>
                   5962: <li><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
                   5963:     variable that holds this package's configuration directory (if
                   5964:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   5965:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   5966:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
                   5967: <li><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
                   5968:     directory where the configuration files for the package identified by
                   5969:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   5970: </ul></div>
                   5971: <p>Based on the above variables, pkginstall determines the value of
                   5972: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
                   5973: variable that can be used within a package to refer to its configuration
                   5974: directory.  The algorithm used to set its value is basically the
                   5975: following:</p>
                   5976: <div class="orderedlist"><ol type="1">
                   5977: <li><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
                   5978:     its value is used.</p></li>
                   5979: <li><p>If the previous variable is not defined but
                   5980:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76      rillig   5981:     <code class="filename">Makefile</code>, the resulting value is
                   5982:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.75      rillig   5983: <li><p>Otherwise, it is set to
1.76      rillig   5984:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75      rillig   5985: </ol></div>
1.76      rillig   5986: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.90      rillig   5987: 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   5988: </div>
                   5989: <div class="sect2" lang="en">
                   5990: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   5991: <a name="conf-files-configure"></a>14.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75      rillig   5992: <p>Given that pkgsrc (and users!) expect configuration files to be in a
                   5993: known place, you need to teach each package where it shall install its
                   5994: files.  In some cases you will have to patch the package Makefiles to
                   5995: achieve it.  If you are lucky, though, it may be as easy as passing an
                   5996: extra flag to the configuration script; this is the case of GNU Autoconf-
                   5997: generated files:</p>
                   5998: <pre class="programlisting">
                   5999:     CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1       grant    6000: </pre>
1.75      rillig   6001: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
                   6002: for</em></span> its configuration files, not where they will be originally
                   6003: installed (although the difference is never explicit,
                   6004: unfortunately).</p>
                   6005: </div>
                   6006: <div class="sect2" lang="en">
                   6007: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   6008: <a name="conf-files-patching"></a>14.2.3. Patching installations</h3></div></div></div>
1.75      rillig   6009: <p>As said before, pkginstall automatically handles configuration files.
                   6010: This means that <span class="strong"><strong>the packages themselves must not
1.76      rillig   6011: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75      rillig   6012: directly</strong></span>.  Bad news is that many software installation scripts
                   6013: will, out of the box, mess with the contents of that directory.  So what is
                   6014: the correct procedure to fix this issue?</p>
                   6015: <p>You must teach the package (usually by manually patching it) to
                   6016: install any configuration files under the examples hierarchy,
1.76      rillig   6017: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   6018: <code class="filename">PLIST</code> registers them and the administrator always
1.75      rillig   6019: has the original copies available.</p>
                   6020: <p>Once the required configuration files are in place (i.e., under the
                   6021: examples hierarchy), the pkginstall framework can use them as master copies
                   6022: during the package installation to update what is in
1.76      rillig   6023: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
1.75      rillig   6024: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.90      rillig   6025: 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   6026: about their syntax and their purpose.  Here is an example, taken from the
1.91      rillig   6027: <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   6028: <pre class="programlisting">
                   6029:     EGDIR=        ${PREFIX}/share/doc/mutt/samples
                   6030:     CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1       grant    6031: </pre>
1.75      rillig   6032: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
                   6033: package and has no meaning outside it.</p>
                   6034: </div>
                   6035: <div class="sect2" lang="en">
                   6036: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   6037: <a name="conf-files-disable"></a>14.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75      rillig   6038: <p>The automatic copying of config files can be toggled by setting the
                   6039: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   6040: installation.</p>
                   6041: </div>
                   6042: </div>
                   6043: <div class="sect1" lang="en">
                   6044: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6045: <a name="rcd-scripts"></a>14.3. System startup scripts</h2></div></div></div>
1.75      rillig   6046: <p>System startup scripts are special files because they must be
                   6047: installed in a place known by the underlying OS, usually outside the
1.90      rillig   6048: 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   6049: can be used.  However, pkginstall provides a special mechanism to handle
                   6050: these files.</p>
                   6051: <p>In order to provide system startup scripts, the package has
                   6052: to:</p>
                   6053: <div class="orderedlist"><ol type="1">
1.76      rillig   6054: <li><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75      rillig   6055:     the <code class="literal">.sh</code> suffix appended.  Considering the
1.91      rillig   6056:     <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   6057:     <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.75      rillig   6058: <li>
                   6059: <p>Tell pkginstall to handle it, appending the name of the script,
                   6060:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   6061:     Continuing the previous example:</p>
                   6062: <pre class="programlisting">
                   6063:     RCD_SCRIPTS+=   cupsd
1.1       grant    6064: </pre>
1.75      rillig   6065: </li>
                   6066: </ol></div>
                   6067: <p>Once this is done, pkginstall will do the following steps for each
                   6068: script in an automated fashion:</p>
                   6069: <div class="orderedlist"><ol type="1">
                   6070: <li><p>Process the file found in the files directory applying all the
1.76      rillig   6071:     substitutions described in the <code class="filename">FILES_SUBST</code>
1.75      rillig   6072:     variable.</p></li>
                   6073: <li><p>Copy the script from the files directory to the examples
1.76      rillig   6074:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
1.75      rillig   6075:     that this master file must be explicitly registered in the
1.76      rillig   6076:     <code class="filename">PLIST</code>.</p></li>
1.75      rillig   6077: <li><p>Add code to the installation scripts to copy the startup script
                   6078:     from the examples hierarchy into the system-wide startup scripts
                   6079:     directory.</p></li>
                   6080: </ol></div>
                   6081: <div class="sect2" lang="en">
                   6082: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   6083: <a name="rcd-scripts-disable"></a>14.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75      rillig   6084: <p>The automatic copying of config files can be toggled by setting the
                   6085: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   6086: installation.  Note that the scripts will be always copied inside the
1.76      rillig   6087: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75      rillig   6088: matter what the value of this variable is.</p>
                   6089: </div>
                   6090: </div>
                   6091: <div class="sect1" lang="en">
                   6092: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6093: <a name="users-and-groups"></a>14.4. System users and groups</h2></div></div></div>
1.75      rillig   6094: <p>If a package needs to create special users and/or groups during
                   6095: installation, it can do so by using the pkginstall framework.</p>
                   6096: <p>Users can be created by adding entries to the
                   6097: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   6098: syntax:</p>
                   6099: <pre class="programlisting">
                   6100:     user:group
1.1       grant    6101: </pre>
1.87      wiz      6102: <p>Further specification of user details may be done by setting
                   6103: per-user variables.
                   6104: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   6105: numeric UID for the user.
                   6106: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   6107: user's description or comment.
                   6108: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   6109: user's home directory, and defaults to
                   6110: <code class="filename">/nonexistent</code> if not specified.
                   6111: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94      dmcmahil 6112: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87      wiz      6113: not specified.</p>
1.75      rillig   6114: <p>Similarly, groups can be created by adding entries to the
                   6115: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   6116: <pre class="programlisting">
                   6117:     group
1.1       grant    6118: </pre>
1.93      rillig   6119: <p>The numeric GID of the group may be set by defining
1.75      rillig   6120: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   6121: <p>If a package needs to create the users and groups at an earlier
                   6122: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
                   6123: either <code class="literal">configure</code> or <code class="literal">build</code> to
                   6124: indicate the phase before which the users and groups are created.  In
                   6125: this case, the numeric UIDs and GIDs of the created users and groups
                   6126: are automatically hardcoded into the final installation scripts.</p>
                   6127: </div>
                   6128: <div class="sect1" lang="en">
                   6129: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6130: <a name="shells"></a>14.5. System shells</h2></div></div></div>
1.75      rillig   6131: <p>Packages that install system shells should register them in the shell
1.76      rillig   6132: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75      rillig   6133: administrator.  This must be done from the installation scripts to keep
                   6134: binary packages working on any system.  pkginstall provides an easy way to
                   6135: accomplish this task.</p>
                   6136: <p>When a package provides a shell interpreter, it has to set the
                   6137: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   6138: add some hooks to the installation scripts to handle it.  Consider the
1.91      rillig   6139: 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   6140: <pre class="programlisting">
                   6141:     PKG_SHELL=      ${PREFIX}/bin/zsh
1.1       grant    6142: </pre>
1.75      rillig   6143: <div class="sect2" lang="en">
                   6144: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   6145: <a name="shells-disable"></a>14.5.1. Disabling shell registration</h3></div></div></div>
1.75      rillig   6146: <p>The automatic registration of shell interpreters can be disabled by
1.76      rillig   6147: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75      rillig   6148: environment variable to <code class="literal">NO</code>.</p>
                   6149: </div>
                   6150: </div>
                   6151: <div class="sect1" lang="en">
                   6152: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6153: <a name="fonts"></a>14.6. Fonts</h2></div></div></div>
1.75      rillig   6154: <p>Packages that install X11 fonts should update the database files
                   6155: that index the fonts within each fonts directory.  This can easily be
                   6156: accomplished within the pkginstall framework.</p>
                   6157: <p>When a package installs X11 fonts, it must list the directories in
                   6158: which fonts are installed in the
                   6159: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
                   6160: where <em class="replaceable"><code>type</code></em> can be one of &#8220;<span class="quote">ttf</span>&#8221;,
                   6161: &#8220;<span class="quote">type1</span>&#8221; or &#8220;<span class="quote">x11</span>&#8221;.  This will add hooks to the
                   6162: installation scripts to run the appropriate commands to update the fonts
                   6163: database files within each of those directories.  For convenience, if the
                   6164: directory path is relative, it is taken to be relative to the package's
1.91      rillig   6165: 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   6166: <pre class="programlisting">
                   6167:     FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
1.1       grant    6168: </pre>
1.75      rillig   6169: <div class="sect2" lang="en">
                   6170: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   6171: <a name="fonts-disable"></a>14.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75      rillig   6172: <p>The automatic update of fonts databases can be disabled by
1.76      rillig   6173: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75      rillig   6174: environment variable to <code class="literal">NO</code>.</p>
                   6175: </div>
                   6176: </div>
                   6177: </div>
                   6178: <div class="chapter" lang="en">
                   6179: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   6180: <a name="options"></a>Chapter 15. Options handling</h2></div></div></div>
1.75      rillig   6181: <div class="toc">
                   6182: <p><b>Table of Contents</b></p>
                   6183: <dl>
1.90      rillig   6184: <dt><span class="sect1"><a href="#global-default-options">15.1. Global default options</a></span></dt>
                   6185: <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>
                   6186: <dt><span class="sect1"><a href="#option-names">15.3. Option Names</a></span></dt>
1.75      rillig   6187: </dl>
                   6188: </div>
                   6189: <p>Many packages have the ability to be built to support different
1.76      rillig   6190: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
1.75      rillig   6191: in pkgsrc that provides generic handling of those options that
                   6192: determine different ways in which the packages can be built.  It's
                   6193: possible for the user to specify exactly which sets of options will be
                   6194: built into a package or to allow a set of global default options
                   6195: apply.</p>
                   6196: <div class="sect1" lang="en">
                   6197: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6198: <a name="global-default-options"></a>15.1. Global default options</h2></div></div></div>
1.75      rillig   6199: <p>Global default options are listed in
                   6200: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   6201: that should be built into every package if that option is supported.
1.76      rillig   6202: This variable should be set in <code class="filename">/etc/mk.conf</code>.</p>
1.75      rillig   6203: </div>
                   6204: <div class="sect1" lang="en">
                   6205: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   6206: <a name="converting-to-options"></a>15.2. Converting packages to use <code class="filename">bsd.options.mk</code>
                   6207: </h2></div></div></div>
1.75      rillig   6208: <p>The following example shows how
1.76      rillig   6209: <code class="filename">bsd.options.mk</code> should be used
1.75      rillig   6210: by the hypothetical ``wibble'' package, either in the package
1.76      rillig   6211: <code class="filename">Makefile</code>, or in a file,
                   6212: e.g. <code class="filename">options.mk</code>, that is included by the
                   6213: main package <code class="filename">Makefile</code>.</p>
1.75      rillig   6214: <pre class="programlisting">
                   6215:     PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   6216:     PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   6217:     PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   6218:     PKG_OPTIONS_GROUP.database=     mysql pgsql
                   6219:     PKG_SUGGESTED_OPTIONS=          wibble-foo
                   6220:     PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   6221:     PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
1.1       grant    6222: 
1.75      rillig   6223:     .include "../../mk/bsd.prefs.mk"
1.69      rillig   6224: 
1.75      rillig   6225:     # this package was previously named wibble2
                   6226:     .if defined(PKG_OPTIONS.wibble2)
                   6227:     PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   6228:     PKG_OPTIONS_DEPRECATED_WARNINGS+= \
1.78      rillig   6229:             "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
1.75      rillig   6230:     .endif
1.69      rillig   6231: 
1.75      rillig   6232:     .include "../../mk/bsd.options.mk"
1.69      rillig   6233: 
1.75      rillig   6234:     # Package-specific option-handling
1.69      rillig   6235: 
1.75      rillig   6236:     ###
                   6237:     ### FOO support
                   6238:     ###
                   6239:     .if !empty(PKG_OPTIONS:Mwibble-foo)
                   6240:     CONFIGURE_ARGS+=    --enable-foo
                   6241:     .endif
1.69      rillig   6242: 
1.75      rillig   6243:     ###
                   6244:     ### LDAP support
                   6245:     ###
                   6246:     .if !empty(PKG_OPTIONS:Mldap)
1.77      rillig   6247:     .  include "../../databases/openldap-client/buildlink3.mk"
                   6248:     CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
1.75      rillig   6249:     .endif
1.69      rillig   6250: 
1.75      rillig   6251:     ###
                   6252:     ### database support
                   6253:     ###
                   6254:     .if !empty(PKG_OPTIONS:Mmysql)
                   6255:     .  include "../../mk/mysql.buildlink3.mk"
                   6256:     .endif
                   6257:     .if !empty(PKG_OPTIONS:Mpgsql)
                   6258:     .  include "../../mk/pgsql.buildlink3.mk"
                   6259:     .endif
                   6260: </pre>
                   6261: <p>The first section contains the information about which build
                   6262: options are supported by the package, and any default options settings
                   6263: if needed.</p>
                   6264: <div class="orderedlist"><ol type="1">
                   6265: <li><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
                   6266: <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
                   6267: options.  It should be set to
1.78      rillig   6268: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   6269: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   6270: at the point where the options are processed.</p></li>
1.75      rillig   6271: <li><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
                   6272: build options supported by the package.</p></li>
                   6273: <li><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
                   6274: list of names of groups of mutually exclusive options.  The options in
                   6275: each group are listed in
                   6276: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   6277: The most specific setting of any option from the group takes
                   6278: precedence over all other options in the group.  Options from the
                   6279: groups will be automatically added to
                   6280: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
                   6281: <li><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
                   6282: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   6283: packages will fail if no option from the group is
                   6284: selected.</p></li>
                   6285: <li><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
                   6286: of names of sets of options.  At least one option from each set must
                   6287: be selected.  The options in each set are listed in
                   6288: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   6289: Options from the sets will be automatically added to
                   6290: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   6291: fail if no option from the set is selected.</p></li>
                   6292: <li><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
                   6293: build options which are enabled by default.</p></li>
                   6294: <li><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
                   6295: of
                   6296: &#8220;<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>&#8221;
1.76      rillig   6297: pairs that map legacy <code class="filename">/etc/mk.conf</code> variables to
1.75      rillig   6298: their option counterparts.  Pairs should be added with
                   6299: &#8220;<span class="quote">+=</span>&#8221; to keep the listing of global legacy variables.  A
                   6300: warning will be issued if the user uses a legacy
                   6301: variable.</p></li>
                   6302: <li><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
                   6303: of
                   6304: &#8220;<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>&#8221;
                   6305: pairs that map options that have been renamed to their new
                   6306: counterparts.  Pairs should be added with &#8220;<span class="quote">+=</span>&#8221; to keep
                   6307: the listing of global legacy options.  A warning will be issued if
                   6308: the user uses a legacy option.</p></li>
                   6309: <li><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
                   6310: options implied by deprecated variables used.  This can be used for
                   6311: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   6312: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   6313: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
                   6314: <li><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
                   6315: a list of warnings about deprecated variables or options used, and
                   6316: what to use instead.</p></li>
                   6317: </ol></div>
                   6318: <p>A package should never modify
                   6319: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   6320: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   6321: To suggest a default set of options, use
                   6322: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   6323: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76      rillig   6324: including <code class="filename">bsd.options.mk</code>.  If none of
1.75      rillig   6325: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   6326: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   6327: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   6328: happen with platform-specific options if none of them is supported on
                   6329: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   6330: empty list and the package is otherwise treated as not using the
                   6331: options framework.</p>
1.76      rillig   6332: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75      rillig   6333: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   6334: build options, properly filtered to remove unsupported and duplicate
                   6335: options.</p>
                   6336: <p>The remaining sections contain the logic that is specific to
                   6337: each option.  The correct way to check for an option is to check
                   6338: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   6339: <pre class="programlisting">
                   6340:     .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
                   6341: </pre>
                   6342: </div>
                   6343: <div class="sect1" lang="en">
                   6344: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6345: <a name="option-names"></a>15.3. Option Names</h2></div></div></div>
1.75      rillig   6346: <p>Options that enable similar features in different packages (like
                   6347: optional support for a library) should use a common name in all
                   6348: packages that support it (like the name of the library).  If another
                   6349: package already has an option with the same meaning, use the same
                   6350: name.</p>
                   6351: <p>Options that enable features specific to one package, where it's
                   6352: unlikely that another (unrelated) package has the same (or a similar)
                   6353: optional feature, should use a name prefixed with
                   6354: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   6355: <p>If a group of related packages share an optional feature
                   6356: specific to that group, prefix it with the name of the
                   6357: &#8220;<span class="quote">main</span>&#8221; package
                   6358: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   6359: <p>For new options, add a line to
1.76      rillig   6360: <code class="filename">mk/defaults/options.description</code>.  Lines have two
1.75      rillig   6361: fields, separated by tab.  The first field is the option name, the
                   6362: second its description.  The description should be a whole sentence
                   6363: (starting with an uppercase letter and ending with a period) that
                   6364: describes what enabling the option does.  E. g. &#8220;<span class="quote">Enable ispell
                   6365: support.</span>&#8221; The file is sorted by option names.</p>
                   6366: </div>
                   6367: </div>
                   6368: <div class="chapter" lang="en">
                   6369: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   6370: <a name="build"></a>Chapter 16. The build process</h2></div></div></div>
1.75      rillig   6371: <div class="toc">
                   6372: <p><b>Table of Contents</b></p>
                   6373: <dl>
1.90      rillig   6374: <dt><span class="sect1"><a href="#build.intro">16.1. Introduction</a></span></dt>
                   6375: <dt><span class="sect1"><a href="#build.prefix">16.2. Program location</a></span></dt>
                   6376: <dt><span class="sect1"><a href="#build.builddirs">16.3. Directories used during the build process</a></span></dt>
                   6377: <dt><span class="sect1"><a href="#build.running">16.4. Running a phase</a></span></dt>
                   6378: <dt><span class="sect1"><a href="#build.fetch">16.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   6379: <dd><dl>
                   6380: <dt><span class="sect2"><a href="#build.fetch.what">16.5.1. What to fetch and where to get it from</a></span></dt>
                   6381: <dt><span class="sect2"><a href="#build.fetch.how">16.5.2. How are the files fetched?</a></span></dt>
                   6382: </dl></dd>
                   6383: <dt><span class="sect1"><a href="#build.checksum">16.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   6384: <dt><span class="sect1"><a href="#build.extract">16.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   6385: <dt><span class="sect1"><a href="#build.patch">16.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   6386: <dt><span class="sect1"><a href="#build.tools">16.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   6387: <dt><span class="sect1"><a href="#build.wrapper">16.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   6388: <dt><span class="sect1"><a href="#build.configure">16.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   6389: <dt><span class="sect1"><a href="#build.build">16.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   6390: <dt><span class="sect1"><a href="#build.test">16.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   6391: <dt><span class="sect1"><a href="#build.install">16.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   6392: <dt><span class="sect1"><a href="#build.package">16.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   6393: <dt><span class="sect1"><a href="#build.clean">16.16. Cleaning up</a></span></dt>
                   6394: <dt><span class="sect1"><a href="#build.helpful-targets">16.17. Other helpful targets</a></span></dt>
1.75      rillig   6395: </dl>
                   6396: </div>
                   6397: <div class="sect1" lang="en">
                   6398: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6399: <a name="build.intro"></a>16.1. Introduction</h2></div></div></div>
1.75      rillig   6400: <p>This chapter gives a detailed description on how a package is
1.87      wiz      6401:     built. Building a package is separated into different
                   6402:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   6403:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
                   6404:     described in the following sections. Each phase is splitted into
                   6405:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   6406:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   6407:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   6408:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   6409:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.75      rillig   6410: <p>The basic steps for building a program are always the same.  First
1.87      wiz      6411:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   6412:     the local system and then extracted. After any pkgsrc-specific patches
                   6413:     to compile properly are applied, the software can be configured, then
                   6414:     built (usually by compiling), and finally the generated binaries, etc.
                   6415:     can be put into place on the system.</p>
1.75      rillig   6416: </div>
                   6417: <div class="sect1" lang="en">
                   6418: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6419: <a name="build.prefix"></a>16.2. Program location</h2></div></div></div>
1.75      rillig   6420: <p>Before outlining the process performed by the NetBSD package system in
1.87      wiz      6421:     the next section, here's a brief discussion on where programs are
                   6422:     installed, and which variables influence this.</p>
1.75      rillig   6423: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87      wiz      6424:     where all files of the final program shall be installed. It is
                   6425:     usually set to <code class="varname">LOCALBASE</code>
                   6426:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88      wiz      6427:     for pkgs in the <code class="filename">cross</code> category.  The value of
1.87      wiz      6428:     <code class="varname">PREFIX</code> needs to be put
                   6429:     into the various places in the program's source where paths to
1.90      rillig   6430:     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   6431: <p>When choosing which of these variables to use,
1.87      wiz      6432:     follow the following rules:</p>
1.75      rillig   6433: <div class="itemizedlist"><ul type="disc">
1.88      wiz      6434: <li><p><code class="varname">PREFIX</code> always points to the location
                   6435:        where the current pkg will be installed.  When referring to a
                   6436:        pkg's own installation path, use
                   6437:        &#8220;<span class="quote">${PREFIX}</span>&#8221;.</p></li>
                   6438: <li><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
                   6439:        are installed.  If you need to construct a -I or -L argument
                   6440:        to the compiler to find includes and libraries installed by
                   6441:        another non-X11 pkg, use &#8220;<span class="quote">${LOCALBASE}</span>&#8221;. The name
1.87      wiz      6442:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   6443:        installed all packages in <code class="filename">/usr/local</code>. As
                   6444:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   6445:        administrator, this variable is a misnomer.</p></li>
1.88      wiz      6446: <li><p><code class="varname">X11BASE</code> is where the actual X11
                   6447:        distribution (from xsrc, etc.) is installed. When looking for
                   6448:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
                   6449:        installed by a package), use &#8220;<span class="quote">${X11BASE}</span>&#8221;.</p></li>
                   6450: <li>
                   6451: <p>X11-based packages are special in that they may be
                   6452:        installed in either <code class="varname">X11BASE</code> or
                   6453:        <code class="varname">LOCALBASE</code>.</p>
1.75      rillig   6454: <p>Usually, X11 packages should be installed under
1.88      wiz      6455:        <code class="varname">LOCALBASE</code> whenever possible.  Note that you
                   6456:        will need to include
                   6457:        <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
                   6458:        request the presence of X11 and to get the right compilation
                   6459:        flags.</p>
1.75      rillig   6460: <p>Even though, there are some packages that cannot be installed
1.87      wiz      6461:        under <code class="varname">LOCALBASE</code>: those that come with app-defaults
                   6462:        files. These packages are special and they must be placed under
                   6463:        <code class="varname">X11BASE</code>. To accomplish this, set either
                   6464:        <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
                   6465:        your package.</p>
1.75      rillig   6466: <p>Some notes: If you need
1.87      wiz      6467:        to find includes or libraries installed by a pkg that has
                   6468:        <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
                   6469:        its pkg <code class="filename">Makefile</code>, you need to look in
                   6470:        <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
                   6471:        <code class="filename">${LOCALBASE}</code>. To force installation of
                   6472:        all X11 packages in <code class="varname">LOCALBASE</code>, the
1.91      rillig   6473:        <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      6474:        is enabled by default.</p>
1.75      rillig   6475: </li>
1.88      wiz      6476: <li><p><code class="varname">X11PREFIX</code> should be used to refer to
                   6477:        the installed location of an X11
                   6478:        package. <code class="varname">X11PREFIX</code> will be set to
                   6479:        <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
                   6480:        to <code class="varname">LOCALBASE</code> if xpkgwedge is
                   6481:        installed.</p></li>
                   6482: <li>
                   6483: <p>If xpkgwedge is installed, it is possible to have some
                   6484:        packages installed in <code class="varname">X11BASE</code> and some in
                   6485:        <code class="varname">LOCALBASE</code>.  To determine the prefix of an
                   6486:        installed package, the <code class="varname">EVAL_PREFIX</code>
                   6487:        definition can be used. It takes pairs in the format
                   6488:        &#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>
                   6489:        variable <code class="varname">DIRNAME</code> will be set to the prefix
                   6490:        of the installed package &lt;package&gt;, or
                   6491:        &#8220;<span class="quote">${X11PREFIX}</span>&#8221; if the package is not
                   6492:        installed.</p>
1.75      rillig   6493: <p>This is best illustrated by example.</p>
                   6494: <p>The following lines are taken from
1.87      wiz      6495:        <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75      rillig   6496: <pre class="programlisting">
1.87      wiz      6497:          EVAL_PREFIX+=           GTKDIR=gtk+
                   6498:          CONFIGURE_ARGS+=        --with-guile-prefix=${LOCALBASE:Q}
                   6499:          CONFIGURE_ARGS+=        --with-gtk-prefix=${GTKDIR:Q}
                   6500:          CONFIGURE_ARGS+=        --enable-multibyte
                   6501:        </pre>
1.88      wiz      6502: <p>Specific defaults can be defined for the packages
                   6503:        evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
                   6504:        definition of the form:</p>
1.75      rillig   6505: <pre class="programlisting">
1.87      wiz      6506:          GTKDIR_DEFAULT= ${LOCALBASE}
                   6507:        </pre>
1.75      rillig   6508: <p>where <code class="varname">GTKDIR</code> corresponds
1.87      wiz      6509:        to the first definition in
                   6510:        the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75      rillig   6511: </li>
1.76      rillig   6512: <li><p>Within <code class="filename">${PREFIX}</code>, packages should
1.87      wiz      6513:        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
                   6514:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   6515:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75      rillig   6516: </ul></div>
                   6517: </div>
                   6518: <div class="sect1" lang="en">
                   6519: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6520: <a name="build.builddirs"></a>16.3. Directories used during the build process</h2></div></div></div>
1.75      rillig   6521: <p>When building a package, a number of directories is used to store
1.87      wiz      6522:     source files, temporary files, pkgsrc-internal files, and so on. These
                   6523:     directories are explained here.</p>
1.75      rillig   6524: <p>Some of the directory variables contain relative pathnames. There
1.87      wiz      6525:     are two common base directories for these relative directories:
                   6526:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   6527:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   6528:     inside the package itself.</p>
1.75      rillig   6529: <div class="variablelist"><dl>
                   6530: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   6531: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87      wiz      6532:       root directory. Generally, you don't need
                   6533:       it.</p></dd>
1.75      rillig   6534: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
                   6535: <dd><p>This is a pathname relative to
1.87      wiz      6536:       <code class="varname">PKGSRCDIR</code> that points to the current
                   6537:       package.</p></dd>
1.75      rillig   6538: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   6539: <dd><p>This is an absolute pathname pointing to the directory
1.93      rillig   6540:       where all work takes place. The distfiles are extracted to this
1.87      wiz      6541:       directory. It also contains temporary directories and log files used by
                   6542:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   6543:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75      rillig   6544: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   6545: <dd><p>This is an absolute pathname pointing to the directory
1.87      wiz      6546:       where the distfiles are extracted. It is usually a direct subdirectory
                   6547:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   6548:       that isn't hidden. This variable may be changed by a package
                   6549:       <code class="filename">Makefile</code>.</p></dd>
1.75      rillig   6550: </dl></div>
                   6551: </div>
                   6552: <div class="sect1" lang="en">
                   6553: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6554: <a name="build.running"></a>16.4. Running a phase</h2></div></div></div>
1.75      rillig   6555: <p>You can run a particular phase by typing <span><strong class="command">make
1.87      wiz      6556:     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
                   6557:     phase. This will automatically run all phases that are required for this
                   6558:     phase. The default phase is <code class="varname">build</code>, that is, when you
                   6559:     run <span><strong class="command">make</strong></span> without parameters in a package directory,
                   6560:     the package will be built, but not installed.</p>
1.75      rillig   6561: </div>
                   6562: <div class="sect1" lang="en">
                   6563: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6564: <a name="build.fetch"></a>16.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81      rillig   6565: <p>The first step in building a package is to fetch the
1.88      wiz      6566:     distribution files (distfiles) from the sites that are providing
                   6567:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   6568:     phase.</p>
1.81      rillig   6569: <div class="sect2" lang="en">
                   6570: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   6571: <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      6572: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   6573:       defines all URLs from where the distfile, whose name is
                   6574:       derived from the <code class="varname">DISTNAME</code> variable, is
                   6575:       fetched. The more complicated cases are described
                   6576:       below.</p>
                   6577: <p>The variable <code class="varname">DISTFILES</code> specifies
                   6578:       the list of distfiles that have to be fetched. Its value
                   6579:       defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
                   6580:       so that most packages don't need to define it at all.
                   6581:       <code class="varname">EXTRACT_SUFX</code> is
                   6582:       <code class="literal">.tar.gz</code> by default, but can be changed
                   6583:       freely. Note that if your package requires additional
                   6584:       distfiles to the default one, you cannot just append the
                   6585:       additional filenames using the <code class="literal">+=</code>
                   6586:       operator, but you have write for example:</p>
1.81      rillig   6587: <pre class="programlisting">
1.88      wiz      6588:        DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
                   6589:       </pre>
                   6590: <p>Each distfile is fetched from a list of sites, usually
                   6591:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   6592:       <code class="varname">DISTFILES</code> or multiple
                   6593:       <code class="varname">PATCHFILES</code> from different sites, you can
                   6594:       set
                   6595:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   6596:       to the list of URLs where the file
                   6597:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   6598:       (including the suffix) can be found.</p>
                   6599: <pre class="programlisting">
                   6600:        DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   6601:        DISTFILES+=     foo-file.tar.gz
                   6602:        SITES.foo-file.tar.gz= \
                   6603:        http://www.somewhere.com/somehow/ \
                   6604:        http://www.somewhereelse.com/mirror/somehow/
                   6605:       </pre>
1.81      rillig   6606: <p>When actually fetching the distfiles, each item from
1.88      wiz      6607:       <code class="varname">MASTER_SITES</code> or
                   6608:       <code class="varname">SITES.*</code> gets the name of each distfile
                   6609:       appended to it, without an intermediate slash. Therefore,
                   6610:       all site values have to end with a slash or other separator
                   6611:       character. This allows for example to set
                   6612:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   6613:       that gets the name of the distfile as a parameter. In this
                   6614:       case, the definition would look like:</p>
1.81      rillig   6615: <pre class="programlisting">
1.88      wiz      6616:        MASTER_SITES=   http://www.example.com/download.cgi?file=
                   6617:       </pre>
1.81      rillig   6618: <p>There are some predefined values for
1.88      wiz      6619:       <code class="varname">MASTER_SITES</code>, which can be used in
                   6620:       packages.  The names of the variables should speak for
                   6621:       themselves.</p>
                   6622: <pre class="programlisting">
                   6623:        ${MASTER_SITE_APACHE}
                   6624:        ${MASTER_SITE_BACKUP}
                   6625:        ${MASTER_SITE_CYGWIN}
                   6626:        ${MASTER_SITE_DEBIAN}
                   6627:        ${MASTER_SITE_FREEBSD}
                   6628:        ${MASTER_SITE_FREEBSD_LOCAL}
1.93      rillig   6629:        ${MASTER_SITE_GENTOO}
1.88      wiz      6630:        ${MASTER_SITE_GNOME}
                   6631:        ${MASTER_SITE_GNU}
                   6632:        ${MASTER_SITE_GNUSTEP}
                   6633:        ${MASTER_SITE_IFARCHIVE}
                   6634:        ${MASTER_SITE_KDE}
                   6635:        ${MASTER_SITE_MOZILLA}
                   6636:        ${MASTER_SITE_MYSQL}
                   6637:        ${MASTER_SITE_OPENOFFICE}
                   6638:        ${MASTER_SITE_PERL_CPAN}
                   6639:        ${MASTER_SITE_PGSQL}
                   6640:        ${MASTER_SITE_R_CRAN}
                   6641:        ${MASTER_SITE_SOURCEFORGE}
                   6642:        ${MASTER_SITE_SOURCEFORGE_JP}
                   6643:        ${MASTER_SITE_SUNSITE}
                   6644:        ${MASTER_SITE_SUSE}
                   6645:        ${MASTER_SITE_TEX_CTAN}
                   6646:        ${MASTER_SITE_XCONTRIB}
                   6647:        ${MASTER_SITE_XEMACS}
                   6648:       </pre>
                   6649: <p>Some explanations for the less self-explaining ones:
                   6650:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.93      rillig   6651:       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
                   6652:       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      6653: <p>If you choose one of these predefined sites, you may
                   6654:       want to specify a subdirectory of that site. Since these
                   6655:       macros may expand to more than one actual site, you
                   6656:       <span class="emphasis"><em>must</em></span> use the following construct to
                   6657:       specify a subdirectory:</p>
1.81      rillig   6658: <pre class="programlisting">
1.88      wiz      6659:        MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   6660:        MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
                   6661:       </pre>
1.81      rillig   6662: <p>Note the trailing slash after the subdirectory
1.88      wiz      6663:       name.</p>
1.81      rillig   6664: </div>
                   6665: <div class="sect2" lang="en">
                   6666: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   6667: <a name="build.fetch.how"></a>16.5.2. How are the files fetched?</h3></div></div></div>
1.88      wiz      6668: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   6669:       all the distfiles exist in a local directory
1.93      rillig   6670:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88      wiz      6671:       user). If the files do not exist, they are fetched using
                   6672:       commands of the form</p>
1.75      rillig   6673: <pre class="programlisting">
1.88      wiz      6674:        ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   6675:       </pre>
                   6676: <p>where <code class="literal">${site}</code> varies through
                   6677:       several possibilities in turn: first,
                   6678:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   6679:       sites specified in either <code class="varname">SITES.file</code> if
                   6680:       defined, else <code class="varname">MASTER_SITES</code> or
                   6681:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   6682:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91      rillig   6683:       all except the first and the last can be optionally sorted
                   6684:       by the user, via setting either
                   6685:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   6686:       <code class="varname">MASTER_SORT_AWK</code> or
1.88      wiz      6687:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.81      rillig   6688: </div>
1.75      rillig   6689: </div>
                   6690: <div class="sect1" lang="en">
                   6691: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6692: <a name="build.checksum"></a>16.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88      wiz      6693: <p>After the distfile(s) are fetched, their checksum is
                   6694:     generated and compared with the checksums stored in the
                   6695:     distinfo file. If the checksums don't match, the build is
                   6696:     aborted. This is to ensure the same distfile is used for
                   6697:     building, and that the distfile wasn't changed, e.g. by some
                   6698:     malign force, deliberately changed distfiles on the master
                   6699:     distribution site or network lossage.</p>
1.75      rillig   6700: </div>
                   6701: <div class="sect1" lang="en">
                   6702: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6703: <a name="build.extract"></a>16.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75      rillig   6704: <p>When the distfiles are present on the local system, they
1.88      wiz      6705:     need to be extracted, as they usually come in the form of some
                   6706:     compressed archive format.</p>
1.75      rillig   6707: <p>By default, all <code class="varname">DISTFILES</code> are
1.88      wiz      6708:     extracted. If you only need some of them, you can set the
                   6709:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   6710:     files.</p>
                   6711: <p>Extracting the files is usually done by a little
1.93      rillig   6712:     program, <code class="filename">mk/extract/extract</code>, which
1.88      wiz      6713:     already knows how to extract various archive formats, so most
                   6714:     likely you will not need to change anything here. But if you
                   6715:     need, the following variables may help you:</p>
1.75      rillig   6716: <div class="variablelist"><dl>
                   6717: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   6718: <dd><p>Use these variables to override the default
1.88      wiz      6719:       options for an extract command, which are defined in
1.93      rillig   6720:       <code class="filename">mk/extract/extract</code>.</p></dd>
1.75      rillig   6721: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   6722: <dd><p>This variable can be set to
1.93      rillig   6723:       <code class="literal">gtar</code>, <code class="literal">nbtar</code> (which is the
                   6724:       default value), <code class="literal">pax</code>, or an
1.88      wiz      6725:       absolute pathname pointing to the command with which tar
                   6726:       archives should be
                   6727:       extracted.</p></dd>
1.75      rillig   6728: </dl></div>
1.88      wiz      6729: <p>If the <code class="filename">extract</code> program doesn't
                   6730:     serve your needs, you can also override the
                   6731:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   6732:     command used for extracting the files. This command is
                   6733:     executed in the <code class="filename">${WRKSRC}</code>
                   6734:     directory. During execution of this command, the shell
                   6735:     variable <code class="varname">extract_file</code> holds the absolute
                   6736:     pathname of the file that is going to be extracted.</p>
1.75      rillig   6737: <p>And if that still does not suffice, you can override the
1.88      wiz      6738:     <code class="varname">do-extract</code> target in the package
                   6739:     Makefile.</p>
1.75      rillig   6740: </div>
                   6741: <div class="sect1" lang="en">
                   6742: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6743: <a name="build.patch"></a>16.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75      rillig   6744: <p>After extraction, all the patches named by the
1.88      wiz      6745:     <code class="varname">PATCHFILES</code>, those present in the patches
                   6746:     subdirectory of the package as well as in
                   6747:     $LOCALPATCHES/$PKGPATH (e.g.
                   6748:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   6749:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   6750:     <code class="filename">.gz</code> are uncompressed before they are
                   6751:     applied, files ending in <code class="filename">.orig</code> or
                   6752:     <code class="filename">.rej</code> are ignored. Any special options to
                   6753:     <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   6754:     <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      6755: <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
                   6756:     it fail if the patches apply with some lines of fuzz. Please
                   6757:     fix (regen) the patches so that they apply cleanly. The
                   6758:     rationale behind this is that patches that don't apply cleanly
                   6759:     may end up being applied in the wrong place, and cause severe
                   6760:     harm there.</p>
1.75      rillig   6761: </div>
                   6762: <div class="sect1" lang="en">
                   6763: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6764: <a name="build.tools"></a>16.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
                   6765: <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      6766:     </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.wrapper"></a>16.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75      rillig   6771: <p>This phase creates wrapper programs for the compilers and
1.88      wiz      6772:     linkers. The following variables can be used to tweak the
                   6773:     wrappers.</p>
1.75      rillig   6774: <div class="variablelist"><dl>
                   6775: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   6776: <dd><p>The command used to print progress
1.88      wiz      6777:       messages. Does nothing by default. Set to
                   6778:       <code class="literal">${ECHO}</code> to see the progress
                   6779:       messages.</p></dd>
1.75      rillig   6780: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   6781: <dd><p>This variable can be set to
1.88      wiz      6782:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   6783:       depending on whether you want additional information in the
                   6784:       wrapper log file.</p></dd>
1.75      rillig   6785: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   6786: <dd><p>This variable can be set to
1.88      wiz      6787:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   6788:       on whether the wrapper should use its cache, which will
                   6789:       improve the speed. The default value is
                   6790:       <code class="literal">yes</code>, but is forced to
                   6791:       <code class="literal">no</code> if the platform does not support
                   6792:       it.</p></dd>
1.75      rillig   6793: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88      wiz      6794: <dd><p>A list of reordering commands. A reordering
                   6795:       command has the form
                   6796:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   6797:       It ensures that that
                   6798:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   6799:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   6800:       </p></dd>
1.75      rillig   6801: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
                   6802: <dd><p>A list of transformation commands. [TODO:
1.88      wiz      6803:       investigate further]</p></dd>
1.75      rillig   6804: </dl></div>
                   6805: </div>
                   6806: <div class="sect1" lang="en">
                   6807: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6808: <a name="build.configure"></a>16.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88      wiz      6809: <p>Most pieces of software need information on the header
                   6810:     files, system calls, and library routines which are available
                   6811:     on the platform they run on. The process of determining this
                   6812:     information is known as configuration, and is usually
                   6813:     automated. In most cases, a script is supplied with the
                   6814:     distfiles, and its invocation results in generation of header
                   6815:     files, Makefiles, etc.</p>
                   6816: <p>If the package contains a configure script, this can be
                   6817:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
                   6818:     &#8220;<span class="quote">yes</span>&#8221;. If the configure script is a GNU autoconf
                   6819:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
                   6820:     &#8220;<span class="quote">yes</span>&#8221; instead. What happens in the
                   6821:     <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
                   6822: <pre class="programlisting">
                   6823:       .for d in ${CONFIGURE_DIRS}
                   6824:       cd ${WRKSRC} &amp;&amp; cd ${d} &amp;&amp; env ${CONFIGURE_ENV} \
                   6825:       ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
                   6826:       .endfor
                   6827:     </pre>
                   6828: <p><code class="varname">CONFIGURE_DIRS</code> (default:
                   6829:     &#8220;<span class="quote">.</span>&#8221;) is a list of pathnames relative to
                   6830:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   6831:     configure script is run with the environment
                   6832:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   6833:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   6834:     <code class="varname">CONFIGURE_ENV</code>,
                   6835:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
                   6836:     &#8220;<span class="quote">./configure</span>&#8221;) and
                   6837:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   6838:     package.</p>
                   6839: <p>If the program uses an <code class="filename">Imakefile</code>
                   6840:     for configuration, the appropriate steps can be invoked by
                   6841:     setting <code class="varname">USE_IMAKE</code> to
                   6842:     &#8220;<span class="quote">yes</span>&#8221;. (If you only want the package installed in
                   6843:     <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
                   6844:     <code class="varname">USE_X11BASE</code> instead.)</p>
1.75      rillig   6845: </div>
                   6846: <div class="sect1" lang="en">
                   6847: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6848: <a name="build.build"></a>16.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88      wiz      6849: <p>For building a package, a rough equivalent of the
                   6850:     following code is executed.</p>
1.75      rillig   6851: <pre class="programlisting">
1.88      wiz      6852:       .for d in ${BUILD_DIRS}
                   6853:       cd ${WRKSRC} &amp;&amp; cd ${d} &amp;&amp; env ${MAKE_ENV} \
                   6854:       ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
                   6855:       -f ${MAKE_FILE} ${BUILD_TARGET}
                   6856:       .endfor
                   6857:     </pre>
                   6858: <p><code class="varname">BUILD_DIRS</code> (default:
                   6859:     &#8220;<span class="quote">.</span>&#8221;) is a list of pathnames relative to
                   6860:     <code class="varname">WRKSRC</code>. In each of these directories,
                   6861:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   6862:     <code class="varname">MAKE_ENV</code> and arguments
                   6863:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   6864:     <code class="varname">MAKE_ENV</code>,
                   6865:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   6866:     <code class="varname">MAKE_FILE</code> and
                   6867:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   6868:     package.</p>
1.75      rillig   6869: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.88      wiz      6870:     &#8220;<span class="quote">gmake</span>&#8221; if <code class="varname">USE_TOOLS</code> contains
                   6871:     &#8220;<span class="quote">gmake</span>&#8221;, &#8220;<span class="quote">make</span>&#8221; otherwise. The
                   6872:     default value of <code class="varname">MAKE_FILE</code> is
                   6873:     &#8220;<span class="quote">Makefile</span>&#8221;, and <code class="varname">BUILD_TARGET</code>
                   6874:     defaults to &#8220;<span class="quote">all</span>&#8221;.</p>
1.75      rillig   6875: </div>
                   6876: <div class="sect1" lang="en">
                   6877: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6878: <a name="build.test"></a>16.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75      rillig   6879: <p>[TODO]</p>
                   6880: </div>
                   6881: <div class="sect1" lang="en">
                   6882: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6883: <a name="build.install"></a>16.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75      rillig   6884: <p>Once the build stage has completed, the final step is to
1.88      wiz      6885:     install the software in public directories, so users can
                   6886:     access the programs and files.</p>
1.75      rillig   6887: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88      wiz      6888:     equivalent of the following code is executed. Additionally,
                   6889:     before and after this code, much magic is performed to do
                   6890:     consistency checks, registering the package, and so on.</p>
                   6891: <pre class="programlisting">
                   6892:       .for d in ${INSTALL_DIRS}
                   6893:       cd ${WRKSRC} &amp;&amp; cd ${d} &amp;&amp; env ${MAKE_ENV} \
                   6894:       ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
                   6895:       -f ${MAKE_FILE} ${BUILD_TARGET}
                   6896:       .endfor
                   6897:     </pre>
1.75      rillig   6898: <p>The variable's meanings are analogous to the ones in the
1.88      wiz      6899:     <span class="emphasis"><em>build</em></span> phase.
                   6900:     <code class="varname">INSTALL_DIRS</code> defaults to
                   6901:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
                   6902:     is &#8220;<span class="quote">install</span>&#8221; by default, plus
                   6903:     &#8220;<span class="quote">install.man</span>&#8221; if <code class="varname">USE_IMAKE</code> is
                   6904:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   6905:     defined.</p>
1.75      rillig   6906: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88      wiz      6907:     variables are useful. They are all variations of the
                   6908:     <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
                   6909:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   6910:     install command. The specialized variants, together with their
                   6911:     intended use, are:</p>
1.75      rillig   6912: <div class="variablelist"><dl>
                   6913: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88      wiz      6914: <dd><p>directories that contain
                   6915:       binaries</p></dd>
1.75      rillig   6916: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88      wiz      6917: <dd><p>directories that contain
                   6918:       scripts</p></dd>
1.75      rillig   6919: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88      wiz      6920: <dd><p>directories that contain shared and static
                   6921:       libraries</p></dd>
1.75      rillig   6922: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88      wiz      6923: <dd><p>directories that contain data
                   6924:       files</p></dd>
1.75      rillig   6925: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88      wiz      6926: <dd><p>directories that contain man
                   6927:       pages</p></dd>
1.75      rillig   6928: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88      wiz      6929: <dd><p>binaries that can be stripped from debugging
                   6930:       symbols</p></dd>
1.75      rillig   6931: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88      wiz      6932: <dd><p>binaries that cannot be
                   6933:       stripped</p></dd>
1.75      rillig   6934: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88      wiz      6935: <dd><p>game
                   6936:       binaries</p></dd>
1.75      rillig   6937: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88      wiz      6938: <dd><p>shared and static
                   6939:       libraries</p></dd>
1.75      rillig   6940: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   6941: <dd><p>data files</p></dd>
                   6942: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88      wiz      6943: <dd><p>data files for
                   6944:       games</p></dd>
1.75      rillig   6945: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   6946: <dd><p>man pages</p></dd>
                   6947: </dl></div>
                   6948: <p>Some other variables are:</p>
                   6949: <div class="variablelist"><dl>
                   6950: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   6951: <dd><p>A list of directories relative to
1.88      wiz      6952:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
                   6953:       beginning of the <span class="emphasis"><em>install</em></span> phase.  If
                   6954:       this variable is set,
                   6955:       <code class="varname">NO_MTREE</code>=&#8220;<span class="quote">yes</span>&#8221; is assumed,
                   6956:       which means that the package claims to create all needed
                   6957:       directories itself before installing files to it. Therefore
                   6958:       this variable should only be set in
                   6959:       <code class="filename">Makefile</code>s that are under control of the
                   6960:       package's author. The directories are created with the
                   6961:       correct ownership, depending on their
                   6962:       name.</p></dd>
1.75      rillig   6963: </dl></div>
                   6964: </div>
                   6965: <div class="sect1" lang="en">
                   6966: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6967: <a name="build.package"></a>16.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88      wiz      6968: <p>Once the install stage has completed, a binary package of
                   6969:     the installed files can be built.  These binary packages can be
                   6970:     used for quick installation without previous compilation, e.g. by
                   6971:     the <span><strong class="command">make bin-install</strong></span> or by using
                   6972:     <span><strong class="command">pkg_add</strong></span>.</p>
                   6973: <p>By default, the binary packages are created in
                   6974:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   6975:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   6976:     one for each category in the <code class="varname">CATEGORIES</code>
                   6977:     variable.  <code class="varname">PACKAGES</code> defaults to
                   6978:     <code class="filename">pkgsrc/packages</code>.</p>
                   6979: </div>
                   6980: <div class="sect1" lang="en">
                   6981: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6982: <a name="build.clean"></a>16.16. Cleaning up</h2></div></div></div>
1.88      wiz      6983: <p>Once you're finished with a package, you can clean the work
                   6984:     directory by running <span><strong class="command">make clean</strong></span>.  If you want
                   6985:     to clean the work directories of all dependencies too, use
                   6986:     <span><strong class="command">make clean-depends</strong></span>.</p>
1.75      rillig   6987: </div>
                   6988: <div class="sect1" lang="en">
                   6989: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6990: <a name="build.helpful-targets"></a>16.17. Other helpful targets</h2></div></div></div>
1.75      rillig   6991: <div class="variablelist"><dl>
                   6992: <dt><span class="term">pre/post-*</span></dt>
1.88      wiz      6993: <dd><p>For any of the main targets described in the
                   6994:          previous section, two auxiliary targets exist with
1.87      wiz      6995:          &#8220;<span class="quote">pre-</span>&#8221; and &#8220;<span class="quote">post-</span>&#8221; used as a
                   6996:          prefix for the main target's name.  These targets are
1.88      wiz      6997:          invoked before and after the main target is called,
                   6998:          allowing extra configuration or installation steps be
                   6999:          performed from a package's Makefile, for example, which
                   7000:          a program's configure script or install target
                   7001:          omitted.</p></dd>
1.75      rillig   7002: <dt><span class="term">do-*</span></dt>
1.88      wiz      7003: <dd><p>Should one of the main targets do the wrong thing,
                   7004:          and should there be no variable to fix this, you can
                   7005:          redefine it with the do-* target.  (Note that redefining
                   7006:          the target itself instead of the do-* target is a bad
                   7007:          idea, as the pre-* and post-* targets won't be called
                   7008:          anymore, etc.) You will not usually need to do
                   7009:          this.</p></dd>
1.75      rillig   7010: <dt><span class="term">reinstall</span></dt>
1.88      wiz      7011: <dd>
                   7012: <p>If you did a <span><strong class="command">make install</strong></span> and
                   7013:          you noticed some file was not installed properly, you
                   7014:          can repeat the installation with this target, which will
                   7015:          ignore the &#8220;<span class="quote">already installed</span>&#8221; flag.</p>
                   7016: <p>This is the default value of
                   7017:          <code class="varname">DEPENDS_TARGET</code> except in the case of
                   7018:          <span><strong class="command">make update</strong></span> and <span><strong class="command">make
                   7019:          package</strong></span>, where the defaults are
                   7020:          &#8220;<span class="quote">package</span>&#8221; and &#8220;<span class="quote">update</span>&#8221;,
                   7021:          respectively.</p>
                   7022: </dd>
1.75      rillig   7023: <dt><span class="term">deinstall</span></dt>
                   7024: <dd>
1.88      wiz      7025: <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
                   7026:          current directory, effectively de-installing the
                   7027:          package. The following variables can be used to tune the
                   7028:          behaviour:</p>
1.75      rillig   7029: <div class="variablelist"><dl>
                   7030: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
                   7031: <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>
                   7032: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88      wiz      7033: <dd><p>Remove all packages that require (depend on)
                   7034:                the given package.  This can be used to remove any
                   7035:                packages that may have been pulled in by a given
                   7036:                package, e.g. if <span><strong class="command">make deinstall
1.87      wiz      7037:                DEINSTALLDEPENDS=1</strong></span> is done in
1.88      wiz      7038:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   7039:                likely to remove whole KDE. Works by adding
                   7040:                &#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>
                   7041:                command line.</p></dd>
1.75      rillig   7042: </dl></div>
                   7043: </dd>
1.88      wiz      7044: <dt><span class="term">bin-install</span></dt>
                   7045: <dd><p>Install a binary package from local disk and via FTP
                   7046:          from a list of sites (see the
                   7047:          <code class="varname">BINPKG_SITES</code> variable), and do a
                   7048:          <span><strong class="command">make package</strong></span> if no binary package is
                   7049:          available anywhere.  The arguments given to
                   7050:          <span><strong class="command">pkg_add</strong></span> can be set via
                   7051:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   7052:          operation, etc.</p></dd>
1.75      rillig   7053: <dt><span class="term">update</span></dt>
                   7054: <dd>
1.88      wiz      7055: <p>This target causes the current package to be
                   7056:          updated to the latest version.  The package and all
                   7057:          depending packages first get de-installed, then current
                   7058:          versions of the corresponding packages get compiled and
                   7059:          installed.  This is similar to manually noting which
                   7060:          packages are currently installed, then performing a
                   7061:          series of <span><strong class="command">make deinstall</strong></span> and
                   7062:          <span><strong class="command">make install</strong></span> (or whatever
                   7063:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   7064:          packages.</p>
                   7065: <p>You can use the &#8220;<span class="quote">update</span>&#8221; target to
                   7066:          resume package updating in case a previous <span><strong class="command">make
                   7067:          update</strong></span> was interrupted for some reason.
                   7068:          However, in this case, make sure you don't call
                   7069:          <span><strong class="command">make clean</strong></span> or otherwise remove the
                   7070:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   7071:          Otherwise, you lose the ability to automatically update
                   7072:          the current package along with the dependent packages
                   7073:          you have installed.</p>
                   7074: <p>Resuming an interrupted <span><strong class="command">make
                   7075:          update</strong></span> will only work as long as the package
                   7076:          tree remains unchanged.  If the source code for one of
                   7077:          the packages to be updated has been changed, resuming
                   7078:          <span><strong class="command">make update</strong></span> will most certainly
                   7079:          fail!</p>
                   7080: <p>The following variables can be used either on the
                   7081:          command line or in <code class="filename">/etc/mk.conf</code> to
                   7082:          alter the behaviour of <span><strong class="command">make
                   7083:          update</strong></span>:</p>
1.75      rillig   7084: <div class="variablelist"><dl>
                   7085: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88      wiz      7086: <dd><p>Install target to recursively use for the
                   7087:                updated package and the dependent packages.
                   7088:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
                   7089:                set, &#8220;<span class="quote">install</span>&#8221; otherwise for
                   7090:                <span><strong class="command">make update</strong></span>.  Other good
                   7091:                targets are &#8220;<span class="quote">package</span>&#8221; or
                   7092:                &#8220;<span class="quote">bin-install</span>&#8221;.  Do not set this to
                   7093:                &#8220;<span class="quote">update</span>&#8221; or you will get stuck in an
                   7094:                endless loop!</p></dd>
1.75      rillig   7095: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88      wiz      7096: <dd><p>Don't clean up after updating.  Useful if
                   7097:                you want to leave the work sources of the updated
                   7098:                packages around for inspection or other purposes.
                   7099:                Be sure you eventually clean up the source tree
                   7100:                (see the &#8220;<span class="quote">clean-update</span>&#8221; target below)
                   7101:                or you may run into troubles with old source code
                   7102:                still lying around on your next
                   7103:                <span><strong class="command">make</strong></span> or <span><strong class="command">make
                   7104:                update</strong></span>.</p></dd>
1.75      rillig   7105: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88      wiz      7106: <dd><p>Deinstall each package before installing
                   7107:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   7108:                may be necessary if the
                   7109:                &#8220;<span class="quote">clean-update</span>&#8221; target (see below) was
                   7110:                called after interrupting a running <span><strong class="command">make
                   7111:                update</strong></span>.</p></dd>
1.75      rillig   7112: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88      wiz      7113: <dd><p>Allows you to disable recursion and hardcode
                   7114:                the target for packages.  The default is
                   7115:                &#8220;<span class="quote">update</span>&#8221; for the update target,
                   7116:                facilitating a recursive update of prerequisite
                   7117:                packages.  Only set
                   7118:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   7119:                disable recursive updates. Use
                   7120:                <code class="varname">UPDATE_TARGET</code> instead to just
                   7121:                set a specific target for each package to be
                   7122:                installed during <span><strong class="command">make update</strong></span>
                   7123:                (see above).</p></dd>
1.75      rillig   7124: </dl></div>
                   7125: </dd>
                   7126: <dt><span class="term">clean-update</span></dt>
                   7127: <dd>
1.88      wiz      7128: <p>Clean the source tree for all packages that would
                   7129:          get updated if <span><strong class="command">make update</strong></span> was called
                   7130:          from the current directory.  This target should not be
                   7131:          used if the current package (or any of its depending
                   7132:          packages) have already been de-installed (e.g., after
                   7133:          calling <span><strong class="command">make update</strong></span>) or you may lose
                   7134:          some packages you intended to update. As a rule of
                   7135:          thumb: only use this target <span class="emphasis"><em>before</em></span>
                   7136:          the first time you run <span><strong class="command">make update</strong></span>
                   7137:          and only if you have a dirty package tree (e.g., if you
                   7138:          used <code class="varname">NOCLEAN</code>).</p>
                   7139: <p>If you are unsure about whether your tree is
                   7140:          clean, you can either perform a <span><strong class="command">make
                   7141:          clean</strong></span> at the top of the tree, or use the
                   7142:          following sequence of commands from the directory of the
                   7143:          package you want to update (<span class="emphasis"><em>before</em></span>
                   7144:          running <span><strong class="command">make update</strong></span> for the first
                   7145:          time, otherwise you lose all the packages you wanted to
                   7146:          update!):</p>
1.87      wiz      7147: <pre class="screen">
                   7148: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75      rillig   7149: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87      wiz      7150: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   7151:          </pre>
1.88      wiz      7152: <p>The following variables can be used either on the
                   7153:          command line or in <code class="filename">/etc/mk.conf</code> to
                   7154:          alter the behaviour of <span><strong class="command">make
                   7155:          clean-update</strong></span>:</p>
1.75      rillig   7156: <div class="variablelist"><dl>
                   7157: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.88      wiz      7158: <dd><p>After <span><strong class="command">make clean</strong></span>, do not
                   7159:                reconstruct the list of directories to update for
                   7160:                this package.  Only use this if <span><strong class="command">make
                   7161:                update</strong></span> successfully installed all
                   7162:                packages you wanted to update.  Normally, this is
                   7163:                done automatically on <span><strong class="command">make
                   7164:                update</strong></span>, but may have been suppressed by
                   7165:                the <code class="varname">NOCLEAN</code> variable (see
                   7166:                above).</p></dd>
1.75      rillig   7167: </dl></div>
                   7168: </dd>
1.88      wiz      7169: <dt><span class="term">replace</span></dt>
                   7170: <dd>
                   7171: <p>Update the installation of the current package.  This
                   7172:          differs from update in that it does not replace dependent
1.93      rillig   7173:          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      7174:          target to work.</p>
                   7175: <p><span class="emphasis"><em>Be careful when using this
                   7176:          target!</em></span> There are no guarantees that dependent
                   7177:          packages will still work, in particular they will most
                   7178:          certainly break if you <span><strong class="command">make replace</strong></span> a
                   7179:          library package whose shared library major version changed
                   7180:          between your installed version and the new one.  For this
                   7181:          reason, this target is not officially supported and only
                   7182:          recommended for advanced users.</p>
                   7183: </dd>
1.75      rillig   7184: <dt><span class="term">info</span></dt>
                   7185: <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      7186:          package. You can use this to check which version of a
                   7187:          package is installed.</p></dd>
                   7188: <dt><span class="term">index</span></dt>
                   7189: <dd>
                   7190: <p>This is a top-level command, i.e. it should be used in
                   7191:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   7192:          database of all packages in the local pkgsrc tree, including
                   7193:          dependencies, comment, maintainer, and some other useful
                   7194:          information.  Individual entries are created by running
                   7195:          <span><strong class="command">make describe</strong></span> in the packages'
                   7196:          directories.  This index file is saved as
                   7197:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
                   7198:          verbose format by running <span><strong class="command">make
                   7199:          print-index</strong></span>.  You can search in it with
                   7200:          <span><strong class="command">make search
                   7201:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   7202:          extract a list of all packages that depend on a particular
                   7203:          one by running <span><strong class="command">make show-deps
                   7204:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   7205: <p>Running this command takes a very long time, some
                   7206:          hours even on fast machines!</p>
                   7207: </dd>
1.75      rillig   7208: <dt><span class="term">readme</span></dt>
1.88      wiz      7209: <dd>
                   7210: <p>This target generates a
                   7211:          <code class="filename">README.html</code> file, which can be
1.91      rillig   7212:          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      7213:          contain references to any packages which are in the
                   7214:          <code class="varname">PACKAGES</code> directory on the local
                   7215:          host. The generated files can be made to refer to URLs
                   7216:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   7217:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
                   7218:          wanted to generate <code class="filename">README.html</code>
                   7219:          files which pointed to binary packages on the local
                   7220:          machine, in the directory
                   7221:          <code class="filename">/usr/packages</code>, set
                   7222:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   7223:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   7224:          <code class="varname">${PACKAGES}</code> directory and its
                   7225:          subdirectories will be searched for all the binary
                   7226:          packages.</p>
                   7227: <p>The target can be run at the toplevel or in category
                   7228:          directories, in which case it descends recursively.</p>
                   7229: </dd>
1.75      rillig   7230: <dt><span class="term">readme-all</span></dt>
1.88      wiz      7231: <dd><p>This is a top-level command, run it in
                   7232:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   7233:          file <code class="filename">README-all.html</code> which contains a
                   7234:          list of all packages currently available in the NetBSD
                   7235:          Packages Collection, together with the category they belong
                   7236:          to and a short description. This file is compiled from the
                   7237:          <code class="filename">pkgsrc/*/README.html</code> files, so be sure
                   7238:          to run this <span class="emphasis"><em>after</em></span> a <span><strong class="command">make
                   7239:          readme</strong></span>.</p></dd>
1.75      rillig   7240: <dt><span class="term">cdrom-readme</span></dt>
1.88      wiz      7241: <dd><p>This is very much the same as the
                   7242:          &#8220;<span class="quote">readme</span>&#8221; target (see above), but is to be
                   7243:          used when generating a pkgsrc tree to be written to a
                   7244:          CD-ROM.  This target also produces
                   7245:          <code class="filename">README.html</code> files, and can be made
                   7246:          to refer to URLs based on
                   7247:          <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87      wiz      7248:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75      rillig   7249: <dt><span class="term">show-distfiles</span></dt>
1.88      wiz      7250: <dd><p>This target shows which distfiles and patchfiles
                   7251:          are needed to build the package
                   7252:          (<code class="varname">ALLFILES</code>, which contains all
                   7253:          <code class="varname">DISTFILES</code> and
1.87      wiz      7254:          <code class="varname">PATCHFILES</code>, but not
                   7255:          <code class="filename">patches/*</code>).</p></dd>
1.75      rillig   7256: <dt><span class="term">show-downlevel</span></dt>
1.88      wiz      7257: <dd><p>This target shows nothing if the package is not
                   7258:          installed. If a version of this package is installed,
                   7259:          but is not the version provided in this version of
                   7260:          pkgsrc, then a warning message is displayed. This target
                   7261:          can be used to show which of your installed packages are
                   7262:          downlevel, and so the old versions can be deleted, and
                   7263:          the current ones added.</p></dd>
1.75      rillig   7264: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88      wiz      7265: <dd><p>This target shows the directory in the pkgsrc
                   7266:          hierarchy from which the package can be built and
                   7267:          installed. This may not be the same directory as the one
                   7268:          from which the package was installed. This target is
                   7269:          intended to be used by people who may wish to upgrade
                   7270:          many packages on a single host, and can be invoked from
                   7271:          the top-level pkgsrc Makefile by using the
1.87      wiz      7272:          &#8220;<span class="quote">show-host-specific-pkgs</span>&#8221; target.</p></dd>
1.75      rillig   7273: <dt><span class="term">show-installed-depends</span></dt>
1.88      wiz      7274: <dd><p>This target shows which installed packages match
                   7275:          the current package's <code class="varname">DEPENDS</code>. Useful
                   7276:          if out of date dependencies are causing build
                   7277:          problems.</p></dd>
1.75      rillig   7278: <dt><span class="term">check-shlibs</span></dt>
1.88      wiz      7279: <dd><p>After a package is installed, check all its
                   7280:          binaries and (on ELF platforms) shared libraries to see
                   7281:          if they find the shared libs they need.  Run by default
                   7282:          if <code class="varname">PKG_DEVELOPER</code> is set in
1.87      wiz      7283:          <code class="filename">/etc/mk.conf</code>.</p></dd>
1.75      rillig   7284: <dt><span class="term">print-PLIST</span></dt>
                   7285: <dd>
                   7286: <p>After a &#8220;<span class="quote">make install</span>&#8221; from a new or
1.88      wiz      7287:          upgraded pkg, this prints out an attempt to generate a
                   7288:          new <code class="filename">PLIST</code> from a <span><strong class="command">find
                   7289:          -newer work/.extract_done</strong></span>.  An attempt is made
                   7290:          to care for shared libs etc., but it is
1.87      wiz      7291:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   7292:          result before putting it into
                   7293:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   7294:          diff the output of this command against an already
                   7295:          existing <code class="filename">PLIST</code> file.</p>
1.88      wiz      7296: <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
                   7297:          other methods that don't update file access times, be
                   7298:          sure to add these files manually to your
1.87      wiz      7299:          <code class="filename">PLIST</code>, as the &#8220;<span class="quote">find
                   7300:          -newer</span>&#8221; command used by this target won't catch
                   7301:          them!</p>
1.90      rillig   7302: <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      7303:          information on this target.</p>
1.75      rillig   7304: </dd>
                   7305: <dt><span class="term">bulk-package</span></dt>
                   7306: <dd>
1.88      wiz      7307: <p>Used to do bulk builds. If an appropriate binary
                   7308:          package already exists, no action is taken. If not, this
                   7309:          target will compile, install and package it (and its
                   7310:          depends, if <code class="varname">PKG_DEPENDS</code> is set
                   7311:          properly. See <a href="#binary.configuration" title="6.3.1. Configuration">Section 6.3.1, &#8220;Configuration&#8221;</a>).
                   7312:          After creating the binary package, the sources, the
                   7313:          just-installed package and its required packages are
                   7314:          removed, preserving free disk space.</p>
                   7315: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7316:          all packages installed on a system!</em></span></p>
1.75      rillig   7317: </dd>
                   7318: <dt><span class="term">bulk-install</span></dt>
                   7319: <dd>
1.88      wiz      7320: <p>Used during bulk-installs to install required
                   7321:          packages. If an up-to-date binary package is available,
                   7322:          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,
                   7323:          <span><strong class="command">make bulk-package</strong></span> will be executed,
1.87      wiz      7324:          but the installed binary won't be removed.</p>
1.88      wiz      7325: <p>A binary package is considered
                   7326:          &#8220;<span class="quote">up-to-date</span>&#8221; to be installed via
                   7327:          <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>
                   7328: <div class="itemizedlist"><ul type="disc">
                   7329: <li><p>None of the package's files
                   7330:              (<code class="filename">Makefile</code>, ...) were modified
                   7331:              since it was built.</p></li>
                   7332: <li><p>None of the package's required (binary)
                   7333:              packages were modified since it was built.</p></li>
1.75      rillig   7334: </ul></div>
1.88      wiz      7335: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7336:          all packages installed on a system!</em></span></p>
1.75      rillig   7337: </dd>
                   7338: </dl></div>
                   7339: </div>
                   7340: </div>
                   7341: <div class="chapter" lang="en">
                   7342: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   7343: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.75      rillig   7344: <div class="toc">
                   7345: <p><b>Table of Contents</b></p>
                   7346: <dl>
1.90      rillig   7347: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                   7348: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                   7349: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.75      rillig   7350: </dl>
                   7351: </div>
1.87      wiz      7352: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75      rillig   7353: by pkgsrc and also for individual packages to define what commands
                   7354: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
                   7355: or for later run-time of an installed packaged (such as
                   7356: <code class="varname">DEPENDS</code>).
                   7357: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87      wiz      7358: package will not be used.</p>
                   7359: <p>When building a package, the replacement tools are
1.75      rillig   7360: made available in a directory (as symlinks or wrapper scripts)
                   7361: that is early in the executable search path. Just like the buildlink
1.87      wiz      7362: system, this helps with consistent builds.</p>
                   7363: <p>A tool may be needed to help build a specific package. For example,
                   7364: perl, GNU make (gmake) or yacc may be needed.</p>
                   7365: <p>Also a tool may be needed, for example, because the native system's supplied
1.75      rillig   7366: tool may be inefficient for building a package with pkgsrc.
                   7367: For example, a package may need GNU awk, bison (instead of
1.87      wiz      7368: yacc) or a better sed.</p>
                   7369: <p>The tools used by a package can be listed by running
                   7370: <span><strong class="command">make show-tools</strong></span>.</p>
1.75      rillig   7371: <div class="sect1" lang="en">
                   7372: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   7373: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
1.87      wiz      7374: <p>The default set of tools used by pkgsrc is defined in
1.76      rillig   7375: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.75      rillig   7376: such as: <span><strong class="command">cat</strong></span>, <span><strong class="command">awk</strong></span>,
                   7377: <span><strong class="command">chmod</strong></span>, <span><strong class="command">test</strong></span>, and so on.
                   7378: These can be seen by running:
1.87      wiz      7379: <span><strong class="command">make show-var VARNAME=USE_TOOLS</strong></span>.</p>
                   7380: <p>If a package needs a specific program to build
1.75      rillig   7381: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87      wiz      7382: to define the tools needed.</p>
1.75      rillig   7383: </div>
                   7384: <div class="sect1" lang="en">
                   7385: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   7386: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
1.87      wiz      7387: <p>In the following examples, the :pkgsrc means to use the pkgsrc version
1.75      rillig   7388: and not the native version for a build dependency.
                   7389: And the :run means that it is used for a
                   7390: run-time dependencies also (and becomes a DEPENDS).
                   7391: The default is a build dependency which can be set with
                   7392: :build. (So in this example, it is the same as gmake:build
1.87      wiz      7393: and pkg-config:build.)</p>
1.75      rillig   7394: <pre class="programlisting">
                   7395: USE_TOOLS+=     mktemp:pkgsrc
                   7396: USE_TOOLS+=     gmake perl:run pkg-config
                   7397: </pre>
1.87      wiz      7398: <p>When using the tools framework, a
1.75      rillig   7399: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   7400: which contains the full path to the appropriate tool. For example,
                   7401: <code class="varname">TOOLS_PATH.bash</code> could be &#8220;<span class="quote">/bin/bash</span>&#8221;
1.87      wiz      7402: on Linux systems.</p>
                   7403: <p>If you always need a pkgsrc version of the
1.75      rillig   7404: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   7405: </p>
                   7406: </div>
                   7407: <div class="sect1" lang="en">
                   7408: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   7409: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
1.87      wiz      7410: <p>When improving or porting pkgsrc to a new platform, have a look
1.75      rillig   7411: at (or create) the corresponding platform specific make file fragment under
1.76      rillig   7412: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75      rillig   7413: the name of the common tools. For example:</p>
                   7414: <pre class="programlisting">
                   7415: .if exists(/usr/bin/bzcat)
                   7416: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   7417: .elif exists(/usr/bin/bzip2)
                   7418: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   7419: .endif
1.69      rillig   7420: 
1.75      rillig   7421: TOOLS_PLATFORM.true?=           true                    # shell builtin
                   7422: </pre>
                   7423: </div>
                   7424: </div>
                   7425: <div class="chapter" lang="en">
                   7426: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   7427: <a name="fixes"></a>Chapter 18. Making your package work</h2></div></div></div>
1.75      rillig   7428: <div class="toc">
                   7429: <p><b>Table of Contents</b></p>
                   7430: <dl>
1.90      rillig   7431: <dt><span class="sect1"><a href="#general-operation">18.1. General operation</a></span></dt>
1.75      rillig   7432: <dd><dl>
1.90      rillig   7433: <dt><span class="sect2"><a href="#portability-of-packages">18.1.1. Portability of packages</a></span></dt>
                   7434: <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>
                   7435: <dt><span class="sect2"><a href="#user-interaction">18.1.3. User interaction</a></span></dt>
                   7436: <dt><span class="sect2"><a href="#handling-licenses">18.1.4. Handling licenses</a></span></dt>
                   7437: <dt><span class="sect2"><a href="#restricted-packages">18.1.5. Restricted packages</a></span></dt>
                   7438: <dt><span class="sect2"><a href="#dependencies">18.1.6. Handling dependencies</a></span></dt>
                   7439: <dt><span class="sect2"><a href="#conflicts">18.1.7. Handling conflicts with other packages</a></span></dt>
                   7440: <dt><span class="sect2"><a href="#not-building-packages">18.1.8. Packages that cannot or should not be built</a></span></dt>
                   7441: <dt><span class="sect2"><a href="#undeletable-packages">18.1.9. Packages which should not be deleted, once installed</a></span></dt>
                   7442: <dt><span class="sect2"><a href="#security-handling">18.1.10. Handling packages with security problems</a></span></dt>
                   7443: <dt><span class="sect2"><a href="#bumping-pkgrevision">18.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   7444: <dt><span class="sect2"><a href="#fixes.subst">18.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   7445: </dl></dd>
                   7446: <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>
                   7447: <dd><dl>
                   7448: <dt><span class="sect2"><a href="#no-plain-download">18.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   7449: <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>
                   7450: </dl></dd>
                   7451: <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>
                   7452: <dd><dl>
                   7453: <dt><span class="sect2"><a href="#fixes.libtool">18.3.1. Shared libraries - libtool</a></span></dt>
                   7454: <dt><span class="sect2"><a href="#using-libtool">18.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   7455: <dt><span class="sect2"><a href="#autoconf-automake">18.3.3. GNU Autoconf/Automake</a></span></dt>
                   7456: </dl></dd>
                   7457: <dt><span class="sect1"><a href="#programming-languages">18.4. Programming languages</a></span></dt>
                   7458: <dd><dl>
                   7459: <dt><span class="sect2"><a href="#basic-programming-languages">18.4.1. C, C++, and Fortran</a></span></dt>
                   7460: <dt><span class="sect2"><a href="#java-programming-language">18.4.2. Java</a></span></dt>
                   7461: <dt><span class="sect2"><a href="#perl-scripts">18.4.3. Packages containing perl scripts</a></span></dt>
                   7462: <dt><span class="sect2"><a href="#other-programming-languages">18.4.4. Other programming languages</a></span></dt>
                   7463: </dl></dd>
                   7464: <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>
                   7465: <dd><dl>
                   7466: <dt><span class="sect2"><a href="#fixes.build.cpp">18.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   7467: <dt><span class="sect2"><a href="#compiler-bugs">18.5.2. How to handle compiler bugs</a></span></dt>
                   7468: <dt><span class="sect2"><a href="#undefined-reference">18.5.3. Undefined reference to &#8220;<span class="quote">...</span>&#8221;</a></span></dt>
                   7469: <dt><span class="sect2"><a href="#out-of-memory">18.5.4. Running out of memory</a></span></dt>
                   7470: </dl></dd>
                   7471: <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>
                   7472: <dd><dl>
                   7473: <dt><span class="sect2"><a href="#install-scripts">18.6.1. Creating needed directories</a></span></dt>
                   7474: <dt><span class="sect2"><a href="#where-to-install-documentation">18.6.2. Where to install documentation</a></span></dt>
                   7475: <dt><span class="sect2"><a href="#installing-score-files">18.6.3. Installing score files</a></span></dt>
                   7476: <dt><span class="sect2"><a href="#hardcoded-paths">18.6.4. Packages with hardcoded paths to other interpreters</a></span></dt>
                   7477: <dt><span class="sect2"><a href="#perl-modules">18.6.5. Packages installing perl modules</a></span></dt>
                   7478: <dt><span class="sect2"><a href="#faq.info-files">18.6.6. Packages installing info files</a></span></dt>
                   7479: <dt><span class="sect2"><a href="#manpages">18.6.7. Packages installing man pages</a></span></dt>
                   7480: <dt><span class="sect2"><a href="#gconf2-data-files">18.6.8. Packages installing GConf2 data files</a></span></dt>
                   7481: <dt><span class="sect2"><a href="#scrollkeeper-data-files">18.6.9. Packages installing scrollkeeper data files</a></span></dt>
                   7482: <dt><span class="sect2"><a href="#x11-fonts">18.6.10. Packages installing X11 fonts</a></span></dt>
                   7483: <dt><span class="sect2"><a href="#gtk2-modules">18.6.11. Packages installing GTK2 modules</a></span></dt>
                   7484: <dt><span class="sect2"><a href="#sgml-xml-data">18.6.12. Packages installing SGML or XML data</a></span></dt>
                   7485: <dt><span class="sect2"><a href="#mime-database">18.6.13. Packages installing extensions to the MIME database</a></span></dt>
                   7486: <dt><span class="sect2"><a href="#intltool">18.6.14. Packages using intltool</a></span></dt>
                   7487: <dt><span class="sect2"><a href="#startup-scripts">18.6.15. Packages installing startup scripts</a></span></dt>
                   7488: <dt><span class="sect2"><a href="#tex-packages">18.6.16. Packages installing TeX modules</a></span></dt>
                   7489: <dt><span class="sect2"><a href="#emulation-packages">18.6.17. Packages supporting running binaries in
1.87      wiz      7490:     emulation</a></span></dt>
1.90      rillig   7491: <dt><span class="sect2"><a href="#hicolor-theme">18.6.18. Packages installing hicolor theme icons</a></span></dt>
                   7492: <dt><span class="sect2"><a href="#desktop-files">18.6.19. Packages installing desktop files</a></span></dt>
1.75      rillig   7493: </dl></dd>
1.90      rillig   7494: <dt><span class="sect1"><a href="#punting">18.7. Marking packages as having problems</a></span></dt>
1.75      rillig   7495: </dl>
                   7496: </div>
                   7497: <div class="sect1" lang="en">
                   7498: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   7499: <a name="general-operation"></a>18.1. General operation</h2></div></div></div>
1.75      rillig   7500: <div class="sect2" lang="en">
                   7501: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   7502: <a name="portability-of-packages"></a>18.1.1. Portability of packages</h3></div></div></div>
1.78      rillig   7503: <p>One appealing feature of pkgsrc is that it runs on many
1.87      wiz      7504:     different platforms. As a result, it is important to ensure,
                   7505:     where possible, that packages in pkgsrc are portable. This
                   7506:     chapter mentions some particular details you should pay
                   7507:     attention to while working on pkgsrc.</p>
1.78      rillig   7508: </div>
                   7509: <div class="sect2" lang="en">
                   7510: <div class="titlepage"><div><div><h3 class="title">
1.93      rillig   7511: <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>
                   7512: </h3></div></div></div>
1.78      rillig   7513: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87      wiz      7514:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
                   7515:     which is <code class="filename">/etc/mk.conf</code> by default. When you
                   7516:     want to use those variables in the preprocessor directives of
                   7517:     <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
                   7518:     <code class="literal">.for</code>), you need to include the file
                   7519:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   7520:     loads the user preferences.</p>
1.78      rillig   7521: <p>But note that some variables may not be completely defined
1.87      wiz      7522:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
                   7523:     included, as they may contain references to variables that are
                   7524:     not yet defined. In shell commands this is no problem, since
                   7525:     variables are actually macros, which are only expanded when they
                   7526:     are used. But in the preprocessor directives mentioned above and
                   7527:     in dependency lines (of the form <code class="literal">target:
                   7528:     dependencies</code>) the variables are expanded at load
                   7529:     time.</p>
1.78      rillig   7530: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   7531: <h3 class="title">Note</h3>
                   7532: <p>Currently there is no exhaustive list of all
1.87      wiz      7533:     variables that tells you whether they can be used at load time
                   7534:     or only at run time, but it is in preparation.</p>
1.78      rillig   7535: </div>
                   7536: </div>
                   7537: <div class="sect2" lang="en">
                   7538: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   7539: <a name="user-interaction"></a>18.1.3. User interaction</h3></div></div></div>
1.88      wiz      7540: <p>Occasionally, packages require interaction from the user,
                   7541:     and this can be in a number of ways:</p>
1.78      rillig   7542: <div class="itemizedlist"><ul type="disc">
1.79      rillig   7543: <li><p>When fetching the distfiles, some packages require user
1.87      wiz      7544:        interaction such as entering username/password or accepting a
                   7545:        license on a web page.</p></li>
1.88      wiz      7546: <li><p>When extracting the distfiles, some packages may ask for
                   7547:        passwords.</p></li>
1.78      rillig   7548: <li><p>help to configure the package before it is built</p></li>
                   7549: <li><p>help during the build process</p></li>
                   7550: <li><p>help during the installation of a package</p></li>
                   7551: </ul></div>
1.88      wiz      7552: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
                   7553:     provided to notify the pkgsrc mechanism of an interactive stage
                   7554:     which will be needed, and this should be set in the package's
                   7555:     <code class="filename">Makefile</code>, e.g.:</p>
1.75      rillig   7556: <pre class="programlisting">
1.87      wiz      7557:       INTERACTIVE_STAGE=      build
                   7558:     </pre>
1.78      rillig   7559: <p>Multiple interactive stages can be specified:</p>
1.75      rillig   7560: <pre class="programlisting">
1.87      wiz      7561:       INTERACTIVE_STAGE=      configure install
                   7562:     </pre>
1.88      wiz      7563: <p>The user can then decide to skip this package by setting the
                   7564:     <code class="varname">BATCH</code> variable.</p>
1.75      rillig   7565: </div>
                   7566: <div class="sect2" lang="en">
                   7567: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   7568: <a name="handling-licenses"></a>18.1.4. Handling licenses</h3></div></div></div>
1.78      rillig   7569: <p>A package may be covered by a license which the user has
1.87      wiz      7570:     or has not agreed to accept.  For these cases, pkgsrc contains
                   7571:     a mechanism to note that a package is covered by a particular
                   7572:     license, and the package cannot be built unless the user has
                   7573:     accepted the license.  (Installation of binary packages are
                   7574:     not currently subject to this mechanism.)  Packages with
                   7575:     licenses that are either Open Source according to the Open
                   7576:     Source Initiative or Free according to the Free Software
                   7577:     Foundation will not be marked with a license tag.  Packages
                   7578:     with licenses that have not been determined to meet either
                   7579:     definition will be marked with a license tag referring to the
                   7580:     license.  This will prevent building unless pkgsrc is informed
                   7581:     that the license is acceptable, and enables displaying the
                   7582:     license.</p>
1.78      rillig   7583: <p>The license tag mechanism is intended to address
1.87      wiz      7584:     copyright-related issues surrounding building, installing and
                   7585:     using a package, and not to address redistribution issues (see
                   7586:     <code class="varname">RESTRICTED</code> and
                   7587:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).  However, the above
                   7588:     definition of licenses for which tags are not needed implies
                   7589:     that packages with redistribution restrictions should have
                   7590:     tags.</p>
                   7591: <p>Denoting that a package is covered by a particular license
                   7592:     is done by placing the license in
                   7593:     <code class="filename">pkgsrc/licenses</code> and setting the
                   7594:     <code class="varname">LICENSE</code> variable to a string identifying the
1.91      rillig   7595:     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      7596: <pre class="programlisting">
                   7597:       LICENSE=        xv-license
                   7598:     </pre>
                   7599: <p>When trying to build, the user will get a notice that the
                   7600:     package is covered by a license which has not been
                   7601:     accepted:</p>
                   7602: <pre class="programlisting">
                   7603:       <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   7604:       ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
                   7605:       ===&gt;     To view the license, enter "/usr/bin/make show-license".
                   7606:       ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
                   7607:       ===&gt;     ACCEPTABLE_LICENSES+=xv-license
                   7608:       *** Error code 1
                   7609:     </pre>
1.78      rillig   7610: <p>The license can be viewed with <span><strong class="command">make
1.87      wiz      7611:     show-license</strong></span>, and if it is considered appropriate,
                   7612:     the line printed above can be added to
                   7613:     <code class="filename">/etc/mk.conf</code> to indicate acceptance of
                   7614:     the particular license:</p>
1.78      rillig   7615: <pre class="programlisting">
1.87      wiz      7616:       ACCEPTABLE_LICENSES+=xv-license
                   7617:     </pre>
1.78      rillig   7618: <p>When adding a package with a new license, the license
1.87      wiz      7619:     text should be added to <code class="filename">pkgsrc/licenses</code>
                   7620:     for displaying. A list of known licenses can be seen in this
1.91      rillig   7621:     directory.</p>
1.78      rillig   7622: <p>The use of <code class="varname">LICENSE=shareware</code>,
1.87      wiz      7623:     <code class="varname">LICENSE=no-commercial-use</code>, and similar
                   7624:     language is deprecated because it does not crisply refer to
                   7625:     a particular license text.  Another problem with such usage
                   7626:     is that it does not enable a user to denote acceptance of
                   7627:     the license for a single package without accepting the same
                   7628:     license text for another package.  In particular, this can
                   7629:     be inappropriate when e.g. one accepts a particular license to
                   7630:     indicate to pkgsrc that a fee has been paid.</p>
1.75      rillig   7631: </div>
                   7632: <div class="sect2" lang="en">
                   7633: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   7634: <a name="restricted-packages"></a>18.1.5. Restricted packages</h3></div></div></div>
1.75      rillig   7635: <p>Some licenses restrict how software may be re-distributed.
1.87      wiz      7636:     In order to satisfy these restrictions, the package system
                   7637:     defines five make variables that can be set to note these
                   7638:     restrictions:</p>
1.75      rillig   7639: <div class="itemizedlist"><ul type="disc">
                   7640: <li>
                   7641: <p><code class="varname">RESTRICTED</code></p>
                   7642: <p>This variable should be set whenever a restriction
1.87      wiz      7643:        exists (regardless of its kind).  Set this variable to a
                   7644:        string containing the reason for the restriction.</p>
1.75      rillig   7645: </li>
                   7646: <li>
                   7647: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
                   7648: <p>Binaries may not be placed on CD-ROM.  Set this
1.87      wiz      7649:        variable to <code class="varname">${RESTRICTED}</code> whenever a
                   7650:        binary package may not be included on a CD-ROM.</p>
1.75      rillig   7651: </li>
                   7652: <li>
                   7653: <p><code class="varname">NO_BIN_ON_FTP</code></p>
                   7654: <p>Binaries may not be placed on an FTP server.  Set
1.87      wiz      7655:        this variable to <code class="varname">${RESTRICTED}</code>
1.93      rillig   7656:        whenever a binary package may not be made available
1.87      wiz      7657:        on the Internet.</p>
1.75      rillig   7658: </li>
                   7659: <li>
                   7660: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
                   7661: <p>Distfiles may not be placed on CD-ROM.  Set this
1.87      wiz      7662:        variable to <code class="varname">${RESTRICTED}</code> if
                   7663:        re-distribution of the source code or other distfile(s) is
                   7664:        not allowed on CD-ROMs.</p>
1.75      rillig   7665: </li>
                   7666: <li>
                   7667: <p><code class="varname">NO_SRC_ON_FTP</code></p>
                   7668: <p>Distfiles may not be placed on FTP.  Set this variable
1.87      wiz      7669:        to <code class="varname">${RESTRICTED}</code> if re-distribution of
                   7670:        the source code or other distfile(s) via the Internet is not
                   7671:        allowed.  If this variable is not set, the distfile(s) will
                   7672:        be mirrored on ftp.NetBSD.org.</p>
1.75      rillig   7673: </li>
                   7674: </ul></div>
                   7675: <p>Please note that the use of <code class="varname">NO_PACKAGE</code>,
1.87      wiz      7676:     <code class="varname">IGNORE</code>, <code class="varname">NO_CDROM</code>, or other
                   7677:     generic make variables to denote restrictions is deprecated,
                   7678:     because they unconditionally prevent users from generating
                   7679:     binary packages!</p>
1.75      rillig   7680: </div>
                   7681: <div class="sect2" lang="en">
                   7682: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   7683: <a name="dependencies"></a>18.1.6. Handling dependencies</h3></div></div></div>
1.75      rillig   7684: <p>Your package may depend on some other package being present
1.88      wiz      7685:     - and there are various ways of expressing this dependency.
                   7686:     pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
                   7687:     <code class="varname">DEPENDS</code> definitions, the
                   7688:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   7689:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   7690:     to handle dependencies, and which uses the variables named above.
1.90      rillig   7691:     See <a href="#buildlink" title="Chapter 13. Buildlink methodology">Chapter 13, <i>Buildlink methodology</i></a> for more information.</p>
1.75      rillig   7692: <p>The basic difference between the two variables is as
1.87      wiz      7693:     follows: The <code class="varname">DEPENDS</code> definition registers
                   7694:     that pre-requisite in the binary package so it will be pulled in
                   7695:     when the binary package is later installed, whilst the
                   7696:     <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
                   7697:     dependency that is only needed for building the package.</p>
1.75      rillig   7698: <p>This means that if you only need a package present whilst
1.87      wiz      7699:     you are building, it should be noted as a
                   7700:     <code class="varname">BUILD_DEPENDS</code>.</p>
1.75      rillig   7701: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87      wiz      7702:     <code class="varname">DEPENDS</code> definition is:</p>
1.75      rillig   7703: <pre class="programlisting">
1.87      wiz      7704:       &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
                   7705:     </pre>
1.75      rillig   7706: <p>Please note that the &#8220;<span class="quote">pre-req-package-name</span>&#8221;
1.87      wiz      7707:     may include any of the wildcard version numbers recognized by
                   7708:     <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   7709: <div class="orderedlist"><ol type="1">
                   7710: <li>
                   7711: <p>If your package needs another package's binaries or
1.87      wiz      7712:        libraries to build or run, and if that package has a
                   7713:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75      rillig   7714: <pre class="programlisting">
1.87      wiz      7715:          .include "../../graphics/jpeg/buildlink3.mk"
                   7716:        </pre>
1.75      rillig   7717: </li>
                   7718: <li>
                   7719: <p>If your package needs to use another package to build
1.87      wiz      7720:        itself and there is no <code class="filename">buildlink3.mk</code>
                   7721:        file available, use the <code class="varname">BUILD_DEPENDS</code>
                   7722:        definition:</p>
1.75      rillig   7723: <pre class="programlisting">
1.87      wiz      7724:          BUILD_DEPENDS+= autoconf-2.13:../../devel/autoconf
                   7725:        </pre>
1.75      rillig   7726: </li>
                   7727: <li>
                   7728: <p>If your package needs a library with which to link and
1.76      rillig   7729:        again there is no <code class="filename">buildlink3.mk</code> file
1.87      wiz      7730:        available, this is specified using the
                   7731:        <code class="varname">DEPENDS</code> definition. For example:</p>
1.75      rillig   7732: <pre class="programlisting">
1.87      wiz      7733:          DEPENDS+=       xpm-3.4j:../../graphics/xpm
                   7734:        </pre>
1.75      rillig   7735: <p>You can also use wildcards in package dependences:</p>
                   7736: <pre class="programlisting">
1.87      wiz      7737:          DEPENDS+=       xpm-[0-9]*:../../graphics/xpm
                   7738:        </pre>
1.75      rillig   7739: <p>Note that such wildcard dependencies are retained when
1.87      wiz      7740:        creating binary packages.  The dependency is checked when
                   7741:        installing the binary package and any package which matches
                   7742:        the pattern will be used.  Wildcard dependencies should be
                   7743:        used with care.</p>
1.75      rillig   7744: <p>The &#8220;<span class="quote">-[0-9]*</span>&#8221; should be used instead of
1.87      wiz      7745:        &#8220;<span class="quote">-*</span>&#8221; to avoid potentially ambiguous matches
                   7746:        such as &#8220;<span class="quote">tk-postgresql</span>&#8221; matching a
                   7747:        &#8220;<span class="quote">tk-*</span>&#8221; <code class="varname">DEPENDS</code>.</p>
1.75      rillig   7748: <p>Wildcards can also be used to specify that a package
1.87      wiz      7749:        will only build against a certain minimum version of a
                   7750:        pre-requisite:</p>
1.75      rillig   7751: <pre class="programlisting">
1.87      wiz      7752:          DEPENDS+=       tiff&gt;=3.5.4:../../graphics/tiff
                   7753:        </pre>
1.75      rillig   7754: <p>This means that the package will build against version
1.87      wiz      7755:        3.5.4 of the tiff library or newer.  Such a dependency may
                   7756:        be warranted if, for example, the API of the library has
                   7757:        changed with version 3.5.4 and a package would not compile
                   7758:        against an earlier version of tiff.</p>
1.75      rillig   7759: <p>Please note that such dependencies should only be
1.87      wiz      7760:        updated if a package requires a newer pre-requisite, but
1.93      rillig   7761:        not to denote recommendations such as
1.87      wiz      7762:        ABI changes that do not prevent a package from building
                   7763:        correctly.  Such recommendations can be expressed using
                   7764:        <code class="varname">ABI_DEPENDS</code>:</p>
1.75      rillig   7765: <pre class="programlisting">
1.87      wiz      7766:          ABI_DEPENDS+=   tiff&gt;=3.6.1:../../graphics/tiff
                   7767:        </pre>
1.75      rillig   7768: <p>In addition to the above <code class="varname">DEPENDS</code>
1.87      wiz      7769:        line, this denotes that while a package will build against
                   7770:        tiff&gt;=3.5.4, at least version 3.6.1 is recommended.
                   7771:        <code class="varname">ABI_DEPENDS</code> entries will be turned into
                   7772:        dependencies unless explicitly ignored (in which case a
                   7773:        warning will be printed).</p>
1.75      rillig   7774: <p>To ignore these ABI dependency recommendations and just
1.87      wiz      7775:        use the required <code class="varname">DEPENDS</code>, set
                   7776:        <code class="varname">USE_ABI_DEPENDS=NO</code>.   This may make
                   7777:        it easier and faster to update packages built using pkgsrc,
                   7778:        since older compatible dependencies can continue to be
                   7779:        used. This is useful for people who watch their rebuilds
                   7780:        very carefully; it is not very good as a general-purpose
                   7781:        hammer.  If you use it, you need to be mindful of possible
                   7782:        ABI changes, including those from the underlying OS.</p>
1.75      rillig   7783: <p>Packages that are built with recommendations ignored
1.87      wiz      7784:        may not be uploaded to ftp.NetBSD.org by developers and
                   7785:        should not be used across different systems that may have
                   7786:        different versions of binary packages installed.</p>
1.75      rillig   7787: <p>For security fixes, please update the package
1.90      rillig   7788:        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      7789:        information.</p>
1.75      rillig   7790: </li>
                   7791: <li>
                   7792: <p>If your package needs some executable to be able to run
1.87      wiz      7793:        correctly and if there's no
                   7794:        <code class="filename">buildlink3.mk</code> file, this is specified
                   7795:        using the <code class="varname">DEPENDS</code> variable. The
1.91      rillig   7796:        <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      7797:        be able to execute the latex binary from the teTeX package
                   7798:        when it runs, and that is specified:</p>
1.75      rillig   7799: <pre class="programlisting">
1.87      wiz      7800:          DEPENDS+=        teTeX-[0-9]*:../../print/teTeX
                   7801:        </pre>
1.75      rillig   7802: <p>The comment about wildcard dependencies from previous
1.87      wiz      7803:        paragraph applies here, too.</p>
1.75      rillig   7804: </li>
                   7805: </ol></div>
                   7806: <p>If your package needs files from another package to build,
1.87      wiz      7807:     add the relevant distribution files to
                   7808:     <code class="varname">DISTFILES</code>, so they will be extracted
1.91      rillig   7809:     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      7810:     (It relies on the jpeg sources being present in source form
                   7811:     during the build.)</p>
1.88      wiz      7812: <p>Please also note the
                   7813:     <code class="varname">BUILD_USES_GETTEXT_M4</code> definition, which is
                   7814:     provided as convenience definition.  It adds a build dependency on
                   7815:     either an installed version of an older gettext package, or if it
1.91      rillig   7816:     isn't, installs the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/gettext-m4/README.html" target="_top"><code class="filename">devel/gettext-m4</code></a> package.</p>
1.75      rillig   7817: </div>
                   7818: <div class="sect2" lang="en">
                   7819: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   7820: <a name="conflicts"></a>18.1.7. Handling conflicts with other packages</h3></div></div></div>
1.75      rillig   7821: <p>Your package may conflict with other packages a user might
1.87      wiz      7822:     already have installed on his system, e.g. if your package
1.88      wiz      7823:     installs the same set of files as another package in the pkgsrc
                   7824:     tree.</p>
1.75      rillig   7825: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
1.87      wiz      7826:     space-separated list of packages (including version string) your
                   7827:     package conflicts with.</p>
1.91      rillig   7828: <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>
                   7829:     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      7830:     install the same shared library, thus you set in
                   7831:     <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
                   7832: <pre class="programlisting">
                   7833:       CONFLICTS=      Xaw-Xpm-[0-9]*
                   7834:     </pre>
                   7835: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
1.75      rillig   7836: <pre class="programlisting">
1.87      wiz      7837:       CONFLICTS=      Xaw3d-[0-9]*
                   7838:     </pre>
1.75      rillig   7839: <p>Packages will automatically conflict with other packages
1.87      wiz      7840:     with the name prefix and a different version
                   7841:     string. &#8220;<span class="quote">Xaw3d-1.5</span>&#8221; e.g. will automatically
                   7842:     conflict with the older version &#8220;<span class="quote">Xaw3d-1.3</span>&#8221;.</p>
1.75      rillig   7843: </div>
                   7844: <div class="sect2" lang="en">
                   7845: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   7846: <a name="not-building-packages"></a>18.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.75      rillig   7847: <p>There are several reasons why a package might be
1.88      wiz      7848:     instructed to not build under certain circumstances.  If the
1.87      wiz      7849:     package builds and runs on most platforms, the exceptions
                   7850:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
                   7851:     the package builds and runs on a small handful of platforms,
                   7852:     set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
                   7853:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   7854:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   7855:     (OS-version-platform) that can use glob-style
                   7856:     wildcards.</p>
1.88      wiz      7857: <p>Some packages are tightly bound to a specific version of an
1.91      rillig   7858:     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      7859:     backwards compatible with other versions of the OS, and should be
                   7860:     uploaded to a version specific directory on the FTP server.  Mark
                   7861:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
                   7862:     &#8220;<span class="quote">yes</span>&#8221;.  This variable is not currently used by any of
                   7863:     the package system internals, but may be used in the
                   7864:     future.</p>
1.75      rillig   7865: <p>If the package should be skipped (for example, because it
1.87      wiz      7866:     provides functionality already provided by the system), set
1.88      wiz      7867:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   7868:     the package should fail because some preconditions are not met,
                   7869:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87      wiz      7870:     message.</p>
1.75      rillig   7871: </div>
                   7872: <div class="sect2" lang="en">
                   7873: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   7874: <a name="undeletable-packages"></a>18.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.75      rillig   7875: <p>To ensure that a package may not be deleted, once it has been
1.87      wiz      7876:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   7877:     be set in the package Makefile. This will be carried into any
                   7878:     binary package that is made from this pkgsrc entry. A
                   7879:     &#8220;<span class="quote">preserved</span>&#8221; package will
                   7880:     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
                   7881:     &#8220;<span class="quote">-f</span>&#8221; option is used.</p>
1.75      rillig   7882: </div>
                   7883: <div class="sect2" lang="en">
                   7884: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   7885: <a name="security-handling"></a>18.1.10. Handling packages with security problems</h3></div></div></div>
1.75      rillig   7886: <p>When a vulnerability is found, this should be noted in
1.87      wiz      7887:     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
                   7888:     and after committing that file, use <span><strong class="command">make upload</strong></span>
                   7889:     in the same directory to update the file on ftp.NetBSD.org.</p>
1.75      rillig   7890: <p>After fixing the vulnerability by a patch, its
1.87      wiz      7891:     <code class="varname">PKGREVISION</code> should be increased (this
                   7892:     is of course not necessary if the problem is fixed by using
                   7893:     a newer release of the software).</p>
1.75      rillig   7894: <p>Also, if the fix should be applied to the stable pkgsrc
1.87      wiz      7895:     branch, be sure to submit a pullup request!</p>
1.75      rillig   7896: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87      wiz      7897:     semi-automatically by a weekly cron job.</p>
1.75      rillig   7898: </div>
                   7899: <div class="sect2" lang="en">
                   7900: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   7901: <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   7902: <p>When making fixes to an existing package it can be useful
1.87      wiz      7903:     to change the version number in <code class="varname">PKGNAME</code>. To
                   7904:     avoid conflicting with future versions by the original author, a
                   7905:     &#8220;<span class="quote">nb1</span>&#8221;, &#8220;<span class="quote">nb2</span>&#8221;, ... suffix can be used
                   7906:     on package versions by setting <code class="varname">PKGREVISION=1</code>
                   7907:     (2, ...). The &#8220;<span class="quote">nb</span>&#8221; is treated like a
                   7908:     &#8220;<span class="quote">.</span>&#8221; by the package tools. e.g.</p>
                   7909: <pre class="programlisting">
                   7910:       DISTNAME=       foo-17.42
                   7911:       PKGREVISION=    9
                   7912:     </pre>
1.75      rillig   7913: <p>will result in a <code class="varname">PKGNAME</code> of
1.87      wiz      7914:     &#8220;<span class="quote">foo-17.42nb9</span>&#8221;. If you want to use the original
                   7915:     value of <code class="varname">PKGNAME</code> without the &#8220;<span class="quote">nbX</span>&#8221;
                   7916:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   7917:     <code class="varname">PKGNAME_NOREV</code>.</p>
1.75      rillig   7918: <p>When a new release of the package is released, the
1.87      wiz      7919:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   7920:     minor release of the above package, things should be like:</p>
1.75      rillig   7921: <pre class="programlisting">
1.87      wiz      7922:       DISTNAME=       foo-17.43
                   7923:     </pre>
                   7924: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   7925:     non-trivial change in the resulting binary package.  Without a
                   7926:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   7927:     version installed has no way of knowing that their package is out
                   7928:     of date.  Thus, changes without increasing
                   7929:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   7930:     trivial that no reasonable person would want to upgrade", and this
                   7931:     is the rough test for when increasing
                   7932:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   7933:     changes that do not merit increasing
                   7934:     <code class="varname">PKGREVISION</code> are:</p>
                   7935: <pre class="programlisting">
                   7936:       Changing <code class="varname">HOMEPAGE</code>, <code class="varname">MAINTAINER</code>,
                   7937:       or comments in Makefile.
                   7938:       Changing build variables if the resulting binary package is the same.
                   7939:       Changing <code class="filename">DESCR</code>.
                   7940:       Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.
                   7941:     </pre>
                   7942: <p>Examples of changes that do merit an increase to
                   7943:     <code class="varname">PKGREVISION</code> include:</p>
                   7944: <pre class="programlisting">
                   7945:       Security fixes
                   7946:       Changes or additions to a patch file
                   7947:       Changes to the <code class="filename">PLIST</code>
                   7948:     </pre>
1.78      rillig   7949: <p>PKGREVISION must also be incremented when dependencies have ABI
                   7950:     changes.</p>
1.75      rillig   7951: </div>
1.79      rillig   7952: <div class="sect2" lang="en">
                   7953: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   7954: <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   7955: <p>When you want to replace the same text in multiple files
1.87      wiz      7956:     or when the replacement text varies, patches alone cannot help.
                   7957:     This is where the SUBST framework comes in. It provides an
                   7958:     easy-to-use interface for replacing text in files.
                   7959:     Example:</p>
                   7960: <pre class="programlisting">
                   7961:       SUBST_CLASSES+=                 fix-paths
                   7962:       SUBST_STAGE.fix-paths=          pre-configure
                   7963:       SUBST_MESSAGE.fix-paths=        Fixing absolute paths.
                   7964:       SUBST_FILES.fix-paths=          src/*.c
                   7965:       SUBST_FILES.fix-paths+=         scripts/*.sh
                   7966:       SUBST_SED.fix-paths=            -e 's,"/usr/local,"${PREFIX},g'
                   7967:       SUBST_SED.fix-paths+=           -e 's,"/var/log,"${VARBASE}/log,g'
                   7968:     </pre>
1.79      rillig   7969: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87      wiz      7970:     that are used to identify the different SUBST blocks that are
                   7971:     defined. The SUBST framework is heavily used by pkgsrc, so it is
                   7972:     important to always use the <code class="literal">+=</code> operator with
                   7973:     this variable. Otherwise some substitutions may be
                   7974:     skipped.</p>
1.79      rillig   7975: <p>The remaining variables of each SUBST block are
1.87      wiz      7976:     parameterized with the identifier from the first line
                   7977:     (<code class="literal">fix-paths</code> in this case.) They can be seen as
                   7978:     parameters to a function call.</p>
1.79      rillig   7979: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87      wiz      7980:     which the replacement will take place. All combinations of
                   7981:     <code class="literal">pre-</code>, <code class="literal">do-</code> and
                   7982:     <code class="literal">post-</code> together with a phase name are
                   7983:     possible, though only few are actually used. Most commonly used
                   7984:     are <code class="literal">post-patch</code> and
                   7985:     <code class="literal">pre-configure</code>. Of these two,
                   7986:     <code class="literal">pre-configure</code> should be preferred because
                   7987:     then it is possible to run <span><strong class="command">bmake patch</strong></span> and
                   7988:     have the state after applying the patches but before making any
                   7989:     other changes. This is especially useful when you are debugging
                   7990:     a package in order to create new patches for it. Similarly,
                   7991:     <code class="literal">post-build</code> is preferred over
                   7992:     <code class="literal">pre-install</code>, because the install phase should
                   7993:     generally be kept as simple as possible. When you use
                   7994:     <code class="literal">post-build</code>, you have the same files in the
                   7995:     working directory that will be installed later, so you can check
                   7996:     if the substitution has succeeded.</p>
1.79      rillig   7997: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87      wiz      7998:     that is printed just before the substitution is done.</p>
1.79      rillig   7999: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87      wiz      8000:     globbing patterns that specifies the files in which the
                   8001:     substitution will take place. The patterns are interpreted
                   8002:     relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79      rillig   8003: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.87      wiz      8004:     <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
                   8005:     command should be prefixed with <code class="literal">-e</code>, so that
                   8006:     all SUBST blocks look uniform.</p>
1.79      rillig   8007: <p>There are some more variables, but they are so seldomly
1.87      wiz      8008:     used that they are only documented in the
                   8009:     <code class="filename">mk/subst.mk</code> file.</p>
1.79      rillig   8010: </div>
1.75      rillig   8011: </div>
                   8012: <div class="sect1" lang="en">
                   8013: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   8014: <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   8015: <div class="sect2" lang="en">
                   8016: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8017: <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   8018: <p>If you need to download from a dynamic URL you can set
1.87      wiz      8019:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span><strong class="command">make
                   8020:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   8021:     with the name of each file to download as an argument, expecting
                   8022:     it to output the URL of the directory from which to download
1.91      rillig   8023:     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      8024:     example of this usage.</p>
1.75      rillig   8025: <p>If the download can't be automated, because the user must
1.87      wiz      8026:     submit personal information to apply for a password, or must pay
                   8027:     for the source, or whatever, you can set
                   8028:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   8029:     displayed to the user before aborting the build. Example:</p>
                   8030: <pre class="programlisting">
                   8031:       FETCH_MESSAGE=  "Please download the files"
                   8032:       FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   8033:       FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
                   8034:     </pre>
1.75      rillig   8035: </div>
                   8036: <div class="sect2" lang="en">
                   8037: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8038: <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   8039: <p>Sometimes authors of a software package make some
1.87      wiz      8040:     modifications after the software was released, and they put up a
                   8041:     new distfile without changing the package's version number. If a
                   8042:     package is already in pkgsrc at that time, the checksum will
                   8043:     no longer match. The contents of the new distfile should be
                   8044:     compared against the old one before changing anything, to make
                   8045:     sure the distfile was really updated on purpose, and that
                   8046:     no trojan horse or so crept in.
                   8047:     Then, the correct way to work around this is to
                   8048:     set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
                   8049:     usually based on <code class="varname">PKGNAME_NOREV</code>. All
                   8050:     <code class="varname">DISTFILES</code> and
1.93      rillig   8051:     <code class="varname">PATCHFILES</code> for this package will be put in that
1.87      wiz      8052:     subdirectory of the local distfiles directory.  In case this
                   8053:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
                   8054:     including the <code class="filename">nbX</code> suffix) or a date stamp
                   8055:     can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
                   8056:     Do not forget regenerating the <code class="filename">distinfo</code> file
                   8057:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   8058:     path in the filenames.
                   8059:     Furthermore, a mail to the package's authors seems appropriate
                   8060:     telling them that changing distfiles after releases without
                   8061:     changing the file names is not good practice.</p>
1.75      rillig   8062: </div>
                   8063: </div>
                   8064: <div class="sect1" lang="en">
                   8065: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   8066: <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   8067: <div class="sect2" lang="en">
                   8068: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8069: <a name="fixes.libtool"></a>18.3.1. Shared libraries - libtool</h3></div></div></div>
1.75      rillig   8070: <p>pkgsrc supports many different machines, with different
1.87      wiz      8071:     object formats like a.out and ELF, and varying abilities to do
                   8072:     shared library and dynamic loading at all. To accompany this,
                   8073:     varying commands and options have to be passed to the
                   8074:     compiler, linker, etc. to get the Right Thing, which can be
                   8075:     pretty annoying especially if you don't have all the machines
                   8076:     at your hand to test things.  The
1.91      rillig   8077:     <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      8078:     can help here, as it just &#8220;<span class="quote">knows</span>&#8221; how to build
                   8079:     both static and dynamic libraries from a set of source files,
                   8080:     thus being platform-independent.</p>
                   8081: <p>Here's how to use libtool in a package in seven simple
                   8082:     steps:</p>
1.75      rillig   8083: <div class="orderedlist"><ol type="1">
                   8084: <li><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87      wiz      8085:        Makefile.</p></li>
1.75      rillig   8086: <li><p>For library objects, use &#8220;<span class="quote">${LIBTOOL} --mode=compile
1.87      wiz      8087:        ${CC}</span>&#8221; in place of &#8220;<span class="quote">${CC}</span>&#8221;. You could even
                   8088:        add it to the definition of <code class="varname">CC</code>, if only
                   8089:        libraries are being built in a given Makefile. This one command
                   8090:        will build both PIC and non-PIC library objects, so you need not
                   8091:        have separate shared and non-shared library rules.</p></li>
1.75      rillig   8092: <li>
                   8093: <p>For the linking of the library, remove any
1.87      wiz      8094:        &#8220;<span class="quote">ar</span>&#8221;, &#8220;<span class="quote">ranlib</span>&#8221;, and &#8220;<span class="quote">ld
                   8095:        -Bshareable</span>&#8221; commands, and instead use:</p>
1.75      rillig   8096: <pre class="programlisting">
1.87      wiz      8097:          ${LIBTOOL} --mode=link ${CC} -o ${.TARGET:.a=.la} ${OBJS:.o=.lo} \
                   8098:          -rpath ${PREFIX}/lib -version-info major:minor
                   8099:        </pre>
1.75      rillig   8100: <p>Note that the library is changed to have a
1.87      wiz      8101:        <code class="filename">.la</code> extension, and the objects are
                   8102:        changed to have a <code class="filename">.lo</code>
                   8103:        extension. Change <code class="varname">OBJS</code> as
                   8104:        necessary. This automatically creates all of the
                   8105:        <code class="filename">.a</code>,
                   8106:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   8107:        necessary) in the build directory. Be sure to include
                   8108:        &#8220;<span class="quote">-version-info</span>&#8221;, especially when major and
                   8109:        minor are zero, as libtool will otherwise strip off the
                   8110:        shared library version.</p>
1.75      rillig   8111: <p>From the libtool manual:</p>
                   8112: <pre class="programlisting">
1.87      wiz      8113:          So, libtool library versions are described by three integers:
1.69      rillig   8114: 
1.87      wiz      8115:          CURRENT
                   8116:          The most recent interface number that this library implements.
1.69      rillig   8117: 
1.87      wiz      8118:          REVISION
                   8119:          The implementation number of the CURRENT interface.
1.69      rillig   8120: 
1.87      wiz      8121:          AGE
                   8122:          The difference between the newest and oldest interfaces that
                   8123:          this library implements.  In other words, the library implements
                   8124:          all the interface numbers in the range from number `CURRENT -
                   8125:          AGE' to `CURRENT'.
1.1       grant    8126: 
1.87      wiz      8127:          If two libraries have identical CURRENT and AGE numbers, then the
                   8128:          dynamic linker chooses the library with the greater REVISION number.
                   8129:        </pre>
1.75      rillig   8130: <p>The &#8220;<span class="quote">-release</span>&#8221; option will produce
1.87      wiz      8131:        different results for a.out and ELF (excluding symlinks)
                   8132:        in only one case. An ELF library of the form
                   8133:        &#8220;<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;
                   8134:        will have a symlink of
                   8135:        &#8220;<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;
                   8136:        on an a.out platform. This is handled
                   8137:        automatically.</p>
1.75      rillig   8138: <p>The &#8220;<span class="quote">-rpath argument</span>&#8221; is the install
1.87      wiz      8139:        directory of the library being built.</p>
1.76      rillig   8140: <p>In the <code class="filename">PLIST</code>, include only the
1.87      wiz      8141:        <code class="filename">.la</code> file, the other files will be
                   8142:        added automatically.</p>
1.75      rillig   8143: </li>
                   8144: <li>
1.76      rillig   8145: <p>When linking shared object (<code class="filename">.so</code>)
1.87      wiz      8146:        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
                   8147:        shared libraries, use &#8220;<span class="quote">-module
                   8148:        -avoid-version</span>&#8221; to prevent them getting version
                   8149:        tacked on.</p>
1.76      rillig   8150: <p>The <code class="filename">PLIST</code> file gets the
1.87      wiz      8151:        <code class="filename">foo.so</code> entry.</p>
1.75      rillig   8152: </li>
                   8153: <li>
                   8154: <p>When linking programs that depend on these libraries
1.87      wiz      8155:        <span class="emphasis"><em>before</em></span> they are installed, preface
                   8156:        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}
                   8157:        --mode=link</span>&#8221;, and it will find the correct
                   8158:        libraries (static or shared), but please be aware that
                   8159:        libtool will not allow you to specify a relative path in
                   8160:        -L (such as &#8220;<span class="quote">-L../somelib</span>&#8221;), because it
                   8161:        expects you to change that argument to be the
                   8162:        <code class="filename">.la</code> file. e.g.</p>
1.75      rillig   8163: <pre class="programlisting">
1.87      wiz      8164:          ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
                   8165:        </pre>
1.75      rillig   8166: <p>should be changed to:</p>
                   8167: <pre class="programlisting">
1.87      wiz      8168:          ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
                   8169:        </pre>
1.75      rillig   8170: <p>and it will do the right thing with the libraries.</p>
                   8171: </li>
                   8172: <li>
                   8173: <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      8174:        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}
                   8175:        --mode=install</span>&#8221;, and change the library name to
                   8176:        <code class="filename">.la</code>. e.g.</p>
1.75      rillig   8177: <pre class="programlisting">
1.87      wiz      8178:          ${LIBTOOL} --mode=install ${BSD_INSTALL_DATA} ${SOMELIB:.a=.la} ${PREFIX}/lib
                   8179:        </pre>
1.76      rillig   8180: <p>This will install the static <code class="filename">.a</code>,
1.87      wiz      8181:        shared library, any needed symlinks, and run
                   8182:        <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   8183: </li>
1.76      rillig   8184: <li><p>In your <code class="filename">PLIST</code>, include only
1.87      wiz      8185:        the <code class="filename">.la</code>
                   8186:        file (this is a change from previous behaviour).</p></li>
1.75      rillig   8187: </ol></div>
                   8188: </div>
                   8189: <div class="sect2" lang="en">
                   8190: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8191: <a name="using-libtool"></a>18.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75      rillig   8192: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87      wiz      8193:     package Makefile. This will override the package's own libtool
                   8194:     in most cases.  For older libtool using packages,  libtool is
                   8195:     made by ltconfig script during the do-configure step; you can
                   8196:     check the libtool script location by doing <span><strong class="command">make
                   8197:     configure; find work*/ -name libtool</strong></span>.</p>
1.75      rillig   8198: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87      wiz      8199:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
                   8200:     default, it is set to &#8220;<span class="quote">libtool */libtool
                   8201:     */*/libtool</span>&#8221;.  If this does not match the location of the
                   8202:     package's libtool script(s), set it as appropriate.</p>
1.76      rillig   8203: <p>If you do not need <code class="filename">*.a</code> static
1.87      wiz      8204:     libraries built and installed, then use
                   8205:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75      rillig   8206: <p>If your package makes use of the platform-independent library
1.87      wiz      8207:     for loading dynamic shared objects, that comes with libtool
                   8208:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   8209: <p>Some packages use libtool incorrectly so that the package
                   8210:     may not work or build in some circumstances. Some of the more
                   8211:     common errors are:</p>
1.75      rillig   8212: <div class="itemizedlist"><ul type="disc">
                   8213: <li>
                   8214: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87      wiz      8215:        executable or library. This in itself isn't a problem if one of two things
                   8216:        has been done:</p>
1.75      rillig   8217: <div class="orderedlist"><ol type="1">
                   8218: <li><p>The shared object is named correctly, i.e.
1.87      wiz      8219:            <code class="filename">libfoo.la</code>, not
                   8220:            <code class="filename">foo.la</code></p></li>
1.75      rillig   8221: <li><p>The -dlopen option is used when linking an executable.</p></li>
                   8222: </ol></div>
                   8223: </li>
                   8224: <li><p>The use of libltdl without the correct calls to initialisation routines.
1.87      wiz      8225:        The function lt_dlinit() should be called and the macro
                   8226:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   8227:        executables.</p></li>
1.75      rillig   8228: </ul></div>
                   8229: </div>
                   8230: <div class="sect2" lang="en">
                   8231: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8232: <a name="autoconf-automake"></a>18.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75      rillig   8233: <p>If a package needs GNU autoconf or automake to be executed
1.87      wiz      8234:     to regenerate the configure script and Makefile.in makefile
                   8235:     templates, then they should be executed in a pre-configure
                   8236:     target.</p>
1.75      rillig   8237: <p>For packages that need only autoconf:</p>
                   8238: <pre class="programlisting">
1.87      wiz      8239:       AUTOCONF_REQD=  2.50            # if default version is not good enough
                   8240:       USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
                   8241:       ...
1.1       grant    8242: 
1.87      wiz      8243:       pre-configure:
                   8244:       cd ${WRKSRC}; autoconf
1.1       grant    8245: 
1.87      wiz      8246:       ...
                   8247:     </pre>
1.75      rillig   8248: <p>and for packages that need automake and autoconf:</p>
                   8249: <pre class="programlisting">
1.87      wiz      8250:       AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
                   8251:       USE_TOOLS+=     automake        # use "automake14" for automake-1.4
                   8252:       ...
                   8253: 
                   8254:       pre-configure:
                   8255:       cd ${WRKSRC};                          \
                   8256:       aclocal; autoheader;                   \
                   8257:       automake -a --foreign -i; autoconf
1.1       grant    8258: 
1.87      wiz      8259:       ...
                   8260:     </pre>
1.75      rillig   8261: <p>Packages which use GNU Automake will almost certainly
1.87      wiz      8262:     require GNU Make.</p>
1.75      rillig   8263: <p>There are times when the configure process makes
1.87      wiz      8264:     additional changes to the generated files, which then causes
                   8265:     the build process to try to re-execute the automake sequence.
                   8266:     This is prevented by touching various files in the configure
                   8267:     stage. If this causes problems with your package you can set
                   8268:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   8269:     Makefile.</p>
1.75      rillig   8270: </div>
                   8271: </div>
                   8272: <div class="sect1" lang="en">
                   8273: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   8274: <a name="programming-languages"></a>18.4. Programming languages</h2></div></div></div>
1.87      wiz      8275: <div class="sect2" lang="en">
                   8276: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8277: <a name="basic-programming-languages"></a>18.4.1. C, C++, and Fortran</h3></div></div></div>
1.87      wiz      8278: <p>Compilers for the C, C++, and Fortran languages comes with
                   8279:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   8280:     is written in C and will hide all other compilers (via the wrapper
1.90      rillig   8281:     framework, see <a href="#buildlink" title="Chapter 13. Buildlink methodology">Chapter 13, <i>Buildlink methodology</i></a>).</p>
1.87      wiz      8282: <p>To declare which language's compiler a package needs, set
                   8283:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
                   8284:     currently are &#8220;<span class="quote">c</span>&#8221;, &#8220;<span class="quote">c++</span>&#8221;, and
                   8285:     &#8220;<span class="quote">fortran</span>&#8221; (and any combination).  The default is
                   8286:     &#8220;<span class="quote">c</span>&#8221;.  Packages using GNU configure scripts, even if
                   8287:     written in C++, usually need a C compiler for the configure
                   8288:     phase.</p>
                   8289: </div>
                   8290: <div class="sect2" lang="en">
                   8291: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8292: <a name="java-programming-language"></a>18.4.2. Java</h3></div></div></div>
1.87      wiz      8293: <p>If a program is written in Java, use the Java framework in
                   8294:     pkgsrc.  The package must include
                   8295:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   8296:     provides the following variables:</p>
                   8297: <div class="itemizedlist"><ul type="disc">
                   8298: <li><p><code class="varname">USE_JAVA</code> defines if a build
                   8299:       dependency on the JDK is added.  If
                   8300:       <code class="varname">USE_JAVA</code> is set to &#8220;<span class="quote">run</span>&#8221;, then
                   8301:       there is only a runtime dependency on the JDK.  The default is
                   8302:       &#8220;<span class="quote">yes</span>&#8221;, which also adds a build dependency on the
                   8303:       JDK.</p></li>
                   8304: <li><p>Set <code class="varname">USE_JAVA2</code> to declare that
                   8305:       a package needs a Java2 implementation.  The supported values
                   8306:       are &#8220;<span class="quote">yes</span>&#8221;, &#8220;<span class="quote">1.4</span>&#8221;, and
                   8307:       &#8220;<span class="quote">1.5</span>&#8221;.  &#8220;<span class="quote">yes</span>&#8221; accepts any Java2
                   8308:       implementation, &#8220;<span class="quote">1.4</span>&#8221; insists on versions 1.4 or
                   8309:       above, and &#8220;<span class="quote">1.5</span>&#8221; only accepts versions 1.5 or
                   8310:       above. This variable is not set by default.</p></li>
                   8311: </ul></div>
                   8312: </div>
                   8313: <div class="sect2" lang="en">
                   8314: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8315: <a name="perl-scripts"></a>18.4.3. Packages containing perl scripts</h3></div></div></div>
1.87      wiz      8316: <p>If your package contains interpreted perl scripts, add
                   8317:     &#8220;<span class="quote">perl</span>&#8221; to the <code class="varname">USE_TOOLS</code> variable
                   8318:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   8319:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   8320:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
                   8321:     that you want adjusted.  Every occurrence of
                   8322:     <code class="filename">*/bin/perl</code> will be replaced with the full
                   8323:     path to the perl executable.</p>
                   8324: <p>If a particular version of perl is needed, set the
                   8325:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
                   8326:     default is &#8220;<span class="quote">5.0</span>&#8221;.</p>
1.90      rillig   8327: <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      8328:     about handling perl modules.</p>
                   8329: </div>
                   8330: <div class="sect2" lang="en">
                   8331: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8332: <a name="other-programming-languages"></a>18.4.4. Other programming languages</h3></div></div></div>
1.87      wiz      8333: <p>Currently, there is no special handling for other languages
                   8334:     in pkgsrc.  If a compiler package provides a
                   8335:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   8336:     just add a (build) dependency on the appropriate compiler
                   8337:     package.</p>
                   8338: </div>
                   8339: </div>
                   8340: <div class="sect1" lang="en">
                   8341: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   8342: <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   8343: <p>The most common failures when building a package are that
                   8344:        some platforms do not provide certain header files, functions or
                   8345:        libraries, or they provide the functions in a library that the
                   8346:        original package author didn't know. To work around this, you
                   8347:        can rewrite the source code in most cases so that it does not
                   8348:        use the missing functions or provides a replacement function.</p>
                   8349: <div class="sect2" lang="en">
                   8350: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8351: <a name="fixes.build.cpp"></a>18.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77      rillig   8352: <p>If a package already comes with a GNU configure script, the
                   8353:        preferred way to fix the build failure is to change the
                   8354:        configure script, not the code. In the other cases, you can
                   8355:        utilize the C preprocessor, which defines certain macros
                   8356:        depending on the operating system and hardware architecture it
                   8357:        compiles for. These macros can be queried using for example
                   8358:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   8359:        system, hardware architecture and compiler has its own macro.
                   8360:        For example, if the macros <code class="varname">__GNUC__</code>,
                   8361:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   8362:        are all defined, you know that you are using NetBSD on an i386
                   8363:        compatible CPU, and your compiler is GCC.</p>
                   8364: <p>The list of the following macros for hardware and
                   8365:        operating system depends on the compiler that is used. For
                   8366:        example, if you want to conditionally compile code on Solaris,
                   8367:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   8368:        does not define it. Use <code class="varname">__sun</code> instead.</p>
1.75      rillig   8369: <div class="sect3" lang="en">
                   8370: <div class="titlepage"><div><div><h4 class="title">
1.90      rillig   8371: <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   8372: <p>To distinguish between 4.4 BSD-derived systems and the
                   8373:         rest of the world, you should use the following code.</p>
                   8374: <pre class="programlisting">
                   8375:     #include &lt;sys/param.h&gt;
                   8376:     #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
                   8377:       /* BSD-specific code goes here */
                   8378:     #else
                   8379:       /* non-BSD-specific code goes here */
                   8380:     #endif
                   8381: </pre>
1.77      rillig   8382: <p>If this distinction is not fine enough, you can also test
                   8383:        for the following macros.</p>
1.75      rillig   8384: <pre class="programlisting">
                   8385:     FreeBSD     __FreeBSD__
                   8386:     DragonFly   __DragonFly__
                   8387:     Interix     __INTERIX
                   8388:     Linux       linux, __linux, __linux__
                   8389:     NetBSD      __NetBSD__
                   8390:     OpenBSD     __OpenBSD__
                   8391:     Solaris     sun, __sun
                   8392: </pre>
                   8393: </div>
                   8394: <div class="sect3" lang="en">
                   8395: <div class="titlepage"><div><div><h4 class="title">
1.90      rillig   8396: <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   8397: <pre class="programlisting">
                   8398:     i386        i386, __i386, __i386__
                   8399:     MIPS        __mips
                   8400:     SPARC       sparc, __sparc
                   8401: </pre>
                   8402: </div>
                   8403: <div class="sect3" lang="en">
                   8404: <div class="titlepage"><div><div><h4 class="title">
1.90      rillig   8405: <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   8406: <pre class="programlisting">
                   8407:     GCC         __GNUC__ (major version), __GNUC_MINOR__
                   8408:     SunPro      __SUNPRO_C (0x570 for version 5.7)
1.81      rillig   8409:     SunPro C++  __SUNPRO_CC (0x580 for version 5.8)
1.75      rillig   8410: </pre>
                   8411: </div>
                   8412: </div>
1.78      rillig   8413: <div class="sect2" lang="en">
                   8414: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8415: <a name="compiler-bugs"></a>18.5.2. How to handle compiler bugs</h3></div></div></div>
1.78      rillig   8416: <p>Some source files trigger bugs in the compiler, based on
1.87      wiz      8417:         combinations of compiler version and architecture and almost
                   8418:         always relation to optimisation being enabled.  Common symptoms
                   8419:         are gcc internal errors or never finishing compiling a
1.78      rillig   8420:        file.</p>
                   8421: <p>Typically, a workaround involves testing the
                   8422:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   8423:         optimisation for that combination of file,
                   8424:        <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
1.87      wiz      8425:        in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
1.78      rillig   8426:        number of examples.</p>
                   8427: </div>
                   8428: <div class="sect2" lang="en">
                   8429: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8430: <a name="undefined-reference"></a>18.5.3. Undefined reference to &#8220;<span class="quote">...</span>&#8221;</h3></div></div></div>
1.92      rillig   8431: <p>This error message often means that a package did not
1.78      rillig   8432:        link to a shared library it needs. The following functions are
                   8433:        known to cause this error message over and over.</p>
                   8434: <div class="informaltable">
                   8435: <a name="undefined-reference-functions"></a><table border="1">
                   8436: <colgroup>
                   8437: <col>
                   8438: <col>
                   8439: <col>
                   8440: </colgroup>
                   8441: <thead><tr>
                   8442: <th>Function</th>
                   8443: <th>Library</th>
                   8444: <th>Affected platforms</th>
                   8445: </tr></thead>
                   8446: <tbody>
                   8447: <tr>
                   8448: <td>accept, bind, connect</td>
                   8449: <td>-lsocket</td>
                   8450: <td>Solaris</td>
                   8451: </tr>
                   8452: <tr>
                   8453: <td>crypt</td>
                   8454: <td>-lcrypt</td>
                   8455: <td>DragonFly, NetBSD</td>
                   8456: </tr>
                   8457: <tr>
                   8458: <td>dlopen, dlsym</td>
                   8459: <td>-ldl</td>
                   8460: <td>Linux</td>
                   8461: </tr>
                   8462: <tr>
                   8463: <td>gethost*</td>
                   8464: <td>-lnsl</td>
                   8465: <td>Solaris</td>
                   8466: </tr>
                   8467: <tr>
                   8468: <td>inet_aton</td>
                   8469: <td>-lresolv</td>
                   8470: <td>Solaris</td>
                   8471: </tr>
                   8472: <tr>
                   8473: <td>nanosleep, sem_*, timer_*</td>
                   8474: <td>-lrt</td>
                   8475: <td>Solaris</td>
                   8476: </tr>
                   8477: <tr>
                   8478: <td>openpty</td>
                   8479: <td>-lutil</td>
                   8480: <td>Linux</td>
                   8481: </tr>
                   8482: </tbody>
                   8483: </table>
                   8484: </div>
                   8485: <p>To fix these linker errors, it is often sufficient to say
1.87      wiz      8486:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   8487:     -l<em class="replaceable"><code>foo</code></em></code> to the package
                   8488:     <code class="filename">Makefile</code> and then say <span><strong class="command">bmake clean;
                   8489:     bmake</strong></span>.</p>
1.92      rillig   8490: <div class="sect3" lang="en">
                   8491: <div class="titlepage"><div><div><h4 class="title">
                   8492: <a name="undefined-reference-sunpro"></a>18.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
                   8493: <p>When you are using the SunPro compiler, there is another
                   8494: possibility. That compiler cannot handle the following code:</p>
                   8495: <pre class="programlisting">
                   8496:     extern int extern_func(int);
1.93      rillig   8497: 
1.92      rillig   8498:     static inline int
                   8499:     inline_func(int x)
                   8500:     {
                   8501:         return extern_func(x);
                   8502:     }
1.93      rillig   8503: 
1.92      rillig   8504:     int main(void)
                   8505:     {
                   8506:         return 0;
                   8507:     }
                   8508: </pre>
                   8509: <p>It generates the code for <code class="function">inline_func</code> even if
                   8510: that function is never used. This code then refers to
                   8511: <code class="function">extern_func</code>, which can usually not be resolved. To
                   8512: solve this problem you can try to tell the package to disable inlining
                   8513: of functions.</p>
                   8514: </div>
1.87      wiz      8515: </div>
                   8516: <div class="sect2" lang="en">
                   8517: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8518: <a name="out-of-memory"></a>18.5.4. Running out of memory</h3></div></div></div>
1.87      wiz      8519: <p>Sometimes packages fail to build because the compiler runs
                   8520:     into an operating system specific soft limit.  With the
                   8521:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
                   8522:     to unlimit the resources.  Currently, the allowed values are
                   8523:     &#8220;<span class="quote">datasize</span>&#8221; and &#8220;<span class="quote">stacksize</span>&#8221; (or both).
                   8524:     Setting this variable is similar to running the shell builtin
                   8525:     <span><strong class="command">ulimit</strong></span> command to raise the maximum data
                   8526:     segment size or maximum stack size of a process, respectively, to
                   8527:     their hard limits.</p>
1.78      rillig   8528: </div>
1.75      rillig   8529: </div>
                   8530: <div class="sect1" lang="en">
                   8531: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   8532: <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   8533: <div class="sect2" lang="en">
                   8534: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8535: <a name="install-scripts"></a>18.6.1. Creating needed directories</h3></div></div></div>
1.78      rillig   8536: <p>The BSD-compatible <span><strong class="command">install</strong></span> supplied
1.87      wiz      8537:     with some operating systems cannot create more than one
                   8538:     directory at a time. As such, you should call
                   8539:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   8540: <pre class="programlisting">
                   8541:       ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   8542:       ${INSTALL_DATA_DIR} ${PREFIX}/dir2
                   8543:     </pre>
1.78      rillig   8544: <p>You can also just append &#8220;<span class="quote"><code class="literal">dir1
1.87      wiz      8545:     dir2</code></span>&#8221; to the
                   8546:     <code class="varname">INSTALLATION_DIRS</code> variable, which will
                   8547:     automatically do the right thing.</p>
1.75      rillig   8548: </div>
                   8549: <div class="sect2" lang="en">
                   8550: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8551: <a name="where-to-install-documentation"></a>18.6.2. Where to install documentation</h3></div></div></div>
1.83      wiz      8552: <p>In general, documentation should be installed into
1.87      wiz      8553:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8554:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
                   8555:     includes the version number of the package).</p>
1.84      wiz      8556: <p>Many modern packages using GNU autoconf allow to set the
1.87      wiz      8557:     directory where HTML documentation is installed with the
                   8558:     &#8220;<span class="quote">--with-html-dir</span>&#8221; option. Sometimes using this flag
                   8559:     is needed because otherwise the documentation ends up in
                   8560:     <code class="filename">${PREFIX}/share/doc/html</code> or other
                   8561:     places.</p>
                   8562: <p>An exception to the above is that library API documentation
1.91      rillig   8563:     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      8564:     browsers (devhelp) should be left at their default location, which
                   8565:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   8566:     documentation can be recognized from files ending in
                   8567:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   8568:     (It is also acceptable to install such files in
                   8569:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8570:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   8571:     <code class="filename">.devhelp*</code> file must be directly in that
                   8572:     directory then, no additional subdirectory level is allowed in
                   8573:     this case. This is usually achieved by using
                   8574:     &#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;.
                   8575:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   8576:     though.)</p>
1.75      rillig   8577: </div>
                   8578: <div class="sect2" lang="en">
                   8579: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8580: <a name="installing-score-files"></a>18.6.3. Installing score files</h3></div></div></div>
1.75      rillig   8581: <p>Certain packages, most of them in the games category, install
1.87      wiz      8582:     a score file that allows all users on the system to record their
                   8583:     highscores.  In order for this to work, the binaries need to be
                   8584:     installed setgid and the score files owned by the appropriate
                   8585:     group and/or owner (traditionally the "games" user/group).  The
                   8586:     following variables, documented in more detail in
                   8587:     <code class="filename">mk/defaults/mk.conf</code>, control this
                   8588:     behaviour: <code class="varname">SETGIDGAME</code>,
                   8589:     <code class="varname">GAMEDATAMODE</code>, <code class="varname">GAMEGRP</code>,
                   8590:     <code class="varname">GAMEMODE</code>, <code class="varname">GAMEOWN</code>.</p>
1.75      rillig   8591: <p>Note that per default, setgid installation of games is
1.87      wiz      8592:     disabled;  setting <code class="varname">SETGIDGAME=YES</code> will set all
                   8593:     the other variables accordingly.</p>
1.75      rillig   8594: <p>A package should therefor never hard code file ownership or
1.87      wiz      8595:     access permissions but rely on <code class="varname">INSTALL_GAME</code> and
                   8596:     <code class="varname">INSTALL_GAME_DATA</code> to set these
                   8597:     correctly.</p>
1.75      rillig   8598: </div>
                   8599: <div class="sect2" lang="en">
                   8600: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8601: <a name="hardcoded-paths"></a>18.6.4. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87      wiz      8602: <p>Your package may also contain scripts with hardcoded paths to
                   8603:       other interpreters besides (or as well as) perl.  To correct the
                   8604:       full pathname to the script interpreter, you need to set the
                   8605:       following definitions in your <code class="filename">Makefile</code> (we
                   8606:     shall use <span><strong class="command">tclsh</strong></span> in this example):</p>
                   8607: <pre class="programlisting">
                   8608:       REPLACE_INTERPRETER+=   tcl
                   8609:       REPLACE.tcl.old=        .*/bin/tclsh
                   8610:       REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   8611:       REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   8612:       # relative to ${WRKSRC}, just as in REPLACE_PERL
                   8613:     </pre>
1.75      rillig   8614: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   8615: <h3 class="title">Note</h3>
                   8616: <p>Before March 2006, these variables were called
1.87      wiz      8617:     <code class="varname">_REPLACE.*</code> and
                   8618:     <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75      rillig   8619: </div>
                   8620: </div>
                   8621: <div class="sect2" lang="en">
                   8622: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8623: <a name="perl-modules"></a>18.6.5. Packages installing perl modules</h3></div></div></div>
1.75      rillig   8624: <p>Makefiles of packages providing perl5 modules should include
1.87      wiz      8625:     the Makefile fragment
                   8626:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
                   8627:     <span><strong class="command">do-configure</strong></span> target for the standard perl
                   8628:     configuration for such modules as well as various hooks to tune
                   8629:     this configuration.  See comments in this file for
                   8630:     details.</p>
1.75      rillig   8631: <p>Perl5 modules will install into different places depending
1.87      wiz      8632:     on the version of perl used during the build process.  To
                   8633:     address this, pkgsrc will append lines to the
                   8634:     <code class="filename">PLIST</code> corresponding to the files listed in
                   8635:     the installed <code class="filename">.packlist</code> file generated by
                   8636:     most perl5 modules.  This is invoked by defining
                   8637:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
                   8638:     paths to packlist files, e.g.:</p>
1.75      rillig   8639: <pre class="programlisting">
1.87      wiz      8640:       PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
                   8641:     </pre>
1.75      rillig   8642: <p>The variables <code class="varname">PERL5_SITELIB</code>,
1.87      wiz      8643:     <code class="varname">PERL5_SITEARCH</code>, and
                   8644:     <code class="varname">PERL5_ARCHLIB</code> represent the three locations
                   8645:     in which perl5 modules may be installed, and may be used by
                   8646:     perl5 packages that don't have a packlist.  These three
                   8647:     variables are also substituted for in the
                   8648:     <code class="filename">PLIST</code>.</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="faq.info-files"></a>18.6.6. Packages installing info files</h3></div></div></div>
1.75      rillig   8653: <p>Some packages install info files or use the
1.87      wiz      8654:     &#8220;<span class="quote">makeinfo</span>&#8221;  or &#8220;<span class="quote">install-info</span>&#8221;
                   8655:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   8656:     the package Makefile so that <code class="filename">INSTALL</code> and
                   8657:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   8658:     handle registration of the info files in the Info directory
                   8659:     file. The &#8220;<span class="quote">install-info</span>&#8221; command used for the info
                   8660:     files registration is either provided by the system, or by a
                   8661:     special purpose package automatically added as dependency if
                   8662:     needed.</p>
1.75      rillig   8663: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87      wiz      8664:     <code class="filename">${PREFIX}</code> where info files are primarily
                   8665:     located. <code class="varname">PKGINFODIR</code> defaults to
                   8666:     &#8220;<span class="quote">info</span>&#8221; and can be overridden by the user.</p>
1.75      rillig   8667: <p>The info files for the package should be listed in the
1.87      wiz      8668:     package <code class="filename">PLIST</code>; however any split info files
                   8669:     need not be listed.</p>
1.75      rillig   8670: <p>A package which needs the &#8220;<span class="quote">makeinfo</span>&#8221; command
1.87      wiz      8671:     at build time must add &#8220;<span class="quote">makeinfo</span>&#8221; to
                   8672:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
                   8673:     version of the &#8220;<span class="quote">makeinfo</span>&#8221; command is needed it
                   8674:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   8675:     variable in the package <code class="filename">Makefile</code>. By
                   8676:     default, a minimum version of 3.12 is required. If the system
                   8677:     does not provide a <span><strong class="command">makeinfo</strong></span> command or if it
                   8678:     does not match the required minimum, a build dependency on the
1.91      rillig   8679:     <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      8680:     be added automatically.</p>
1.75      rillig   8681: <p>The build and installation process of the software provided
1.87      wiz      8682:     by the package should not use the
                   8683:     <span><strong class="command">install-info</strong></span> command as the registration of
                   8684:     info files is the task of the package
                   8685:     <code class="filename">INSTALL</code> script, and it must use the
                   8686:     appropriate <span><strong class="command">makeinfo</strong></span> command.</p>
1.75      rillig   8687: <p>To achieve this goal, the pkgsrc infrastructure creates
1.87      wiz      8688:     overriding scripts for the <span><strong class="command">install-info</strong></span> and
                   8689:     <span><strong class="command">makeinfo</strong></span> commands in a directory listed early
                   8690:     in <code class="varname">PATH</code>.</p>
1.75      rillig   8691: <p>The script overriding <span><strong class="command">install-info</strong></span> has
1.87      wiz      8692:     no effect except the logging of a message. The script overriding
                   8693:     <span><strong class="command">makeinfo</strong></span> logs a message and according to the
                   8694:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
                   8695:     <span><strong class="command">makeinfo</strong></span> command or exit on error.</p>
1.75      rillig   8696: </div>
                   8697: <div class="sect2" lang="en">
                   8698: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8699: <a name="manpages"></a>18.6.7. Packages installing man pages</h3></div></div></div>
1.81      rillig   8700: <p>All packages that install manual pages should install them
1.87      wiz      8701:     into the same directory, so that there is one common place to look
                   8702:     for them. In pkgsrc, this place is
                   8703:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   8704:     should be used in packages. The default for
                   8705:     <code class="varname">PKGMANDIR</code> is
                   8706:     &#8220;<span class="quote"><code class="filename">man</code></span>&#8221;. Another often-used value
                   8707:     is &#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;.</p>
1.75      rillig   8708: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   8709: <h3 class="title">Note</h3>
1.87      wiz      8710: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   8711:     is far from complete.</p>
1.75      rillig   8712: </div>
1.81      rillig   8713: <p>The <code class="filename">PLIST</code> files can just use
1.87      wiz      8714:     <code class="filename">man/</code> as the top level directory for the man
                   8715:     page file entries, and the pkgsrc framework will convert as
                   8716:     needed. In all other places, the correct
                   8717:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   8718: <p>Packages that are
                   8719:     configured with <code class="varname">GNU_CONFIGURE</code> set as
                   8720:     &#8220;<span class="quote">yes</span>&#8221;, by default will use the
                   8721:     <code class="filename">./configure</code>
                   8722:     --mandir switch to set where the man pages should be installed.
                   8723:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   8724:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   8725: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   8726:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
                   8727:     to &#8220;<span class="quote">no</span>&#8221;.
                   8728:     Or if the <code class="filename">./configure</code> script uses
                   8729:     a non-standard use of --mandir, you can set
                   8730:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.90      rillig   8731: <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      8732:     information on installation of compressed manual pages.</p>
1.75      rillig   8733: </div>
                   8734: <div class="sect2" lang="en">
                   8735: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8736: <a name="gconf2-data-files"></a>18.6.8. Packages installing GConf2 data files</h3></div></div></div>
1.87      wiz      8737: <p>If a package installs <code class="filename">.schemas</code> or
                   8738:     <code class="filename">.entries</code> files, used by GConf2,
                   8739:     you need to take some extra steps to make sure they get registered
                   8740:     in the database:</p>
1.75      rillig   8741: <div class="orderedlist"><ol type="1">
1.76      rillig   8742: <li><p>Include <code class="filename">../../devel/GConf2/schemas.mk</code>
1.87      wiz      8743:        instead of its <code class="filename">buildlink3.mk</code> file.  This
                   8744:        takes care of rebuilding the GConf2 database at installation and
                   8745:        deinstallation time, and tells the package where to install
                   8746:        GConf2 data files using some standard configure arguments.  It
                   8747:        also disallows any access to the database directly from the
                   8748:        package.</p></li>
1.75      rillig   8749: <li><p>Ensure that the package installs its
1.87      wiz      8750:        <code class="filename">.schemas</code> files under
                   8751:        <code class="filename">${PREFIX}/share/gconf/schemas</code>.  If they get
                   8752:        installed under <code class="filename">${PREFIX}/etc</code>, you will
                   8753:        need to manually patch the package.</p></li>
1.75      rillig   8754: <li><p>Check the PLIST and remove any entries under the etc/gconf
1.87      wiz      8755:        directory, as they will be handled automatically.  See
1.90      rillig   8756:        <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   8757: <li><p>Define the <code class="varname">GCONF2_SCHEMAS</code> variable in
1.87      wiz      8758:        your <code class="filename">Makefile</code> with a list of all
                   8759:        <code class="filename">.schemas</code> files installed by the package, if
                   8760:        any.  Names must not contain any directories in them.</p></li>
1.75      rillig   8761: <li><p>Define the <code class="varname">GCONF2_ENTRIES</code> variable in
1.87      wiz      8762:        your <code class="filename">Makefile</code> with a
                   8763:        list of all <code class="filename">.entries</code> files installed by the
                   8764:        package, if any. Names must not contain any directories in
                   8765:        them.</p></li>
1.75      rillig   8766: </ol></div>
                   8767: </div>
                   8768: <div class="sect2" lang="en">
                   8769: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8770: <a name="scrollkeeper-data-files"></a>18.6.9. Packages installing scrollkeeper data files</h3></div></div></div>
1.87      wiz      8771: <p>If a package installs <code class="filename">.omf</code> files, used by
                   8772:     scrollkeeper, you need to take some extra steps to make sure they
                   8773:     get registered in the database:</p>
1.75      rillig   8774: <div class="orderedlist"><ol type="1">
                   8775: <li><p>Include
1.87      wiz      8776:        <code class="filename">../../textproc/scrollkeeper/omf.mk</code>
                   8777:        instead of its <code class="filename">buildlink3.mk</code> file.  This
                   8778:        takes care of rebuilding the scrollkeeper database at
                   8779:        installation and deinstallation time, and disallows any access
                   8780:        to it directly from the package.</p></li>
1.75      rillig   8781: <li><p>Check the PLIST and remove any entries under the
1.87      wiz      8782:        <code class="filename">libdata/scrollkeeper</code> directory, as they
                   8783:        will be handled automatically.</p></li>
1.76      rillig   8784: <li><p>Remove the <code class="filename">share/omf</code> directory from
1.87      wiz      8785:        the PLIST.  It will be handled by scrollkeeper.</p></li>
1.75      rillig   8786: </ol></div>
                   8787: </div>
                   8788: <div class="sect2" lang="en">
                   8789: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8790: <a name="x11-fonts"></a>18.6.10. Packages installing X11 fonts</h3></div></div></div>
1.75      rillig   8791: <p>If a package installs font files, you will need to rebuild
1.87      wiz      8792:     the fonts database in the directory where they get installed at
                   8793:     installation and deinstallation time.  This can be automatically
                   8794:     done by using the pkginstall framework.</p>
1.75      rillig   8795: <p>You can list the directories where fonts are installed in the
1.87      wiz      8796:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   8797:     variables, where <em class="replaceable"><code>type</code></em> can be one of
                   8798:     &#8220;<span class="quote">ttf</span>&#8221;, &#8220;<span class="quote">type1</span>&#8221; or &#8220;<span class="quote">x11</span>&#8221;.
                   8799:     Also make sure that the database file
                   8800:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75      rillig   8801: <p>Note that you should not create new directories for fonts;
1.87      wiz      8802:     instead use the standard ones to avoid that the user needs to
                   8803:     manually configure his X server to find them.</p>
1.75      rillig   8804: </div>
                   8805: <div class="sect2" lang="en">
                   8806: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8807: <a name="gtk2-modules"></a>18.6.11. Packages installing GTK2 modules</h3></div></div></div>
1.75      rillig   8808: <p>If a package installs GTK2 immodules or loaders, you need to
1.87      wiz      8809:     take some extra steps to get them registered in the GTK2 database
                   8810:     properly:</p>
1.75      rillig   8811: <div class="orderedlist"><ol type="1">
                   8812: <li><p>Include
1.87      wiz      8813:       <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
                   8814:       <code class="filename">buildlink3.mk</code> file.  This takes care of
                   8815:       rebuilding the database at installation and deinstallation time.</p></li>
                   8816: <li><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
                   8817:       your package installs GTK2 immodules.</p></li>
                   8818: <li><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
                   8819:       GTK2 loaders.</p></li>
1.75      rillig   8820: <li>
1.87      wiz      8821: <p>Patch the package to not touch any of the GTK2
                   8822:       databases directly.  These are:</p>
1.75      rillig   8823: <div class="itemizedlist"><ul type="disc">
1.76      rillig   8824: <li><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
                   8825: <li><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75      rillig   8826: </ul></div>
                   8827: </li>
1.87      wiz      8828: <li><p>Check the <code class="filename">PLIST</code> and remove
                   8829:       any entries under the <code class="filename">libdata/gtk-2.0</code>
                   8830:       directory, as they will be handled automatically.</p></li>
1.75      rillig   8831: </ol></div>
                   8832: </div>
                   8833: <div class="sect2" lang="en">
                   8834: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8835: <a name="sgml-xml-data"></a>18.6.12. Packages installing SGML or XML data</h3></div></div></div>
1.75      rillig   8836: <p>If a package installs SGML or XML data files that need to be
1.87      wiz      8837:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   8838:     etc.), you need to take some extra steps:</p>
1.75      rillig   8839: <div class="orderedlist"><ol type="1">
                   8840: <li><p>Include
1.87      wiz      8841:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   8842:        your <code class="filename">Makefile</code>, which takes care of
                   8843:        registering those files in system-wide catalogs at
                   8844:        installation and deinstallation time.</p></li>
1.75      rillig   8845: <li><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87      wiz      8846:        any SGML catalogs installed by the package.</p></li>
1.75      rillig   8847: <li><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87      wiz      8848:        any XML catalogs installed by the package.</p></li>
1.75      rillig   8849: <li><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87      wiz      8850:        to be added to the SGML catalog.  These come in groups of
                   8851:        three strings; see xmlcatmgr(1) for more information
                   8852:        (specifically, arguments recognized by the 'add' action).
                   8853:        Note that you will normally not use this variable.</p></li>
1.75      rillig   8854: <li><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87      wiz      8855:        to be added to the XML catalog.  These come in groups of three
                   8856:        strings; see xmlcatmgr(1) for more information (specifically,
                   8857:        arguments recognized by the 'add' action).  Note that you will
                   8858:        normally not use this variable.</p></li>
1.75      rillig   8859: </ol></div>
                   8860: </div>
                   8861: <div class="sect2" lang="en">
                   8862: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8863: <a name="mime-database"></a>18.6.13. Packages installing extensions to the MIME database</h3></div></div></div>
1.75      rillig   8864: <p>If a package provides extensions to the MIME database by
1.87      wiz      8865:     installing <code class="filename">.xml</code> files inside
                   8866:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   8867:     need to take some extra steps to ensure that the database is kept
                   8868:     consistent with respect to these new files:</p>
1.75      rillig   8869: <div class="orderedlist"><ol type="1">
                   8870: <li><p>Include
1.87      wiz      8871:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   8872:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   8873:        this same directory, which is reserved for inclusion from
                   8874:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   8875:        care of rebuilding the MIME database at installation and
                   8876:        deinstallation time, and disallows any access to it directly
                   8877:        from the package.</p></li>
1.75      rillig   8878: <li><p>Check the PLIST and remove any entries under the
1.87      wiz      8879:        <code class="filename">share/mime</code> directory,
                   8880:        <span class="emphasis"><em>except</em></span> for files saved under
                   8881:        <code class="filename">share/mime/packages</code>.  The former are
                   8882:        handled automatically by
                   8883:        the update-mime-database program, but the latter are
                   8884:        package-dependent and must be removed by the package that
                   8885:        installed them in the first place.</p></li>
1.76      rillig   8886: <li><p>Remove any <code class="filename">share/mime/*</code> directories
1.87      wiz      8887:        from the PLIST.  They will be handled by the shared-mime-info
                   8888:        package.</p></li>
1.75      rillig   8889: </ol></div>
                   8890: </div>
                   8891: <div class="sect2" lang="en">
                   8892: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8893: <a name="intltool"></a>18.6.14. Packages using intltool</h3></div></div></div>
1.93      rillig   8894: <p>If a package uses intltool during its build, add
                   8895:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87      wiz      8896:     which forces it to use the intltool package provided by pkgsrc,
                   8897:     instead of the one bundled with the distribution file.</p>
1.75      rillig   8898: <p>This tracks intltool's build-time dependencies and uses the
1.87      wiz      8899:     latest available version; this way, the package benefits of any
                   8900:     bug fixes that may have appeared since it was released.</p>
1.75      rillig   8901: </div>
                   8902: <div class="sect2" lang="en">
                   8903: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8904: <a name="startup-scripts"></a>18.6.15. Packages installing startup scripts</h3></div></div></div>
1.75      rillig   8905: <p>If a package contains a rc.d script, it won't be copied into
1.87      wiz      8906:     the startup directory by default, but you can enable it, by adding
                   8907:     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
                   8908:     <code class="filename">/etc/mk.conf</code>. This option will copy the scripts
                   8909:     into <code class="filename">/etc/rc.d</code> when a package is installed, and
                   8910:     it will automatically remove the scripts when the package is
                   8911:     deinstalled.</p>
1.75      rillig   8912: </div>
                   8913: <div class="sect2" lang="en">
                   8914: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8915: <a name="tex-packages"></a>18.6.16. Packages installing TeX modules</h3></div></div></div>
1.75      rillig   8916: <p>If a package installs TeX packages into the texmf tree,
1.87      wiz      8917:     the <code class="filename">ls-R</code> database of the tree needs to be
                   8918:     updated.</p>
1.75      rillig   8919: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   8920: <h3 class="title">Note</h3>
                   8921: <p>Except the main TeX packages such as teTeX-texmf,
1.87      wiz      8922:     packages should install files
                   8923:     into <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
                   8924:     not <code class="varname">PKG_TEXMFPREFIX</code>.</p>
1.75      rillig   8925: </div>
                   8926: <div class="orderedlist"><ol type="1">
                   8927: <li><p>Include
1.87      wiz      8928:       <code class="filename">../../print/teTeX/module.mk</code> instead
                   8929:       of <code class="filename">../../mk/tex.buildlink3.mk</code>.  This
                   8930:       takes care of rebuilding the <code class="filename">ls-R</code>
                   8931:       database at installation and deinstallation time.</p></li>
1.75      rillig   8932: <li>
                   8933: <p>If your package installs files into a texmf
1.87      wiz      8934:       tree other than the one
                   8935:       at <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
                   8936:       set <code class="varname">TEXMFDIRS</code> to the list of all texmf
                   8937:       trees that need database update.</p>
1.75      rillig   8938: <p>If your package also installs font map files that need
1.87      wiz      8939:       to be registered using <span><strong class="command">updmap</strong></span>,
                   8940:       set <code class="varname">TEX_FONTMAPS</code> to the list of all
                   8941:       such font map files.  Then <span><strong class="command">updmap</strong></span> will
                   8942:       be run automatically at installation/deinstallation to
                   8943:       enable/disable font map files for TeX output
                   8944:       drivers.</p>
1.75      rillig   8945: </li>
1.76      rillig   8946: <li><p>Make sure that none of <code class="filename">ls-R</code>
1.87      wiz      8947:       databases are included in <code class="filename">PLIST</code>, as
                   8948:       they will be removed only by the teTeX-bin package.</p></li>
1.75      rillig   8949: </ol></div>
                   8950: </div>
1.85      jmmv     8951: <div class="sect2" lang="en">
                   8952: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8953: <a name="emulation-packages"></a>18.6.17. Packages supporting running binaries in
1.87      wiz      8954:     emulation</h3></div></div></div>
                   8955: <p>There are some packages that provide libraries and
                   8956:     executables for running binaries from a one operating system
                   8957:     on a different one (if the latter supports it).  One example
                   8958:     is running Linux binaries on NetBSD.</p>
1.91      rillig   8959: <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      8960:     helps in extracting and packaging Linux rpm packages.</p>
                   8961: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
                   8962:     avoid the <span><strong class="command">check-shlibs</strong></span> target, which tests
                   8963:     if all libraries for each installed executable can be found by
                   8964:     the dynamic linker.  Since the standard dynamic linker is run,
                   8965:     this fails for emulation packages, because the libraries used
                   8966:     by the emulation are not in the standard directories.</p>
                   8967: </div>
                   8968: <div class="sect2" lang="en">
                   8969: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8970: <a name="hicolor-theme"></a>18.6.18. Packages installing hicolor theme icons</h3></div></div></div>
1.85      jmmv     8971: <p>If a package installs images under the
1.87      wiz      8972:     <code class="filename">share/icons/hicolor</code> and/or updates the
                   8973:     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
                   8974:     database, you need to take some extra steps to make sure that the
                   8975:     shared theme directory is handled appropriately and that the cache
                   8976:     database is rebuilt:</p>
1.85      jmmv     8977: <div class="orderedlist"><ol type="1">
                   8978: <li><p>Include
1.87      wiz      8979:        <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
                   8980: <li><p>Check the <code class="filename">PLIST</code> and remove the
                   8981:        entry that refers to the theme cache.</p></li>
1.85      jmmv     8982: <li><p>Ensure that the PLIST does not remove the shared icon
                   8983:          directories from the <code class="filename">share/icons/hicolor</code>
                   8984:          hierarchy because they will be handled automatically.</p></li>
                   8985: </ol></div>
                   8986: <p>The best way to verify that the PLIST is correct with
                   8987:       respect to the last two points is to regenerate it using
                   8988:       <span><strong class="command">make print-PLIST</strong></span>.</p>
                   8989: </div>
                   8990: <div class="sect2" lang="en">
                   8991: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8992: <a name="desktop-files"></a>18.6.19. Packages installing desktop files</h3></div></div></div>
1.85      jmmv     8993: <p>If a package installs <code class="filename">.desktop</code> files
                   8994:       under <code class="filename">share/applications</code> and these include
                   8995:       MIME information, you need to take extra steps to ensure that they
                   8996:       are registered into the MIME database:</p>
                   8997: <div class="orderedlist"><ol type="1">
                   8998: <li><p>Include
                   8999:          <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
                   9000: <li><p>Check the PLIST and remove the entry that refers to the
                   9001:          <code class="filename">share/applications/mimeinfo.cache</code> file.
                   9002:          It will be handled automatically.</p></li>
                   9003: </ol></div>
                   9004: <p>The best way to verify that the PLIST is correct with
                   9005:       respect to the last point is to regenerate it using <span><strong class="command">make
                   9006:       print-PLIST</strong></span>.</p>
1.75      rillig   9007: </div>
                   9008: </div>
1.87      wiz      9009: <div class="sect1" lang="en">
                   9010: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9011: <a name="punting"></a>18.7. Marking packages as having problems</h2></div></div></div>
1.87      wiz      9012: <p>In some cases one does not have the time to solve a problem
                   9013:   immediately.  There are currently two ways to declare that one knows
                   9014:   that a package has problems.</p>
                   9015: <div class="itemizedlist"><ul type="disc">
                   9016: <li><p>The first way is to plainly mark it as broken.  For
                   9017:     this, one just sets the variable <code class="varname">BROKEN</code> to the
                   9018:     reason why the package is broken (similar to the
                   9019:     <code class="varname">RESTRICTED</code> variable).  A user trying to build
                   9020:     the package will immediately be shown this message, and the build
                   9021:     will not be even tried.</p></li>
                   9022: <li><p>After each pkgsrc freeze period (a time when the
                   9023:     tree is stabilized and a new pkgsrc branch is cut), the packages
                   9024:     that were not building in the official branch build on the latest
                   9025:     NetBSD release will be marked as broken on that branch.  This is
                   9026:     done by setting the <code class="varname">BROKEN_IN</code> variable to the
                   9027:     branch name (or appending the branch name to it).  If a user tries
                   9028:     to build such a package and the build fails, the user gets a
                   9029:     message that says that the package was broken on the respective
                   9030:     branch(es).</p></li>
                   9031: </ul></div>
                   9032: <p>Both types of packages are removed from pkgsrc in irregular
                   9033:   intervals.</p>
                   9034: </div>
1.75      rillig   9035: </div>
                   9036: <div class="chapter" lang="en">
                   9037: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   9038: <a name="debug"></a>Chapter 19. Debugging</h2></div></div></div>
1.88      wiz      9039: <p>To check out all the gotchas when building a package, here are
                   9040:   the steps that I do in order to get a package working.  Please note
                   9041:   this is basically the same as what was explained in the previous
                   9042:   sections, only with some debugging aids.</p>
1.75      rillig   9043: <div class="itemizedlist"><ul type="disc">
1.88      wiz      9044: <li><p>Be sure to set <code class="varname">PKG_DEVELOPER=1</code> in
                   9045:       <code class="filename">/etc/mk.conf</code></p></li>
1.75      rillig   9046: <li>
1.91      rillig   9047: <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      9048:       create a directory for a new package, change into it, then run
                   9049:       <span><strong class="command">url2pkg</strong></span>:</p>
1.75      rillig   9050: <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>
                   9051: <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>
                   9052: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
                   9053: </li>
1.76      rillig   9054: <li><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
                   9055: <li><p>Fill in the <code class="filename">DESCR</code> file</p></li>
1.87      wiz      9056: <li><p>Run <span><strong class="command">make configure</strong></span></p></li>
1.75      rillig   9057: <li><p>Add any dependencies glimpsed from documentation and the
1.88      wiz      9058:       configure step to the package's
                   9059:       <code class="filename">Makefile</code>.</p></li>
1.75      rillig   9060: <li>
                   9061: <p>Make the package compile, doing multiple rounds of</p>
                   9062: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   9063: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   9064: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
                   9065: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
                   9066: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
                   9067: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
                   9068: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88      wiz      9069: <p>Doing this step as non-root user will ensure that no files
                   9070:       are modified that shouldn't be, especially during the build
                   9071:       phase.  <span><strong class="command">mkpatches</strong></span>,
                   9072:       <span><strong class="command">patchdiff</strong></span> and <span><strong class="command">pkgvi</strong></span> are
1.91      rillig   9073:       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      9074:       package.</p>
1.75      rillig   9075: </li>
1.88      wiz      9076: <li><p>Look at the <code class="filename">Makefile</code>, fix if
1.90      rillig   9077:       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   9078: <li>
1.76      rillig   9079: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75      rillig   9080: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9081: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST &gt;PLIST</code></strong>
                   9082: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
                   9083: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9084: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88      wiz      9085: <p>You usually need to be <code class="username">root</code> to do
                   9086:       this.  Look if there are any files left:</p>
1.75      rillig   9087: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9088: <p>If this reveals any files that are missing in
1.88      wiz      9089:       <code class="filename">PLIST</code>, add them.</p>
1.75      rillig   9090: </li>
                   9091: <li>
1.88      wiz      9092: <p>Now that the <code class="filename">PLIST</code> is OK, install the
                   9093:       package again and make a binary package:</p>
1.75      rillig   9094: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
                   9095: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
                   9096: </li>
                   9097: <li>
                   9098: <p>Delete the installed package:</p>
1.88      wiz      9099: <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   9100: </li>
                   9101: <li>
1.88      wiz      9102: <p>Repeat the above <span><strong class="command">make print-PLIST</strong></span>
                   9103:       command, which shouldn't find anything now:</p>
1.75      rillig   9104: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9105: </li>
                   9106: <li>
                   9107: <p>Reinstall the binary package:</p>
1.93      rillig   9108: <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   9109: </li>
1.88      wiz      9110: <li><p>Play with it.  Make sure everything works.</p></li>
1.75      rillig   9111: <li>
1.91      rillig   9112: <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      9113:       reports:</p>
1.75      rillig   9114: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
                   9115: </li>
1.90      rillig   9116: <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   9117: </ul></div>
                   9118: </div>
                   9119: <div class="chapter" lang="en">
                   9120: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   9121: <a name="submit"></a>Chapter 20. Submitting and Committing</h2></div></div></div>
1.75      rillig   9122: <div class="toc">
                   9123: <p><b>Table of Contents</b></p>
                   9124: <dl>
1.90      rillig   9125: <dt><span class="sect1"><a href="#submitting-binary-packages">20.1. Submitting binary packages</a></span></dt>
                   9126: <dt><span class="sect1"><a href="#submitting-your-package">20.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   9127: <dt><span class="sect1"><a href="#general-notes-for-changes">20.3. General notes when adding, updating, or removing packages</a></span></dt>
                   9128: <dt><span class="sect1"><a href="#committing-importing">20.4. Committing: Importing a package into CVS</a></span></dt>
                   9129: <dt><span class="sect1"><a href="#updating-package">20.5. Updating a package to a newer version</a></span></dt>
                   9130: <dt><span class="sect1"><a href="#moving-package">20.6. Moving a package in pkgsrc</a></span></dt>
1.75      rillig   9131: </dl>
                   9132: </div>
                   9133: <div class="sect1" lang="en">
                   9134: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9135: <a name="submitting-binary-packages"></a>20.1. Submitting binary packages</h2></div></div></div>
1.75      rillig   9136: <p>Our policy is that we accept binaries only from pkgsrc
                   9137:        developers to guarantee that the packages don't contain any
                   9138:        trojan horses etc. This is not to annoy anyone but rather to
                   9139:        protect our users! You're still free to put up your home-made
                   9140:        binary packages and tell the world where to get them. NetBSD
                   9141:        developers doing bulk builds and wanting to upload them please
                   9142:        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>
                   9143: </div>
                   9144: <div class="sect1" lang="en">
                   9145: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9146: <a name="submitting-your-package"></a>20.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75      rillig   9147: <p>First, check that your package is complete, compiles and
1.90      rillig   9148:        runs well; see <a href="#debug" title="Chapter 19. Debugging">Chapter 19, <i>Debugging</i></a> and the rest of this
1.75      rillig   9149:        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   9150:        archive that contains all files that make up the package.
1.87      wiz      9151:        Finally, send this package to the pkgsrc bug tracking system,
                   9152:        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
                   9153:        that, go to the web page
                   9154:        <a href="http://www.NetBSD.org/Misc/send-pr.html" target="_top">http://www.NetBSD.org/Misc/send-pr.html</a>,
                   9155:        which contains some instructions and a link to a form, where you
                   9156:        can submit packages.</p>
                   9157: <p>In the form of the problem report, the category should be
                   9158:        &#8220;<span class="quote">pkg</span>&#8221;, the synopsis should include the package name
                   9159:        and version number, and the description field should contain a
                   9160:        short description of your package (contents of the COMMENT
                   9161:        variable or DESCR file are OK). The uuencoded package data should
                   9162:        go into the &#8220;<span class="quote">fix</span>&#8221; field.</p>
1.75      rillig   9163: <p>If you want to submit several packages, please send a
                   9164:        separate PR for each one, it's easier for us to track things
                   9165:        that way.</p>
                   9166: <p>Alternatively, you can also import new packages into
                   9167:        pkgsrc-wip (&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;); see the
                   9168:        homepage at <a href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
                   9169:        for details.</p>
                   9170: </div>
                   9171: <div class="sect1" lang="en">
                   9172: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9173: <a name="general-notes-for-changes"></a>20.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75      rillig   9174: <p>Please note all package additions, updates, moves, and
1.93      rillig   9175:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75      rillig   9176:        important to keep this file up to date and conforming to the
                   9177:        existing format, because it will be used by scripts to
                   9178:        automatically update pages on <a href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
                   9179:        sites. Additionally, check the
1.76      rillig   9180:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75      rillig   9181:        for the package you updated or removed, in case it was mentioned
                   9182:        there.</p>
                   9183: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   9184:        bumped, the change should appear in
1.93      rillig   9185:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75      rillig   9186:        related or otherwise relevant. Mass bumps that result from a
                   9187:        dependency being updated should not be mentioned. In all other
                   9188:        cases it's the developer's decision.</p>
                   9189: <p>There is a make target that helps in creating proper
1.93      rillig   9190:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span><strong class="command">make
1.75      rillig   9191:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   9192:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93      rillig   9193:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75      rillig   9194:   file is up-to-date (to avoid having to resolve conflicts later-on)
                   9195:   and then to <span><strong class="command">cd</strong></span> to the package directory.  For
                   9196:   package updates, <span><strong class="command">make changes-entry</strong></span> is enough.
                   9197:   For new packages, or package moves or removals, set the
                   9198:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   9199:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.76      rillig   9200:   in <code class="filename">/etc/mk.conf</code> if your local login name is
1.75      rillig   9201:   not the same as your NetBSD login name. Don't forget to commit
1.93      rillig   9202:   the changes to <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>!</p>
1.75      rillig   9203: </div>
                   9204: <div class="sect1" lang="en">
                   9205: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9206: <a name="committing-importing"></a>20.4. Committing: Importing a package into CVS</h2></div></div></div>
1.87      wiz      9207: <p>This section is only of interest for pkgsrc developers with write
1.75      rillig   9208:   access to the pkgsrc repository. Please remember that cvs
                   9209:   imports files relative to the current working directory, and that
                   9210:   the pathname that you
                   9211:   give the <span><strong class="command">cvs import</strong></span> command is so that it knows where
                   9212:   to place the files in the repository.  Newly created packages should be
                   9213:   imported with a vendor tag of &#8220;<span class="quote">TNF</span>&#8221; and a release tag of
1.87      wiz      9214:   &#8220;<span class="quote">pkgsrc-base</span>&#8221;, e.g:</p>
1.75      rillig   9215: <pre class="programlisting">
                   9216:     <code class="prompt">$</code> cd .../pkgsrc/category/pkgname
                   9217:     <code class="prompt">$</code> cvs import pkgsrc/category/pkgname TNF pkgsrc-base
                   9218: </pre>
1.87      wiz      9219: <p>Remember to move the directory from which you imported out of
1.75      rillig   9220:   the way, or cvs will complain the next time you &#8220;<span class="quote">cvs
                   9221:   update</span>&#8221; your source tree.  Also don't forget to add the new
1.87      wiz      9222:   package to the category's <code class="filename">Makefile</code>.</p>
                   9223: <p>The commit message of the initial import should include part of the
1.76      rillig   9224:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87      wiz      9225:   what the package is/does.</p>
                   9226: <p>For new packages, &#8220;<span class="quote">cvs import</span>&#8221; is preferred to &#8220;<span class="quote">cvs
1.75      rillig   9227:   add</span>&#8221; because the former gets everything with a single command,
1.87      wiz      9228:   and provides a consistent tag.</p>
1.75      rillig   9229: </div>
                   9230: <div class="sect1" lang="en">
                   9231: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9232: <a name="updating-package"></a>20.5. Updating a package to a newer version</h2></div></div></div>
1.87      wiz      9233: <p>Please always put a concise, appropriate and relevant summary of the
1.75      rillig   9234:   changes between old and new versions into the commit log when updating
1.87      wiz      9235:   a package. There are various reasons for this:</p>
1.75      rillig   9236: <div class="itemizedlist"><ul type="disc">
1.87      wiz      9237: <li><p>A URL is volatile, and can change over time. It may go away completely
                   9238:   or its information may be overwritten by newer information.</p></li>
                   9239: <li><p>Having the change information between old and new versions in our CVS
                   9240:   repository is very useful for people who use either cvs or anoncvs.</p></li>
                   9241: <li><p>Having the change information between old and new versions in our CVS
1.75      rillig   9242:   repository is very useful for people who read the pkgsrc-changes mailing
                   9243:   list, so that they can make tactical decisions about when to upgrade
1.87      wiz      9244:   the package.</p></li>
1.75      rillig   9245: </ul></div>
1.87      wiz      9246: <p>Please also recognize that, just because a new version of a package
1.75      rillig   9247:   has been released, it should not automatically be upgraded in the CVS
                   9248:   repository.  We prefer to be conservative in the packages that are
                   9249:   included in pkgsrc - development or beta packages are not really the
                   9250:   best thing for most places in which pkgsrc is used. Please use your
                   9251:   judgement about what should go into pkgsrc, and bear in mind that
1.87      wiz      9252:   stability is to be preferred above new and possibly untested features.</p>
1.75      rillig   9253: </div>
                   9254: <div class="sect1" lang="en">
                   9255: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9256: <a name="moving-package"></a>20.6. Moving a package in pkgsrc</h2></div></div></div>
1.75      rillig   9257: <div class="orderedlist"><ol type="1">
                   9258: <li><p>Make a copy of the directory somewhere else.</p></li>
                   9259: <li>
                   9260: <p>Remove all CVS dirs.</p>
1.87      wiz      9261: <p>Alternatively to the first two steps you can also do:</p>
1.75      rillig   9262: <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      9263: <p>and use that for further work.</p>
1.75      rillig   9264: </li>
                   9265: <li><p>Fix <code class="varname">CATEGORIES</code> and any
                   9266: <code class="varname">DEPENDS</code> paths that just did &#8220;<span class="quote">../package</span>&#8221;
                   9267: instead of &#8220;<span class="quote">../../category/package</span>&#8221;.</p></li>
                   9268: <li><p><span><strong class="command">cvs import</strong></span> the modified package in the new
                   9269: place.</p></li>
                   9270: <li>
                   9271: <p>Check if any package depends on it:
                   9272: </p>
                   9273: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   9274: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   9275: </li>
                   9276: <li><p>Fix paths in packages from step 5 to point to new location.</p></li>
                   9277: <li><p><span><strong class="command">cvs rm (-f)</strong></span> the package at the old location.</p></li>
1.76      rillig   9278: <li><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   9279: <li><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
1.75      rillig   9280: <li>
                   9281: <p>Commit the changed and removed files:</p>
                   9282: <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      9283: <p>(and any packages from step 5, of course).</p>
1.75      rillig   9284: </li>
                   9285: </ol></div>
                   9286: </div>
                   9287: </div>
                   9288: <div class="chapter" lang="en">
                   9289: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   9290: <a name="devfaq"></a>Chapter 21. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   9291: <p>This section contains the answers to questions that may
                   9292:        arise when you are writing a package. If you don't find your
                   9293:        question answered here, first have a look in the other chapters,
                   9294:        and if you still don't have the answer, ask on the
                   9295:        <code class="literal">pkgsrc-users</code> mailing list.</p>
                   9296: <div class="qandaset">
                   9297: <dl>
1.93      rillig   9298: <dt>21.1. <a href="#devfaq.makeflags">What is the difference between
1.75      rillig   9299:        MAKEFLAGS, .MAKEFLAGS and
                   9300:        MAKE_FLAGS?</a>
                   9301: </dt>
1.93      rillig   9302: <dt>21.2. <a href="#devfaq.make">What is the difference between
1.75      rillig   9303:        MAKE, GMAKE and
                   9304:        MAKE_PROGRAM?</a>
                   9305: </dt>
1.93      rillig   9306: <dt>21.3. <a href="#devfaq.cc">What is the difference between
1.75      rillig   9307:        CC, PKG_CC and
                   9308:        PKGSRC_COMPILER?</a>
                   9309: </dt>
1.93      rillig   9310: <dt>21.4. <a href="#devfaq.bl3flags">What is the difference between
1.75      rillig   9311:        BUILDLINK_LDFLAGS,
                   9312:        BUILDLINK_LDADD and
                   9313:        BUILDLINK_LIBS?</a>
                   9314: </dt>
1.93      rillig   9315: <dt>21.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75      rillig   9316:        VARNAME=BUILDLINK_PREFIX.foo
                   9317:        say it's empty?</a>
                   9318: </dt>
1.93      rillig   9319: <dt>21.6. <a href="#devfaq.master_sites">What does
1.78      rillig   9320:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   9321:        don't understand the := inside
                   9322:        it.</a>
                   9323: </dt>
1.93      rillig   9324: <dt>21.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78      rillig   9325:        developers?</a>
                   9326: </dt>
1.93      rillig   9327: <dt>21.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80      rillig   9328:        documentation?</a>
                   9329: </dt>
1.92      rillig   9330: <dt>21.9. <a href="#devfaq.too-much-time">I have a little time to kill.  What shall I
                   9331: do?</a>
                   9332: </dt>
1.75      rillig   9333: </dl>
                   9334: <table border="0" summary="Q and A Set">
                   9335: <col align="left" width="1%">
                   9336: <tbody>
                   9337: <tr class="question">
                   9338: <td align="left" valign="top">
1.95    ! tron     9339: <a name="devfaq.makeflags"></a><a name="id2686092"></a><b>21.1.</b>
1.75      rillig   9340: </td>
                   9341: <td align="left" valign="top"><p>What is the difference between
                   9342:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   9343:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   9344: </tr>
                   9345: <tr class="answer">
1.91      rillig   9346: <td align="left" valign="top"></td>
1.75      rillig   9347: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
                   9348:        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
                   9349:        <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
                   9350:        the <code class="varname">MAKE_PROGRAM</code> when building the
                   9351:        package. [FIXME: What is .MAKEFLAGS for?]</p></td>
                   9352: </tr>
                   9353: <tr class="question">
                   9354: <td align="left" valign="top">
1.95    ! tron     9355: <a name="devfaq.make"></a><a name="id2686131"></a><b>21.2.</b>
1.75      rillig   9356: </td>
                   9357: <td align="left" valign="top"><p>What is the difference between
                   9358:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   9359:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   9360: </tr>
                   9361: <tr class="answer">
1.91      rillig   9362: <td align="left" valign="top"></td>
1.75      rillig   9363: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
                   9364:        <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
                   9365:        infrastructure. <code class="varname">GMAKE</code> is the path to GNU
                   9366:        Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
                   9367:        use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
                   9368:        Make program that is used for building the
                   9369:        package.</p></td>
                   9370: </tr>
                   9371: <tr class="question">
                   9372: <td align="left" valign="top">
1.95    ! tron     9373: <a name="devfaq.cc"></a><a name="id2686171"></a><b>21.3.</b>
1.75      rillig   9374: </td>
                   9375: <td align="left" valign="top"><p>What is the difference between
                   9376:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   9377:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   9378: </tr>
                   9379: <tr class="answer">
1.91      rillig   9380: <td align="left" valign="top"></td>
1.75      rillig   9381: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
                   9382:        compiler, which can be configured by the pkgsrc user.
                   9383:        <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
                   9384:        <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
                   9385:        path to a compiler, but the type of compiler that should be
1.76      rillig   9386:        used. See <code class="filename">mk/compiler.mk</code> for more
1.75      rillig   9387:        information about the latter variable.</p></td>
                   9388: </tr>
                   9389: <tr class="question">
                   9390: <td align="left" valign="top">
1.95    ! tron     9391: <a name="devfaq.bl3flags"></a><a name="id2686211"></a><b>21.4.</b>
1.75      rillig   9392: </td>
                   9393: <td align="left" valign="top"><p>What is the difference between
                   9394:        <code class="varname">BUILDLINK_LDFLAGS</code>,
                   9395:        <code class="varname">BUILDLINK_LDADD</code> and
                   9396:        <code class="varname">BUILDLINK_LIBS</code>?</p></td>
                   9397: </tr>
                   9398: <tr class="answer">
1.91      rillig   9399: <td align="left" valign="top"></td>
1.75      rillig   9400: <td align="left" valign="top"><p>[FIXME]</p></td>
                   9401: </tr>
                   9402: <tr class="question">
                   9403: <td align="left" valign="top">
1.95    ! tron     9404: <a name="devfaq.bl3prefix"></a><a name="id2686299"></a><b>21.5.</b>
1.75      rillig   9405: </td>
                   9406: <td align="left" valign="top"><p>Why does <span><strong class="command">make show-var
                   9407:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   9408:        say it's empty?</p></td>
                   9409: </tr>
                   9410: <tr class="answer">
1.91      rillig   9411: <td align="left" valign="top"></td>
1.75      rillig   9412: <td align="left" valign="top"><p>For optimization reasons, some variables are only
                   9413:        available in the &#8220;<span class="quote">wrapper</span>&#8221; phase and later. To
                   9414:        &#8220;<span class="quote">simulate</span>&#8221; the wrapper phase, append
                   9415:        <span><strong class="command">PKG_PHASE=wrapper</strong></span> to the above
                   9416:        command.</p></td>
                   9417: </tr>
1.78      rillig   9418: <tr class="question">
                   9419: <td align="left" valign="top">
1.95    ! tron     9420: <a name="devfaq.master_sites"></a><a name="id2686329"></a><b>21.6.</b>
1.78      rillig   9421: </td>
                   9422: <td align="left" valign="top"><p>What does
                   9423:        <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   9424:        don't understand the <code class="literal">:=</code> inside
                   9425:        it.</p></td>
                   9426: </tr>
                   9427: <tr class="answer">
1.91      rillig   9428: <td align="left" valign="top"></td>
1.78      rillig   9429: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
                   9430:        assignment operator, like you might expect at first sight.
                   9431:        Instead, it is a degenerate form of
                   9432:        <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
                   9433:        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
                   9434:        may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
                   9435:        case of <code class="varname">MASTER_SITE_*</code>,
                   9436:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   9437:        <em class="replaceable"><code>new_string</code></em> is
                   9438:        <code class="literal">package/</code>. That's where the
                   9439:        <code class="literal">:</code> and the <code class="literal">=</code> fall
                   9440:        together.</p></td>
                   9441: </tr>
                   9442: <tr class="question">
                   9443: <td align="left" valign="top">
1.95    ! tron     9444: <a name="devfaq.mailinglists"></a><a name="id2686406"></a><b>21.7.</b>
1.78      rillig   9445: </td>
                   9446: <td align="left" valign="top"><p>Which mailing lists are there for package
                   9447:        developers?</p></td>
                   9448: </tr>
                   9449: <tr class="answer">
1.91      rillig   9450: <td align="left" valign="top"></td>
1.78      rillig   9451: <td align="left" valign="top"><div class="variablelist"><dl>
                   9452: <dt><span class="term"><a href="http://www.NetBSD.org/MailingLists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
                   9453: <dd><p>This is a list for technical discussions related
                   9454:        to pkgsrc development, e.g. soliciting feedback for changes to
                   9455:        pkgsrc infrastructure, proposed new features, questions related
                   9456:        to porting pkgsrc to a new platform, advice for maintaining a
                   9457:        package, patches that affect many packages, help requests moved
                   9458:        from pkgsrc-users when an infrastructure bug is found,
                   9459:        etc.</p></dd>
                   9460: <dt><span class="term"><a href="http://www.NetBSD.org/MailingLists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
                   9461: <dd><p>All bug reports in category "pkg" sent with
                   9462:        <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
                   9463:        directly; use one of the other mailing
                   9464:        lists.</p></dd>
                   9465: </dl></div></td>
                   9466: </tr>
1.80      rillig   9467: <tr class="question">
                   9468: <td align="left" valign="top">
1.95    ! tron     9469: <a name="devfaq.documentation"></a><a name="id2686513"></a><b>21.8.</b>
1.80      rillig   9470: </td>
                   9471: <td align="left" valign="top"><p>Where is the pkgsrc
                   9472:        documentation?</p></td>
                   9473: </tr>
                   9474: <tr class="answer">
1.91      rillig   9475: <td align="left" valign="top"></td>
1.80      rillig   9476: <td align="left" valign="top">
                   9477: <p>There are many places where you can find
                   9478:        documentation about pkgsrc:</p>
                   9479: <div class="itemizedlist"><ul type="disc">
                   9480: <li><p>The pkgsrc guide (this document) is a collection
                   9481:        of chapters that explain large parts of pkgsrc, but some
                   9482:        chapters tend to be outdated. Which ones they are is hard to
                   9483:        say.</p></li>
                   9484: <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
                   9485:        about certain features, announcements of new parts of the pkgsrc
                   9486:        infrastructure and sometimes even announcements that a certain
                   9487:        feature has been marked as obsolete. The benefit here is that
                   9488:        each message has a date appended to it.</p></li>
                   9489: <li><p>Many of the files in the
                   9490:        <code class="filename">mk/</code> directory start with a comment that
                   9491:        describes the purpose of the file and how it can be used by the
1.92      rillig   9492:        pkgsrc user and package authors. An easy way to find this
                   9493:        documentation is to run <span><strong class="command">bmake
                   9494:        help</strong></span>.</p></li>
1.80      rillig   9495: <li><p>The CVS log messages are a rich source of
                   9496:        information, but they tend to be highly abbreviated, especially
                   9497:        for actions that occur often. Some contain a detailed
                   9498:        description of what has changed, but they are geared towards the
                   9499:        other pkgsrc developers, not towards an average pkgsrc user.
                   9500:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   9501:        don't know what has been before, these messages may not be worth
                   9502:        too much to you.</p></li>
                   9503: <li><p>Some parts of pkgsrc are only &#8220;<span class="quote">implicitly
                   9504:        documented</span>&#8221;, that is the documentation exists only in the
                   9505:        mind of the developer who wrote the code. To get this
1.93      rillig   9506:        information, use the <span><strong class="command">cvs annotate</strong></span> command
1.80      rillig   9507:        to see who has written it and ask on the
                   9508:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   9509:        find your questions later (see above). To be sure that the
                   9510:        developer in charge reads the mail, you may CC him or
                   9511:        her.</p></li>
                   9512: </ul></div>
                   9513: </td>
                   9514: </tr>
1.92      rillig   9515: <tr class="question">
                   9516: <td align="left" valign="top">
1.95    ! tron     9517: <a name="devfaq.too-much-time"></a><a name="id2686574"></a><b>21.9.</b>
1.92      rillig   9518: </td>
                   9519: <td align="left" valign="top"><p>I have a little time to kill.  What shall I
                   9520: do?</p></td>
                   9521: </tr>
                   9522: <tr class="answer">
                   9523: <td align="left" valign="top"></td>
                   9524: <td align="left" valign="top">
1.93      rillig   9525: <p>This is not really an FAQ yet, but here's the answer
1.92      rillig   9526: anyway.</p>
                   9527: <div class="itemizedlist"><ul type="disc">
                   9528: <li><p>Run <span><strong class="command">pkg_chk -N</strong></span> (from the
                   9529:     <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
                   9530:     will tell you about newer versions of installed packages that are
                   9531:     available, but not yet updated in pkgsrc.</p></li>
                   9532: <li><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
                   9533:     &mdash; it contains a list of suggested new packages and a list of
                   9534:     cleanups and enhancements for pkgsrc that would be nice to
                   9535:     have.</p></li>
                   9536: <li><p>Review packages for which review was requested on
                   9537:     the <a href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
                   9538:     mailing list.</p></li>
                   9539: </ul></div>
                   9540: </td>
                   9541: </tr>
1.75      rillig   9542: </tbody>
                   9543: </table>
                   9544: </div>
                   9545: </div>
1.85      jmmv     9546: <div class="chapter" lang="en">
                   9547: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   9548: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
1.85      jmmv     9549: <div class="toc">
                   9550: <p><b>Table of Contents</b></p>
                   9551: <dl>
1.90      rillig   9552: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                   9553: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                   9554: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                   9555: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
1.85      jmmv     9556: </dl>
                   9557: </div>
                   9558: <p>Quoting <a href="http://www.gnome.org/" target="_top">GNOME's web
                   9559: site</a>:</p>
                   9560: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   9561:   environment, an intuitive and attractive desktop for users, and the
                   9562:   GNOME development platform, an extensive framework for building
                   9563:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   9564: <p>pkgsrc provides a seamless way to automatically build and install
                   9565: a complete GNOME environment <span class="emphasis"><em>under many different
                   9566: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   9567: the most advanced build and packaging systems for GNOME due to its
                   9568: included technologies buildlink3, the wrappers and tools framework and
                   9569: automatic configuration file management.  Lots of efforts are put into
                   9570: achieving a completely clean deinstallation of installed software
                   9571: components.</p>
                   9572: <p>Given that pkgsrc is <a href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
                   9573: the above also means that great efforts are put into making GNOME work
                   9574: under this operating system.  Recently, <a href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
                   9575: pkgsrc as its preferred packaging system, contributing lots of
                   9576: portability fixes to make GNOME build and install under it.</p>
                   9577: <p>This chapter is aimed at pkgsrc developers and other people
                   9578: interested in helping our GNOME porting and packaging efforts.  It
                   9579: provides instructions on how to manage the existing packages and some
                   9580: important information regarding their internals.</p>
                   9581: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   9582: <h3 class="title">We need your help!</h3>
                   9583: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
                   9584:   and GNOME and are willing to learn new exciting stuff, please jump
                   9585:   straight to the <a href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
                   9586:   work</a> list!  There is still a long way to go to get a
                   9587:   fully-functional GNOME desktop under NetBSD and we need your help to
                   9588:   achieve it!</p>
                   9589: </div>
                   9590: <div class="sect1" lang="en">
                   9591: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9592: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
1.85      jmmv     9593: <p>pkgsrc includes three GNOME-related meta packages:</p>
                   9594: <div class="itemizedlist"><ul type="disc">
1.91      rillig   9595: <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     9596:     the core GNOME desktop environment.  It only includes the necessary
                   9597:     bits to get it to boot correctly, although it may lack important
                   9598:     functionality for daily operation.  The idea behind this package is
                   9599:     to let end users build their own configurations on top of this one,
                   9600:     first installing this meta package to achieve a functional setup and
                   9601:     then adding individual applications.</p></li>
1.91      rillig   9602: <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     9603:     complete installation of the GNOME platform and desktop as defined
                   9604:     by the GNOME project; this is based on the components distributed in
                   9605:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   9606:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   9607:     official FTP server.  Developer-only tools found in those
                   9608:     directories are not installed unless required by some other
                   9609:     component to work properly.  Similarly, packages from the bindings
                   9610:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   9611:     in unless required as a dependency for an end-user component.  This
1.91      rillig   9612:     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>
                   9613: <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     9614:     Installs all the tools required to build a GNOME component when
                   9615:     fetched from the CVS repository.  These are required to let the
                   9616:     <span><strong class="command">autogen.sh</strong></span> scripts work appropriately.</p></li>
                   9617: </ul></div>
                   9618: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   9619: sorted in a way that eases updates: a package may depend on other
                   9620: packages listed before it but not on any listed after it.  It is very
                   9621: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   9622: change it to alphabetical sorting!</em></span></p>
                   9623: </div>
                   9624: <div class="sect1" lang="en">
                   9625: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9626: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
1.85      jmmv     9627: <p>Almost all GNOME applications are written in C and use a common
                   9628: set of tools as their build system.  Things get different with the new
                   9629: bindings to other languages (such as Python), but the following will
                   9630: give you a general idea on the minimum required tools:</p>
                   9631: <div class="itemizedlist"><ul type="disc">
                   9632: <li>
                   9633: <p>Almost all GNOME applications use the GNU Autotools as their
                   9634:     build system.  As a general rule you will need to tell this to your
                   9635:     package:</p>
                   9636: <pre class="programlisting">GNU_CONFIGURE=yes
                   9637: USE_LIBTOOL=yes
                   9638: USE_TOOLS+=gmake</pre>
                   9639: </li>
                   9640: <li>
                   9641: <p>If the package uses pkg-config to detect dependencies, add this
                   9642:     tool to the list of required utilities:</p>
                   9643: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.91      rillig   9644: <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     9645:     the end of the build process to ensure that you did not miss to
                   9646:     specify any dependency in your package and that the version
                   9647:     requirements are all correct.</p>
                   9648: </li>
1.93      rillig   9649: <li><p>If the package uses intltool, be sure to add
                   9650:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85      jmmv     9651:     to handle dependencies and to force the package to use the latest
                   9652:     available version.</p></li>
                   9653: <li>
                   9654: <p>If the package uses gtk-doc (a documentation generation
                   9655:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   9656:     tool is rather big and the distfile should come with pregenerated
                   9657:     documentation anyway; if it does not, it is a bug that you ought to
                   9658:     report.  For such packages you should disable gtk-doc (unless it is
1.89      rillig   9659:     the default):</p>
                   9660: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
                   9661: <p>The default location of installed HTML files
                   9662:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   9663:     and should not be changed unless the package insists on installing
                   9664:     them somewhere else.  Otherwise programs as
                   9665:     <span><strong class="command">devhelp</strong></span> will not be able to open them.  You can
                   9666:     do that with an entry similar to:</p>
                   9667: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
1.85      jmmv     9668: </li>
                   9669: </ul></div>
                   9670: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   9671: files under the installation prefix to maintain databases.  In this
                   9672: context, shared means that those exact same directories and files are
                   9673: used among several different packages, leading to conflicts in the
                   9674: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   9675: handle the most common cases, so you have to forget about using
                   9676: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   9677: omitting shared files from them.  If you find yourself doing those,
                   9678: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   9679: <p>The following table lists the common situations that result in
                   9680: using shared directories or files.  For each of them, the appropriate
                   9681: solution is given.  After applying the solution be sure to
                   9682: <span class="emphasis"><em>regenerate the package's file list</em></span> with
                   9683: <span><strong class="command">make print-PLIST</strong></span> and ensure it is correct.</p>
                   9684: <div class="table">
1.90      rillig   9685: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
1.91      rillig   9686: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
1.85      jmmv     9687: <colgroup>
                   9688: <col>
                   9689: <col>
                   9690: </colgroup>
                   9691: <thead><tr>
                   9692: <th>If the package...</th>
                   9693: <th>Then...</th>
                   9694: </tr></thead>
                   9695: <tbody>
                   9696: <tr>
                   9697: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.90      rillig   9698: <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     9699: </tr>
                   9700: <tr>
                   9701: <td>Installs icons under the
                   9702:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   9703:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.90      rillig   9704: <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     9705: </tr>
                   9706: <tr>
                   9707: <td>Installs files under
                   9708:         <code class="filename">share/mime/packages</code>.</td>
1.90      rillig   9709: <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     9710: </tr>
                   9711: <tr>
                   9712: <td>Installs <code class="filename">.desktop</code> files under
                   9713:         <code class="filename">share/applications</code> and these include MIME
                   9714:         information.</td>
1.90      rillig   9715: <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     9716: </tr>
                   9717: </tbody>
1.91      rillig   9718: </table></div>
1.85      jmmv     9719: </div>
1.91      rillig   9720: <br class="table-break">
1.85      jmmv     9721: </div>
                   9722: <div class="sect1" lang="en">
                   9723: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9724: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
1.85      jmmv     9725: <p>When seeing GNOME as a whole, there are two kinds of
                   9726: updates:</p>
                   9727: <div class="variablelist"><dl>
                   9728: <dt><span class="term">Major update</span></dt>
                   9729: <dd>
                   9730: <p>Given that there is still a very long way for GNOME 3 (if it
                   9731:       ever appears), we consider a major update one that goes from a
                   9732:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   9733:       where <code class="literal">Y</code> is even and greater than
                   9734:       <code class="literal">X</code>.  These are hard to achieve because they
                   9735:       introduce lots of changes in the components' code and almost all
                   9736:       GNOME distfiles are updated to newer versions.  Some of them can
                   9737:       even break API and ABI compatibility with the previous major
                   9738:       version series.  As a result, the update needs to be done all at
                   9739:       once to minimize breakage.</p>
                   9740: <p>A major update typically consists of around 80 package
                   9741:       updates and the addition of some new ones.</p>
                   9742: </dd>
                   9743: <dt><span class="term">Minor update</span></dt>
                   9744: <dd>
                   9745: <p>We consider a minor update one that goes from a
                   9746:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   9747:       one where <code class="literal">Y</code> is greater than
                   9748:       <code class="literal">X</code>.  These are easy to achieve because they do
                   9749:       not update all GNOME components, can be done in an incremental way
                   9750:       and do not break API nor ABI compatibility.</p>
                   9751: <p>A minor update typically consists of around 50 package
                   9752:       updates, although the numbers here may vary a lot.</p>
                   9753: </dd>
                   9754: </dl></div>
                   9755: <p>In order to update the GNOME components in pkgsrc to a new stable
                   9756: release (either major or minor), the following steps should be
                   9757: followed:</p>
                   9758: <div class="orderedlist"><ol type="1">
                   9759: <li>
                   9760: <p>Get a list of all the tarballs that form the new release by
                   9761:     using the following commands.  These will leave the full list of the
                   9762:     components's distfiles into the <code class="filename">list.txt</code>
                   9763:     file:</p>
1.88      wiz      9764: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85      jmmv     9765:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   9766:     awk '{ print $9 }' &gt;list.txt</code></strong>
1.88      wiz      9767: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85      jmmv     9768:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   9769:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
                   9770: </li>
                   9771: <li><p>Open each meta package's <code class="filename">Makefile</code> and
                   9772:     bump their version to the release you are updating them to.  The
                   9773:     three meta packages should be always consistent with versioning.
                   9774:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   9775:     in them.</p></li>
                   9776: <li>
                   9777: <p>For each meta package, update all its
                   9778:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   9779:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   9780:     newer version (even if found in the FTP) because the meta packages
                   9781:     are supposed to list the exact versions that form a specific GNOME
                   9782:     release.  Exceptions are permitted here if a newer version solves a
                   9783:     serious issue in the overall desktop experience; these typically
                   9784:     come in the form of a revision bump in pkgsrc, not in newer versions
                   9785:     from the developers.</p>
                   9786: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   9787:     should be updated to the latest version available (if found in
                   9788:     pkgsrc).  This is the case, for example, of the dependencies on the
1.91      rillig   9789:     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     9790: </li>
                   9791: <li>
                   9792: <p>Generate a patch from the modified meta packages and extract the
                   9793:     list of "new" lines.  This will provide you an outline on what
                   9794:     packages need to be updated in pkgsrc and in what order:</p>
1.93      rillig   9795: <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     9796: </li>
                   9797: <li><p>For major desktop updates it is recommended to zap all your
                   9798:     installed packages and start over from scratch at this point.</p></li>
                   9799: <li><p>Now comes the longest step by far: iterate over the contents
                   9800:     of <code class="filename">todo.txt</code> and update the packages listed in
                   9801:     it in order.  For major desktop updates none of these should be
1.93      rillig   9802:     committed until the entire set is completed because there are chances
1.85      jmmv     9803:     of breaking not-yet-updated packages.</p></li>
                   9804: <li><p>Once the packages are up to date and working, commit them to
                   9805:     the tree one by one with appropriate log messages.  At the end,
                   9806:     commit the three meta package updates and all the corresponding
                   9807:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
                   9808:     <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>
                   9809: </ol></div>
                   9810: </div>
                   9811: <div class="sect1" lang="en">
                   9812: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9813: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
1.85      jmmv     9814: <p>GNOME is a very big component in pkgsrc which approaches 100
                   9815: packages.  Please, it is very important that you always, always,
                   9816: <span class="strong"><strong>always</strong></span> feed back any portability
1.93      rillig   9817: 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     9818: their attention on portability issues and to ensure that future versions
                   9819: can be built out-of-the box on NetBSD.  The less custom patches in
                   9820: pkgsrc, the easier further updates are.  Those developers in charge of
                   9821: issuing major GNOME updates will be grateful if you do that.</p>
                   9822: <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
                   9823: Bugzilla</a>.  Not all components use these to track bugs, but most
                   9824: of them do.  Do not be short on your reports: always provide detailed
                   9825: explanations of the current failure, how it can be improved to achieve
                   9826: maximum portability and, if at all possible, provide a patch against CVS
                   9827: head.  The more verbose you are, the higher chances of your patch being
                   9828: accepted.</p>
                   9829: <p>Also, please avoid using preprocessor magic to fix portability
                   9830: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   9831: GNOME to their operating system, the official GNOME sources are now
                   9832: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   9833: and similar macros.  This hurts portability.  Please see our patching
1.93      rillig   9834: 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     9835: details.</p>
                   9836: </div>
                   9837: </div>
1.75      rillig   9838: </div>
                   9839: <div class="part" lang="en">
                   9840: <div class="titlepage"><div><div><h1 class="title">
                   9841: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
                   9842: <div class="partintro" lang="en">
                   9843: <div></div>
                   9844: <p>This part of the guide deals with everything
                   9845:        from the infrastructure that is behind the interfaces described
                   9846:        in the developer's guide. A casual package maintainer should not
                   9847:        need anything from this part.</p>
                   9848: <div class="toc">
                   9849: <p><b>Table of Contents</b></p>
                   9850: <dl>
1.90      rillig   9851: <dt><span class="chapter"><a href="#infr.design">23. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig   9852: <dd><dl>
1.90      rillig   9853: <dt><span class="sect1"><a href="#infr.vardef">23.1. The meaning of variable definitions</a></span></dt>
                   9854: <dt><span class="sect1"><a href="#infr.vardef.problems">23.2. Avoiding problems before they arise</a></span></dt>
                   9855: <dt><span class="sect1"><a href="#infr.var">23.3. Variable evaluation</a></span></dt>
1.75      rillig   9856: <dd><dl>
1.90      rillig   9857: <dt><span class="sect2"><a href="#infr.var.load">23.3.1. At load time</a></span></dt>
                   9858: <dt><span class="sect2"><a href="#infr.var.run">23.3.2. At runtime</a></span></dt>
1.75      rillig   9859: </dl></dd>
1.90      rillig   9860: <dt><span class="sect1"><a href="#infr.varspec">23.4. How can variables be specified?</a></span></dt>
                   9861: <dt><span class="sect1"><a href="#infr.design.intf">23.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   9862: <dd><dl>
1.90      rillig   9863: <dt><span class="sect2"><a href="#infr.design.intf.proc">23.5.1. Procedures with parameters</a></span></dt>
                   9864: <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   9865: </dl></dd>
1.90      rillig   9866: <dt><span class="sect1"><a href="#infr.order">23.6. The order in which files are loaded</a></span></dt>
1.81      rillig   9867: <dd><dl>
1.90      rillig   9868: <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>
                   9869: <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   9870: </dl></dd>
                   9871: </dl></dd>
1.90      rillig   9872: <dt><span class="chapter"><a href="#regression">24. Regression tests</a></span></dt>
1.75      rillig   9873: <dd><dl>
1.90      rillig   9874: <dt><span class="sect1"><a href="#regression.descr">24.1. The regression tests framework</a></span></dt>
                   9875: <dt><span class="sect1"><a href="#regression.run">24.2. Running the regression tests</a></span></dt>
                   9876: <dt><span class="sect1"><a href="#regression.new">24.3. Adding a new regression test</a></span></dt>
1.75      rillig   9877: <dd><dl>
1.90      rillig   9878: <dt><span class="sect2"><a href="#regression.fun.override">24.3.1. Overridable functions</a></span></dt>
                   9879: <dt><span class="sect2"><a href="#regression.fun.helper">24.3.2. Helper functions</a></span></dt>
1.75      rillig   9880: </dl></dd>
                   9881: </dl></dd>
1.90      rillig   9882: <dt><span class="chapter"><a href="#porting">25. Porting pkgsrc</a></span></dt>
1.75      rillig   9883: <dd><dl>
1.90      rillig   9884: <dt><span class="sect1"><a href="#porting.opsys">25.1. Porting pkgsrc to a new operating system</a></span></dt>
                   9885: <dt><span class="sect1"><a href="#porting.compiler">25.2. Adding support for a new compiler</a></span></dt>
1.75      rillig   9886: </dl></dd>
                   9887: </dl>
                   9888: </div>
                   9889: </div>
                   9890: <div class="chapter" lang="en">
                   9891: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   9892: <a name="infr.design"></a>Chapter 23. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75      rillig   9893: <div class="toc">
                   9894: <p><b>Table of Contents</b></p>
                   9895: <dl>
1.90      rillig   9896: <dt><span class="sect1"><a href="#infr.vardef">23.1. The meaning of variable definitions</a></span></dt>
                   9897: <dt><span class="sect1"><a href="#infr.vardef.problems">23.2. Avoiding problems before they arise</a></span></dt>
                   9898: <dt><span class="sect1"><a href="#infr.var">23.3. Variable evaluation</a></span></dt>
1.81      rillig   9899: <dd><dl>
1.90      rillig   9900: <dt><span class="sect2"><a href="#infr.var.load">23.3.1. At load time</a></span></dt>
                   9901: <dt><span class="sect2"><a href="#infr.var.run">23.3.2. At runtime</a></span></dt>
1.81      rillig   9902: </dl></dd>
1.90      rillig   9903: <dt><span class="sect1"><a href="#infr.varspec">23.4. How can variables be specified?</a></span></dt>
                   9904: <dt><span class="sect1"><a href="#infr.design.intf">23.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   9905: <dd><dl>
1.90      rillig   9906: <dt><span class="sect2"><a href="#infr.design.intf.proc">23.5.1. Procedures with parameters</a></span></dt>
                   9907: <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   9908: </dl></dd>
1.90      rillig   9909: <dt><span class="sect1"><a href="#infr.order">23.6. The order in which files are loaded</a></span></dt>
1.75      rillig   9910: <dd><dl>
1.90      rillig   9911: <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>
                   9912: <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   9913: </dl></dd>
                   9914: </dl>
                   9915: </div>
                   9916: <p>The pkgsrc infrastructure consists of many small Makefile
                   9917:        fragments. Each such fragment needs a properly specified
                   9918:        interface. This chapter explains how such an interface looks
                   9919:        like.</p>
                   9920: <div class="sect1" lang="en">
                   9921: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9922: <a name="infr.vardef"></a>23.1. The meaning of variable definitions</h2></div></div></div>
1.81      rillig   9923: <p>Whenever a variable is defined in the pkgsrc
                   9924:        infrastructure, the location and the way of definition provide
                   9925:        much information about the intended use of that variable.
                   9926:        Additionally, more documentation may be found in a header
                   9927:        comment or in this pkgsrc guide.</p>
                   9928: <p>A special file is
                   9929:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   9930:        variables that are intended to be user-defined. They are either
                   9931:        defined using the <code class="literal">?=</code> operator or they are
                   9932:        left undefined because defining them to anything would
                   9933:        effectively mean &#8220;<span class="quote">yes</span>&#8221;. All these variables may be
                   9934:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   9935:        file.</p>
                   9936: <p>Outside this file, the following conventions apply:
                   9937:        Variables that are defined using the <code class="literal">?=</code>
                   9938:        operator may be overridden by a package.</p>
                   9939: <p>Variables that are defined using the <code class="literal">=</code>
                   9940:        operator may be used read-only at run-time.</p>
                   9941: <p>Variables whose name starts with an underscore must not be
                   9942:        accessed outside the pkgsrc infrastructure at all. They may
                   9943:        change without further notice.</p>
                   9944: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   9945: <h3 class="title">Note</h3>
                   9946: <p>These conventions are currently not applied
                   9947:        consistently to the complete pkgsrc
                   9948:        infrastructure.</p>
                   9949: </div>
                   9950: </div>
                   9951: <div class="sect1" lang="en">
                   9952: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9953: <a name="infr.vardef.problems"></a>23.2. Avoiding problems before they arise</h2></div></div></div>
1.81      rillig   9954: <p>All variables that contain lists of things should default
                   9955:        to being empty. Two examples that do not follow this rule are
                   9956:        <code class="varname">USE_LANGUAGES</code> and
                   9957:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   9958:        modified using the <code class="literal">+=</code> operator in package
                   9959:        <code class="filename">Makefile</code>s (or other files included by
                   9960:        them), since there is no guarantee whether the variable is
                   9961:        already set or not, and what its value is. In the case of
                   9962:        <code class="varname">DISTFILES</code>, the packages &#8220;<span class="quote">know</span>&#8221;
                   9963:        the default value and just define it as in the following
                   9964:        example.</p>
                   9965: <pre class="programlisting">
                   9966:     DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
                   9967: </pre>
                   9968: <p>Because of the selection of this default value, the same
                   9969:        value appears in many package Makefiles. Similarly for
                   9970:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
                   9971:        value (&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;) is so short that it
                   9972:        doesn't stand out. Nevertheless it is mentioned in many
                   9973:        files.</p>
                   9974: </div>
                   9975: <div class="sect1" lang="en">
                   9976: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9977: <a name="infr.var"></a>23.3. Variable evaluation</h2></div></div></div>
1.75      rillig   9978: <div class="sect2" lang="en">
                   9979: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   9980: <a name="infr.var.load"></a>23.3.1. At load time</h3></div></div></div>
1.75      rillig   9981: <p>Variable evaluation takes place either at load time or at
                   9982:        runtime, depending on the context in which they occur. The
                   9983:        contexts where variables are evaluated at load time are:</p>
                   9984: <div class="itemizedlist"><ul type="disc">
                   9985: <li><p>The right hand side of the <code class="literal">:=</code>
                   9986:        and <code class="literal">!=</code> operators,</p></li>
                   9987: <li><p>Make directives like <code class="literal">.if</code> or
                   9988:        <code class="literal">.for</code>,</p></li>
                   9989: <li><p>Dependency lines.</p></li>
                   9990: </ul></div>
                   9991: <p>A special exception are references to the iteration
                   9992:        variables of <code class="literal">.for</code> loops, which are expanded
                   9993:        inline, no matter in which context they appear.</p>
                   9994: <p>As the values of variables may change during load time,
                   9995:        care must be taken not to evaluate them by accident. Typical
                   9996:        examples for variables that should not be evaluated at load time
                   9997:        are <code class="varname">DEPENDS</code> and
                   9998:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   9999:        clear, here is an example:</p>
                   10000: <pre class="programlisting">
                   10001:     CONFIGURE_ARGS=         # none
                   10002:     CFLAGS=                 -O
                   10003:     CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
1.1       grant    10004: 
1.75      rillig   10005:     CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
1.1       grant    10006: 
1.75      rillig   10007:     CFLAGS+=                -Wall
                   10008:        </pre>
                   10009: <p>This code shows how the use of the <code class="literal">:=</code>
                   10010:        operator can quickly lead to unexpected results. The first
                   10011:        paragraph is fairly common code. The second paragraph evaluates
                   10012:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   10013:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   10014:        <code class="literal">-Wall</code> is appended to the
                   10015:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   10016:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   10017:        paragraphs from above typically occur in completely unrelated
                   10018:        files.</p>
                   10019: </div>
                   10020: <div class="sect2" lang="en">
                   10021: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   10022: <a name="infr.var.run"></a>23.3.2. At runtime</h3></div></div></div>
1.75      rillig   10023: <p>After all the files have been loaded, the values of the
                   10024:        variables cannot be changed anymore. Variables that are used in
                   10025:        the shell commands are expanded at this point.</p>
                   10026: </div>
                   10027: </div>
                   10028: <div class="sect1" lang="en">
                   10029: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10030: <a name="infr.varspec"></a>23.4. How can variables be specified?</h2></div></div></div>
1.78      rillig   10031: <p>There are many ways in which the definition and use of a
                   10032:        variable can be restricted in order to detect bugs and
                   10033:        violations of the (mostly unwritten) policies. See the
                   10034:        <code class="literal">pkglint</code> developer's documentation for further
                   10035:        details.</p>
                   10036: </div>
                   10037: <div class="sect1" lang="en">
                   10038: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10039: <a name="infr.design.intf"></a>23.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76      rillig   10040: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75      rillig   10041:        of the following classes. Cases where a file falls into more
                   10042:        than one class should be avoided as it often leads to subtle
                   10043:        bugs.</p>
                   10044: <div class="sect2" lang="en">
                   10045: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   10046: <a name="infr.design.intf.proc"></a>23.5.1. Procedures with parameters</h3></div></div></div>
1.75      rillig   10047: <p>In a traditional imperative programming language some of
1.76      rillig   10048:        the <code class="filename">.mk</code> files could be described as
1.89      rillig   10049:        procedures. They take some input parameters and&mdash;after
                   10050:        inclusion&mdash;provide a result in output parameters. Since all
1.76      rillig   10051:        variables in <code class="filename">Makefile</code>s have global scope
1.75      rillig   10052:        care must be taken not to use parameter names that have already
                   10053:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   10054:        bad choice for a parameter name.</p>
                   10055: <p>Procedures are completely evaluated at preprocessing time.
                   10056:        That is, when calling a procedure all input parameters must be
                   10057:        completely resolvable. For example,
                   10058:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   10059:        parameter since it is very likely that further text will be
                   10060:        added after calling the procedure, which would effectively apply
                   10061:        the procedure to only a part of the variable. Also, references
                   10062:        to other variables wit will be modified after calling the
                   10063:        procedure.</p>
                   10064: <p>A procedure can declare its output parameters either as
                   10065:        suitable for use in preprocessing directives or as only
                   10066:        available at runtime. The latter alternative is for variables
                   10067:        that contain references to other runtime variables.</p>
                   10068: <p>Procedures shall be written such that it is possible to
                   10069:        call the procedure more than once. That is, the file must not
                   10070:        contain multiple-inclusion guards.</p>
                   10071: <p>Examples for procedures are
1.76      rillig   10072:        <code class="filename">mk/bsd.options.mk</code> and
                   10073:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75      rillig   10074:        that the parameters are evaluated at load time, they should be
                   10075:        assigned using the <code class="literal">:=</code> operator, which should
                   10076:        be used only for this purpose.</p>
                   10077: </div>
                   10078: <div class="sect2" lang="en">
                   10079: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   10080: <a name="infr.design.intf.action"></a>23.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75      rillig   10081: <p>Action files take some input parameters and may define
                   10082:        runtime variables. They shall not define loadtime variables.
                   10083:        There are action files that are included implicitly by the
                   10084:        pkgsrc infrastructure, while other must be included
                   10085:        explicitly.</p>
                   10086: <p>An example for action files is
1.76      rillig   10087:        <code class="filename">mk/subst.mk</code>.</p>
1.75      rillig   10088: </div>
                   10089: </div>
1.81      rillig   10090: <div class="sect1" lang="en">
                   10091: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10092: <a name="infr.order"></a>23.6. The order in which files are loaded</h2></div></div></div>
1.81      rillig   10093: <p>Package <code class="filename">Makefile</code>s usually consist of
                   10094:        a set of variable definitions, and include the file
                   10095:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   10096:        Before that, they may also include various other
                   10097:        <code class="filename">*.mk</code> files if they need to query the
                   10098:        availability of certain features like the type of compiler or
                   10099:        the X11 implementation. Due to the heavy use of preprocessor
                   10100:        directives like <code class="literal">.if</code> and
                   10101:        <code class="literal">.for</code>, the order in which the files are loaded
                   10102:        matters.</p>
                   10103: <p>This section describes at which point the various files
                   10104:        are loaded and gives reasons for that order.</p>
                   10105: <div class="sect2" lang="en">
                   10106: <div class="titlepage"><div><div><h3 class="title">
1.93      rillig   10107: <a name="infr.order.prefs"></a>23.6.1. The order in <code class="filename">bsd.prefs.mk</code>
                   10108: </h3></div></div></div>
                   10109: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81      rillig   10110:        is to define some essential variables like
                   10111:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   10112:        <code class="varname">MACHINE_ARCH</code>.</p>
                   10113: <p>Then, the user settings are loaded from the file specified
                   10114:        in <code class="varname">MAKECONF</code>. If the bmake command from pkgsrc
                   10115:        is used, <code class="varname">MAKECONF</code> defaults to
                   10116:        <code class="filename"><em class="replaceable"><code>${prefix}</code></em>/etc/mk.conf</code>.
                   10117:        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
                   10118:        <code class="filename">/etc/mk.conf</code>. After that, those variables
                   10119:        that have not been overridden by the user are loaded from
                   10120:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   10121: <p>After the user settings, the system settings and platform
                   10122:        settings are loaded, which may override the user
                   10123:        settings.</p>
                   10124: <p>Then, the tool definitions are loaded. The tool wrappers
                   10125:        are not yet in effect. This only happens when building a
                   10126:        package, so the proper variables must be used instead of the
                   10127:        direct tool names.</p>
                   10128: <p>As the last steps, some essential variables from the
                   10129:        wrapper and the package system flavor are loaded, as well as the
                   10130:        variables that have been cached in earlier phases of a package
                   10131:        build.</p>
                   10132: </div>
                   10133: <div class="sect2" lang="en">
                   10134: <div class="titlepage"><div><div><h3 class="title">
1.93      rillig   10135: <a name="infr.order.pkg"></a>23.6.2. The order in <code class="filename">bsd.pkg.mk</code>
                   10136: </h3></div></div></div>
1.81      rillig   10137: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   10138: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   10139:        loaded, which fill default values for those variables that have
1.93      rillig   10140:        not been defined by the package. These variables may later
1.81      rillig   10141:        be used even in unrelated files.</p>
                   10142: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   10143:        provides the target <code class="literal">error-check</code> that is added
                   10144:        as a special dependency to all other targets that use
                   10145:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   10146:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   10147: <p>Then, the package-specific hacks from
                   10148:        <code class="filename">hacks.mk</code> are included.</p>
                   10149: <p>Then, various other files follow. Most of them don't have
                   10150:        any dependencies on what they need to have included before or
                   10151:        after them, though some do.</p>
                   10152: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   10153:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   10154:        restricts the use of these variables to all the files that have
                   10155:        been included before. Appearances in later files will be
                   10156:        silently ignored.</p>
                   10157: <p>Then, the files for the main targets are included, in the
                   10158:        order of later execution, though the actual order should not
                   10159:        matter.</p>
                   10160: <p>At last, some more files are included that don't set any
                   10161:        interesting variables but rather just define make targets to be
                   10162:        executed.</p>
                   10163: </div>
                   10164: </div>
1.75      rillig   10165: </div>
                   10166: <div class="chapter" lang="en">
                   10167: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   10168: <a name="regression"></a>Chapter 24. Regression tests</h2></div></div></div>
1.75      rillig   10169: <div class="toc">
                   10170: <p><b>Table of Contents</b></p>
                   10171: <dl>
1.90      rillig   10172: <dt><span class="sect1"><a href="#regression.descr">24.1. The regression tests framework</a></span></dt>
                   10173: <dt><span class="sect1"><a href="#regression.run">24.2. Running the regression tests</a></span></dt>
                   10174: <dt><span class="sect1"><a href="#regression.new">24.3. Adding a new regression test</a></span></dt>
1.75      rillig   10175: <dd><dl>
1.90      rillig   10176: <dt><span class="sect2"><a href="#regression.fun.override">24.3.1. Overridable functions</a></span></dt>
                   10177: <dt><span class="sect2"><a href="#regression.fun.helper">24.3.2. Helper functions</a></span></dt>
1.75      rillig   10178: </dl></dd>
                   10179: </dl>
                   10180: </div>
                   10181: <p>The pkgsrc infrastructure consists of a large codebase,
                   10182:        and there are many corners where every little bit of a file is
                   10183:        well thought out, making pkgsrc likely to fail as soon as
                   10184:        anything is changed near those parts. To prevent most changes
                   10185:        from breaking anything, a suite of regression tests should go
                   10186:        along with every important part of the pkgsrc infrastructure.
                   10187:        This chapter describes how regression tests work in pkgsrc and
                   10188:        how you can add new tests.</p>
                   10189: <div class="sect1" lang="en">
                   10190: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10191: <a name="regression.descr"></a>24.1. The regression tests framework</h2></div></div></div>
1.75      rillig   10192: <p></p>
                   10193: </div>
                   10194: <div class="sect1" lang="en">
                   10195: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10196: <a name="regression.run"></a>24.2. Running the regression tests</h2></div></div></div>
1.91      rillig   10197: <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   10198:        provides the <span><strong class="command">pkg_regress</strong></span> command. Then you
                   10199:        can simply run that command, which will run all tests in the
1.76      rillig   10200:        <code class="filename">regress</code> category.</p>
1.75      rillig   10201: </div>
                   10202: <div class="sect1" lang="en">
                   10203: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10204: <a name="regression.new"></a>24.3. Adding a new regression test</h2></div></div></div>
1.76      rillig   10205: <p>Every directory in the <code class="filename">regress</code>
                   10206:        category that contains a file called <code class="filename">spec</code>
1.75      rillig   10207:        is considered a regression test. This file is a shell program
                   10208:        that is included by the <span><strong class="command">pkg_regress</strong></span> command.
                   10209:        The following functions can be overridden to suit your
                   10210:        needs.</p>
                   10211: <div class="sect2" lang="en">
                   10212: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   10213: <a name="regression.fun.override"></a>24.3.1. Overridable functions</h3></div></div></div>
1.75      rillig   10214: <p>These functions do not take any parameters. They are all
                   10215:        called in &#8220;<span class="quote">set -e</span>&#8221; mode, so you should be careful
                   10216:        to check the exitcodes of any commands you run in the
                   10217:        test.</p>
                   10218: <div class="variablelist"><dl>
                   10219: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
                   10220: <dd><p>This function prepares the environment for the
                   10221:        test. By default it does nothing.</p></dd>
                   10222: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
                   10223: <dd><p>This function runs the actual test. By default,
                   10224:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   10225:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   10226:        error messages into the file
                   10227:        <code class="varname">TEST_OUTFILE</code>.</p></dd>
                   10228: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
                   10229: <dd><p>This function is run after the test and is
                   10230:        typically used to compare the actual output from the one that is
                   10231:        expected. It can make use of the various helper functions from
                   10232:        the next section.</p></dd>
                   10233: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
                   10234: <dd><p>This function cleans everything up after the
                   10235:        test has been run. By default it does nothing.</p></dd>
                   10236: </dl></div>
                   10237: </div>
                   10238: <div class="sect2" lang="en">
                   10239: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   10240: <a name="regression.fun.helper"></a>24.3.2. Helper functions</h3></div></div></div>
1.75      rillig   10241: <div class="variablelist"><dl>
                   10242: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
                   10243: <dd><p>This function compares the exitcode of the
                   10244:        <span><strong class="command">do_test()</strong></span> function with its first parameter.
                   10245:        If they differ, the test will fail.</p></dd>
                   10246: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
                   10247: <dd><p>This function checks for each of its parameters
                   10248:        if the output from <span><strong class="command">do_test()</strong></span> matches the
                   10249:        extended regular expression. If it does not, the test will
                   10250:        fail.</p></dd>
                   10251: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
                   10252: <dd><p>This function checks for each of its parameters
                   10253:        if the output from <span><strong class="command">do_test()</strong></span> does
                   10254:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   10255:        If any of the regular expressions matches, the test will
                   10256:        fail.</p></dd>
                   10257: </dl></div>
                   10258: </div>
                   10259: </div>
                   10260: </div>
                   10261: <div class="chapter" lang="en">
                   10262: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   10263: <a name="porting"></a>Chapter 25. Porting pkgsrc</h2></div></div></div>
1.75      rillig   10264: <div class="toc">
                   10265: <p><b>Table of Contents</b></p>
                   10266: <dl>
1.90      rillig   10267: <dt><span class="sect1"><a href="#porting.opsys">25.1. Porting pkgsrc to a new operating system</a></span></dt>
                   10268: <dt><span class="sect1"><a href="#porting.compiler">25.2. Adding support for a new compiler</a></span></dt>
1.75      rillig   10269: </dl>
                   10270: </div>
                   10271: <p>The pkgsrc system has already been ported to many
                   10272:        operating systems, hardware architectures and compilers. This
                   10273:        chapter explains the necessary steps to make pkgsrc even more
                   10274:        portable.</p>
                   10275: <div class="sect1" lang="en">
                   10276: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10277: <a name="porting.opsys"></a>25.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75      rillig   10278: <p>To port pkgsrc to a new operating system (called
                   10279:        <code class="literal">MyOS</code> in this example), you need to touch the
                   10280:        following files:</p>
                   10281: <div class="variablelist"><dl>
1.93      rillig   10282: <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   10283: <dd><p>This file contains some basic definitions, for
                   10284:        example the name of the C
                   10285:        compiler.</p></dd>
1.76      rillig   10286: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75      rillig   10287: <dd><p>Insert code that defines the variables
                   10288:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
                   10289:        <code class="varname">LOWER_OS_VERSION</code>,
                   10290:        <code class="varname">LOWER_VENDOR</code>,
                   10291:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   10292:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   10293:        appear in this file.</p></dd>
1.93      rillig   10294: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10295: <dd><p>This file contains the platform-specific
                   10296:        definitions that are used by pkgsrc. Start by copying one of the
                   10297:        other files and edit it to your
                   10298:        needs.</p></dd>
1.93      rillig   10299: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
1.75      rillig   10300: <dd><p>This file contains a list of directories,
                   10301:        together with their permission bits and ownership. These
                   10302:        directories will be created automatically with every package
                   10303:        that does not explicitly set <code class="varname">NO_MTREE</code>. There
                   10304:        have been some discussions about whether this file is needed at
                   10305:        all, but with no result.</p></dd>
1.93      rillig   10306: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
1.75      rillig   10307: <dd><p>Just copy one of the pre-existing x11.dist files
                   10308:        to your
1.76      rillig   10309:        <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
                   10310: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
1.75      rillig   10311: <dd><p>On some operating systems, the tools that are
                   10312:        provided with the base system are not good enough for pkgsrc.
                   10313:        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
                   10314:        narrow limit on the line length they can process. Therefore
                   10315:        pkgsrc brings its own tools, which can be enabled
                   10316:        here.</p></dd>
1.93      rillig   10317: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10318: <dd><p>This file defines the paths to all the tools
                   10319:        that are needed by one or the other package in pkgsrc, as well
                   10320:        as by pkgsrc itself. Find out where these tools are on your
                   10321:        platform and add them.</p></dd>
                   10322: </dl></div>
                   10323: <p>Now, you should be able to build some basic packages, like
1.91      rillig   10324:        <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   10325: </div>
                   10326: <div class="sect1" lang="en">
                   10327: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10328: <a name="porting.compiler"></a>25.2. Adding support for a new compiler</h2></div></div></div>
1.75      rillig   10329: <p>TODO</p>
                   10330: </div>
                   10331: </div>
                   10332: </div>
                   10333: <div class="appendix" lang="en">
                   10334: <div class="titlepage"><div><div><h2 class="title">
                   10335: <a name="examples"></a>Appendix A. A simple example package: bison</h2></div></div></div>
                   10336: <div class="toc">
                   10337: <p><b>Table of Contents</b></p>
                   10338: <dl>
                   10339: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   10340: <dd><dl>
                   10341: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   10342: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   10343: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
                   10344: <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>
                   10345: </dl></dd>
                   10346: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   10347: </dl>
                   10348: </div>
                   10349: <p>We checked to find a piece of software that wasn't in the packages
                   10350:     collection, and picked GNU bison. Quite why someone would want to have
                   10351:     <span><strong class="command">bison</strong></span> when Berkeley <span><strong class="command">yacc</strong></span> is already
                   10352:     present in the tree is beyond us, but it's useful for the purposes of
                   10353:     this exercise.</p>
                   10354: <div class="sect1" lang="en">
                   10355: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10356: <a name="example-files"></a>A.1. files</h2></div></div></div>
                   10357: <div class="sect2" lang="en">
                   10358: <div class="titlepage"><div><div><h3 class="title">
                   10359: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
                   10360: <pre class="programlisting">
1.51      rillig   10361:     # $NetBSD$
                   10362:     #
1.1       grant    10363: 
1.51      rillig   10364:     DISTNAME=       bison-1.25
                   10365:     CATEGORIES=     devel
                   10366:     MASTER_SITES=   ${MASTER_SITE_GNU}
1.1       grant    10367: 
1.51      rillig   10368:     MAINTAINER=     thorpej@NetBSD.org
                   10369:     HOMEPAGE=       http://www.gnu.org/software/bison/bison.html
                   10370:     COMMENT=        GNU yacc clone
1.1       grant    10371: 
1.51      rillig   10372:     GNU_CONFIGURE=  yes
                   10373:     INFO_FILES=     bison.info
1.1       grant    10374: 
1.51      rillig   10375:     .include "../../mk/bsd.pkg.mk"
1.1       grant    10376: </pre>
1.75      rillig   10377: </div>
                   10378: <div class="sect2" lang="en">
                   10379: <div class="titlepage"><div><div><h3 class="title">
                   10380: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
                   10381: <pre class="programlisting">
1.51      rillig   10382:     GNU version of yacc.  Can make re-entrant parsers, and numerous other
1.75      rillig   10383:     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   10384:     of the NetBSD source tree is beyond me.
1.1       grant    10385: </pre>
1.75      rillig   10386: </div>
                   10387: <div class="sect2" lang="en">
                   10388: <div class="titlepage"><div><div><h3 class="title">
                   10389: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
                   10390: <pre class="programlisting">
1.51      rillig   10391:     @comment $NetBSD$
                   10392:     bin/bison
                   10393:     man/man1/bison.1.gz
                   10394:     share/bison.simple
                   10395:     share/bison.hairy
1.1       grant    10396: </pre>
1.75      rillig   10397: </div>
                   10398: <div class="sect2" lang="en">
                   10399: <div class="titlepage"><div><div><h3 class="title">
1.93      rillig   10400: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span><strong class="command">pkglint</strong></span>
                   10401: </h3></div></div></div>
1.75      rillig   10402: <p>The NetBSD package system comes with
1.91      rillig   10403:         <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   10404:        which helps to check the contents of these
                   10405:        files. After installation it is quite easy to use, just change to the
                   10406:        directory of the package you wish to examine and execute
                   10407:        <span><strong class="command">pkglint</strong></span>:</p>
                   10408: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
                   10409: looks fine.</pre>
                   10410: <p>Depending on the supplied command line arguments (see pkglint(1)),
                   10411:        more checks will be performed. Use e.g. <span><strong class="command">pkglint -Call
                   10412:        -Wall</strong></span> for a very thorough check.</p>
                   10413: </div>
                   10414: </div>
                   10415: <div class="sect1" lang="en">
                   10416: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10417: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
                   10418: <p>Create the directory where the package lives,
                   10419:       plus any auxiliary directories:</p>
                   10420: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   10421: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   10422: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   10423: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76      rillig   10424: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.90      rillig   10425:       <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   10426:       then continue with fetching the distfile:</p>
                   10427: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1       grant    10428: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   10429: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   10430: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10431: ftp: Error retrieving file: 500 Internal error
                   10432: 
                   10433: &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   10434: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10435: ftp: Error retrieving file: 500 Internal error
                   10436: 
                   10437: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   10438: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75      rillig   10439: Successfully retrieved file.</pre>
                   10440: <p>Generate the checksum of the distfile into
1.76      rillig   10441:       <code class="filename">distinfo</code>:</p>
1.88      wiz      10442: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75      rillig   10443: <p>Now compile:</p>
                   10444: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10445: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10446: ===&gt;  Extracting for bison-1.25
                   10447: ===&gt;  Patching for bison-1.25
                   10448: ===&gt;   Ignoring empty patch directory
                   10449: ===&gt;  Configuring for bison-1.25
                   10450: creating cache ./config.cache
                   10451: checking for gcc... cc
                   10452: checking whether we are using GNU C... yes
                   10453: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   10454: checking how to run the C preprocessor... cc -E
                   10455: checking for minix/config.h... no
                   10456: checking for POSIXized ISC... no
                   10457: checking whether cross-compiling... no
                   10458: checking for ANSI C header files... yes
                   10459: checking for string.h... yes
                   10460: checking for stdlib.h... yes
                   10461: checking for memory.h... yes
                   10462: checking for working const... yes
                   10463: checking for working alloca.h... no
                   10464: checking for alloca... yes
                   10465: checking for strerror... yes
                   10466: updating cache ./config.cache
                   10467: creating ./config.status
                   10468: creating Makefile
                   10469: ===&gt;  Building for bison-1.25
                   10470: 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
                   10471: 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
                   10472: 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
                   10473: 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
                   10474: 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   10475: 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    10476: 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
                   10477: 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
                   10478: 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
                   10479: 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
                   10480: 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
                   10481: 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
                   10482: 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
                   10483: 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
                   10484: 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
                   10485: 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
                   10486: 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
                   10487: 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
                   10488: 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
                   10489: 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
                   10490: 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
                   10491: 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
                   10492: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   10493: rm -f bison.s1
1.75      rillig   10494: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   10495: <p>Everything seems OK, so install the files:</p>
                   10496: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10497: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10498: ===&gt;  Installing for bison-1.25
                   10499: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   10500: rm -f /usr/pkg/bin/bison
                   10501: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   10502: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   10503: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   10504: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   10505: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   10506: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   10507: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75      rillig   10508: ===&gt;  Registering installation for bison-1.25</pre>
                   10509: <p>You can now use bison, and also - if you decide so - remove it with
                   10510:       <span><strong class="command">pkg_delete bison</strong></span>. Should you decide that you want a
                   10511:       binary package, do this now:</p>
                   10512: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10513: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10514: ===&gt;  Building package for bison-1.25
                   10515: Creating package bison-1.25.tgz
                   10516: Registering depends:.
1.75      rillig   10517: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   10518: <p>Now that you don't need the source and object files
                   10519:       any more, clean up:</p>
                   10520: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   10521: ===&gt;  Cleaning for bison-1.25</pre>
                   10522: </div>
                   10523: </div>
                   10524: <div class="appendix" lang="en">
                   10525: <div class="titlepage"><div><div><h2 class="title">
                   10526: <a name="logs"></a>Appendix B. Build logs</h2></div></div></div>
                   10527: <div class="toc">
                   10528: <p><b>Table of Contents</b></p>
                   10529: <dl>
                   10530: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                   10531: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                   10532: </dl>
                   10533: </div>
                   10534: <div class="sect1" lang="en">
                   10535: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10536: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
                   10537: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10538: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10539: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   10540: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   10541: =&gt; [172219 bytes]
                   10542: Connected to ftp.plig.net.
                   10543: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   10544: 331 Guest login ok, send your complete e-mail address as password.
                   10545: 230-You are user #5 of 500 simultaneous users allowed.
                   10546: 230-
1.68      rillig   10547: 230-  ___ _             _ _
                   10548: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
1.1       grant    10549: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   10550: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   10551: 230-         |_|   |_|     |___|         |___|
                   10552: 230-
                   10553: 230-** Welcome to ftp.plig.org **
                   10554: 230-
                   10555: 230-Please note that all transfers from this FTP site are logged. If you
                   10556: 230-do not like this, please disconnect now.
                   10557: 230-
                   10558: 230-This arhive is available via
                   10559: 230-
                   10560: 230-HTTP:  http://ftp.plig.org/
                   10561: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   10562: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   10563: 230-
                   10564: 230-Please email comments, bug reports and requests for packages to be
1.68      rillig   10565: 230-mirrored to ftp-admin@plig.org.
1.1       grant    10566: 230-
                   10567: 230-
                   10568: 230 Logged in anonymously.
                   10569: Remote system type is UNIX.
                   10570: Using binary mode to transfer files.
                   10571: 200 Type okay.
                   10572: 250 "/pub" is new cwd.
                   10573: 250-"/pub/figlet" is new cwd.
                   10574: 250-
                   10575: 250-Welcome to the figlet archive at ftp.figlet.org
1.68      rillig   10576: 250-
1.75      rillig   10577: 250-   ftp://ftp.figlet.org/pub/figlet/
1.1       grant    10578: 250-
                   10579: 250-The official FIGlet web page is:
1.75      rillig   10580: 250-   http://www.figlet.org/
1.1       grant    10581: 250-
                   10582: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   10583: 250-contribute a font or something else, you can email us.
1.68      rillig   10584: 250
1.1       grant    10585: 250 "/pub/figlet/program" is new cwd.
                   10586: 250 "/pub/figlet/program/unix" is new cwd.
                   10587: local: figlet221.tar.gz remote: figlet221.tar.gz
                   10588: 502 Unimplemented command.
                   10589: 227 Entering Passive Mode (195,40,6,41,246,104)
                   10590: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   10591: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   10592: 226 Transfer completed.
                   10593: 172219 bytes received in 00:02 (75.99 KB/s)
                   10594: 221 Goodbye.
                   10595: =&gt; Checksum OK for figlet221.tar.gz.
                   10596: ===&gt; Extracting for figlet-2.2.1nb2
                   10597: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   10598: ===&gt; Patching for figlet-2.2.1nb2
                   10599: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   10600: ===&gt; Overriding tools for figlet-2.2.1nb2
                   10601: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   10602: ===&gt; Configuring for figlet-2.2.1nb2
                   10603: ===&gt; Building for figlet-2.2.1nb2
                   10604: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   10605: chmod a+x figlet
                   10606: gcc -O2 -o chkfont chkfont.c
                   10607: =&gt; Unwrapping files-to-be-installed.
1.14      xtraeme  10608: <code class="prompt">#</code>
1.75      rillig   10609: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10610: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10611: ===&gt; Installing for figlet-2.2.1nb2
                   10612: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   10613: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   10614: mkdir -p /usr/pkg/share/figlet
                   10615: cp figlet /usr/pkg/bin
                   10616: cp chkfont /usr/pkg/bin
                   10617: chmod 555 figlist showfigfonts
                   10618: cp figlist /usr/pkg/bin
                   10619: cp showfigfonts /usr/pkg/bin
                   10620: cp fonts/*.flf /usr/pkg/share/figlet
                   10621: cp fonts/*.flc /usr/pkg/share/figlet
                   10622: cp figlet.6 /usr/pkg/man/man6
                   10623: ===&gt; Registering installation for figlet-2.2.1nb2
1.75      rillig   10624: <code class="prompt">#</code></pre>
                   10625: </div>
                   10626: <div class="sect1" lang="en">
                   10627: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10628: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
                   10629: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10630: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10631: ===&gt; Packaging figlet-2.2.1nb2
                   10632: ===&gt; Building binary package for figlet-2.2.1nb2
                   10633: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   10634: Using SrcDir value of /usr/pkg
1.68      rillig   10635: Registering depends:.
1.75      rillig   10636: <code class="prompt">#</code></pre>
                   10637: </div>
                   10638: </div>
                   10639: <div class="appendix" lang="en">
                   10640: <div class="titlepage"><div><div><h2 class="title">
1.76      rillig   10641: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h2></div></div></div>
                   10642: <div class="toc">
                   10643: <p><b>Table of Contents</b></p>
                   10644: <dl>
                   10645: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</a></span></dt>
                   10646: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                   10647: <dt><span class="sect1"><a href="#ftp-iso">C.3. <code class="filename">iso</code>: Currently empty</a></span></dt>
                   10648: <dt><span class="sect1"><a href="#ftp-misc">C.4. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                   10649: <dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages*</code>: Binary packages</a></span></dt>
                   10650: <dt><span class="sect1"><a href="#ftp-source">C.6. <code class="filename">current</code>,
1.93      rillig   10651: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   10652: source packages</a></span></dt>
                   10653: </dl>
                   10654: </div>
                   10655: <p>As in other big projects, the directory layout of pkgsrc
                   10656:        is quite complex for newbies. This chapter explains where you
                   10657:        find things on the FTP server. The base directory on
1.89      rillig   10658:        <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>.
                   10659:        On other servers it may be different, but inside this directory,
                   10660:        everything should look the same, no matter on which server you
                   10661:        are. This directory contains some subdirectories, which are
                   10662:        explained below.</p>
1.76      rillig   10663: <div class="sect1" lang="en">
                   10664: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10665: <a name="ftp-bootstrap"></a>C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</h2></div></div></div>
                   10666: <p>For those who only want to manage binary packages on
                   10667:        systems other than NetBSD, we provide the package management
                   10668:        tools in a separate, small tar file.</p>
                   10669: </div>
                   10670: <div class="sect1" lang="en">
                   10671: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10672: <a name="ftp-distfiles"></a>C.2. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
                   10673: <p>The directory <code class="filename">distfiles</code> contains lots
                   10674:        of archive files from all pkgsrc packages, which are mirrored
                   10675:        here. The subdirectories are called after their package names
                   10676:        and are used when the distributed files have names that don't
                   10677:        explicitly contain a version number or are otherwise too generic
                   10678:        (for example <code class="filename">release.tar.gz</code>).</p>
                   10679: </div>
                   10680: <div class="sect1" lang="en">
                   10681: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10682: <a name="ftp-iso"></a>C.3. <code class="filename">iso</code>: Currently empty</h2></div></div></div>
                   10683: <p>This directory is currently not in use.</p>
                   10684: </div>
                   10685: <div class="sect1" lang="en">
                   10686: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10687: <a name="ftp-misc"></a>C.4. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
                   10688: <p>This directory contains things that individual pkgsrc
                   10689:        developers find worth publishing.</p>
                   10690: </div>
                   10691: <div class="sect1" lang="en">
                   10692: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10693: <a name="ftp-packages"></a>C.5. <code class="filename">packages*</code>: Binary packages</h2></div></div></div>
                   10694: <p>These directories contain binary packages. Those
                   10695:        directories that have a branch name
                   10696:        (200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em>)
                   10697:        contain packages from that particular branch. The directory
                   10698:        <code class="filename">packages</code> contains binary packages from
                   10699:        pkgsrc-current. (However, this does not necessarily mean that
                   10700:        the packages are still current anymore.)</p>
                   10701: <p>Below the <code class="filename">packages*</code> directories are
                   10702:        directories that distinguish the packages by operating system
                   10703:        and version, the next directory level specifies the hardware
                   10704:        architecture.</p>
                   10705: <p>In each of the platform-specific directories, there is a
                   10706:        whole binary packages collection. It has a directory called
                   10707:        <code class="filename">All</code> which contains all binary packages.
                   10708:        Besides that, there are various category directories that
                   10709:        contain symbolic links to the real binary packages.</p>
                   10710: </div>
                   10711: <div class="sect1" lang="en">
                   10712: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10713: <a name="ftp-source"></a>C.6. <code class="filename">current</code>,
1.93      rillig   10714: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   10715: source packages</h2></div></div></div>
                   10716: <p>These directories contain the &#8220;<span class="quote">real</span>&#8221; pkgsrc,
                   10717:        that is the files that define how to create binary packages from
                   10718:        source archives.</p>
                   10719: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89      rillig   10720:        snapshot of the CVS repository, which is updated regularly. The
                   10721:        file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
                   10722:        directory, ready to be downloaded as a whole.</p>
1.76      rillig   10723: <p>In the directories for the quarterly branches, there is an
                   10724:        additional file called
                   10725:        <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
                   10726:        which contains the state of pkgsrc when it was branched.</p>
                   10727: </div>
1.75      rillig   10728: </div>
                   10729: <div class="appendix" lang="en">
                   10730: <div class="titlepage"><div><div><h2 class="title">
                   10731: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h2></div></div></div>
                   10732: <div class="toc">
                   10733: <p><b>Table of Contents</b></p>
                   10734: <dl>
1.79      rillig   10735: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75      rillig   10736: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                   10737: </dl>
                   10738: </div>
1.79      rillig   10739: <p>This section contains information on editing the pkgsrc
                   10740:        guide itself.</p>
1.75      rillig   10741: <div class="sect1" lang="en">
                   10742: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79      rillig   10743: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
                   10744: <p>The pkgsrc guide's source code is stored in
                   10745:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   10746:        are created from it:</p>
                   10747: <div class="itemizedlist"><ul type="disc">
                   10748: <li><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   10749: <li><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
                   10750: <li><p><a href="http://www.NetBSD.org/Documentation/pkgsrc/" target="_top">http://www.NetBSD.org/Documentation/pkgsrc/</a></p></li>
                   10751: <li><p><a href="http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.pdf" target="_top">http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.pdf</a>:
                   10752:        The PDF version of the pkgsrc guide.</p></li>
                   10753: <li><p><a href="http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.ps" target="_top">http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.ps</a>:
                   10754:        PostScript version of the pkgsrc guide.</p></li>
1.75      rillig   10755: </ul></div>
                   10756: </div>
                   10757: <div class="sect1" lang="en">
                   10758: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10759: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79      rillig   10760: <p>The procedure to edit the pkgsrc guide is:</p>
                   10761: <div class="procedure"><ol type="1">
                   10762: <li><p>Make sure you have the packages needed to
1.83      wiz      10763:        regenerate the pkgsrc guide (and other XML-based NetBSD
1.91      rillig   10764:        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
                   10765:        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   10766:        PostScript and PDF versions. You will need both packages
                   10767:        installed, to make sure documentation is consistent across all
                   10768:        formats.</p></li>
                   10769: <li><p>Run <span><strong class="command">cd doc/guide</strong></span> to get to the
                   10770:        right directory. All further steps will take place
                   10771:        here.</p></li>
                   10772: <li><p>Edit the XML file(s) in
                   10773:        <code class="filename">files/</code>.</p></li>
                   10774: <li><p>Run <span><strong class="command">bmake</strong></span> to check the pkgsrc
                   10775:        guide for valid XML and to build the final output files. If you
                   10776:        get any errors at this stage, you can just edit the files, as
                   10777:        there are only symbolic links in the working directory, pointing
                   10778:        to the files in <code class="filename">files/</code>.</p></li>
                   10779: <li><p><span><strong class="command">(cd files &amp;&amp; cvs
                   10780:        commit)</strong></span></p></li>
                   10781: <li><p>Run <span><strong class="command">bmake clean &amp;&amp; bmake</strong></span> to
                   10782:        regenerate the output files with the proper RCS
                   10783:        Ids.</p></li>
1.91      rillig   10784: <li>
                   10785: <p>Run <span><strong class="command">bmake regen</strong></span> to install and
                   10786:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                   10787:        <code class="filename">htdocs</code>.</p>
                   10788: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   10789: <h3 class="title">Note</h3>
                   10790: <p>If you have added, removed or renamed some chapters,
1.83      wiz      10791:        you need to synchronize them using <span><strong class="command">cvs add</strong></span> or
                   10792:        <span><strong class="command">cvs delete</strong></span> in the htdocs
1.91      rillig   10793:        directory.</p>
                   10794: </div>
                   10795: </li>
1.79      rillig   10796: </ol></div>
1.75      rillig   10797: </div>
                   10798: </div>
                   10799: </div></body>
1.1       grant    10800: </html>

CVSweb <webmaster@jp.NetBSD.org>