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

1.75      rillig      1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
                      2: <html>
1.1       grant       3: <head>
1.75      rillig      4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
                      5: <title>The pkgsrc guide</title>
                      6: <link rel="stylesheet" href="/NetBSD.css" type="text/css">
                      7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
1.91      rillig      8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
1.75      rillig      9: </head>
                     10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" lang="en">
                     11: <div class="titlepage">
                     12: <div>
                     13: <div><h1 class="title">
                     14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
                     15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
                     16: <div><div class="authorgroup">
                     17: <div class="author">
                     18: <h3 class="author">
                     19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
                     20: </h3>
                     21: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>&gt;</code></p></div></div>
                     22: </div>
                     23: <div class="author">
                     24: <h3 class="author">
                     25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
                     26: </h3>
                     27: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>&gt;</code></p></div></div>
                     28: </div>
                     29: <h3 class="corpauthor">
                     30:         The pkgsrc Developers
                     31:       </h3>
                     32: </div></div>
                     33: <div><p class="copyright">Copyright © 1994-2006 The NetBSD Foundation, Inc</p></div>
1.92      rillig     34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.24 2006/11/11 05:39:09 rillig Exp $</p></div>
1.76      rillig     35: <div><div class="abstract">
1.75      rillig     36: <p class="title"><b>Abstract</b></p>
                     37: <p>pkgsrc is a centralized package management system for
                     38:        Unix-like operating systems. This guide provides information for
                     39:        users and developers of pkgsrc. It covers installation of binary
                     40:        and source packages, creation of binary and source packages and
                     41:        a high-level overview about the infrastructure.</p>
                     42: </div></div>
                     43: </div>
                     44: <hr>
                     45: </div>
                     46: <div class="toc">
                     47: <p><b>Table of Contents</b></p>
                     48: <dl>
                     49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
                     50: <dd><dl>
                     51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig     52: <dd><dl>
                     53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                     54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                     55: </dl></dd>
1.75      rillig     56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                     57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88      wiz        58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75      rillig     59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                     60: </dl></dd>
                     61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
                     62: <dd><dl>
                     63: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
                     64: <dd><dl>
                     65: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                     66: <dd><dl>
                     67: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
                     68: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
1.97      rillig     69: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75      rillig     70: </dl></dd>
                     71: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                     72: <dd><dl>
                     73: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                     74: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                     75: </dl></dd>
                     76: </dl></dd>
                     77: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
                     78: <dd><dl>
1.82      rillig     79: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                     80: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                     81: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                     82: <dd><dl>
                     83: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
                     84: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
                     85: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
                     86: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
                     87: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
                     88: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
                     89: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75      rillig     90: </dl></dd>
                     91: </dl></dd>
                     92: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                     93: <dd><dl>
                     94: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                     95: <dd><dl>
                     96: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                     97: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig     98: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                     99: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                    100: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    101: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                    102: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                    103: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75      rillig    104: </dl></dd>
                    105: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                    106: <dd><dl>
                    107: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                    108: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                    109: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                    110: </dl></dd>
                    111: </dl></dd>
                    112: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    113: <dd><dl>
                    114: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    115: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.78      rillig    116: <dt><span class="sect1"><a href="#conf.compiler">5.3. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       117: <dd><dl>
1.89      rillig    118: <dt><span class="sect2"><a href="#selecting-the-compiler">5.3.1. Selecting the compiler</a></span></dt>
                    119: <dt><span class="sect2"><a href="#conf.cflags">5.3.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    120: <dt><span class="sect2"><a href="#conf.ldflags">5.3.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz       121: </dl></dd>
1.78      rillig    122: <dt><span class="sect1"><a href="#developer-advanced-settings">5.4. Developer/advanced settings</a></span></dt>
                    123: <dt><span class="sect1"><a href="#selecting-build-options">5.5. Selecting Build Options</a></span></dt>
1.75      rillig    124: </dl></dd>
                    125: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    126: <dd><dl>
                    127: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    128: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
                    129: <dt><span class="sect1"><a href="#bulkbuild">6.3. Doing a bulk build of all packages</a></span></dt>
                    130: <dd><dl>
                    131: <dt><span class="sect2"><a href="#binary.configuration">6.3.1. Configuration</a></span></dt>
                    132: <dt><span class="sect2"><a href="#other-environmental-considerations">6.3.2. Other environmental considerations</a></span></dt>
                    133: <dt><span class="sect2"><a href="#operation">6.3.3. Operation</a></span></dt>
                    134: <dt><span class="sect2"><a href="#what-it-does">6.3.4. What it does</a></span></dt>
                    135: <dt><span class="sect2"><a href="#disk-space-requirements">6.3.5. Disk space requirements</a></span></dt>
                    136: <dt><span class="sect2"><a href="#setting-up-a-sandbox">6.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                    137: <dt><span class="sect2"><a href="#building-a-partial-set">6.3.7. Building a partial set of packages</a></span></dt>
                    138: <dt><span class="sect2"><a href="#bulk-upload">6.3.8. Uploading results of a bulk build</a></span></dt>
                    139: </dl></dd>
                    140: <dt><span class="sect1"><a href="#creating-cdroms">6.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                    141: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">6.4.1. Example of cdpack</a></span></dt></dl></dd>
                    142: </dl></dd>
1.90      rillig    143: <dt><span class="chapter"><a href="#files">7. Directory layout of the installed files</a></span></dt>
1.75      rillig    144: <dd><dl>
1.91      rillig    145: <dt><span class="sect1"><a href="#files.localbase">7.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
1.90      rillig    146: <dt><span class="sect1"><a href="#files.varbase">7.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
                    147: </dl></dd>
                    148: <dt><span class="chapter"><a href="#faq">8. Frequently Asked Questions</a></span></dt>
                    149: <dd><dl>
                    150: <dt><span class="sect1"><a href="#mailing-list-pointers">8.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    151: <dt><span class="sect1"><a href="#pkgviews-docs">8.2. Where's the pkgviews documentation?</a></span></dt>
                    152: <dt><span class="sect1"><a href="#faq-pkgtools">8.3. Utilities for package management (pkgtools)</a></span></dt>
                    153: <dt><span class="sect1"><a href="#non-root-pkgsrc">8.4. How to use pkgsrc as non-root</a></span></dt>
                    154: <dt><span class="sect1"><a href="#resume-transfers">8.5. How to resume transfers when fetching distfiles?</a></span></dt>
                    155: <dt><span class="sect1"><a href="#XFree86-from-pkgsrc">8.6. How can I install/use XFree86 from pkgsrc?</a></span></dt>
                    156: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">8.7. How can I install/use X.org from pkgsrc?</a></span></dt>
                    157: <dt><span class="sect1"><a href="#fetch-behind-firewall">8.8. How to fetch files from behind a firewall</a></span></dt>
                    158: <dt><span class="sect1"><a href="#passive-ftp">8.9. How do I tell <span><strong class="command">make fetch</strong></span> to do passive FTP?</a></span></dt>
                    159: <dt><span class="sect1"><a href="#fetching-all-distfiles">8.10. How to fetch all distfiles at once</a></span></dt>
                    160: <dt><span class="sect1"><a href="#tmac.andoc-missing">8.11. What does &#8220;<span class="quote">Don't know how to make
1.75      rillig    161: /usr/share/tmac/tmac.andoc</span>&#8221; mean?</a></span></dt>
1.90      rillig    162: <dt><span class="sect1"><a href="#bsd.own.mk-missing">8.12. What does &#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221; mean?</a></span></dt>
                    163: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">8.13. Using 'sudo' with pkgsrc</a></span></dt>
                    164: <dt><span class="sect1"><a href="#faq.conf">8.14. How do I change the location of configuration files?</a></span></dt>
                    165: <dt><span class="sect1"><a href="#audit-packages">8.15. Automated security checks</a></span></dt>
                    166: <dt><span class="sect1"><a href="#ufaq-cflags">8.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    167: <dt><span class="sect1"><a href="#ufaq-fail">8.17. A package does not build.  What shall I do?</a></span></dt>
                    168: <dt><span class="sect1"><a href="#faq.rcs-conflicts">8.18. What does &#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221; mean?</a></span></dt>
1.75      rillig    169: </dl></dd>
                    170: </dl></dd>
                    171: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
                    172: <dd><dl>
1.90      rillig    173: <dt><span class="chapter"><a href="#creating">9. Creating a new pkgsrc package from scratch</a></span></dt>
1.91      rillig    174: <dd><dl>
                    175: <dt><span class="sect1"><a href="#creating.common">9.1. Common types of packages</a></span></dt>
                    176: <dd><dl>
                    177: <dt><span class="sect2"><a href="#creating.perl-module">9.1.1. Perl modules</a></span></dt>
                    178: <dt><span class="sect2"><a href="#creating.kde-app">9.1.2. KDE applications</a></span></dt>
                    179: </dl></dd>
                    180: <dt><span class="sect1"><a href="#creating.examples">9.2. Examples</a></span></dt>
                    181: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">9.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
                    182: </dl></dd>
1.90      rillig    183: <dt><span class="chapter"><a href="#components">10. Package components - files, directories and contents</a></span></dt>
1.75      rillig    184: <dd><dl>
1.90      rillig    185: <dt><span class="sect1"><a href="#components.Makefile">10.1. <code class="filename">Makefile</code></a></span></dt>
                    186: <dt><span class="sect1"><a href="#components.distinfo">10.2. <code class="filename">distinfo</code></a></span></dt>
                    187: <dt><span class="sect1"><a href="#components.patches">10.3. patches/*</a></span></dt>
                    188: <dd><dl>
1.93      rillig    189: <dt><span class="sect2"><a href="#components.patch.structure">10.3.1. Structure of a single patch file</a></span></dt>
                    190: <dt><span class="sect2"><a href="#components.patches.caveats">10.3.2. Creating patch files</a></span></dt>
                    191: <dt><span class="sect2"><a href="#components.patches.sources">10.3.3. Sources where the patch files come from</a></span></dt>
                    192: <dt><span class="sect2"><a href="#components.patches.guidelines">10.3.4. Patching guidelines</a></span></dt>
                    193: <dt><span class="sect2"><a href="#components.patches.feedback">10.3.5. Feedback to the author</a></span></dt>
1.90      rillig    194: </dl></dd>
                    195: <dt><span class="sect1"><a href="#other-mandatory-files">10.4. Other mandatory files</a></span></dt>
                    196: <dt><span class="sect1"><a href="#components.optional">10.5. Optional files</a></span></dt>
                    197: <dd><dl>
                    198: <dt><span class="sect2"><a href="#components.optional.bin">10.5.1. Files affecting the binary package</a></span></dt>
                    199: <dt><span class="sect2"><a href="#components.optional.build">10.5.2. Files affecting the build process</a></span></dt>
                    200: <dt><span class="sect2"><a href="#components.optional.none">10.5.3. Files affecting nothing at all</a></span></dt>
                    201: </dl></dd>
                    202: <dt><span class="sect1"><a href="#work-dir">10.6. <code class="filename">work*</code></a></span></dt>
                    203: <dt><span class="sect1"><a href="#files-dir">10.7. <code class="filename">files/*</code></a></span></dt>
                    204: </dl></dd>
                    205: <dt><span class="chapter"><a href="#makefile">11. Programming in <code class="filename">Makefile</code>s</a></span></dt>
                    206: <dd><dl>
1.97      rillig    207: <dt><span class="sect1"><a href="#makefile.style">11.1. Caveats</a></span></dt>
                    208: <dt><span class="sect1"><a href="#makefile.variables">11.2. <code class="filename">Makefile</code> variables</a></span></dt>
                    209: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">11.2.1. Naming conventions</a></span></dt></dl></dd>
                    210: <dt><span class="sect1"><a href="#makefile.code">11.3. Code snippets</a></span></dt>
                    211: <dd><dl>
                    212: <dt><span class="sect2"><a href="#adding-to-list">11.3.1. Adding things to a list</a></span></dt>
                    213: <dt><span class="sect2"><a href="#converting-internal-to-external">11.3.2. Converting an internal list into an external list</a></span></dt>
                    214: <dt><span class="sect2"><a href="#passing-variable-to-shell">11.3.3. Passing variables to a shell command</a></span></dt>
                    215: <dt><span class="sect2"><a href="#quoting-guideline">11.3.4. Quoting guideline</a></span></dt>
                    216: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">11.3.5. Workaround for a bug in BSD Make</a></span></dt>
1.90      rillig    217: </dl></dd>
                    218: </dl></dd>
                    219: <dt><span class="chapter"><a href="#plist">12. PLIST issues</a></span></dt>
                    220: <dd><dl>
                    221: <dt><span class="sect1"><a href="#rcs-id">12.1. RCS ID</a></span></dt>
                    222: <dt><span class="sect1"><a href="#automatic-plist-generation">12.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                    223: <dt><span class="sect1"><a href="#print-PLIST">12.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span></a></span></dt>
                    224: <dt><span class="sect1"><a href="#plist.misc">12.4. Variable substitution in PLIST</a></span></dt>
                    225: <dt><span class="sect1"><a href="#manpage-compression">12.5. Man page compression</a></span></dt>
                    226: <dt><span class="sect1"><a href="#using-PLIST_SRC">12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                    227: <dt><span class="sect1"><a href="#platform-specific-plist">12.7. Platform-specific and differing PLISTs</a></span></dt>
                    228: <dt><span class="sect1"><a href="#faq.common-dirs">12.8. Sharing directories between packages</a></span></dt>
                    229: </dl></dd>
                    230: <dt><span class="chapter"><a href="#buildlink">13. Buildlink methodology</a></span></dt>
                    231: <dd><dl>
                    232: <dt><span class="sect1"><a href="#converting-to-buildlink3">13.1. Converting packages to use buildlink3</a></span></dt>
                    233: <dt><span class="sect1"><a href="#creating-buildlink3.mk">13.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
                    234: <dd><dl>
                    235: <dt><span class="sect2"><a href="#anatomy-of-bl3">13.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                    236: <dt><span class="sect2"><a href="#updating-buildlink-depends">13.2.2. Updating <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code> in <code class="filename">buildlink3.mk</code> files</a></span></dt>
                    237: </dl></dd>
                    238: <dt><span class="sect1"><a href="#writing-builtin.mk">13.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
                    239: <dd><dl>
                    240: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">13.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
                    241: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">13.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                    242: </dl></dd>
                    243: </dl></dd>
                    244: <dt><span class="chapter"><a href="#pkginstall">14. The pkginstall framework</a></span></dt>
                    245: <dd><dl>
                    246: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">14.1. Files and directories outside the installation prefix</a></span></dt>
                    247: <dd><dl>
                    248: <dt><span class="sect2"><a href="#dirs-outside-prefix">14.1.1. Directory manipulation</a></span></dt>
                    249: <dt><span class="sect2"><a href="#files-outside-prefix">14.1.2. File manipulation</a></span></dt>
                    250: </dl></dd>
                    251: <dt><span class="sect1"><a href="#conf-files">14.2. Configuration files</a></span></dt>
                    252: <dd><dl>
                    253: <dt><span class="sect2"><a href="#conf-files-sysconfdir">14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                    254: <dt><span class="sect2"><a href="#conf-files-configure">14.2.2. Telling the software where configuration files are</a></span></dt>
                    255: <dt><span class="sect2"><a href="#conf-files-patching">14.2.3. Patching installations</a></span></dt>
                    256: <dt><span class="sect2"><a href="#conf-files-disable">14.2.4. Disabling handling of configuration files</a></span></dt>
                    257: </dl></dd>
                    258: <dt><span class="sect1"><a href="#rcd-scripts">14.3. System startup scripts</a></span></dt>
                    259: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">14.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
                    260: <dt><span class="sect1"><a href="#users-and-groups">14.4. System users and groups</a></span></dt>
                    261: <dt><span class="sect1"><a href="#shells">14.5. System shells</a></span></dt>
                    262: <dd><dl><dt><span class="sect2"><a href="#shells-disable">14.5.1. Disabling shell registration</a></span></dt></dl></dd>
                    263: <dt><span class="sect1"><a href="#fonts">14.6. Fonts</a></span></dt>
                    264: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">14.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
                    265: </dl></dd>
                    266: <dt><span class="chapter"><a href="#options">15. Options handling</a></span></dt>
                    267: <dd><dl>
                    268: <dt><span class="sect1"><a href="#global-default-options">15.1. Global default options</a></span></dt>
                    269: <dt><span class="sect1"><a href="#converting-to-options">15.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
                    270: <dt><span class="sect1"><a href="#option-names">15.3. Option Names</a></span></dt>
                    271: </dl></dd>
                    272: <dt><span class="chapter"><a href="#build">16. The build process</a></span></dt>
                    273: <dd><dl>
                    274: <dt><span class="sect1"><a href="#build.intro">16.1. Introduction</a></span></dt>
                    275: <dt><span class="sect1"><a href="#build.prefix">16.2. Program location</a></span></dt>
                    276: <dt><span class="sect1"><a href="#build.builddirs">16.3. Directories used during the build process</a></span></dt>
                    277: <dt><span class="sect1"><a href="#build.running">16.4. Running a phase</a></span></dt>
                    278: <dt><span class="sect1"><a href="#build.fetch">16.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                    279: <dd><dl>
                    280: <dt><span class="sect2"><a href="#build.fetch.what">16.5.1. What to fetch and where to get it from</a></span></dt>
                    281: <dt><span class="sect2"><a href="#build.fetch.how">16.5.2. How are the files fetched?</a></span></dt>
                    282: </dl></dd>
                    283: <dt><span class="sect1"><a href="#build.checksum">16.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                    284: <dt><span class="sect1"><a href="#build.extract">16.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                    285: <dt><span class="sect1"><a href="#build.patch">16.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                    286: <dt><span class="sect1"><a href="#build.tools">16.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                    287: <dt><span class="sect1"><a href="#build.wrapper">16.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                    288: <dt><span class="sect1"><a href="#build.configure">16.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    289: <dt><span class="sect1"><a href="#build.build">16.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    290: <dt><span class="sect1"><a href="#build.test">16.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                    291: <dt><span class="sect1"><a href="#build.install">16.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    292: <dt><span class="sect1"><a href="#build.package">16.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                    293: <dt><span class="sect1"><a href="#build.clean">16.16. Cleaning up</a></span></dt>
                    294: <dt><span class="sect1"><a href="#build.helpful-targets">16.17. Other helpful targets</a></span></dt>
                    295: </dl></dd>
                    296: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
                    297: <dd><dl>
                    298: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                    299: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                    300: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.97      rillig    301: <dt><span class="sect1"><a href="#tools.questions">17.4. Questions regarding the tools</a></span></dt>
1.90      rillig    302: </dl></dd>
                    303: <dt><span class="chapter"><a href="#fixes">18. Making your package work</a></span></dt>
                    304: <dd><dl>
                    305: <dt><span class="sect1"><a href="#general-operation">18.1. General operation</a></span></dt>
                    306: <dd><dl>
                    307: <dt><span class="sect2"><a href="#portability-of-packages">18.1.1. Portability of packages</a></span></dt>
                    308: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">18.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
                    309: <dt><span class="sect2"><a href="#user-interaction">18.1.3. User interaction</a></span></dt>
                    310: <dt><span class="sect2"><a href="#handling-licenses">18.1.4. Handling licenses</a></span></dt>
                    311: <dt><span class="sect2"><a href="#restricted-packages">18.1.5. Restricted packages</a></span></dt>
                    312: <dt><span class="sect2"><a href="#dependencies">18.1.6. Handling dependencies</a></span></dt>
                    313: <dt><span class="sect2"><a href="#conflicts">18.1.7. Handling conflicts with other packages</a></span></dt>
                    314: <dt><span class="sect2"><a href="#not-building-packages">18.1.8. Packages that cannot or should not be built</a></span></dt>
                    315: <dt><span class="sect2"><a href="#undeletable-packages">18.1.9. Packages which should not be deleted, once installed</a></span></dt>
                    316: <dt><span class="sect2"><a href="#security-handling">18.1.10. Handling packages with security problems</a></span></dt>
                    317: <dt><span class="sect2"><a href="#bumping-pkgrevision">18.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                    318: <dt><span class="sect2"><a href="#fixes.subst">18.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                    319: </dl></dd>
                    320: <dt><span class="sect1"><a href="#fixes.fetch">18.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                    321: <dd><dl>
                    322: <dt><span class="sect2"><a href="#no-plain-download">18.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                    323: <dt><span class="sect2"><a href="#modified-distfiles-same-name">18.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
                    324: </dl></dd>
                    325: <dt><span class="sect1"><a href="#fixes.configure">18.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    326: <dd><dl>
                    327: <dt><span class="sect2"><a href="#fixes.libtool">18.3.1. Shared libraries - libtool</a></span></dt>
                    328: <dt><span class="sect2"><a href="#using-libtool">18.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                    329: <dt><span class="sect2"><a href="#autoconf-automake">18.3.3. GNU Autoconf/Automake</a></span></dt>
                    330: </dl></dd>
                    331: <dt><span class="sect1"><a href="#programming-languages">18.4. Programming languages</a></span></dt>
                    332: <dd><dl>
                    333: <dt><span class="sect2"><a href="#basic-programming-languages">18.4.1. C, C++, and Fortran</a></span></dt>
                    334: <dt><span class="sect2"><a href="#java-programming-language">18.4.2. Java</a></span></dt>
                    335: <dt><span class="sect2"><a href="#perl-scripts">18.4.3. Packages containing perl scripts</a></span></dt>
                    336: <dt><span class="sect2"><a href="#other-programming-languages">18.4.4. Other programming languages</a></span></dt>
                    337: </dl></dd>
                    338: <dt><span class="sect1"><a href="#fixes.build">18.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    339: <dd><dl>
                    340: <dt><span class="sect2"><a href="#fixes.build.cpp">18.5.1. Compiling C and C++ code conditionally</a></span></dt>
                    341: <dt><span class="sect2"><a href="#compiler-bugs">18.5.2. How to handle compiler bugs</a></span></dt>
                    342: <dt><span class="sect2"><a href="#undefined-reference">18.5.3. Undefined reference to &#8220;<span class="quote">...</span>&#8221;</a></span></dt>
                    343: <dt><span class="sect2"><a href="#out-of-memory">18.5.4. Running out of memory</a></span></dt>
                    344: </dl></dd>
                    345: <dt><span class="sect1"><a href="#fixes.install">18.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    346: <dd><dl>
                    347: <dt><span class="sect2"><a href="#install-scripts">18.6.1. Creating needed directories</a></span></dt>
                    348: <dt><span class="sect2"><a href="#where-to-install-documentation">18.6.2. Where to install documentation</a></span></dt>
1.100   ! rillig    349: <dt><span class="sect2"><a href="#installing-score-files">18.6.3. Installing highscore files</a></span></dt>
1.90      rillig    350: <dt><span class="sect2"><a href="#hardcoded-paths">18.6.4. Packages with hardcoded paths to other interpreters</a></span></dt>
                    351: <dt><span class="sect2"><a href="#perl-modules">18.6.5. Packages installing perl modules</a></span></dt>
                    352: <dt><span class="sect2"><a href="#faq.info-files">18.6.6. Packages installing info files</a></span></dt>
                    353: <dt><span class="sect2"><a href="#manpages">18.6.7. Packages installing man pages</a></span></dt>
                    354: <dt><span class="sect2"><a href="#gconf2-data-files">18.6.8. Packages installing GConf2 data files</a></span></dt>
                    355: <dt><span class="sect2"><a href="#scrollkeeper-data-files">18.6.9. Packages installing scrollkeeper data files</a></span></dt>
                    356: <dt><span class="sect2"><a href="#x11-fonts">18.6.10. Packages installing X11 fonts</a></span></dt>
                    357: <dt><span class="sect2"><a href="#gtk2-modules">18.6.11. Packages installing GTK2 modules</a></span></dt>
                    358: <dt><span class="sect2"><a href="#sgml-xml-data">18.6.12. Packages installing SGML or XML data</a></span></dt>
                    359: <dt><span class="sect2"><a href="#mime-database">18.6.13. Packages installing extensions to the MIME database</a></span></dt>
                    360: <dt><span class="sect2"><a href="#intltool">18.6.14. Packages using intltool</a></span></dt>
                    361: <dt><span class="sect2"><a href="#startup-scripts">18.6.15. Packages installing startup scripts</a></span></dt>
                    362: <dt><span class="sect2"><a href="#tex-packages">18.6.16. Packages installing TeX modules</a></span></dt>
                    363: <dt><span class="sect2"><a href="#emulation-packages">18.6.17. Packages supporting running binaries in
1.87      wiz       364:     emulation</a></span></dt>
1.90      rillig    365: <dt><span class="sect2"><a href="#hicolor-theme">18.6.18. Packages installing hicolor theme icons</a></span></dt>
                    366: <dt><span class="sect2"><a href="#desktop-files">18.6.19. Packages installing desktop files</a></span></dt>
1.77      rillig    367: </dl></dd>
1.90      rillig    368: <dt><span class="sect1"><a href="#punting">18.7. Marking packages as having problems</a></span></dt>
1.77      rillig    369: </dl></dd>
1.90      rillig    370: <dt><span class="chapter"><a href="#debug">19. Debugging</a></span></dt>
                    371: <dt><span class="chapter"><a href="#submit">20. Submitting and Committing</a></span></dt>
1.77      rillig    372: <dd><dl>
1.90      rillig    373: <dt><span class="sect1"><a href="#submitting-binary-packages">20.1. Submitting binary packages</a></span></dt>
                    374: <dt><span class="sect1"><a href="#submitting-your-package">20.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                    375: <dt><span class="sect1"><a href="#general-notes-for-changes">20.3. General notes when adding, updating, or removing packages</a></span></dt>
                    376: <dt><span class="sect1"><a href="#committing-importing">20.4. Committing: Importing a package into CVS</a></span></dt>
                    377: <dt><span class="sect1"><a href="#updating-package">20.5. Updating a package to a newer version</a></span></dt>
                    378: <dt><span class="sect1"><a href="#moving-package">20.6. Moving a package in pkgsrc</a></span></dt>
                    379: </dl></dd>
                    380: <dt><span class="chapter"><a href="#devfaq">21. Frequently Asked Questions</a></span></dt>
                    381: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
                    382: <dd><dl>
                    383: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                    384: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                    385: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                    386: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
1.85      jmmv      387: </dl></dd>
1.75      rillig    388: </dl></dd>
                    389: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
                    390: <dd><dl>
1.90      rillig    391: <dt><span class="chapter"><a href="#infr.design">23. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig    392: <dd><dl>
1.90      rillig    393: <dt><span class="sect1"><a href="#infr.vardef">23.1. The meaning of variable definitions</a></span></dt>
                    394: <dt><span class="sect1"><a href="#infr.vardef.problems">23.2. Avoiding problems before they arise</a></span></dt>
                    395: <dt><span class="sect1"><a href="#infr.var">23.3. Variable evaluation</a></span></dt>
1.81      rillig    396: <dd><dl>
1.90      rillig    397: <dt><span class="sect2"><a href="#infr.var.load">23.3.1. At load time</a></span></dt>
                    398: <dt><span class="sect2"><a href="#infr.var.run">23.3.2. At runtime</a></span></dt>
1.81      rillig    399: </dl></dd>
1.90      rillig    400: <dt><span class="sect1"><a href="#infr.varspec">23.4. How can variables be specified?</a></span></dt>
                    401: <dt><span class="sect1"><a href="#infr.design.intf">23.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig    402: <dd><dl>
1.90      rillig    403: <dt><span class="sect2"><a href="#infr.design.intf.proc">23.5.1. Procedures with parameters</a></span></dt>
                    404: <dt><span class="sect2"><a href="#infr.design.intf.action">23.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75      rillig    405: </dl></dd>
1.90      rillig    406: <dt><span class="sect1"><a href="#infr.order">23.6. The order in which files are loaded</a></span></dt>
1.75      rillig    407: <dd><dl>
1.90      rillig    408: <dt><span class="sect2"><a href="#infr.order.prefs">23.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
                    409: <dt><span class="sect2"><a href="#infr.order.pkg">23.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75      rillig    410: </dl></dd>
                    411: </dl></dd>
1.90      rillig    412: <dt><span class="chapter"><a href="#regression">24. Regression tests</a></span></dt>
1.75      rillig    413: <dd><dl>
1.90      rillig    414: <dt><span class="sect1"><a href="#regression.descr">24.1. The regression tests framework</a></span></dt>
                    415: <dt><span class="sect1"><a href="#regression.run">24.2. Running the regression tests</a></span></dt>
                    416: <dt><span class="sect1"><a href="#regression.new">24.3. Adding a new regression test</a></span></dt>
1.75      rillig    417: <dd><dl>
1.90      rillig    418: <dt><span class="sect2"><a href="#regression.fun.override">24.3.1. Overridable functions</a></span></dt>
                    419: <dt><span class="sect2"><a href="#regression.fun.helper">24.3.2. Helper functions</a></span></dt>
1.75      rillig    420: </dl></dd>
                    421: </dl></dd>
1.90      rillig    422: <dt><span class="chapter"><a href="#porting">25. Porting pkgsrc</a></span></dt>
1.75      rillig    423: <dd><dl>
1.90      rillig    424: <dt><span class="sect1"><a href="#porting.opsys">25.1. Porting pkgsrc to a new operating system</a></span></dt>
                    425: <dt><span class="sect1"><a href="#porting.compiler">25.2. Adding support for a new compiler</a></span></dt>
1.75      rillig    426: </dl></dd>
                    427: </dl></dd>
                    428: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
                    429: <dd><dl>
                    430: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                    431: <dd><dl>
                    432: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                    433: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                    434: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
                    435: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span><strong class="command">pkglint</strong></span></a></span></dt>
                    436: </dl></dd>
                    437: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                    438: </dl></dd>
                    439: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
                    440: <dd><dl>
                    441: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                    442: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                    443: </dl></dd>
1.76      rillig    444: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
                    445: <dd><dl>
                    446: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</a></span></dt>
                    447: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                    448: <dt><span class="sect1"><a href="#ftp-iso">C.3. <code class="filename">iso</code>: Currently empty</a></span></dt>
                    449: <dt><span class="sect1"><a href="#ftp-misc">C.4. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                    450: <dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages*</code>: Binary packages</a></span></dt>
                    451: <dt><span class="sect1"><a href="#ftp-source">C.6. <code class="filename">current</code>,
1.93      rillig    452: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig    453: source packages</a></span></dt>
                    454: </dl></dd>
1.75      rillig    455: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
                    456: <dd><dl>
1.79      rillig    457: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75      rillig    458: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                    459: </dl></dd>
                    460: </dl>
                    461: </div>
1.82      rillig    462: <div class="list-of-tables">
                    463: <p><b>List of Tables</b></p>
                    464: <dl>
                    465: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
                    466: </dt>
                    467: <dt>3.1. <a href="#binary-kits">Binary kits and available packages</a>
                    468: </dt>
1.90      rillig    469: <dt>10.1. <a href="#patch-examples">Patching examples</a>
1.85      jmmv      470: </dt>
1.90      rillig    471: <dt>22.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85      jmmv      472: </dt>
1.82      rillig    473: </dl>
                    474: </div>
1.75      rillig    475: <div class="chapter" lang="en">
                    476: <div class="titlepage"><div><div><h2 class="title">
                    477: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h2></div></div></div>
                    478: <div class="toc">
                    479: <p><b>Table of Contents</b></p>
                    480: <dl>
                    481: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig    482: <dd><dl>
                    483: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                    484: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                    485: </dl></dd>
1.75      rillig    486: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                    487: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88      wiz       488: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75      rillig    489: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                    490: </dl>
                    491: </div>
                    492: <div class="sect1" lang="en">
                    493: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    494: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82      rillig    495: <p>There is a lot of software freely available for Unix-based
                    496: systems, which is usually available in form of the source code. Before
                    497: such software can be used, it needs to be configured to the local
                    498: system, compiled and installed, and this is exactly what The NetBSD
                    499: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
                    500: to handle binary packages, so that not every user has to build the
                    501: packages for himself, which is a time-costly task.</p>
1.75      rillig    502: <p>pkgsrc currently contains several thousand packages,
                    503:       including:</p>
                    504: <div class="itemizedlist"><ul type="disc">
1.91      rillig    505: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache/README.html" target="_top"><code class="filename">www/apache</code></a> - The Apache
1.75      rillig    506:          web server</p></li>
1.91      rillig    507: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.75      rillig    508:          web browser</p></li>
1.91      rillig    509: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
1.75      rillig    510:          Desktop Environment</p></li>
1.91      rillig    511: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde3/README.html" target="_top"><code class="filename">meta-pkgs/kde3</code></a> - The K
1.75      rillig    512:          Desktop Environment</p></li>
                    513: </ul></div>
                    514: <p>...just to name a few.</p>
                    515: <p>pkgsrc has built-in support for handling varying dependencies,
                    516:       such as pthreads and X11, and extended features such as IPv6 support on
                    517:       a range of platforms.</p>
1.82      rillig    518: <div class="sect2" lang="en">
                    519: <div class="titlepage"><div><div><h3 class="title">
                    520: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
                    521: <p>
                    522: pkgsrc provides the following key features:
                    523: </p>
                    524: <div class="itemizedlist"><ul type="disc">
                    525: <li><p>Easy building of software from source as well as the creation
                    526:   and installation of binary packages. The source and latest
                    527:   patches are retrieved from a master or mirror download site, checksum
                    528:   verified, then built on your system. Support for binary-only
                    529:   distributions is available for both native platforms and NetBSD
                    530:   emulated platforms.</p></li>
                    531: <li><p>All packages are installed in a consistent directory tree,
                    532:   including binaries, libraries, man pages and other
                    533:   documentation.</p></li>
                    534: <li><p>Package dependencies, including when performing package updates,
                    535:   are handled automatically. The configuration files of various
                    536:   packages are handled automatically during updates, so local changes
                    537:   are preserved.</p></li>
                    538: <li><p>Like NetBSD, pkgsrc is designed with portability in mind and
                    539:   consists of highly portable code. This allows the greatest speed of
                    540:   development when porting to new a platform. This portability also
                    541:   ensures that pkgsrc is <span class="emphasis"><em>consistent across all
                    542:   platforms</em></span>.</p></li>
                    543: <li><p>The installation prefix, acceptable software licenses,
                    544:   international encryption requirements and build-time options for a
                    545:   large number of packages are all set in a simple, central
                    546:   configuration file.</p></li>
                    547: <li><p>The entire source (not including the distribution files) is
                    548:   freely available under a BSD license, so you may extend and adapt
                    549:   pkgsrc to your needs. Support for local packages and patches is
                    550:   available right out of the box, so you can configure it specifically
                    551:   for your environment.</p></li>
                    552: </ul></div>
1.91      rillig    553: <p>The following principles are basic to pkgsrc:</p>
                    554: <div class="itemizedlist"><ul type="disc">
                    555: <li><p>&#8220;<span class="quote">It should only work if it's right.</span>&#8221;
                    556: &mdash; That means, if a package contains bugs, it's better to find
                    557: them and to complain about them rather than to just install the package
                    558: and hope that it works. There are numerous checks in pkgsrc that try to
                    559: find such bugs: Static analysis tools (<a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
                    560: of shell scripts), and post-installation checks (installed files,
                    561: references to shared libraries, script interpreters).</p></li>
                    562: <li><p>&#8220;<span class="quote">If it works, it should work everywhere</span>&#8221;
                    563: &mdash; Like NetBSD has been ported to many hardware architectures,
                    564: pkgsrc has been ported to many operating systems. Care is taken that
                    565: packages behave the same on all platforms.</p></li>
                    566: </ul></div>
1.82      rillig    567: </div>
                    568: <div class="sect2" lang="en">
                    569: <div class="titlepage"><div><div><h3 class="title">
                    570: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
                    571: <p>pkgsrc consists of both a source distribution and a binary
                    572: distribution for these operating systems. After retrieving the required
                    573: source or binaries, you can be up and running with pkgsrc in just
                    574: minutes!</p>
1.75      rillig    575: <p>pkgsrc was derived from FreeBSD's ports system, and
                    576:       initially developed for NetBSD only. Since then, pkgsrc has
                    577:       grown a lot, and now supports the following platforms:</p>
1.82      rillig    578: <div class="table">
                    579: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.91      rillig    580: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
1.82      rillig    581: <colgroup>
                    582: <col>
                    583: <col>
                    584: </colgroup>
                    585: <thead><tr>
                    586: <th>Platform</th>
                    587: <th>Date Support Added</th>
                    588: </tr></thead>
                    589: <tbody>
                    590: <tr>
                    591: <td><a href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
                    592: <td align="center">Aug 1997</td>
                    593: </tr>
                    594: <tr>
                    595: <td><a href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
                    596: <td align="center">Mar 1999</td>
                    597: </tr>
                    598: <tr>
                    599: <td><a href="http://www.kernel.org/" target="_top">Linux</a></td>
                    600: <td align="center">Jun 1999</td>
                    601: </tr>
                    602: <tr>
                    603: <td>
                    604:           <a href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
                    605:           (<a href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
                    606:         </td>
                    607: <td align="center">Oct 2001</td>
                    608: </tr>
                    609: <tr>
                    610: <td><a href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
                    611: <td align="center">Nov 2002</td>
                    612: </tr>
                    613: <tr>
                    614: <td><a href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
                    615: <td align="center">Nov 2002</td>
                    616: </tr>
                    617: <tr>
                    618: <td><a href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
                    619: <td align="center">Dec 2002</td>
                    620: </tr>
                    621: <tr>
                    622: <td>BSD/OS</td>
                    623: <td align="center">Dec 2003</td>
                    624: </tr>
                    625: <tr>
                    626: <td><a href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
                    627: <td align="center">Dec 2003</td>
                    628: </tr>
                    629: <tr>
                    630: <td>
                    631:           <a href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
                    632:           (Microsoft Windows Services for Unix)
                    633:         </td>
                    634: <td align="center">Mar 2004</td>
                    635: </tr>
                    636: <tr>
                    637: <td><a href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
                    638: <td align="center">Oct 2004</td>
                    639: </tr>
                    640: <tr>
                    641: <td><a href="http://www.tru64.org/" target="_top">OSF/1</a></td>
                    642: <td align="center">Nov 2004</td>
                    643: </tr>
1.98      wiz       644: <tr>
                    645: <td><a href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
                    646: <td align="center">Apr 2007</td>
                    647: </tr>
1.82      rillig    648: </tbody>
1.91      rillig    649: </table></div>
1.82      rillig    650: </div>
1.91      rillig    651: <br class="table-break">
1.82      rillig    652: </div>
1.75      rillig    653: </div>
                    654: <div class="sect1" lang="en">
                    655: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    656: <a name="overview"></a>1.2. Overview</h2></div></div></div>
                    657: <p>This document is divided into three parts. The first,
                    658:        <a href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
                    659:        describes how one can use one of the packages in the Package
                    660:        Collection, either by installing a precompiled binary package,
1.93      rillig    661:        or by building one's own copy using the NetBSD package system.
1.75      rillig    662:        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
                    663:        package so it can be easily built by other NetBSD users without
                    664:        knowing about the package's building details. The third part,
                    665:        <a href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
                    666:        is intended for those who want to understand how pkgsrc is
                    667:        implemented.</p>
                    668: <p>This document is available in various formats:
                    669:        <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>
                    670: </div>
                    671: <div class="sect1" lang="en">
                    672: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    673: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
                    674: <p>There has been a lot of talk about &#8220;<span class="quote">ports</span>&#8221;,
                    675:       &#8220;<span class="quote">packages</span>&#8221;, etc. so far. Here is a description of all the
                    676:       terminology used within this document.</p>
                    677: <div class="variablelist"><dl>
                    678: <dt><span class="term">Package</span></dt>
                    679: <dd><p>A set of files and building instructions
                    680:            that describe what's necessary
                    681:            to build a certain piece of software using
                    682:             pkgsrc. Packages are traditionally stored under
1.76      rillig    683:            <code class="filename">/usr/pkgsrc</code>.</p></dd>
1.75      rillig    684: <dt><span class="term">The NetBSD package system</span></dt>
1.87      wiz       685: <dd><p>This is the former name of &#8220;<span class="quote">pkgsrc</span>&#8221;.  It
                    686:          is part of the NetBSD operating system and can be bootstrapped
                    687:          to run on non-NetBSD operating systems as well.  It handles
                    688:          building (compiling), installing, and removing of
                    689:          packages.</p></dd>
1.75      rillig    690: <dt><span class="term">Distfile</span></dt>
                    691: <dd><p>This term describes the file or files that are
                    692:            provided by the author of the piece of software to
                    693:            distribute his work. All the changes necessary to build on
                    694:            NetBSD are reflected in the corresponding package. Usually
                    695:            the distfile is in the form of a compressed tar-archive,
                    696:            but other types are possible, too. Distfiles are usually
                    697:            stored below
1.76      rillig    698:            <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75      rillig    699: <dt><span class="term">Port</span></dt>
                    700: <dd><p>This is the term used by FreeBSD and OpenBSD people
                    701:            for what we call a package.
                    702:            In NetBSD terminology, &#8220;<span class="quote">port</span>&#8221; refers to a different
                    703:            architecture.</p></dd>
                    704: <dt><span class="term">Precompiled/binary package</span></dt>
                    705: <dd>
                    706: <p>A set of binaries built with pkgsrc from a distfile
1.76      rillig    707:            and stuffed together in a single <code class="filename">.tgz</code>
1.75      rillig    708:            file so it can be installed on machines of the same
                    709:            machine architecture without the need to
                    710:            recompile. Packages are usually generated in
1.76      rillig    711:            <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.75      rillig    712:            an archive on <a href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/" target="_top">ftp.NetBSD.org</a>.</p>
                    713: <p>Sometimes, this is referred to by the term &#8220;<span class="quote">package</span>&#8221; too,
                    714:            especially in the context of precompiled packages.</p>
                    715: </dd>
                    716: <dt><span class="term">Program</span></dt>
1.88      wiz       717: <dd><p>The piece of software to be installed which will be
                    718:          constructed from all the files in the distfile by the
                    719:          actions defined in the corresponding package.</p></dd>
1.75      rillig    720: </dl></div>
                    721: <div class="sect2" lang="en">
                    722: <div class="titlepage"><div><div><h3 class="title">
1.88      wiz       723: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.75      rillig    724: <div class="variablelist"><dl>
                    725: <dt><span class="term">pkgsrc users</span></dt>
                    726: <dd>
                    727: <p>The
                    728:        pkgsrc users are people who use the packages provided by pkgsrc.
                    729:        Typically they are system administrators. The people using the
                    730:        software that is inside the packages (maybe called &#8220;<span class="quote">end
                    731:        users</span>&#8221;) are not covered by the pkgsrc guide.</p>
                    732: <p>There are two kinds of pkgsrc users: Some only want to
                    733:        install pre-built binary packages. Others build the pkgsrc
                    734:        packages from source, either for installing them directly or for
                    735:        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
                    736:        documentation.</p>
                    737: </dd>
                    738: <dt><span class="term">package maintainers</span></dt>
                    739: <dd><p>A
                    740:        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>
                    741: <dt><span class="term">infrastructure developers</span></dt>
                    742: <dd><p>These people are involved in all those files
1.76      rillig    743:        that live in the <code class="filename">mk/</code> directory and below.
1.75      rillig    744:        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,
                    745:        too.</p></dd>
                    746: </dl></div>
                    747: </div>
                    748: </div>
                    749: <div class="sect1" lang="en">
                    750: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    751: <a name="typography"></a>1.4. Typography</h2></div></div></div>
                    752: <p>When giving examples for commands, shell prompts are used to
                    753:       show if the command should/can be issued as root, or if
                    754:       &#8220;<span class="quote">normal</span>&#8221; user privileges are sufficient. We use a
                    755:       <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
                    756:       shell prompt, assuming they use the C-shell or tcsh.</p>
                    757: </div>
                    758: </div>
                    759: <div class="part" lang="en">
                    760: <div class="titlepage"><div><div><h1 class="title">
                    761: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
                    762: <div class="toc">
                    763: <p><b>Table of Contents</b></p>
                    764: <dl>
                    765: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
                    766: <dd><dl>
                    767: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    768: <dd><dl>
                    769: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
                    770: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
1.97      rillig    771: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75      rillig    772: </dl></dd>
                    773: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    774: <dd><dl>
                    775: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    776: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    777: </dl></dd>
                    778: </dl></dd>
                    779: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
                    780: <dd><dl>
1.82      rillig    781: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                    782: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                    783: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                    784: <dd><dl>
                    785: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
                    786: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
                    787: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
                    788: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
                    789: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
                    790: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
                    791: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75      rillig    792: </dl></dd>
                    793: </dl></dd>
                    794: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                    795: <dd><dl>
                    796: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                    797: <dd><dl>
                    798: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                    799: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig    800: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                    801: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                    802: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    803: <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>
                    804: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                    805: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75      rillig    806: </dl></dd>
                    807: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                    808: <dd><dl>
                    809: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                    810: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                    811: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                    812: </dl></dd>
                    813: </dl></dd>
                    814: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    815: <dd><dl>
                    816: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    817: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.78      rillig    818: <dt><span class="sect1"><a href="#conf.compiler">5.3. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       819: <dd><dl>
1.89      rillig    820: <dt><span class="sect2"><a href="#selecting-the-compiler">5.3.1. Selecting the compiler</a></span></dt>
                    821: <dt><span class="sect2"><a href="#conf.cflags">5.3.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    822: <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       823: </dl></dd>
1.78      rillig    824: <dt><span class="sect1"><a href="#developer-advanced-settings">5.4. Developer/advanced settings</a></span></dt>
                    825: <dt><span class="sect1"><a href="#selecting-build-options">5.5. Selecting Build Options</a></span></dt>
1.75      rillig    826: </dl></dd>
                    827: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    828: <dd><dl>
                    829: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    830: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
                    831: <dt><span class="sect1"><a href="#bulkbuild">6.3. Doing a bulk build of all packages</a></span></dt>
                    832: <dd><dl>
                    833: <dt><span class="sect2"><a href="#binary.configuration">6.3.1. Configuration</a></span></dt>
                    834: <dt><span class="sect2"><a href="#other-environmental-considerations">6.3.2. Other environmental considerations</a></span></dt>
                    835: <dt><span class="sect2"><a href="#operation">6.3.3. Operation</a></span></dt>
                    836: <dt><span class="sect2"><a href="#what-it-does">6.3.4. What it does</a></span></dt>
                    837: <dt><span class="sect2"><a href="#disk-space-requirements">6.3.5. Disk space requirements</a></span></dt>
                    838: <dt><span class="sect2"><a href="#setting-up-a-sandbox">6.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                    839: <dt><span class="sect2"><a href="#building-a-partial-set">6.3.7. Building a partial set of packages</a></span></dt>
                    840: <dt><span class="sect2"><a href="#bulk-upload">6.3.8. Uploading results of a bulk build</a></span></dt>
                    841: </dl></dd>
                    842: <dt><span class="sect1"><a href="#creating-cdroms">6.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                    843: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">6.4.1. Example of cdpack</a></span></dt></dl></dd>
                    844: </dl></dd>
1.90      rillig    845: <dt><span class="chapter"><a href="#files">7. Directory layout of the installed files</a></span></dt>
                    846: <dd><dl>
1.91      rillig    847: <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    848: <dt><span class="sect1"><a href="#files.varbase">7.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
                    849: </dl></dd>
                    850: <dt><span class="chapter"><a href="#faq">8. Frequently Asked Questions</a></span></dt>
1.75      rillig    851: <dd><dl>
1.90      rillig    852: <dt><span class="sect1"><a href="#mailing-list-pointers">8.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    853: <dt><span class="sect1"><a href="#pkgviews-docs">8.2. Where's the pkgviews documentation?</a></span></dt>
                    854: <dt><span class="sect1"><a href="#faq-pkgtools">8.3. Utilities for package management (pkgtools)</a></span></dt>
                    855: <dt><span class="sect1"><a href="#non-root-pkgsrc">8.4. How to use pkgsrc as non-root</a></span></dt>
                    856: <dt><span class="sect1"><a href="#resume-transfers">8.5. How to resume transfers when fetching distfiles?</a></span></dt>
                    857: <dt><span class="sect1"><a href="#XFree86-from-pkgsrc">8.6. How can I install/use XFree86 from pkgsrc?</a></span></dt>
                    858: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">8.7. How can I install/use X.org from pkgsrc?</a></span></dt>
                    859: <dt><span class="sect1"><a href="#fetch-behind-firewall">8.8. How to fetch files from behind a firewall</a></span></dt>
                    860: <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>
                    861: <dt><span class="sect1"><a href="#fetching-all-distfiles">8.10. How to fetch all distfiles at once</a></span></dt>
                    862: <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    863: /usr/share/tmac/tmac.andoc</span>&#8221; mean?</a></span></dt>
1.90      rillig    864: <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>
                    865: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">8.13. Using 'sudo' with pkgsrc</a></span></dt>
                    866: <dt><span class="sect1"><a href="#faq.conf">8.14. How do I change the location of configuration files?</a></span></dt>
                    867: <dt><span class="sect1"><a href="#audit-packages">8.15. Automated security checks</a></span></dt>
                    868: <dt><span class="sect1"><a href="#ufaq-cflags">8.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    869: <dt><span class="sect1"><a href="#ufaq-fail">8.17. A package does not build.  What shall I do?</a></span></dt>
                    870: <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    871: </dl></dd>
                    872: </dl>
                    873: </div>
                    874: <div class="chapter" lang="en">
                    875: <div class="titlepage"><div><div><h2 class="title">
                    876: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
                    877: <div class="toc">
                    878: <p><b>Table of Contents</b></p>
                    879: <dl>
                    880: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    881: <dd><dl>
                    882: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
                    883: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
1.97      rillig    884: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75      rillig    885: </dl></dd>
                    886: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    887: <dd><dl>
                    888: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    889: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    890: </dl></dd>
                    891: </dl>
                    892: </div>
1.91      rillig    893: <p>Before you download and extract the files, you need to decide
                    894: where you want to extract them. When using pkgsrc as root user, pkgsrc
                    895: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
                    896: free to install the sources and binary packages wherever you want in
                    897: your filesystem, provided that the pathname does not contain white-space
                    898: or other characters that are interpreted specially by the shell and some
                    899: other programs. A safe bet is to use only letters, digits, underscores
                    900: and dashes.</p>
1.75      rillig    901: <div class="sect1" lang="en">
                    902: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    903: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
                    904: <p>Before you download any pkgsrc files, you should decide
                    905:        whether you want the <span class="emphasis"><em>current</em></span> branch or the
                    906:        <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
                    907:        quarterly basis from the current branch and only gets modified
                    908:        for security updates. The names of the stable branches are built
                    909:        from the year and the quarter, for example
1.98      wiz       910:        <code class="literal">2007Q1</code>.</p>
1.75      rillig    911: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
                    912:        want to download pkgsrc. You can get it as a tar file, via SUP,
                    913:        or via CVS. All three ways are described here.</p>
                    914: <div class="sect2" lang="en">
                    915: <div class="titlepage"><div><div><h3 class="title">
                    916: <a name="getting-via-tar"></a>2.1.1. As tar file</h3></div></div></div>
                    917: <p>The primary download location for all pkgsrc files is
                    918:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>. There are a
                    919:        number of subdirectories for different purposes, which are
1.76      rillig    920:        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    921: <p>The tar file for the current branch is in the directory
1.76      rillig    922:        <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    923:        It is autogenerated daily.</p>
1.98      wiz       924: <p>The tar file for the stable branch 2007Q1 is in the
                    925:        directory <code class="filename">pkgsrc-2007Q1</code> and is also called <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2007Q1/pkgsrc-2007Q1.tar.gz" target="_top"><code class="filename">pkgsrc-2007Q1.tar.gz</code></a>.</p>
1.75      rillig    926: <p>After downloading the tar file, change to the directory
                    927:        where you want to have pkgsrc. This is usually
1.91      rillig    928:        <code class="filename">/usr</code>. Then, run <span><strong class="command">gzcat
                    929:        pkgsrc.tar.gz | tar xf -</strong></span> to extract the files.</p>
1.75      rillig    930: </div>
                    931: <div class="sect2" lang="en">
                    932: <div class="titlepage"><div><div><h3 class="title">
                    933: <a name="getting-via-sup"></a>2.1.2. Via SUP</h3></div></div></div>
                    934: <p>As an alternative to the tar file, you can get pkgsrc via
                    935:        the Software Update Protocol, SUP. To do so, make sure your
                    936:        supfile has a line
1.1       grant     937: 
1.75      rillig    938: </p>
                    939: <pre class="programlisting">
1.100   ! rillig    940: release=pkgsrc
1.1       grant     941: </pre>
1.75      rillig    942: <p>
1.1       grant     943: 
1.75      rillig    944:        in it, see the examples in
1.76      rillig    945:        <code class="filename">/usr/share/examples/supfiles</code>, and that the
                    946:        <code class="filename">/usr/pkgsrc</code> directory exists. Then, simply
1.75      rillig    947:        run <span><strong class="command">sup -v
                    948:        <em class="replaceable"><code>/path/to/your/supfile</code></em></strong></span>.</p>
                    949: </div>
                    950: <div class="sect2" lang="en">
                    951: <div class="titlepage"><div><div><h3 class="title">
1.97      rillig    952: <a name="getting-via-cvs"></a>2.1.3. Via anonymous CVS</h3></div></div></div>
1.75      rillig    953: <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>
                    954:        installed. To do an initial (full) checkout of pkgsrc, you first
                    955:        have to set some environment variables. For the C-Shell,
                    956:        type:</p>
                    957: <pre class="screen">
                    958:     <code class="prompt">%</code> <strong class="userinput"><code>setenv CVSROOT anoncvs@anoncvs.NetBSD.org:/cvsroot</code></strong>
                    959:     <code class="prompt">%</code> <strong class="userinput"><code>setenv CVS_RSH ssh</code></strong>
                    960: </pre>
                    961: <p>Or, the same for the bourne shell:</p>
                    962: <pre class="screen">
                    963:     <code class="prompt">$</code> <strong class="userinput"><code>CVSROOT="anoncvs@anoncvs.NetBSD.org:/cvsroot"</code></strong>
                    964:     <code class="prompt">$</code> <strong class="userinput"><code>CVS_RSH="ssh"</code></strong>
                    965:     <code class="prompt">$</code> <strong class="userinput"><code>export CVSROOT CVS_RSH</code></strong>
                    966: </pre>
                    967: <p>Then, you change to the directory where you want to have
                    968:        your copy of pkgsrc. In most cases this is
1.76      rillig    969:        <code class="filename">/usr</code>. In that directory you run the
1.75      rillig    970:        checkout command, which is <span><strong class="command">cvs -q checkout -P
                    971:        pkgsrc</strong></span> for the current branch and <span><strong class="command">cvs -q
1.98      wiz       972:        checkout -rpkgsrc-2007Q1 -P pkgsrc</strong></span> for the stable
1.75      rillig    973:        branch. This command will create a directory called
1.76      rillig    974:        <code class="filename">pkgsrc</code> with all the pkgsrc files in
1.75      rillig    975:        it.</p>
                    976: </div>
                    977: </div>
                    978: <div class="sect1" lang="en">
                    979: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    980: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
                    981: <p>The preferred way to keep pkgsrc up-to-date is via CVS
                    982:        (which also works if you have first installed it via a tar
                    983:        file). It saves bandwidth and hard disk activity, compared to
                    984:        downloading the tar file again.</p>
                    985: <div class="sect2" lang="en">
                    986: <div class="titlepage"><div><div><h3 class="title">
                    987: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
                    988: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
                    989: <h3 class="title">Warning</h3>
1.77      rillig    990: <p>When updating from a tar file, you first need to
                    991:        completely remove the old pkgsrc directory. Otherwise those
                    992:        files that have been removed from pkgsrc in the mean time will
                    993:        not be removed on your local disk, resulting in inconsistencies.
                    994:        When removing the old files, any changes that you have done to
                    995:        the pkgsrc files will be lost after updating. Therefore updating
                    996:        via CVS is strongly recommended.</p>
1.75      rillig    997: </div>
1.82      rillig    998: <p>Note that by default the distfiles and the binary packages
                    999:        are saved in the pkgsrc tree, so don't forget to rescue them
                   1000:        before updating. You can also configure pkgsrc to use other than
                   1001:        the default directories by setting the
                   1002:        <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
                   1003:        variables. See <a href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1.75      rillig   1004: <p>To update pkgsrc from a tar file, download the tar file as
                   1005:        explained above. Then, make sure that you have not made any
                   1006:        changes to the files in the pkgsrc directory. Remove the pkgsrc
                   1007:        directory and extract the new tar file. Done.</p>
                   1008: </div>
                   1009: <div class="sect2" lang="en">
                   1010: <div class="titlepage"><div><div><h3 class="title">
                   1011: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
                   1012: <p>To update pkgsrc via CVS, make sure the environment
                   1013:        variable <code class="varname">CVS_RSH</code> is set as above. Then,
                   1014:        change to the pkgsrc directory and run <span><strong class="command">cvs -q update
1.77      rillig   1015:        -dP</strong></span>.</p>
1.75      rillig   1016: <div class="sect3" lang="en">
                   1017: <div class="titlepage"><div><div><h4 class="title">
                   1018: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
                   1019: <p>When updating pkgsrc, the CVS program keeps track of the
                   1020:        branch you selected. But if you, for whatever reason, want to
                   1021:        switch from the stable branch to the current one, you can do it
                   1022:        by adding the option &#8220;<span class="quote">-A</span>&#8221; after the
                   1023:        &#8220;<span class="quote">update</span>&#8221; keyword. To switch from the current branch
                   1024:        back to the stable branch, add the
1.98      wiz      1025:        &#8220;<span class="quote">-rpkgsrc-2007Q1</span>&#8221; option.</p>
1.75      rillig   1026: </div>
                   1027: <div class="sect3" lang="en">
                   1028: <div class="titlepage"><div><div><h4 class="title">
                   1029: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
                   1030: <p>When you update pkgsrc, the CVS program will only touch
                   1031:        those files that are registered in the CVS repository. That
                   1032:        means that any packages that you created on your own will stay
                   1033:        unmodified. If you change files that are managed by CVS, later
                   1034:        updates will try to merge your changes with those that have been
                   1035:        done by others. See the CVS manual, chapter
                   1036:        &#8220;<span class="quote">update</span>&#8221; for details.</p>
                   1037: </div>
                   1038: </div>
                   1039: </div>
                   1040: </div>
                   1041: <div class="chapter" lang="en">
                   1042: <div class="titlepage"><div><div><h2 class="title">
                   1043: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
                   1044: <div class="toc">
                   1045: <p><b>Table of Contents</b></p>
                   1046: <dl>
1.82      rillig   1047: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                   1048: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                   1049: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                   1050: <dd><dl>
                   1051: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
                   1052: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
                   1053: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
                   1054: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
                   1055: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
                   1056: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
                   1057: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75      rillig   1058: </dl></dd>
                   1059: </dl>
                   1060: </div>
                   1061: <div class="sect1" lang="en">
                   1062: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82      rillig   1063: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
                   1064: <p>
                   1065: We provide a bootstrap kit in both source and binary form for other
                   1066: platforms than NetBSD, consisting of the pkg administration tools and other
                   1067: tools required to use pkgsrc and build packages.
                   1068: </p>
                   1069: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1070: <h3 class="title">Note</h3>
                   1071: <p>
                   1072: Older binary snapshots are available in the
                   1073: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/archive/" target="_top">bootstrap-pkgsrc/archive</a>
                   1074: directory on ftp.NetBSD.org.</p>
                   1075: </div>
                   1076: <div class="table">
                   1077: <a name="binary-kits"></a><p class="title"><b>Table 3.1. Binary kits and available packages</b></p>
1.91      rillig   1078: <div class="table-contents"><table summary="Binary kits and available packages" border="1">
1.82      rillig   1079: <colgroup>
                   1080: <col>
                   1081: <col>
                   1082: <col>
                   1083: <col>
                   1084: </colgroup>
                   1085: <thead><tr>
                   1086: <th>Platform</th>
                   1087: <th>Latest snapshot</th>
                   1088: <th>Binary kit</th>
                   1089: <th>Binary packages</th>
                   1090: </tr></thead>
                   1091: <tbody>
                   1092: <tr>
                   1093: <td class="osname">Darwin 5.5/powerpc (Mac OS X 10.1.5)</td>
                   1094: <td class="date">20021209</td>
                   1095: <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>
                   1096: <td class="binary-pkgs-url"> </td>
                   1097: </tr>
                   1098: <tr>
                   1099: <td class="osname">Darwin 6.6/powerpc (Mac OS X 10.2.6)</td>
                   1100: <td class="date">20030623</td>
                   1101: <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>
                   1102: <td class="binary-pkgs-url"> </td>
                   1103: </tr>
                   1104: <tr>
                   1105: <td class="osname">Darwin 7.6/powerpc (Mac OS X 10.3.6)</td>
                   1106: <td class="date">20041219</td>
                   1107: <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>
                   1108: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/Darwin-7.6/" target="_top">binary packages</a></td>
                   1109: </tr>
                   1110: <tr>
                   1111: <td class="osname">Darwin 7.8/powerpc (Mac OS X 10.3.8)</td>
                   1112: <td class="date">20050320</td>
                   1113: <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>
                   1114: <td class="binary-pkgs-url"> </td>
                   1115: </tr>
                   1116: <tr>
                   1117: <td class="osname">Darwin 8.1/powerpc (Mac OS X 10.4.1)</td>
                   1118: <td class="date">20050625</td>
                   1119: <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>
                   1120: <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>
                   1121: </tr>
                   1122: <tr>
                   1123: <td class="osname">Debian GNU Linux/i386</td>
                   1124: <td class="date">20031023</td>
                   1125: <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>
                   1126: <td class="binary-pkgs-url"> </td>
                   1127: </tr>
                   1128: <tr>
                   1129: <td class="osname">Fedora Core 2 Linux/i386</td>
                   1130: <td class="date">20050618</td>
                   1131: <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>
                   1132: <td class="binary-pkgs-url"> </td>
                   1133: </tr>
                   1134: <tr>
                   1135: <td class="osname">Fedora Core 4 Linux/i386</td>
                   1136: <td class="date">20060105</td>
                   1137: <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>
                   1138: <td class="binary-pkgs-url"> </td>
                   1139: </tr>
                   1140: <tr>
                   1141: <td class="osname">FreeBSD 3.5/i386</td>
                   1142: <td class="date">20030411</td>
                   1143: <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>
                   1144: <td class="binary-pkgs-url"> </td>
                   1145: </tr>
                   1146: <tr>
                   1147: <td class="osname">FreeBSD 4.7/i386</td>
                   1148: <td class="date">20021211</td>
                   1149: <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>
                   1150: <td class="binary-pkgs-url"> </td>
                   1151: </tr>
                   1152: <tr>
                   1153: <td class="osname">FreeBSD 5.0/i386</td>
                   1154: <td class="date">20030411</td>
                   1155: <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>
                   1156: <td class="binary-pkgs-url"> </td>
                   1157: </tr>
                   1158: <tr>
                   1159: <td class="osname">FreeBSD 5.1/i386</td>
                   1160: <td class="date">20030630</td>
                   1161: <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>
                   1162: <td class="binary-pkgs-url"> </td>
                   1163: </tr>
                   1164: <tr>
                   1165: <td class="osname">FreeBSD 5.2.1/i386</td>
                   1166: <td class="date">20040227</td>
                   1167: <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>
                   1168: <td class="binary-pkgs-url"> </td>
                   1169: </tr>
                   1170: <tr>
                   1171: <td class="osname">FreeBSD 5.3/i386</td>
                   1172: <td class="date">20050119</td>
                   1173: <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>
                   1174: <td class="binary-pkgs-url"> </td>
                   1175: </tr>
                   1176: <tr>
1.98      wiz      1177: <td class="osname">HP-UX 11.11/hppa</td>
                   1178: <td class="date">20070421</td>
                   1179: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-HPUX-B.11.11-hppa-20070421.tar.gz" target="_top">binary kit</a></td>
                   1180: <td class="binary-pkgs-url"> </td>
                   1181: </tr>
                   1182: <tr>
1.82      rillig   1183: <td class="osname">Interix 3.5</td>
1.93      rillig   1184: <td class="date">20061106</td>
                   1185: <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>
                   1186: <td class="binary-pkgs-url"> </td>
1.82      rillig   1187: </tr>
                   1188: <tr>
                   1189: <td class="osname">IRIX 6.5 n32-bit ABI</td>
                   1190: <td class="date">20040911</td>
                   1191: <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>
                   1192: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/IRIX-6.5/n32/" target="_top">binary packages</a></td>
                   1193: </tr>
                   1194: <tr>
                   1195: <td class="osname">IRIX 6.5 64-bit ABI</td>
                   1196: <td class="date">20040912</td>
                   1197: <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>
                   1198: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/IRIX-6.5/64/" target="_top">binary packages</a></td>
                   1199: </tr>
                   1200: <tr>
                   1201: <td class="osname">OpenBSD 3.2/i386</td>
                   1202: <td class="date">20030420</td>
                   1203: <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>
                   1204: <td class="binary-pkgs-url"> </td>
                   1205: </tr>
                   1206: <tr>
                   1207: <td class="osname">OpenBSD 3.3/i386</td>
                   1208: <td class="date">20030503</td>
                   1209: <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>
                   1210: <td class="binary-pkgs-url"> </td>
                   1211: </tr>
                   1212: <tr>
                   1213: <td class="osname">OpenBSD 3.5/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-OpenBSD-3.5-i386-20040703.tar.gz" target="_top">binary kit</a></td>
                   1216: <td class="binary-pkgs-url"> </td>
                   1217: </tr>
                   1218: <tr>
1.98      wiz      1219: <td class="osname">OSF1 5.1/alpha</td>
                   1220: <td class="date">20070420</td>
                   1221: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-OSF1-V5.1-alpha-20070420.tar.gz" target="_top">binary kit</a></td>
                   1222: <td class="binary-pkgs-url"> </td>
                   1223: </tr>
                   1224: <tr>
1.82      rillig   1225: <td class="osname">Slackware Linux 8.1/i386</td>
                   1226: <td class="date">20030417</td>
                   1227: <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>
                   1228: <td class="binary-pkgs-url"> </td>
                   1229: </tr>
                   1230: <tr>
                   1231: <td class="osname">Slackware Linux 9/i386</td>
1.93      rillig   1232: <td class="date">20040703</td>
1.82      rillig   1233: <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>
                   1234: <td class="binary-pkgs-url"> </td>
                   1235: </tr>
                   1236: <tr>
                   1237: <td class="osname">Solaris 8/sparc</td>
                   1238: <td class="date">20050220</td>
                   1239: <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>
                   1240: <td class="binary-pkgs-url"> </td>
                   1241: </tr>
                   1242: <tr>
                   1243: <td class="osname">Solaris 8/i386</td>
                   1244: <td class="date">20050220</td>
                   1245: <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>
                   1246: <td class="binary-pkgs-url"> </td>
                   1247: </tr>
                   1248: <tr>
                   1249: <td class="osname">Solaris 9/sparc</td>
1.93      rillig   1250: <td class="date">20060713</td>
                   1251: <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>
                   1252: <td class="binary-pkgs-url"> </td>
1.82      rillig   1253: </tr>
                   1254: <tr>
                   1255: <td class="osname">Solaris 9/i386</td>
                   1256: <td class="date">20030411</td>
                   1257: <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>
                   1258: <td class="binary-pkgs-url"> </td>
                   1259: </tr>
                   1260: </tbody>
1.91      rillig   1261: </table></div>
1.82      rillig   1262: </div>
1.91      rillig   1263: <br class="table-break"><p>
1.82      rillig   1264: Simply download the binary kit for your platform, and extract it into
                   1265: <code class="filename">/</code> e.g.
                   1266: </p>
                   1267: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   1268: <code class="prompt">#</code> <strong class="userinput"><code>gzip -c -d /tmp/bootstrap-pkgsrc-SunOS-5.9-sparc-20031023.tar.gz \
                   1269:   | tar -xpf -</code></strong></pre>
                   1270: <p>
                   1271: Of course, as with any binary distributions, you should verify the
                   1272: checksum against the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/SUM" target="_top">SUM</a>
                   1273: or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/CKSUM" target="_top">CKSUM</a>
                   1274: file and inspect the contents before extracting it.
                   1275: </p>
                   1276: </div>
                   1277: <div class="sect1" lang="en">
                   1278: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1279: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
                   1280: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75      rillig   1281: <pre class="screen">
                   1282: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc</code></strong>
                   1283: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87      wiz      1284: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
                   1285:     </pre>
1.75      rillig   1286: <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      1287:     pkgsrc before bootstrapping. The given
                   1288:     <span><strong class="command">bootstrap</strong></span> command will use the defaults of
                   1289:     <code class="filename">/usr/pkg</code> for the
                   1290:     <span class="emphasis"><em>prefix</em></span> where programs will be installed in,
                   1291:     and <code class="filename">/var/db/pkg</code> for the package database
                   1292:     directory where pkgsrc will do its internal bookkeeping.
                   1293:     However, these can also be set using command-line
                   1294:     arguments.</p>
1.75      rillig   1295: <p>Binary packages for the pkgsrc tools and an initial set of packages is
1.87      wiz      1296:     available for supported platforms. An up-to-date list of these can be
                   1297:     found on <a href="http://www.pkgsrc.org/" target="_top">www.pkgsrc.org</a>.
                   1298:     Note that this only works for privileged builds that install
                   1299:     into <code class="filename">/usr/pkg</code>.</p>
1.75      rillig   1300: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1301: <h3 class="title">Note</h3>
                   1302: <p>The bootstrap installs a <span><strong class="command">bmake</strong></span> tool.
1.87      wiz      1303:       Use this <span><strong class="command">bmake</strong></span> when building via pkgsrc.
                   1304:       For examples in this guide, use <span><strong class="command">bmake</strong></span>
                   1305:       instead of &#8220;<span class="quote">make</span>&#8221;.</p>
1.75      rillig   1306: </div>
                   1307: </div>
                   1308: <div class="sect1" lang="en">
                   1309: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82      rillig   1310: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1.75      rillig   1311: <p>Here are some platform-specific notes you should be aware of.</p>
                   1312: <div class="sect2" lang="en">
                   1313: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1314: <a name="darwin"></a>3.3.1. Darwin (Mac OS X)</h3></div></div></div>
1.85      jmmv     1315: <p>Darwin 5.x and up are supported. There are two methods of using
1.82      rillig   1316:        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   1317:          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   1318:          partition</a>.</p>
                   1319: <p>Before you start, you will need to download and install the Mac OS X Developer
1.87      wiz      1320:       Tools from Apple's Developer Connection.  See <a href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
                   1321:       for details.  Also, make sure you install X11 for Mac OS X and the X11 SDK
                   1322:       from <a href="http://www.apple.com/macosx/x11/download/" target="_top">http://www.apple.com/macosx/x11/download/</a>
                   1323:       if you intend to build packages that use the X11 Window System.</p>
1.89      rillig   1324: <p>If you already have a UFS or HFSX partition, or have a spare partition
                   1325:       that you can format as UFS or HFSX, it is recommended to use that instead of
1.87      wiz      1326:       the disk image. It'll be somewhat faster and will mount automatically
                   1327:       at boot time, where you must manually mount a disk image.</p>
1.75      rillig   1328: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1329: <h3 class="title">Note</h3>
1.85      jmmv     1330: <p>You cannot use an ordinary HFS+ file system for pkgsrc, because pkgsrc currently
1.89      rillig   1331:          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   1332: </div>
                   1333: <div class="sect3" lang="en">
                   1334: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1335: <a name="platform.osx-image"></a>3.3.1.1. Using a disk image</h4></div></div></div>
1.75      rillig   1336: <p>Create the disk image:</p>
                   1337: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.95      tron     1338: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage create ~/Documents/NetBSD 1024</code></strong> # megabytes - season to taste
1.85      jmmv     1339: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage mount ~/Documents/NetBSD</code></strong>
1.75      rillig   1340: <code class="prompt">#</code> <strong class="userinput"><code>sudo chown `id -u`:`id -g` /Volumes/NetBSD</code></strong></pre>
1.85      jmmv     1341: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1342: <h3 class="title">Note</h3>
1.89      rillig   1343: <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     1344: </div>
1.89      rillig   1345: <p>Allow suid:</p>
                   1346: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sudo mount -u -o suid /Volumes/NetBSD</code></strong></pre>
1.75      rillig   1347: </div>
                   1348: <div class="sect3" lang="en">
                   1349: <div class="titlepage"><div><div><h4 class="title">
1.89      rillig   1350: <a name="platform.osx-part"></a>3.3.1.2. Using a UFS or HFSX partition</h4></div></div></div>
1.76      rillig   1351: <p>By default, <code class="filename">/usr</code> will be on your root file
1.87      wiz      1352:        system, normally HFS+. It is possible to use the default
                   1353:        <span class="emphasis"><em>prefix</em></span> of <code class="filename">/usr/pkg</code>
                   1354:        by symlinking <code class="filename">/usr/pkg</code> to a directory on a UFS
1.89      rillig   1355:        or HFSX file system. Obviously, another symlink is required if you want to
1.87      wiz      1356:        place the package database directory outside the
                   1357:        <span class="emphasis"><em>prefix</em></span>. e.g.</p>
1.75      rillig   1358: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --pkgdbdir /usr/pkg/pkgdb</code></strong></pre>
                   1359: <p>If you created your partitions at the time of installing Mac OS X
1.89      rillig   1360:        and formatted the target partition as UFS or HFSX, it should automatically
1.87      wiz      1361:        mount on <code class="filename">/Volumes/&lt;volume name&gt;</code> when the
1.89      rillig   1362:        machine boots. If you are (re)formatting a partition as UFS or HFSX, you need
1.87      wiz      1363:        to ensure that the partition map correctly reflects
1.89      rillig   1364:        &#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   1365: <p>The problem is that none of the disk tools will let you touch a
1.87      wiz      1366:        disk that is booted from. You can unmount the partition, but even if
                   1367:        you newfs it, the partition type will be incorrect and the
                   1368:        automounter won't mount it. It can be mounted manually, but it won't
                   1369:        appear in Finder.</p>
1.75      rillig   1370: <p>You'll need to boot off of the OS X Installation (User) CD.  When
1.87      wiz      1371:        the Installation program starts, go up to the menu and select Disk
                   1372:        Utility.  Now, you will be able to select the partition you want
1.89      rillig   1373:        to be UFS or HFSX, and Format it Apple UFS or HFSX. Quit the Disk Utility, quit the
                   1374:        installer which will reboot your machine. The new UFS or HFSX file system
1.87      wiz      1375:        will appear in Finder.</p>
1.75      rillig   1376: <p>Be aware that the permissions on the new file system will be writable
1.87      wiz      1377:        by root only.</p>
1.75      rillig   1378: <p>This note is as of 10.2 (Jaguar) and applies to earlier versions.
1.87      wiz      1379:        Hopefully Apple will fix Disk Utility in 10.3 (Panther).</p>
1.75      rillig   1380: </div>
                   1381: </div>
                   1382: <div class="sect2" lang="en">
                   1383: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1384: <a name="freebsd"></a>3.3.2. FreeBSD</h3></div></div></div>
1.87      wiz      1385: <p>FreeBSD 4.7 and 5.0 have been tested and are supported,
                   1386:       other versions may work.</p>
1.75      rillig   1387: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87      wiz      1388:       with the FreeBSD userland tools. There are several steps:</p>
1.75      rillig   1389: <div class="orderedlist"><ol type="1">
                   1390: <li><p>FreeBSD stores its ports pkg database in
1.87      wiz      1391:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1392:          recommended that you choose a different location (e.g.
                   1393:          <code class="filename">/usr/pkgdb</code>) by
                   1394:          using the --pkgdbdir option to the bootstrap script.</p></li>
1.75      rillig   1395: <li>
                   1396: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1.87      wiz      1397:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1398: <pre class="screen">
                   1399: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75      rillig   1400: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1401: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1402: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87      wiz      1403: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1404:          </pre>
1.75      rillig   1405: </li>
1.76      rillig   1406: <li><p>An example <code class="filename">/etc/mk.conf</code> file will be placed in
1.87      wiz      1407:          <code class="filename">/etc/mk.conf.example</code> file
                   1408:          when you use the bootstrap script.</p></li>
1.75      rillig   1409: </ol></div>
                   1410: </div>
                   1411: <div class="sect2" lang="en">
                   1412: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1413: <a name="interix"></a>3.3.3. Interix</h3></div></div></div>
1.75      rillig   1414: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1.87      wiz      1415:       providing a Unix-like environment with a tighter kernel integration than
                   1416:       available with Cygwin.  It is part of the Windows Services for Unix
                   1417:       package, available for free for any licensed copy of Windows 2000, XP
                   1418:       (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   1419: <p>Services for Unix 3.5 has been tested.  3.0 or 3.1 may work, but
                   1420:       are not officially supported.  (The main difference in 3.0/3.1 is lack
                   1421:       of pthreads, but other parts of libc may also be lacking.)</p>
                   1422: <p>Services for Unix Applications (aka SUA) is an integrated component
                   1423:       of Windows Server 2003 R2 and Windows Vista.  As of this writing, SUA's
1.95      tron     1424:       Interix 5.x subsystem has not yet been tested with pkgsrc.</p>
1.75      rillig   1425: <div class="sect3" lang="en">
                   1426: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1427: <a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
1.75      rillig   1428: <p>At an absolute minimum, the following packages must be installed from
1.87      wiz      1429:        the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.75      rillig   1430: <div class="itemizedlist"><ul type="disc">
                   1431: <li><p>Utilities -&gt; Base Utilities</p></li>
                   1432: <li><p>Interix GNU Components -&gt; (all)</p></li>
                   1433: <li><p>Remote Connectivity</p></li>
                   1434: <li><p>Interix SDK</p></li>
                   1435: </ul></div>
                   1436: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1.87      wiz      1437:        "UNIX Perl".  That is Perl 5.6 without shared module support, installed to
                   1438:        /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
                   1439:        pkgsrc (or from a binary package).</p>
1.75      rillig   1440: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1.87      wiz      1441:        not need to be installed, but Remote Connectivity itself should be
                   1442:        installed in order to have a working inetd.</p>
1.75      rillig   1443: <p>During installation you may be asked whether to enable setuid
1.87      wiz      1444:        behavior for Interix programs, and whether to make pathnames default to
                   1445:        case-sensitive.  Setuid should be enabled, and case-sensitivity MUST be
                   1446:        enabled.  (Without case-sensitivity, a large number of packages including
                   1447:        perl will not build.)</p>
1.75      rillig   1448: <p>NOTE:  Newer Windows service packs change the way binary execution
1.87      wiz      1449:        works (via the Data Execution Prevention feature).  In order to use
                   1450:        pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
                   1451:        POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
                   1452:        must be installed.  Hotfixes are available from Microsoft through a
                   1453:        support contract; however, a NetBSD developer has made most Interix
                   1454:        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   1455: <p>In addition to the hotfix noted above, it may be necessary to
                   1456:        disable Data Execution Prevention entirely to make Interix functional.
                   1457:        This may happen only with certain types of CPUs; the cause is not fully
                   1458:        understood at this time.  If gcc or other applications still segfault
                   1459:        repeatedly after installing one of the hotfixes note above, the
                   1460:        following option can be added to the appropriate "boot.ini" line on the
                   1461:        Windows boot drive:  /NoExecute=AlwaysOff
                   1462:        (WARNING, this will disable DEP completely, which may be a security
                   1463:        risk if applications are often run as a user in the Administrators
                   1464:        group!)</p>
1.75      rillig   1465: </div>
                   1466: <div class="sect3" lang="en">
                   1467: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1468: <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   1469: <p>If SFU is already installed and you wish to alter these settings to work
1.87      wiz      1470:        with pkgsrc, note the following things.</p>
1.75      rillig   1471: <div class="itemizedlist"><ul type="disc">
                   1472: <li><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.87      wiz      1473:            Windows Services for UNIX, then click Change.  In the installer, choose
                   1474:            Add or Remove, then uncheck Utilities-&gt;UNIX Perl.</p></li>
1.75      rillig   1475: <li>
                   1476: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1.87      wiz      1477:            change the following registry key:</p>
1.75      rillig   1478: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
                   1479: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
                   1480: </li>
                   1481: <li>
                   1482: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1.87      wiz      1483:            following registry key:</p>
1.75      rillig   1484: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
                   1485: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
                   1486: </li>
                   1487: </ul></div>
                   1488: </div>
                   1489: <div class="sect3" lang="en">
                   1490: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1491: <a name="platform.interix-notes"></a>3.3.3.3. Important notes for using pkgsrc</h4></div></div></div>
1.75      rillig   1492: <p>The package manager (either the pkgsrc "su" user, or the user
1.87      wiz      1493:        running "pkg_add") must be a member of the local Administrators
                   1494:        group.  Such a user must also be used to run the bootstrap.  This is
                   1495:        slightly relaxed from the normal pkgsrc requirement of "root".</p>
1.75      rillig   1496: <p>The package manager should use a umask of 002.  "make install" will
1.87      wiz      1497:        automatically complain if this is not the case.  This ensures that
                   1498:        directories written in /var/db/pkg are Administrators-group writeable.</p>
1.75      rillig   1499: <p>The popular Interix binary packages from http://www.interopsystems.com/
1.87      wiz      1500:        use an older version of pkgsrc's pkg_* tools.  Ideally, these should
                   1501:        NOT be used in conjunction with pkgsrc.  If you choose to use them at
                   1502:        the same time as the pkgsrc packages, ensure that you use the proper
                   1503:        pkg_* tools for each type of binary package.</p>
1.75      rillig   1504: <p>The TERM setting used for DOS-type console windows (including those
1.87      wiz      1505:        invoked by the csh and ksh startup shortcuts) is "interix".  Most systems
                   1506:        don't have a termcap/terminfo entry for it, but the following .termcap
                   1507:        entry provides adequate emulation in most cases:</p>
1.75      rillig   1508: <pre class="programlisting">
1.100   ! rillig   1509: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1.87      wiz      1510:        </pre>
1.75      rillig   1511: </div>
                   1512: <div class="sect3" lang="en">
                   1513: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1514: <a name="platform.interix-limits"></a>3.3.3.4. Limitations of the Interix platform</h4></div></div></div>
1.75      rillig   1515: <p>Though Interix suffices as a familiar and flexible substitute
1.87      wiz      1516:        for a full Unix-like platform, it has some drawbacks that should
                   1517:        be noted for those desiring to make the most of Interix.</p>
1.75      rillig   1518: <div class="itemizedlist"><ul type="disc">
                   1519: <li>
                   1520: <p><span class="strong"><strong>X11:</strong></span></p>
                   1521: <p>Interix comes with the standard set of X11R6 client libraries,
1.87      wiz      1522:          and can run X11 based applications, but it does
                   1523:          <span class="emphasis"><em>not</em></span> come with an X server.  Some options are
                   1524:          <a href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
                   1525:          <a href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
                   1526:          (available in a trimmed version for Interix from Interop Systems as the
                   1527:          <a href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
                   1528:          and the free X11 server included with
                   1529:          <a href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.75      rillig   1530: </li>
                   1531: <li>
                   1532: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
                   1533: <p>Because Interix runs in a completely different NT subsystem from
1.87      wiz      1534:          Win32 applications, it does not currently support various X11
                   1535:          protocol extensions for acceleration (such as MIT-SHM or DGA).
                   1536:          Most interactive applications to a local X server will run
                   1537:          reasonably fast, but full motion video and other graphics
                   1538:          intensive applications may require a faster-than-expected CPU.</p>
1.75      rillig   1539: </li>
                   1540: <li>
                   1541: <p><span class="strong"><strong>Audio:</strong></span></p>
                   1542: <p>Interix has no native support for audio output.  For audio
1.87      wiz      1543:          support, pkgsrc uses the <span><strong class="command">esound</strong></span> client/server
                   1544:          audio system on Interix.  Unlike on most platforms, the
1.91      rillig   1545:          <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      1546:          <span class="emphasis"><em>not</em></span> contain the <span><strong class="command">esd</strong></span>
                   1547:          server component.  To output audio via an Interix host, the
1.91      rillig   1548:          <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      1549:          must also be installed.</p>
1.75      rillig   1550: </li>
                   1551: <li>
                   1552: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
                   1553: <p>Direct device access is not currently supported in Interix, so it
1.87      wiz      1554:          is not currently possible to access CD/DVD drives, USB devices,
                   1555:          or SCSI devices through non-filesystem means.  Among other things,
                   1556:          this makes it impossible to use Interix directly for CD/DVD
                   1557:          burning.</p>
1.75      rillig   1558: </li>
                   1559: <li>
                   1560: <p><span class="strong"><strong>Tape drives:</strong></span></p>
                   1561: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1.87      wiz      1562:          drives are also not directly accessible in Interix.  However,
                   1563:          support is in work to make tape drive access possible by using
                   1564:          Cygwin as a bridge (similarly to audio bridged via Cygwin's
                   1565:          esound server).</p>
1.75      rillig   1566: </li>
                   1567: </ul></div>
                   1568: </div>
                   1569: <div class="sect3" lang="en">
                   1570: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1571: <a name="platform.interix-knownissues"></a>3.3.3.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.75      rillig   1572: <p>It is not necessary, in general, to have a "root" user on the
1.87      wiz      1573:        Windows system; any member of the local Administrators group will
                   1574:        suffice.  However, some packages currently assume that the user
                   1575:        named "root" is the privileged user.  To accommodate these, you
                   1576:        may create such a user; make sure it is in the local group
                   1577:        Administrators (or your language equivalent).</p>
                   1578: <p><span><strong class="command">pkg_add</strong></span> creates directories of mode
                   1579:        0755, not 0775, in <code class="filename">$PKG_DBDIR</code>.  For the
                   1580:        time being, install packages as the local Administrator (or
                   1581:        your language equivalent), or run the following command after
                   1582:        installing a package to work around the issue:</p>
1.75      rillig   1583: <pre class="screen">
1.87      wiz      1584: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
                   1585:        </pre>
1.75      rillig   1586: </div>
                   1587: </div>
                   1588: <div class="sect2" lang="en">
                   1589: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1590: <a name="irix"></a>3.3.4. IRIX</h3></div></div></div>
1.75      rillig   1591: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1.87      wiz      1592:       compiler (cc/c89).  Please set the <code class="varname">CC</code> environment variable
                   1593:       according to your preference.  If you do not have a license for the MIPSpro
                   1594:       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   1595: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.87      wiz      1596:       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>,
                   1597:       etc.</p>
1.86      schwarz  1598: <p>At this point in time, pkgsrc only supports one ABI at a time.  That is, you cannot
1.75      rillig   1599:        switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI.  If
                   1600:        you start out using "abi=n32", that's what all your packages will be built
                   1601:        with.</p>
                   1602: <p>Therefore, please make sure that you have no conflicting
1.87      wiz      1603:       <code class="varname">CFLAGS</code> in your environment or the
                   1604:       <code class="filename">/etc/mk.conf</code>.  Particularly, make sure that you do not
                   1605:       try to link n32 object files with lib64 or vice versa.  Check your
                   1606:       <code class="filename">/etc/compiler.defaults</code>!</p>
1.75      rillig   1607: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1.87      wiz      1608:       please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
                   1609:       as it appears that IRIX linker occasionally runs into issues when trying to
                   1610:       link over a network-mounted file system.</p>
1.75      rillig   1611: <p>The bootstrapping process should set all the right options for programs such
1.87      wiz      1612:       as imake(1), but you may want to set some options depending on your local
                   1613:       setup.  Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
                   1614:       course, your compiler's man pages for details.</p>
1.75      rillig   1615: <p>If you are using SGI's MIPSPro compiler, please set
1.1       grant    1616: 
1.87      wiz      1617:       </p>
1.75      rillig   1618: <pre class="programlisting">
1.100   ! rillig   1619: PKGSRC_COMPILER=        mipspro
1.87      wiz      1620:       </pre>
1.75      rillig   1621: <p>
1.1       grant    1622: 
1.87      wiz      1623:       in <code class="filename">/etc/mk.conf</code>.  Otherwise, pkgsrc will assume you
                   1624:       are using gcc and may end up passing invalid flags to the compiler.  Note that
                   1625:       bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
                   1626:       default.</p>
1.75      rillig   1627: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1.93      rillig   1628:       but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1.87      wiz      1629:       to <span class="emphasis"><em>not</em></span> include the location of gcc (often
                   1630:       <code class="filename">/usr/freeware/bin</code>), and (important) pass the
                   1631:       '--preserve-path' flag.</p>
1.75      rillig   1632: </div>
                   1633: <div class="sect2" lang="en">
                   1634: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1635: <a name="linux"></a>3.3.5. Linux</h3></div></div></div>
1.87      wiz      1636: <p>Some versions of Linux (for example Debian GNU/Linux) need
                   1637:       either libtermcap or libcurses (libncurses).  Installing the
                   1638:       distributions libncurses-dev package (or equivalent) should fix
                   1639:       the problem.</p>
                   1640: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
                   1641:       (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
                   1642:       i386 have been tested.</p>
1.75      rillig   1643: <p>To bootstrap using icc, assuming the default icc installation
1.87      wiz      1644:       directory:</p>
1.75      rillig   1645: <pre class="programlisting">
1.100   ! rillig   1646: env CC=/opt/intel_cc_80/bin/icc LDFLAGS=-static-libcxa \
        !          1647: ac_cv___attribute__=yes ./bootstrap
1.87      wiz      1648:       </pre>
1.75      rillig   1649: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1650: <h3 class="title">Note</h3>
                   1651: <p>icc 8.1 needs the `-i-static' argument instead of -static-libcxa.</p>
                   1652: </div>
                   1653: <p>icc supports __attribute__, but the GNU configure test uses a nested
1.87      wiz      1654:       function, which icc does not support. #undef'ing __attribute__ has the
                   1655:       unfortunate side-effect of breaking many of the Linux header files, which
                   1656:       cannot be compiled properly without __attribute__. The test must be
                   1657:       overridden so that __attribute__ is assumed supported by the
                   1658:       compiler.</p>
1.75      rillig   1659: <p>After bootstrapping, you should set <code class="varname">PKGSRC_COMPILER</code>
1.87      wiz      1660:       in <code class="filename">/etc/mk.conf</code>:</p>
1.75      rillig   1661: <pre class="programlisting">
1.100   ! rillig   1662: PKGSRC_COMPILER=        icc
1.87      wiz      1663:       </pre>
1.75      rillig   1664: <p>The default installation directory for icc is
1.87      wiz      1665:       <code class="filename">/opt/intel_cc_80</code>, which
                   1666:       is also the pkgsrc default. If you have installed it into a different
                   1667:       directory, set <code class="varname">ICCBASE</code> in
                   1668:       <code class="filename">/etc/mk.conf</code>:</p>
1.75      rillig   1669: <pre class="programlisting">
1.100   ! rillig   1670: ICCBASE=                /opt/icc
1.87      wiz      1671:       </pre>
1.75      rillig   1672: <p>pkgsrc uses the static linking method of the runtime libraries
1.87      wiz      1673:       provided by icc, so binaries can be run on other systems which do not
                   1674:       have the shared libraries installed.</p>
                   1675: <p>Libtool, however, extracts a list of libraries from the
                   1676:       <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
                   1677:       records it, throwing away the -Bstatic and -Bdynamic options
                   1678:       interspersed between the libraries.  This means that
                   1679:       libtool-linked C++ shared libraries will have a runtime
                   1680:       dependency on the icc libraries until this is fixed in
                   1681:       libtool.</p>
1.75      rillig   1682: </div>
                   1683: <div class="sect2" lang="en">
                   1684: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1685: <a name="openbsd"></a>3.3.6. OpenBSD</h3></div></div></div>
1.75      rillig   1686: <p>OpenBSD 3.0 and 3.2 are tested and supported.</p>
                   1687: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87      wiz      1688:       with the OpenBSD userland tools. There are several steps:</p>
1.75      rillig   1689: <div class="orderedlist"><ol type="1">
                   1690: <li><p>OpenBSD stores its ports pkg database in
1.87      wiz      1691:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1692:          recommended that you choose a different location (e.g.
                   1693:          <code class="filename">/usr/pkgdb</code>) by
                   1694:          using the --pkgdbdir option to the bootstrap script.</p></li>
1.75      rillig   1695: <li>
                   1696: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1.87      wiz      1697:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1698: <pre class="screen">
                   1699: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75      rillig   1700: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1701: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1702: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87      wiz      1703: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1704:          </pre>
1.75      rillig   1705: </li>
                   1706: <li>
1.76      rillig   1707: <p>An example <code class="filename">/etc/mk.conf</code> file will be placed in
1.87      wiz      1708:          <code class="filename">/etc/mk.conf.example</code> file
                   1709:          when you use the bootstrap script. OpenBSD's make program uses
                   1710:          <code class="filename">/etc/mk.conf</code>
                   1711:          as well. You can work around this by enclosing all the pkgsrc-specific parts
                   1712:          of the file with:</p>
                   1713: <pre class="programlisting">
1.100   ! rillig   1714: .ifdef BSD_PKG_MK
        !          1715: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
        !          1716: .else
        !          1717: # OpenBSD stuff
        !          1718: .endif
1.87      wiz      1719:          </pre>
1.75      rillig   1720: </li>
                   1721: </ol></div>
                   1722: </div>
                   1723: <div class="sect2" lang="en">
                   1724: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1725: <a name="solaris"></a>3.3.7. Solaris</h3></div></div></div>
1.75      rillig   1726: <p>Solaris 2.6 through 9 are supported on both x86 and sparc.
1.87      wiz      1727:       You will need a working C compiler. Both gcc 2.95.3 and
                   1728:       Sun WorkShop 5 have been tested.</p>
1.75      rillig   1729: <p>The following packages are required on Solaris 8 for the bootstrap
1.87      wiz      1730:       process and to build packages.</p>
1.75      rillig   1731: <div class="itemizedlist"><ul type="disc">
                   1732: <li><p>SUNWsprot</p></li>
                   1733: <li><p>SUNWarc</p></li>
                   1734: <li><p>SUNWbtool</p></li>
                   1735: <li><p>SUNWtoo</p></li>
                   1736: <li><p>SUNWlibm</p></li>
                   1737: </ul></div>
1.78      rillig   1738: <p>Please note that the use of GNU binutils on Solaris is
1.87      wiz      1739:       <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1.75      rillig   1740: <p>Whichever compiler you use, please ensure the compiler tools and
1.87      wiz      1741:       your $prefix are in your <code class="varname">PATH</code>. This includes
                   1742:       <code class="filename">/usr/ccs/{bin,lib}</code>
                   1743:       and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.75      rillig   1744: <div class="sect3" lang="en">
                   1745: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1746: <a name="solaris-gcc-note"></a>3.3.7.1. If you are using gcc</h4></div></div></div>
1.75      rillig   1747: <p>It makes life much simpler if you only use the same gcc consistently
1.87      wiz      1748:        for building all packages.</p>
1.75      rillig   1749: <p>It is recommended that an external gcc be used only for bootstrapping,
1.87      wiz      1750:        then either build gcc from
1.91      rillig   1751:        <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      1752:        package, then remove gcc used during bootstrapping.</p>
1.93      rillig   1753: <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   1754: </div>
                   1755: <div class="sect3" lang="en">
                   1756: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1757: <a name="solaris-sun-workshop-note"></a>3.3.7.2. If you are using Sun WorkShop</h4></div></div></div>
1.75      rillig   1758: <p>You will need at least the following packages installed (from WorkShop
1.87      wiz      1759:        5.0)</p>
1.75      rillig   1760: <div class="itemizedlist"><ul type="disc">
                   1761: <li><p>SPROcc
1.87      wiz      1762:          - Sun WorkShop Compiler C 5.0</p></li>
1.75      rillig   1763: <li><p>SPROcpl
1.87      wiz      1764:          - Sun WorkShop Compiler C++ 5.0</p></li>
1.75      rillig   1765: <li><p>SPROild
1.87      wiz      1766:          - Sun WorkShop Incremental Linker</p></li>
1.75      rillig   1767: <li><p>SPROlang
1.87      wiz      1768:          - Sun WorkShop Compilers common components</p></li>
1.75      rillig   1769: </ul></div>
1.96      rillig   1770: <p>You should set the following variables in your
                   1771:        <code class="filename">mk.conf</code> file:</p>
                   1772: <pre class="programlisting">
1.100   ! rillig   1773: CC=     cc
        !          1774: CXX=    CC
        !          1775: CPP=    cc -E
        !          1776: CXXCPP= CC -E
1.96      rillig   1777: </pre>
                   1778: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1779: <h3 class="title">Note</h3>
                   1780: <p>The <code class="varname">CPP</code> setting might break some
                   1781:        packages that use the C preprocessor for processing things other
                   1782:        than C source code.</p>
                   1783: </div>
1.75      rillig   1784: </div>
                   1785: <div class="sect3" lang="en">
                   1786: <div class="titlepage"><div><div><h4 class="title">
1.93      rillig   1787: <a name="solaris-sunpro-64"></a>3.3.7.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.96      rillig   1788: <p>To build 64-bit packages, you just need to have the
                   1789:        following lines in your <code class="filename">mk.conf</code>
1.75      rillig   1790:        file:</p>
                   1791: <pre class="programlisting">
1.100   ! rillig   1792: PKGSRC_COMPILER=        sunpro
        !          1793: ABI=                    64
1.96      rillig   1794: </pre>
                   1795: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1796: <h3 class="title">Note</h3>
                   1797: <p>This setting has been tested for the SPARC
                   1798:        architecture. Intel and AMD machines need some more
                   1799:        work.</p>
                   1800: </div>
1.75      rillig   1801: </div>
                   1802: <div class="sect3" lang="en">
                   1803: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1804: <a name="plat.sunos.problems"></a>3.3.7.4. Common problems</h4></div></div></div>
1.75      rillig   1805: <p>Sometimes, when using <span><strong class="command">libtool</strong></span>,
1.87      wiz      1806:       <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
                   1807:       The workaround is to use another shell for the configure
1.91      rillig   1808:       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      1809:       to your <code class="filename">mk.conf</code>:</p>
                   1810: <pre class="programlisting">
1.100   ! rillig   1811: CONFIG_SHELL=   ${LOCALBASE}/bin/bash
        !          1812: WRAPPER_SHELL=  ${LOCALBASE}/bin/bash
1.87      wiz      1813:       </pre>
1.91      rillig   1814: <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   1815: </div>
                   1816: </div>
                   1817: </div>
                   1818: </div>
                   1819: <div class="chapter" lang="en">
                   1820: <div class="titlepage"><div><div><h2 class="title">
                   1821: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
                   1822: <div class="toc">
                   1823: <p><b>Table of Contents</b></p>
                   1824: <dl>
                   1825: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                   1826: <dd><dl>
                   1827: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                   1828: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig   1829: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                   1830: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                   1831: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                   1832: <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>
                   1833: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                   1834: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75      rillig   1835: </dl></dd>
                   1836: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                   1837: <dd><dl>
                   1838: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                   1839: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                   1840: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                   1841: </dl></dd>
                   1842: </dl>
                   1843: </div>
                   1844: <p>Basically, there are two ways of using pkgsrc. The first
1.88      wiz      1845: is to only install the package tools and to use binary packages
                   1846: that someone else has prepared. This is the &#8220;<span class="quote">pkg</span>&#8221;
                   1847: in pkgsrc. The second way is to install the &#8220;<span class="quote">src</span>&#8221;
                   1848: of pkgsrc, too. Then you are able to build your own packages,
                   1849: and you can still use binary packages from someone else.</p>
1.75      rillig   1850: <div class="sect1" lang="en">
                   1851: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1852: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
                   1853: <p>To use binary packages, you need some tools to manage
1.88      wiz      1854:   them. On NetBSD, these tools are already installed. On all other
                   1855:   operating systems, you need to install them first. For the
                   1856:   following platforms, prebuilt versions of the package tools
                   1857:   are available and can simply be downloaded and unpacked in the
                   1858:   <code class="filename">/</code> directory:</p>
1.75      rillig   1859: <div class="informaltable">
                   1860: <a name="binary-bootstrap-kits"></a><table border="1">
                   1861: <colgroup>
                   1862: <col>
                   1863: <col>
                   1864: </colgroup>
                   1865: <thead><tr>
                   1866: <th>Platform</th>
                   1867: <th>URL</th>
                   1868: </tr></thead>
                   1869: <tbody>
                   1870: <tr>
                   1871: <td>Solaris 9</td>
1.76      rillig   1872: <td><code class="filename">ftp://ftp0.mh.bbc.co.uk/pub/pkgsrc/packages/bootstrap-pkgsrc/</code></td>
1.75      rillig   1873: </tr>
                   1874: <tr>
                   1875: <td>Solaris 10</td>
1.76      rillig   1876: <td><code class="filename">http://public.enst.fr/pkgsrc/packages/bootstrap-pkgsrc/</code></td>
1.75      rillig   1877: </tr>
                   1878: </tbody>
                   1879: </table>
                   1880: </div>
1.82      rillig   1881: <p>These pre-built package tools use
1.88      wiz      1882:   <code class="filename">/usr/pkg</code> for the base directory, and
                   1883:   <code class="filename">/var/db/pkg</code> for the database of installed
                   1884:   packages. If you cannot use these directories for whatever
                   1885:   reasons (maybe because you're not root), you have to build the
                   1886:   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   1887: <div class="sect2" lang="en">
                   1888: <div class="titlepage"><div><div><h3 class="title">
                   1889: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
                   1890: <p>To install binary packages, you first need to know from
1.88      wiz      1891:     where to get them. You can get them on CD-ROMs, DVDs, or via FTP
                   1892:     or HTTP.</p>
1.81      rillig   1893: <p>The binary packages can be found at the following
1.88      wiz      1894:     locations.</p>
1.75      rillig   1895: <div class="informaltable">
                   1896: <a name="binary-packages"></a><table border="1">
                   1897: <colgroup>
                   1898: <col>
                   1899: <col>
                   1900: </colgroup>
                   1901: <thead><tr>
                   1902: <th>Platform</th>
                   1903: <th>URL</th>
                   1904: </tr></thead>
                   1905: <tbody>
                   1906: <tr>
1.81      rillig   1907: <td>NetBSD</td>
                   1908: <td><code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/</code></td>
                   1909: </tr>
                   1910: <tr>
1.75      rillig   1911: <td>Solaris 9</td>
1.76      rillig   1912: <td><code class="filename">ftp://ftp0.mh.bbc.co.uk/pub/pkgsrc/packages/</code></td>
1.75      rillig   1913: </tr>
                   1914: <tr>
                   1915: <td>Solaris 10</td>
1.76      rillig   1916: <td><code class="filename">http://public.enst.fr/pkgsrc/packages/</code></td>
1.75      rillig   1917: </tr>
                   1918: </tbody>
                   1919: </table>
                   1920: </div>
1.81      rillig   1921: <p>Most of these directories contain binary packages for
1.88      wiz      1922:     multiple platforms. Select the appropriate subdirectories,
                   1923:     according to your machine architecture and operating system,
                   1924:     until you find a directory called <code class="filename">All</code>. This
                   1925:     directory contains all the binary packages. Further, there are
                   1926:     subdirectories for categories that contain symbolic links that
                   1927:     point to the actual binary package in
                   1928:     <code class="filename">../All</code>. This directory layout is used for
                   1929:     all package repositories, no matter if they are accessed via
                   1930:     HTTP, FTP, NFS, CD-ROM, or the local filesystem.</p>
1.75      rillig   1931: </div>
                   1932: <div class="sect2" lang="en">
                   1933: <div class="titlepage"><div><div><h3 class="title">
                   1934: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.87      wiz      1935: <p>If you have the files on a CD-ROM or downloaded them to
1.88      wiz      1936:     your hard disk, you can install them with the following command
                   1937:     (be sure to <span><strong class="command">su</strong></span> to root first):</p>
1.75      rillig   1938: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add /path/to/package.tgz</code></strong></pre>
1.87      wiz      1939: <p>If you have FTP access and you don't want to download the
1.88      wiz      1940:     packages via FTP prior to installation, you can do this
                   1941:     automatically by giving <span><strong class="command">pkg_add</strong></span> an FTP URL:</p>
1.82      rillig   1942: <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   1943: <p>Note that any prerequisite packages needed to run the
1.88      wiz      1944:     package in question will be installed, too, assuming they are
                   1945:     present where you install from.</p>
1.75      rillig   1946: <p>To save some typing, you can set the
1.88      wiz      1947:     <code class="varname">PKG_PATH</code> environment variable to a semicolon-separated
                   1948:     list of paths (including remote URLs); trailing slashes are not allowed.
                   1949:     </p>
1.76      rillig   1950: <p>Additionally to the <code class="filename">All</code> directory
1.88      wiz      1951:     there exists a <code class="filename">vulnerable</code> directory to
                   1952:     which binary packages with known vulnerabilities are
                   1953:     moved, since removing them could cause missing dependencies. To
                   1954:     use these packages, add the <code class="filename">vulnerable</code>
                   1955:     directory to your <code class="varname">PKG_PATH</code>. However, you should run
1.91      rillig   1956:     <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      1957:     especially after installing new packages, and verify that the
                   1958:     vulnerabilities are acceptable for your configuration. An example
                   1959:     <code class="varname">PKG_PATH</code> would be:
                   1960:     <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>
                   1961:     Please note that semicolon (';') is a shell meta-character, so
                   1962:     you'll probably have to quote it.</p>
1.75      rillig   1963: <p>After you've installed packages, be sure to have
1.88      wiz      1964:     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
                   1965:     <code class="varname">PATH</code> so you can actually start the just
                   1966:     installed program.</p>
1.75      rillig   1967: </div>
                   1968: <div class="sect2" lang="en">
                   1969: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1970: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
                   1971: <p>To deinstall a package, it does not matter whether it was
1.88      wiz      1972:     installed from source code or from a binary package. The
                   1973:     <span><strong class="command">pkg_delete</strong></span> command does not know it anyway.
                   1974:     To delete a package, you can just run <span><strong class="command">pkg_delete
                   1975:     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
                   1976:     name can be given with or without version number. Wildcards can
                   1977:     also be used to deinstall a set of packages, for example
                   1978:     <code class="literal">*emacs*</code>. Be sure to include them in quotes,
                   1979:     so that the shell does not expand them before
                   1980:     <code class="literal">pkg_delete</code> sees them.</p>
1.82      rillig   1981: <p>The <code class="option">-r</code> option is very powerful: it
1.88      wiz      1982:     removes all the packages that require the package in question
                   1983:     and then removes the package itself. For example:
1.82      rillig   1984: 
1.88      wiz      1985:     </p>
1.82      rillig   1986: <pre class="screen">
1.88      wiz      1987: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
                   1988:     </pre>
1.82      rillig   1989: <p>
                   1990: 
1.88      wiz      1991:     will remove jpeg and all the packages that used it; this allows
                   1992:     upgrading the jpeg package.</p>
1.82      rillig   1993: </div>
                   1994: <div class="sect2" lang="en">
                   1995: <div class="titlepage"><div><div><h3 class="title">
                   1996: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
                   1997: <p>The <span><strong class="command">pkg_info</strong></span> shows information about
1.88      wiz      1998:     installed packages or binary package files.</p>
1.82      rillig   1999: </div>
                   2000: <div class="sect2" lang="en">
                   2001: <div class="titlepage"><div><div><h3 class="title">
                   2002: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
                   2003: <p>
1.88      wiz      2004:       The NetBSD Security-Officer and Packages Groups maintain a list of
                   2005:       known security vulnerabilities to packages which are (or have been)
                   2006:       included in pkgsrc.  The list is available from the NetBSD
                   2007:       FTP site at <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
                   2008:     </p>
1.82      rillig   2009: <p>
1.93      rillig   2010:       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      2011:       this list can be downloaded
                   2012:       automatically, and a security audit of all packages installed on a system
                   2013:       can take place.
                   2014:     </p>
1.82      rillig   2015: <p>
1.93      rillig   2016:       There are two components to
1.91      rillig   2017:       <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      2018:       component, &#8220;<span class="quote">download-vulnerability-list</span>&#8221;, is for downloading
                   2019:       the list of vulnerabilities from the NetBSD FTP site.  The second
                   2020:       component, &#8220;<span class="quote">audit-packages</span>&#8221;, checks to see if any of your
                   2021:       installed packages are vulnerable.  If a package is vulnerable, you
                   2022:       will see output similar to the following:
                   2023:     </p>
1.82      rillig   2024: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88      wiz      2025:     http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82      rillig   2026: <p>
1.91      rillig   2027:       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      2028:       <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
                   2029:       file daily, and include a package audit in the daily security script.
                   2030:       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   2031:       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      2032:     </p>
1.82      rillig   2033: </div>
                   2034: <div class="sect2" lang="en">
                   2035: <div class="titlepage"><div><div><h3 class="title">
                   2036: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
                   2037: <p>
1.93      rillig   2038:       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      2039:       <span><strong class="command">lintpkgsrc</strong></span> with the &#8220;<span class="quote">-i</span>&#8221;
                   2040:       argument to check if your packages are up-to-date, e.g.
                   2041:     </p>
                   2042: <pre class="screen">
                   2043: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82      rillig   2044: ...
1.88      wiz      2045: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   2046:     </pre>
1.82      rillig   2047: <p>You can then use <span><strong class="command">make update</strong></span> to update the
1.88      wiz      2048:     package on your system and rebuild any dependencies.
                   2049:     </p>
1.82      rillig   2050: </div>
                   2051: <div class="sect2" lang="en">
                   2052: <div class="titlepage"><div><div><h3 class="title">
                   2053: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
                   2054: <p>The <span><strong class="command">pkg_admin</strong></span> executes various
1.88      wiz      2055:     administrative functions on the package system.</p>
1.82      rillig   2056: </div>
                   2057: <div class="sect2" lang="en">
                   2058: <div class="titlepage"><div><div><h3 class="title">
                   2059: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1.75      rillig   2060: <p>Please pay very careful attention to the warnings
1.88      wiz      2061:     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
                   2062:     inherent dangers of installing binary packages which you did
                   2063:     not create yourself, and the security holes that can be
                   2064:     introduced onto your system by indiscriminate adding of such
                   2065:     files.</p>
1.75      rillig   2066: <p>The same warning of course applies to every package you
1.88      wiz      2067:     install from source when you haven't completely read and
                   2068:     understood the source code of the package, the compiler that
                   2069:     is used to build the package and all the other tools that are
                   2070:     involved.</p>
1.75      rillig   2071: </div>
                   2072: </div>
                   2073: <div class="sect1" lang="en">
                   2074: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2075: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88      wiz      2076: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
                   2077:   directory now contains a set of packages, organized into
                   2078:   categories. You can browse the online index of packages, or run
                   2079:   <span><strong class="command">make readme</strong></span> from the <code class="filename">pkgsrc</code>
                   2080:   directory to build local <code class="filename">README.html</code> files for
1.91      rillig   2081:   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      2082: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
                   2083:   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
                   2084:   should do so by setting <code class="varname">LOCALBASE</code> in
                   2085:   <code class="filename">mk.conf</code>. You should not try to use multiple
                   2086:   different <code class="varname">LOCALBASE</code> definitions on the same
                   2087:   system (inside a chroot is an exception). </p>
                   2088: <p>The rest of this chapter assumes that the package is already
                   2089:   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
                   2090:   instructions how to create your own packages.</p>
1.75      rillig   2091: <div class="sect2" lang="en">
                   2092: <div class="titlepage"><div><div><h3 class="title">
                   2093: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82      rillig   2094: <p>To build packages from source, you need a working C
1.88      wiz      2095:     compiler. On NetBSD, you need to install the
                   2096:     &#8220;<span class="quote">comp</span>&#8221; and the &#8220;<span class="quote">text</span>&#8221; distribution
                   2097:     sets. If you want to build X11-related packages, the
                   2098:     &#8220;<span class="quote">xbase</span>&#8221; and &#8220;<span class="quote">xcomp</span>&#8221; distribution
                   2099:     sets are required, too.</p>
1.75      rillig   2100: </div>
                   2101: <div class="sect2" lang="en">
                   2102: <div class="titlepage"><div><div><h3 class="title">
                   2103: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
                   2104: <p>The first step for building a package is downloading the
1.88      wiz      2105:     distfiles (i.e. the unmodified source). If they have not yet been
                   2106:     downloaded, pkgsrc will fetch them automatically.</p>
                   2107: <p>If you have all files that you need in the
                   2108:     <code class="filename">distfiles</code> directory,
                   2109:     you don't need to connect. If the distfiles are on CD-ROM, you can
                   2110:     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
                   2111:     </p>
1.82      rillig   2112: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
                   2113: <p>
1.88      wiz      2114:     to your <code class="filename">mk.conf</code>.</p>
1.91      rillig   2115: <p>By default a list of distribution sites will be randomly
                   2116:     intermixed to prevent huge load on servers which holding popular
                   2117:     packages (for example, SourceForge.net mirrors). Thus, every
                   2118:     time when you need to fetch yet another distfile all the mirrors
                   2119:     will be tried in new (random) order. You can turn this feature
                   2120:     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
                   2121:     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88      wiz      2122: <p>You can overwrite some of the major distribution sites to
                   2123:     fit to sites that are close to your own.  By setting one or two
                   2124:     variables you can modify the order in which the master sites are
                   2125:     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
                   2126:     delimited list of domain suffixes.
                   2127:     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
                   2128:     contains a whitespace delimited list of regular expressions.  It
                   2129:     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
                   2130:     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
                   2131:     some examples.  This may save some of your bandwidth and
                   2132:     time.</p>
1.75      rillig   2133: <p>You can change these settings either in your shell's environment, or,
1.88      wiz      2134:     if you want to keep the settings, by editing the
                   2135:     <code class="filename">/etc/mk.conf</code> file,
                   2136:     and adding the definitions there.</p>
1.82      rillig   2137: <p>
1.88      wiz      2138:       If a package depends on many other packages (such as
1.93      rillig   2139:       <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      2140:       alternate between periods of
                   2141:       downloading source, and compiling. To ensure you have all the source
                   2142:       downloaded initially you can run the command:
                   2143:       </p>
1.82      rillig   2144: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
                   2145: <p>
1.88      wiz      2146:       which will output and run a set of shell commands to fetch the
                   2147:       necessary files into the <code class="filename">distfiles</code> directory.  You can
                   2148:       also choose to download the files manually.
                   2149:     </p>
1.75      rillig   2150: </div>
                   2151: <div class="sect2" lang="en">
                   2152: <div class="titlepage"><div><div><h3 class="title">
                   2153: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82      rillig   2154: <p>
1.88      wiz      2155:       Once the software has downloaded, any patches will be applied, then it
                   2156:       will be compiled for you. This may take some time depending on your
                   2157:       computer, and how many other packages the software depends on and their
                   2158:       compile time.
                   2159:     </p>
1.75      rillig   2160: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2161: <h3 class="title">Note</h3>
                   2162: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.88      wiz      2163:     use the pkgsrc <span><strong class="command">bmake</strong></span> command instead of
                   2164:     &#8220;<span class="quote">make</span>&#8221; in the examples in this guide.</p>
1.75      rillig   2165: </div>
1.87      wiz      2166: <p>For example, type</p>
1.88      wiz      2167: <pre class="screen">
                   2168: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2169: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   2170:     </pre>
1.75      rillig   2171: <p>at the shell prompt to build the various components of the
1.88      wiz      2172:     package.</p>
1.82      rillig   2173: <p>The next stage is to actually install the newly compiled
1.88      wiz      2174:     program onto your system. Do this by entering:
1.82      rillig   2175: 
1.88      wiz      2176:     </p>
1.82      rillig   2177: <pre class="screen">
1.88      wiz      2178: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
                   2179:     </pre>
1.82      rillig   2180: <p>
                   2181: 
1.88      wiz      2182:     while you are still in the directory for whatever package you
                   2183:     are installing.</p>
1.82      rillig   2184: <p>Installing the package on your system may require you to
1.88      wiz      2185:     be root.  However, pkgsrc has a
                   2186:     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
                   2187:     to only become root for the actual installation step.</p>
1.82      rillig   2188: <p>That's it, the software should now be installed and setup for use.
1.88      wiz      2189:     You can now enter:
1.82      rillig   2190: 
1.88      wiz      2191:     </p>
1.82      rillig   2192: <pre class="screen">
1.88      wiz      2193: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
                   2194:     </pre>
1.82      rillig   2195: <p>
                   2196: 
1.88      wiz      2197:     to remove the compiled files in the work directory, as you shouldn't need
                   2198:     them any more. If other packages were also added to your system
                   2199:     (dependencies) to allow your program to compile, you can tidy these up
                   2200:     also with the command:</p>
1.82      rillig   2201: <pre class="screen">
1.88      wiz      2202: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
                   2203:     </pre>
1.75      rillig   2204: <p>Taking the figlet utility as an example, we can install it on our
1.88      wiz      2205:     system by building as shown in <a href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
                   2206: <p>The program is installed under the default root of the
                   2207:     packages tree - <code class="filename">/usr/pkg</code>. Should this not
                   2208:     conform to your tastes, set the <code class="varname">LOCALBASE</code>
                   2209:     variable in your environment, and it will use that value as the
                   2210:     root of your packages tree. So, to use
                   2211:     <code class="filename">/usr/local</code>, set
                   2212:     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
                   2213:     Please note that you should use a directory which is dedicated to
                   2214:     packages and not shared with other programs (i.e., do not try and
                   2215:     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
                   2216:     to add any of your own files or directories (such as
                   2217:     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
                   2218:     <code class="filename">pkgsrc/</code>) below the
                   2219:     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
                   2220:     conflicts between programs and other files installed by the
                   2221:     package system and whatever else may have been installed
                   2222:     there.</p>
                   2223: <p>Some packages look in <code class="filename">/etc/mk.conf</code> to
                   2224:     alter some configuration options at build time.  Have a look at
                   2225:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
                   2226:     of what will be set there by default.  Environment variables such
                   2227:     as <code class="varname">LOCALBASE</code> can be set in
                   2228:     <code class="filename">/etc/mk.conf</code> to save having to remember to
                   2229:     set them each time you want to use pkgsrc.</p>
                   2230: <p>Occasionally, people want to &#8220;<span class="quote">look under the
                   2231:     covers</span>&#8221; to see what is going on when a package is building
                   2232:     or being installed. This may be for debugging purposes, or out of
                   2233:     simple curiosity. A number of utility values have been added to
                   2234:     help with this.</p>
1.75      rillig   2235: <div class="orderedlist"><ol type="1">
                   2236: <li>
1.88      wiz      2237: <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
                   2238:        <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
                   2239:        information will be displayed. For example,</p>
1.75      rillig   2240: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88      wiz      2241: <p>will show all the commands that are invoked, up to and
                   2242:        including the &#8220;<span class="quote">patch</span>&#8221; stage.</p>
1.75      rillig   2243: </li>
                   2244: <li>
1.88      wiz      2245: <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>
                   2246:        definition, then the <code class="varname">VARNAME</code> definition
                   2247:        should be used, in conjunction with the show-var
                   2248:        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>
                   2249:        variable <code class="varname">LOCALBASE</code>:</p>
                   2250: <pre class="screen">
                   2251: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75      rillig   2252: /usr/pkg
                   2253: <code class="prompt">%</code>
1.88      wiz      2254:        </pre>
1.75      rillig   2255: </li>
                   2256: </ol></div>
                   2257: <p>If you want to install a binary package that you've either
1.88      wiz      2258:     created yourself (see next section), that you put into
                   2259:     pkgsrc/packages manually or that is located on a remote FTP
                   2260:     server, you can use the "bin-install" target. This target will
                   2261:     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>,
                   2262:     else do a <span><strong class="command">make package</strong></span>.  The list of remote FTP
                   2263:     sites searched is kept in the variable
                   2264:     <code class="varname">BINPKG_SITES</code>, which defaults to
                   2265:     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>
                   2266:     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
                   2267:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
                   2268:     details.</p>
                   2269: <p>A final word of warning: If you set up a system that has a
                   2270:     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
                   2271:     set that before any packages are installed, as you cannot use
                   2272:     several directories for the same purpose. Doing so will result in
                   2273:     pkgsrc not being able to properly detect your installed packages,
                   2274:     and fail miserably. Note also that precompiled binary packages are
                   2275:     usually built with the default <code class="varname">LOCALBASE</code> of
                   2276:     <code class="filename">/usr/pkg</code>, and that you should
                   2277:     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
                   2278:     <code class="varname">LOCALBASE</code>.</p>
1.75      rillig   2279: </div>
                   2280: </div>
                   2281: </div>
                   2282: <div class="chapter" lang="en">
                   2283: <div class="titlepage"><div><div><h2 class="title">
                   2284: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
                   2285: <div class="toc">
                   2286: <p><b>Table of Contents</b></p>
                   2287: <dl>
                   2288: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                   2289: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.78      rillig   2290: <dt><span class="sect1"><a href="#conf.compiler">5.3. Selecting and configuring the compiler</a></span></dt>
1.88      wiz      2291: <dd><dl>
1.89      rillig   2292: <dt><span class="sect2"><a href="#selecting-the-compiler">5.3.1. Selecting the compiler</a></span></dt>
                   2293: <dt><span class="sect2"><a href="#conf.cflags">5.3.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                   2294: <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      2295: </dl></dd>
1.78      rillig   2296: <dt><span class="sect1"><a href="#developer-advanced-settings">5.4. Developer/advanced settings</a></span></dt>
                   2297: <dt><span class="sect1"><a href="#selecting-build-options">5.5. Selecting Build Options</a></span></dt>
1.75      rillig   2298: </dl>
                   2299: </div>
1.89      rillig   2300: <p>The whole pkgsrc system is configured in a single file, usually
                   2301: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
                   2302: that file depends on the installation. On NetBSD, when you use
                   2303: <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
                   2304: <code class="filename">/etc/</code>. In all other cases the default location is
                   2305: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
                   2306: bootstrap program to install the binary packages.</p>
                   2307: <p>During the bootstrap, an example configuration file is created. To
                   2308: use that, you have to create the directory
                   2309: <code class="filename">${PREFIX}/etc</code> and copy the example file
                   2310: there.</p>
                   2311: <p>The format of the configuration file is that of the usual
                   2312: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
                   2313: is done by setting variables in this file. Note that you can define all
                   2314: kinds of variables, and no special error checking (for example for
                   2315: spelling mistakes) takes place, so you have to try it out to see if it
                   2316: works.</p>
1.75      rillig   2317: <div class="sect1" lang="en">
                   2318: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2319: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
                   2320: <p>In this section, you can find some variables that apply to all
1.89      rillig   2321:     pkgsrc packages. A complete list of the variables that can be
                   2322:     configured by the user is available in
                   2323:     <code class="filename">mk/defaults/mk.conf</code>, together with some
                   2324:     comments that describe each variable's intent.</p>
1.75      rillig   2325: <div class="itemizedlist"><ul type="disc">
                   2326: <li><p><code class="varname">LOCALBASE</code>: Where
                   2327:            packages will be installed. The default is
1.76      rillig   2328:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75      rillig   2329:            with different <code class="varname">LOCALBASE</code>s!</p></li>
                   2330: <li><p><code class="varname">CROSSBASE</code>: Where
                   2331:            &#8220;<span class="quote">cross</span>&#8221; category packages will be
                   2332:            installed. The default is
1.76      rillig   2333:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.75      rillig   2334: <li><p><code class="varname">X11BASE</code>: Where
                   2335:            X11 is installed on the system. The default is
1.76      rillig   2336:            <code class="filename">/usr/X11R6</code>.</p></li>
1.75      rillig   2337: <li><p><code class="varname">DISTDIR</code>: Where to store the
                   2338:            downloaded copies of the original source distributions used
                   2339:            for building pkgsrc packages. The default is
1.76      rillig   2340:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.97      rillig   2341: <li><p><code class="varname">PKG_DBDIR</code>: Where the
                   2342:            database about installed packages is stored.  The default is
                   2343:            <code class="filename">/var/db/pkg</code>.</p></li>
1.75      rillig   2344: <li><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
                   2345:            If set, override the packages'
                   2346:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
                   2347: <li><p><code class="varname">MASTER_SITE_BACKUP</code>:
                   2348:            Backup location(s) for distribution files and patch files
                   2349:            if not found locally or in
1.76      rillig   2350:            <code class="filename">${MASTER_SITES}</code> or
                   2351:            <code class="filename">${PATCH_SITES}</code> respectively.
1.75      rillig   2352:            The defaults are
1.76      rillig   2353:            <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}/</code>
1.75      rillig   2354:            and
1.76      rillig   2355:            <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.75      rillig   2356: <li><p><code class="varname">BINPKG_SITES</code>:
1.93      rillig   2357:            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
                   2358:            <em class="replaceable"><code>arch</code></em> are replaced with OS
                   2359:            release (&#8220;<span class="quote">2.0</span>&#8221;, etc.) and architecture
                   2360:            (&#8220;<span class="quote">mipsel</span>&#8221;, etc.).</p></li>
1.82      rillig   2361: <li><p><code class="varname">ACCEPTABLE_LICENSES</code>:
                   2362:            List of acceptable licenses. Whenever you try to build a package
                   2363:            whose license is not in this list, you will get an error message
                   2364:            that includes instructions on how to change this variable.</p></li>
1.75      rillig   2365: </ul></div>
                   2366: </div>
                   2367: <div class="sect1" lang="en">
                   2368: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2369: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
                   2370: <p>XXX
                   2371:       </p>
                   2372: <div class="itemizedlist"><ul type="disc">
                   2373: <li><p><code class="varname">PACKAGES</code>: The top level
                   2374:            directory for the binary packages. The default is
1.76      rillig   2375:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.75      rillig   2376: <li><p><code class="varname">WRKOBJDIR</code>:
                   2377:            The top level directory where, if defined, the separate
                   2378:            working directories will get created, and symbolically
1.76      rillig   2379:            linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75      rillig   2380:            This is useful for building packages on several
1.76      rillig   2381:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                   2382:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75      rillig   2383:            is local to every architecture. (It should be noted that
                   2384:            <code class="varname">PKGSRCDIR</code> should not be set by the user
1.89      rillig   2385:            &mdash; it is an internal definition which refers to the
1.75      rillig   2386:            root of the pkgsrc tree. It is possible to have many
                   2387:            pkgsrc tree instances.)</p></li>
                   2388: <li><p><code class="varname">LOCALPATCHES</code>:
                   2389:            Directory for local patches that aren't part of pkgsrc.
1.90      rillig   2390:            See <a href="#components.patches" title="10.3. patches/*">Section 10.3, &#8220;patches/*&#8221;</a> for more
1.93      rillig   2391:            information.</p></li>
1.75      rillig   2392: <li><p><code class="varname">PKGMAKECONF</code>: Location of
1.76      rillig   2393:            the <code class="filename">mk.conf</code> file used by a package's
1.75      rillig   2394:            BSD-style Makefile. If this is not set,
                   2395:            <code class="varname">MAKECONF</code> is set to
1.76      rillig   2396:            <code class="filename">/dev/null</code> to avoid picking up
                   2397:            settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.82      rillig   2398: <li><p><code class="varname">DEPENDS_TARGET</code>:
                   2399:            By default, dependencies are only installed, and no binary
                   2400:            package is created for them. You can set this variable to
                   2401:            <code class="literal">package</code> to automatically create binary
                   2402:            packages after installing dependencies.</p></li>
1.75      rillig   2403: </ul></div>
                   2404: </div>
                   2405: <div class="sect1" lang="en">
                   2406: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.78      rillig   2407: <a name="conf.compiler"></a>5.3. Selecting and configuring the compiler</h2></div></div></div>
                   2408: <div class="sect2" lang="en">
                   2409: <div class="titlepage"><div><div><h3 class="title">
1.89      rillig   2410: <a name="selecting-the-compiler"></a>5.3.1. Selecting the compiler</h3></div></div></div>
                   2411: <p>By default, pkgsrc will use GCC to build packages.  This may be
                   2412:     overridden by setting the following variables in /etc/mk.conf:</p>
                   2413: <div class="variablelist"><dl>
                   2414: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
                   2415: <dd>
                   2416: <p>This is a list of values specifying the chain of
                   2417:          compilers to invoke when building packages.  Valid values
                   2418:          are:</p>
                   2419: <div class="itemizedlist"><ul type="disc">
                   2420: <li><p><code class="varname">distcc</code>:
                   2421:            distributed C/C++ (chainable)</p></li>
                   2422: <li><p><code class="varname">ccache</code>:
                   2423:            compiler cache (chainable)</p></li>
                   2424: <li><p><code class="varname">gcc</code>:
                   2425:            GNU C/C++ Compiler</p></li>
                   2426: <li><p><code class="varname">mipspro</code>:
                   2427:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
                   2428: <li><p><code class="varname">mipspro</code>:
                   2429:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
                   2430: <li><p><code class="varname">sunpro</code>:
                   2431:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
                   2432: </ul></div>
                   2433: <p>The default is
                   2434:          &#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;.  You can use
                   2435:          <code class="varname">ccache</code> and/or
                   2436:          <code class="varname">distcc</code> with an appropriate
                   2437:          <code class="varname">PKGSRC_COMPILER</code> setting,
                   2438:          e.g. &#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;.  This
1.94      dmcmahil 2439:          variable should always be terminated with a value for
                   2440:          a real compiler.  Note that only one real compiler
                   2441:          should be listed (e.g. &#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;
                   2442:          is not allowed).</p>
1.89      rillig   2443: </dd>
                   2444: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
                   2445: <dd><p>This specifies the minimum version of GCC to use
                   2446:          when building packages.  If the system GCC doesn't
                   2447:          satisfy this requirement, then pkgsrc will build and
                   2448:          install one of the GCC packages to use instead.</p></dd>
                   2449: </dl></div>
                   2450: </div>
                   2451: <div class="sect2" lang="en">
                   2452: <div class="titlepage"><div><div><h3 class="title">
                   2453: <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   2454: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
                   2455:        please make sure to use the <code class="literal">+=</code> operator
                   2456:        instead of the <code class="literal">=</code> operator:</p>
                   2457: <pre class="programlisting">
1.100   ! rillig   2458: CFLAGS+=        -your -flags
1.78      rillig   2459: </pre>
                   2460: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
                   2461:        &#8220;<span class="quote">+</span>&#8221;) may lead to problems with packages that need
                   2462:        to add their own flags.  Also, you may want to take a look at
1.91      rillig   2463:        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   2464:        you're interested in optimization for the current CPU.</p>
                   2465: </div>
1.88      wiz      2466: <div class="sect2" lang="en">
                   2467: <div class="titlepage"><div><div><h3 class="title">
1.89      rillig   2468: <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      2469: <p>If you want to pass flags to the linker, both in the configure
                   2470: step and the build step, you can do this in two ways.  Either set
                   2471: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
                   2472: between the two is that <code class="varname">LIBS</code> will be appended to
                   2473: the command line, while <code class="varname">LDFLAGS</code> come earlier.
                   2474: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
                   2475: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
                   2476: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
                   2477: <code class="varname">CFLAGS</code>, if you do not wish to override these
                   2478: settings, use the <code class="literal">+=</code> operator:</p>
                   2479: <pre class="programlisting">
1.100   ! rillig   2480: LDFLAGS+=        -your -linkerflags
1.88      wiz      2481: </pre>
                   2482: </div>
1.78      rillig   2483: </div>
                   2484: <div class="sect1" lang="en">
                   2485: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2486: <a name="developer-advanced-settings"></a>5.4. Developer/advanced settings</h2></div></div></div>
1.75      rillig   2487: <p>XXX
                   2488:       </p>
                   2489: <div class="itemizedlist"><ul type="disc">
                   2490: <li>
                   2491: <p><code class="varname">PKG_DEVELOPER</code>:
                   2492:            Run some sanity checks that package developers want:
                   2493:            </p>
                   2494: <div class="itemizedlist"><ul type="circle">
1.88      wiz      2495: <li><p>make sure patches apply with zero
                   2496:              fuzz</p></li>
                   2497: <li><p>run check-shlibs to see that all
                   2498:              binaries will find their shared libs.</p></li>
1.75      rillig   2499: </ul></div>
                   2500: <p>
1.87      wiz      2501:        </p>
1.75      rillig   2502: </li>
1.88      wiz      2503: <li><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
                   2504:        of debugging output which is displayed whilst making and
                   2505:        installing the package.  The default value for this is 0,
                   2506:        which will not display the commands as they are executed
                   2507:        (normal, default, quiet operation); the value 1 will display
                   2508:        all shell commands before their invocation, and the value 2
                   2509:        will display both the shell commands before their invocation,
                   2510:        and their actual execution progress with <span><strong class="command">set
                   2511:        -x</strong></span> will be displayed.</p></li>
1.75      rillig   2512: </ul></div>
                   2513: <p>
                   2514:     </p>
                   2515: </div>
                   2516: <div class="sect1" lang="en">
                   2517: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.78      rillig   2518: <a name="selecting-build-options"></a>5.5. Selecting Build Options</h2></div></div></div>
1.88      wiz      2519: <p>Some packages have build time options, usually to select
                   2520:     between different dependencies, enable optional support for big
                   2521:     dependencies or enable experimental features.</p>
1.75      rillig   2522: <p>To see which options, if any, a package supports, and which
1.88      wiz      2523:     options are mutually exclusive, run <span><strong class="command">make
                   2524:     show-options</strong></span>, for example:</p>
1.75      rillig   2525: <pre class="programlisting">
                   2526:     The following options are supported by this package:
                   2527:         ssl      Enable SSL support.
                   2528:     Exactly one of the following gecko options is required:
                   2529:         firefox  Use firefox as gecko rendering engine.
                   2530:         mozilla  Use mozilla as gecko rendering engine.
                   2531:     At most one of the following database options may be selected:
                   2532:         mysql    Enable support for MySQL database.
                   2533:         pgsql    Enable support for PostgreSQL database.
1.1       grant    2534: 
1.75      rillig   2535:     These options are enabled by default: firefox
                   2536:     These options are currently enabled: mozilla ssl
1.1       grant    2537: </pre>
1.75      rillig   2538: <p>The following variables can be defined in
1.88      wiz      2539:     <code class="filename">/etc/mk.conf</code> to select which options to
                   2540:     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
                   2541:     which can be used to select or disable options for all packages
                   2542:     that support them, and
                   2543:     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
                   2544:     which can be used to select or disable options specifically for
                   2545:     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
                   2546:     these variables are selected, options preceded by &#8220;<span class="quote">-</span>&#8221;
                   2547:     are disabled. A few examples:</p>
1.75      rillig   2548: <pre class="screen">
                   2549: <code class="prompt">$</code> <span><strong class="command">grep "PKG.*OPTION" /etc/mk.conf</strong></span>
                   2550: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   2551: PKG_OPTIONS.kdebase=    debug -sasl
                   2552: PKG_OPTIONS.apache=     suexec </pre>
1.88      wiz      2553: <p>The following settings are consulted in the order given, and
                   2554:     the last setting that selects or disables an option is
                   2555:     used:</p>
1.75      rillig   2556: <div class="orderedlist"><ol type="1">
                   2557: <li><p>the default options as suggested by the package
1.88      wiz      2558:       maintainer</p></li>
1.75      rillig   2559: <li><p>the options implied by the settings of legacy
1.88      wiz      2560:       variables (see below)</p></li>
1.75      rillig   2561: <li><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
                   2562: <li><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
                   2563: </ol></div>
                   2564: <p>For groups of mutually exclusive options, the last option
1.88      wiz      2565:     selected is used, all others are automatically disabled.  If an
                   2566:     option of the group is explicitly disabled, the previously
                   2567:     selected option, if any, is used.  It is an error if no option
                   2568:     from a required group of options is selected, and building the
                   2569:     package will fail.</p>
                   2570: <p>Before the options framework was introduced, build options
                   2571:     were selected by setting a variable (often named
                   2572:     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
                   2573:     <code class="filename">/etc/mk.conf</code> for each option.  To ease
                   2574:     transition to the options framework for the user, these legacy
                   2575:     variables are converted to the appropriate options setting
                   2576:     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
                   2577:     automatically.  A warning is issued to prompt the user to update
                   2578:     <code class="filename">/etc/mk.conf</code> to use the options framework
                   2579:     directly.  Support for the legacy variables will be removed
                   2580:     eventually.</p>
1.75      rillig   2581: </div>
                   2582: </div>
                   2583: <div class="chapter" lang="en">
                   2584: <div class="titlepage"><div><div><h2 class="title">
                   2585: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
                   2586: <div class="toc">
                   2587: <p><b>Table of Contents</b></p>
                   2588: <dl>
                   2589: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                   2590: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
                   2591: <dt><span class="sect1"><a href="#bulkbuild">6.3. Doing a bulk build of all packages</a></span></dt>
                   2592: <dd><dl>
                   2593: <dt><span class="sect2"><a href="#binary.configuration">6.3.1. Configuration</a></span></dt>
                   2594: <dt><span class="sect2"><a href="#other-environmental-considerations">6.3.2. Other environmental considerations</a></span></dt>
                   2595: <dt><span class="sect2"><a href="#operation">6.3.3. Operation</a></span></dt>
                   2596: <dt><span class="sect2"><a href="#what-it-does">6.3.4. What it does</a></span></dt>
                   2597: <dt><span class="sect2"><a href="#disk-space-requirements">6.3.5. Disk space requirements</a></span></dt>
                   2598: <dt><span class="sect2"><a href="#setting-up-a-sandbox">6.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                   2599: <dt><span class="sect2"><a href="#building-a-partial-set">6.3.7. Building a partial set of packages</a></span></dt>
                   2600: <dt><span class="sect2"><a href="#bulk-upload">6.3.8. Uploading results of a bulk build</a></span></dt>
                   2601: </dl></dd>
                   2602: <dt><span class="sect1"><a href="#creating-cdroms">6.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                   2603: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">6.4.1. Example of cdpack</a></span></dt></dl></dd>
                   2604: </dl>
                   2605: </div>
                   2606: <div class="sect1" lang="en">
                   2607: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2608: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87      wiz      2609: <p>Once you have built and installed a package, you can create
                   2610:     a <span class="emphasis"><em>binary package</em></span> which can be installed on
                   2611:     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
                   2612:     the same package on a group of hosts and wasting CPU time. It also
                   2613:     provides a simple means for others to install your package, should
                   2614:     you distribute it.</p>
                   2615: <p>To create a binary package, change into the appropriate
                   2616:     directory in pkgsrc, and run <span><strong class="command">make
                   2617:     package</strong></span>:</p>
                   2618: <pre class="screen">
                   2619: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2620: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   2621:     </pre>
                   2622: <p>This will build and install your package (if not already done),
                   2623:     and then build a binary package from what was installed. You can
                   2624:     then use the <span><strong class="command">pkg_*</strong></span> tools to manipulate
                   2625:     it. Binary packages are created by default in
                   2626:     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
                   2627:     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   2628:     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   2629: <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      2630:     such a binary package.</p>
1.75      rillig   2631: </div>
                   2632: <div class="sect1" lang="en">
                   2633: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2634: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.90      rillig   2635: <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   2636: </div>
                   2637: <div class="sect1" lang="en">
                   2638: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2639: <a name="bulkbuild"></a>6.3. Doing a bulk build of all packages</h2></div></div></div>
                   2640: <p>If you want to get a full set of precompiled binary
1.87      wiz      2641:     packages, this section describes how to get them. Beware that
                   2642:     the bulk build will remove all currently installed packages from
                   2643:     your system!</p>
1.75      rillig   2644: <p>Having an FTP server configured either on the
1.87      wiz      2645:     machine doing the bulk builds or on a nearby NFS server can help
                   2646:     to make the packages available to other machines that can then
                   2647:     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
                   2648:     more information. If you use a remote NFS server's storage, be
                   2649:     sure to not actually compile on NFS storage, as this slows
                   2650:     things down a lot.</p>
1.75      rillig   2651: <div class="sect2" lang="en">
                   2652: <div class="titlepage"><div><div><h3 class="title">
                   2653: <a name="binary.configuration"></a>6.3.1. Configuration</h3></div></div></div>
                   2654: <div class="sect3" lang="en">
                   2655: <div class="titlepage"><div><div><h4 class="title">
1.93      rillig   2656: <a name="binary.bulk.build.conf"></a>6.3.1.1. <code class="filename">build.conf</code>
                   2657: </h4></div></div></div>
1.76      rillig   2658: <p>The <code class="filename">build.conf</code> file is the main
1.87      wiz      2659:        configuration file for bulk builds. You can configure how your
                   2660:        copy of pkgsrc is kept up to date, how the distfiles are
                   2661:        downloaded, how the packages are built and how the report is
                   2662:        generated. You can find an annotated example file in
                   2663:        <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
                   2664:        it, copy <code class="filename">build.conf-example</code> to
                   2665:        <code class="filename">build.conf</code> and edit it, following the
                   2666:        comments in that file.</p>
1.75      rillig   2667: </div>
                   2668: <div class="sect3" lang="en">
                   2669: <div class="titlepage"><div><div><h4 class="title">
                   2670: <a name="binary.mk.conf"></a>6.3.1.2. /etc/mk.conf</h4></div></div></div>
                   2671: <p>You may want to set variables in
1.87      wiz      2672:        <code class="filename">/etc/mk.conf</code>.
                   2673:        Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
                   2674:        details of the default settings. You will want to ensure that
                   2675:        <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
                   2676:        As used in this example, <code class="varname">_ACCEPTABLE=yes</code>
                   2677:        accepts <span class="emphasis"><em>all</em></span> licenses.</p>
                   2678: <pre class="programlisting">
1.100   ! rillig   2679: PACKAGES?=      ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
        !          2680: WRKOBJDIR?=     /usr/tmp/pkgsrc   # build here instead of in pkgsrc
        !          2681: BSDSRCDIR=      /usr/src
        !          2682: BSDXSRCDIR=     /usr/xsrc         # for x11/xservers
        !          2683: OBJHOSTNAME?=   yes               # use work.`hostname`
        !          2684: FAILOVER_FETCH= yes               # insist on the correct checksum
        !          2685: PKG_DEVELOPER?= yes
        !          2686: _ACCEPTABLE=    yes
        !          2687: </pre>
1.75      rillig   2688: <p>Some options that are especially useful for bulk builds
                   2689:        can be found at the top lines of the file
1.76      rillig   2690:        <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
1.75      rillig   2691:        options of these are briefly described here.</p>
                   2692: <div class="itemizedlist"><ul type="disc">
                   2693: <li><p>If you are on a slow machine, you may want to
1.87      wiz      2694:          set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
                   2695:          &#8220;<span class="quote">no</span>&#8221;.</p></li>
1.75      rillig   2696: <li><p>If you are doing bulk builds from a read-only
1.87      wiz      2697:          copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
                   2698:          to the directory where all log files are created. Otherwise the
                   2699:          log files are created in the pkgsrc directory.</p></li>
1.75      rillig   2700: <li><p>Another important variable is
1.87      wiz      2701:          <code class="varname">BULK_PREREQ</code>, which is a list of packages that
                   2702:          should be always available while building other
                   2703:          packages.</p></li>
1.75      rillig   2704: </ul></div>
                   2705: <p>Some other options are scattered in the pkgsrc
                   2706:        infrastructure:</p>
                   2707: <div class="itemizedlist"><ul type="disc">
                   2708: <li><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
1.87      wiz      2709:          should be set to <code class="literal">yes</code>. The purpose of the bulk
                   2710:          builds is creating binary packages, no matter if they are
                   2711:          vulnerable or not. When uploading the packages to a public
                   2712:          server, the vulnerable packages will be put into a directory of
                   2713:          their own. Leaving this variable unset would prevent the bulk
                   2714:          build system from even trying to build them, so possible
                   2715:          building errors would not show up.</p></li>
1.75      rillig   2716: <li><p><code class="varname">CHECK_FILES</code>
1.93      rillig   2717:          (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
1.87      wiz      2718:          &#8220;<span class="quote">yes</span>&#8221; to check that the installed set of files
                   2719:          matches the <code class="filename">PLIST</code>.</p></li>
1.75      rillig   2720: <li><p><code class="varname">CHECK_INTERPRETER</code>
1.93      rillig   2721:          (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
1.87      wiz      2722:          &#8220;<span class="quote">yes</span>&#8221; to check that the installed
                   2723:          &#8220;<span class="quote">#!</span>&#8221;-scripts will find their
                   2724:          interpreter.</p></li>
1.91      rillig   2725: <li><p><code class="varname">PKGSRC_RUN_TEST</code> can be
                   2726:          set to &#8220;<span class="quote"><code class="literal">yes</code></span>&#8221; to run each
                   2727:          package's self-test before installing it. Note that some
                   2728:          packages make heavy use of &#8220;<span class="quote">good</span>&#8221; random
                   2729:          numbers, so you need to assure that the machine on which you
                   2730:          are doing the bulk builds is not completely idle. Otherwise
                   2731:          some test programs will seem to hang, while they are just
                   2732:          waiting for new random data to be
                   2733:          available.</p></li>
1.75      rillig   2734: </ul></div>
                   2735: </div>
                   2736: <div class="sect3" lang="en">
                   2737: <div class="titlepage"><div><div><h4 class="title">
1.93      rillig   2738: <a name="pre-build.local"></a>6.3.1.3. <code class="filename">pre-build.local</code>
                   2739: </h4></div></div></div>
1.75      rillig   2740: <p>It is possible to configure the bulk build to perform
1.87      wiz      2741:        certain site-specific tasks at the end of the pre-build
                   2742:        stage.  If the file
                   2743:        <code class="filename">pre-build.local</code> exists in
                   2744:        <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
                   2745:        (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
                   2746:        stage.  An example use of
                   2747:        <code class="filename">pre-build.local</code> is to have the line:</p>
1.75      rillig   2748: <pre class="screen">echo "I do not have enough disk space to build this pig." \
1.87      wiz      2749:        &gt; misc/openoffice/$BROKENF</pre>
1.75      rillig   2750: <p>to prevent the system from trying to build a particular package
1.87      wiz      2751:        which requires nearly 3 GB of disk space.</p>
1.75      rillig   2752: </div>
                   2753: </div>
                   2754: <div class="sect2" lang="en">
                   2755: <div class="titlepage"><div><div><h3 class="title">
                   2756: <a name="other-environmental-considerations"></a>6.3.2. Other environmental considerations</h3></div></div></div>
1.76      rillig   2757: <p>As <code class="filename">/usr/pkg</code> will be completely
1.87      wiz      2758:       deleted at the start of bulk builds, make sure your login
                   2759:       shell is placed somewhere else. Either drop it into
                   2760:       <code class="filename">/usr/local/bin</code> (and adjust your login
                   2761:       shell in the passwd file), or (re-)install it via
                   2762:       <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
                   2763:       you can login after a reboot (remember that your current
                   2764:       process won't die if the package is removed, you just can't
                   2765:       start any new instances of the shell any more).  Also, if you
                   2766:       use NetBSD earlier than 1.5, or you still want to use the pkgsrc
                   2767:       version of ssh for some reason, be sure to install ssh before
                   2768:       starting it from <code class="filename">rc.local</code>:</p>
                   2769: <pre class="programlisting">
1.100   ! rillig   2770: (cd /usr/pkgsrc/security/ssh &amp;&amp; make bulk-install)
        !          2771: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
        !          2772:   /usr/pkg/etc/rc.d/sshd
        !          2773: fi
        !          2774: </pre>
1.75      rillig   2775: <p>Not doing so will result in you being not able to log in
1.87      wiz      2776:       via ssh after the bulk build is finished or if the machine
                   2777:       gets rebooted or crashes. You have been warned! :)</p>
1.75      rillig   2778: </div>
                   2779: <div class="sect2" lang="en">
                   2780: <div class="titlepage"><div><div><h3 class="title">
                   2781: <a name="operation"></a>6.3.3. Operation</h3></div></div></div>
                   2782: <p>Make sure you don't need any of the packages still
1.87      wiz      2783:       installed.</p>
1.75      rillig   2784: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2785: <h3 class="title">Warning</h3>
1.99      rillig   2786: <p>During the bulk build, <span class="emphasis"><em>all packages, their
                   2787:        configuration files and some more files from
                   2788:        <code class="filename">/var</code>, <code class="filename">/home</code> and
                   2789:        possibly other locations will be removed! So don't run a bulk
                   2790:        build with privileges that might harm your
                   2791:        system.</em></span></p>
1.75      rillig   2792: </div>
                   2793: <p>Be sure to remove all other things that might
1.87      wiz      2794:       interfere with builds, like some libs installed in
                   2795:       <code class="filename">/usr/local</code>, etc. then become root and type:</p>
                   2796: <pre class="screen">
                   2797: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   2798: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
                   2799:       </pre>
1.75      rillig   2800: <p>If for some reason your last build didn't complete (power
1.87      wiz      2801:       failure, system panic, ...), you can continue it by
                   2802:       running:</p>
1.75      rillig   2803: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
1.87      wiz      2804: <p>At the end of the bulk build, you will get a summary via mail,
                   2805:       and find build logs in the directory specified by
                   2806:       <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
                   2807:       file.</p>
1.75      rillig   2808: </div>
                   2809: <div class="sect2" lang="en">
                   2810: <div class="titlepage"><div><div><h3 class="title">
                   2811: <a name="what-it-does"></a>6.3.4. What it does</h3></div></div></div>
                   2812: <p>The bulk builds consist of three steps:</p>
                   2813: <div class="variablelist"><dl>
                   2814: <dt><span class="term">1. pre-build</span></dt>
1.87      wiz      2815: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
                   2816:            cleans out any broken distfiles, and removes all
                   2817:            packages installed.</p></dd>
1.75      rillig   2818: <dt><span class="term">2. the bulk build</span></dt>
1.87      wiz      2819: <dd><p>This is basically &#8220;<span class="quote">make bulk-package</span>&#8221; with
                   2820:            an optimised order in which packages will be
                   2821:            built. Packages that don't require other packages will
                   2822:            be built first, and packages with many dependencies will
                   2823:            be built later.</p></dd>
1.75      rillig   2824: <dt><span class="term">3. post-build</span></dt>
1.87      wiz      2825: <dd><p>Generates a report that's placed in the directory
                   2826:            specified in the <code class="filename">build.conf</code> file
                   2827:            named <code class="filename">broken.html</code>, a short version
                   2828:            of that report will also be mailed to the build's
                   2829:            admin.</p></dd>
1.75      rillig   2830: </dl></div>
1.87      wiz      2831: <p>During the build, a list of broken packages will be compiled
                   2832:       in <code class="filename">/usr/pkgsrc/.broken</code> (or
                   2833:       <code class="filename">.../.broken.${MACHINE}</code> if
                   2834:       <code class="varname">OBJMACHINE</code> is set), individual build logs
                   2835:       of broken builds can be found in the package's
                   2836:       directory. These files are used by the bulk-targets to mark
                   2837:       broken builds to not waste time trying to rebuild them, and
                   2838:       they can be used to debug these broken package builds
                   2839:       later.</p>
1.75      rillig   2840: </div>
                   2841: <div class="sect2" lang="en">
                   2842: <div class="titlepage"><div><div><h3 class="title">
                   2843: <a name="disk-space-requirements"></a>6.3.5. Disk space requirements</h3></div></div></div>
                   2844: <p>Currently, roughly the following requirements are valid for
1.87      wiz      2845:       NetBSD 2.0/i386:</p>
1.75      rillig   2846: <div class="itemizedlist"><ul type="disc">
1.87      wiz      2847: <li><p>10 GB - distfiles (NFS ok)</p></li>
                   2848: <li><p>8 GB - full set of all binaries (NFS ok)</p></li>
                   2849: <li><p>5 GB - temp space for compiling (local disk recommended)</p></li>
                   2850: </ul></div>
                   2851: <p>Note that all pkgs will be de-installed as soon as they are
                   2852:       turned into a binary package, and that sources are removed,
                   2853:       so there is no excessively huge demand to disk
                   2854:       space. Afterwards, if the package is needed again, it will
                   2855:       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
                   2856:       there are no cycles wasted by recompiling.</p>
1.75      rillig   2857: </div>
                   2858: <div class="sect2" lang="en">
                   2859: <div class="titlepage"><div><div><h3 class="title">
                   2860: <a name="setting-up-a-sandbox"></a>6.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.87      wiz      2861: <p>If you don't want all the packages nuked from a machine
                   2862:       (rendering it useless for anything but pkg compiling), there
                   2863:       is the possibility of doing the package bulk build inside a
                   2864:       chroot environment.</p>
                   2865: <p>The first step is to set up a chroot sandbox,
                   2866:       e.g. <code class="filename">/usr/sandbox</code>.  This can be done by
                   2867:       using null mounts, or manually.</p>
                   2868: <p>There is a shell script called
                   2869:       <code class="filename">pkgsrc/mk/bulk/mksandbox</code> which will set
                   2870:       up the sandbox environment using null mounts. It will also
                   2871:       create a script called <code class="filename">sandbox</code> in the
                   2872:       root of the sandbox environment, which will allow the null
                   2873:       mounts to be activated using the <span><strong class="command">sandbox
                   2874:       mount</strong></span> command and deactivated using the
                   2875:       <span><strong class="command">sandbox umount</strong></span> command.</p>
                   2876: <p>To set up a sandbox environment by hand, after extracting all
                   2877:       the sets from a NetBSD installation or doing a <span><strong class="command">make
                   2878:       distribution DESTDIR=/usr/sandbox</strong></span> in
                   2879:       <code class="filename">/usr/src/etc</code>, be sure the following items
                   2880:       are present and properly configured:</p>
1.75      rillig   2881: <div class="procedure"><ol type="1">
                   2882: <li>
                   2883: <p>Kernel</p>
                   2884: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
                   2885: </li>
                   2886: <li>
1.76      rillig   2887: <p><code class="filename">/dev/*</code></p>
1.75      rillig   2888: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
                   2889: </li>
                   2890: <li>
1.91      rillig   2891: <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   2892: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
                   2893: </li>
                   2894: <li>
                   2895: <p>Working(!) mail config (hostname, sendmail.cf):</p>
                   2896: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
                   2897: </li>
                   2898: <li>
1.91      rillig   2899: <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   2900: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
                   2901: </li>
                   2902: <li>
1.76      rillig   2903: <p><code class="filename">/usr/src</code> (system sources,
1.91      rillig   2904:          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   2905: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
1.87      wiz      2906:          <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
1.75      rillig   2907: </li>
                   2908: <li>
1.76      rillig   2909: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
1.75      rillig   2910: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
                   2911: </li>
                   2912: <li>
1.76      rillig   2913: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
1.75      rillig   2914: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
                   2915: </li>
                   2916: <li>
                   2917: <p>Checkout pkgsrc via cvs into
1.87      wiz      2918:          <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
                   2919: <pre class="screen">
                   2920: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
                   2921: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
                   2922:          </pre>
1.75      rillig   2923: <p>Do not mount/link this to the copy of your pkgsrc tree
1.87      wiz      2924:          you do development in, as this will likely cause problems!</p>
1.75      rillig   2925: </li>
                   2926: <li><p>Make
1.87      wiz      2927:          <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
                   2928:          <code class="filename">.../distfiles</code> point somewhere
                   2929:          appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.76      rillig   2930: <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>
                   2931: <li><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
1.75      rillig   2932: </ol></div>
                   2933: <p>When the chroot sandbox is set up, you can start
1.87      wiz      2934:       the build with the following steps:</p>
                   2935: <pre class="screen">
                   2936: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
                   2937: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
                   2938:       </pre>
                   2939: <p>This will just jump inside the sandbox and start building.  At
                   2940:        the end of the build, mail will be sent with the results of
                   2941:        the build. Created binary pkgs will be in
                   2942:        <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
                   2943:       (wherever that points/mounts to/from).</p>
1.75      rillig   2944: </div>
                   2945: <div class="sect2" lang="en">
                   2946: <div class="titlepage"><div><div><h3 class="title">
                   2947: <a name="building-a-partial-set"></a>6.3.7. Building a partial set of packages</h3></div></div></div>
1.87      wiz      2948: <p>In addition to building a complete set of all packages in
                   2949:       pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
                   2950:       may be used to build a subset of the packages contained in
                   2951:       pkgsrc.  By setting <code class="varname">SPECIFIC_PKGS</code>
                   2952:       in <code class="filename">/etc/mk.conf</code>, the variables</p>
1.75      rillig   2953: <div class="itemizedlist"><ul type="disc">
                   2954: <li><p>SITE_SPECIFIC_PKGS</p></li>
                   2955: <li><p>HOST_SPECIFIC_PKGS</p></li>
                   2956: <li><p>GROUP_SPECIFIC_PKGS</p></li>
                   2957: <li><p>USER_SPECIFIC_PKGS</p></li>
                   2958: </ul></div>
1.87      wiz      2959: <p>will define the set of packages which should be built.
                   2960:       The bulk build code will also include any packages which are
                   2961:       needed as dependencies for the explicitly listed packages.</p>
                   2962: <p>One use of this is to do a bulk build with
                   2963:       <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
                   2964:       periodically to have a complete set of the binary packages
                   2965:       needed for your site available without the overhead of
                   2966:       building extra packages that are not needed.</p>
1.75      rillig   2967: </div>
                   2968: <div class="sect2" lang="en">
                   2969: <div class="titlepage"><div><div><h3 class="title">
                   2970: <a name="bulk-upload"></a>6.3.8. Uploading results of a bulk build</h3></div></div></div>
1.87      wiz      2971: <p>This section describes how pkgsrc developers can upload binary
                   2972:       pkgs built by bulk builds to ftp.NetBSD.org.</p>
                   2973: <p>If you would like to automatically create checksum files for the
                   2974:       binary packages you intend to upload, remember to set
                   2975:       <code class="varname">MKSUMS=yes</code> in your
                   2976:       <code class="filename">mk/bulk/build.conf</code>.</p>
                   2977: <p>If you would like to PGP sign the checksum files (highly
                   2978:       recommended!), remember to set
                   2979:       <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
                   2980:       <code class="filename">mk/bulk/build.conf</code>.  This will prompt you for
                   2981:       your GPG password to sign the files before uploading everything.</p>
                   2982: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
                   2983:       set properly in your <code class="filename">mk/bulk/build.conf</code>
                   2984:       file, i.e. adjust it to something like one of the following:</p>
1.93      rillig   2985: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload </pre>
                   2986: <p>Please use appropriate values for "packages-200xQy",
1.87      wiz      2987:       "NetBSD-a.b.c" and "arch" here. If your login on ftp.NetBSD.org
                   2988:       is different from your local login, write your login directly
                   2989:       into the variable, e.g. my local account is "feyrer", but for my
                   2990:       login "hubertf", I use:</p>
1.93      rillig   2991: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload</pre>
1.87      wiz      2992: <p>A separate <code class="filename">upload</code> directory is used
                   2993:       here to allow "closing" the directory during upload. To do
                   2994:       so, run the following command on ftp.NetBSD.org next:</p>
1.93      rillig   2995: <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      2996: <p>Please note that <code class="filename">/pub/NetBSD/packages</code> is
                   2997:       only appropriate for packages for the NetBSD operating
                   2998:       system. Binary packages for other operating systems should go
                   2999:       into <code class="filename">/pub/pkgsrc</code>.</p>
                   3000: <p>Before uploading the binary pkgs, ssh authentication needs
                   3001:       to be set up. This example shows how to set up temporary keys
                   3002:       for the root account <span class="emphasis"><em>inside the sandbox</em></span>
                   3003:       (assuming that no keys should be present there usually):</p>
                   3004: <pre class="screen">
                   3005: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
1.75      rillig   3006: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
                   3007: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t dsa</code></strong>
1.87      wiz      3008: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-dsa.pub</code></strong>
                   3009:       </pre>
                   3010: <p>Now take the output of <code class="filename">id-dsa.pub</code> and
                   3011:       append it to your <code class="filename">~/.ssh/authorized_keys</code>
                   3012:       file on ftp.NetBSD.org. You can remove the key after the
                   3013:       upload is done!</p>
                   3014: <p>Next, test if your ssh connection really works:</p>
1.75      rillig   3015: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
1.87      wiz      3016: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
                   3017: <p>Now after all this works, you can exit the sandbox and start
                   3018:       the upload:</p>
                   3019: <pre class="screen">
                   3020: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
1.75      rillig   3021: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
1.87      wiz      3022: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
                   3023:       </pre>
                   3024: <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
                   3025:       <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
                   3026:       upload. The upload script will take care of not uploading
                   3027:       restricted packages and putting vulnerable packages into the
                   3028:       <code class="filename">vulnerable</code> subdirectory.</p>
                   3029: <p>After the upload has ended, first thing is to revoke ssh access:</p>
1.75      rillig   3030: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
1.87      wiz      3031:       Gdd:x! </pre>
                   3032: <p>Use whatever is needed to remove the key you've entered
                   3033:       before! Last, move the uploaded packages out of the
                   3034:       <code class="filename">upload</code> directory to have them accessible
                   3035:       to everyone:</p>
                   3036: <pre class="screen">
1.93      rillig   3037: nbftp% <strong class="userinput"><code>cd /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch</code></strong>
1.75      rillig   3038: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
                   3039: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
1.87      wiz      3040: nbftp% <strong class="userinput"><code>chmod 755 .</code></strong>
                   3041:       </pre>
1.75      rillig   3042: </div>
                   3043: </div>
                   3044: <div class="sect1" lang="en">
                   3045: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3046: <a name="creating-cdroms"></a>6.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87      wiz      3047: <p>After your pkgsrc bulk-build has completed, you may wish to
                   3048:     create a CD-ROM set of the resulting binary packages to assist
                   3049:     in installing packages on other machines.  The
1.91      rillig   3050:     <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      3051:     a simple tool for creating the ISO 9660 images.
                   3052:     <span><strong class="command">cdpack</strong></span> arranges the packages on the CD-ROMs in a
                   3053:     way that keeps all the dependencies for a given package on the same
                   3054:     CD as that package.</p>
1.75      rillig   3055: <div class="sect2" lang="en">
                   3056: <div class="titlepage"><div><div><h3 class="title">
                   3057: <a name="cdpack-example"></a>6.4.1. Example of cdpack</h3></div></div></div>
1.87      wiz      3058: <p>Complete documentation for cdpack is found in the cdpack(1)
                   3059:       man page. The following short example assumes that the binary
                   3060:       packages are left in
                   3061:       <code class="filename">/usr/pkgsrc/packages/All</code> and that
                   3062:       sufficient disk space exists in <code class="filename">/u2</code> to
                   3063:       hold the ISO 9660 images.</p>
                   3064: <pre class="screen">
                   3065: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75      rillig   3066: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87      wiz      3067: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
                   3068:       </pre>
                   3069: <p>If you wish to include a common set of files
                   3070:       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
                   3071:       etc.) on each CD in the collection, then you need to create a
                   3072:       directory which contains these files. e.g.</p>
                   3073: <pre class="screen">
                   3074: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75      rillig   3075: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
                   3076: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
                   3077: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
                   3078: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
                   3079: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
1.87      wiz      3080: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
                   3081:       </pre>
1.75      rillig   3082: <p>Now create the images:</p>
                   3083: <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   3084: <p>Each image will contain <code class="filename">README</code>,
1.87      wiz      3085:       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
                   3086:       in their root directories.</p>
1.75      rillig   3087: </div>
                   3088: </div>
                   3089: </div>
                   3090: <div class="chapter" lang="en">
                   3091: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   3092: <a name="files"></a>Chapter 7. Directory layout of the installed files</h2></div></div></div>
                   3093: <div class="toc">
                   3094: <p><b>Table of Contents</b></p>
                   3095: <dl>
1.91      rillig   3096: <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   3097: <dt><span class="sect1"><a href="#files.varbase">7.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
                   3098: </dl>
                   3099: </div>
                   3100: <p>The files that are installed by pkgsrc are organized in a way that
                   3101: is similar to what you find in the <code class="filename">/usr</code> directory
                   3102: of the base system. But some details are different. This is because
                   3103: pkgsrc initially came from FreeBSD and had adopted its file system
                   3104: hierarchy. Later it was largely influenced by NetBSD. But no matter
                   3105: which operating system you are using pkgsrc with, you can expect the
                   3106: same layout for pkgsrc.</p>
1.91      rillig   3107: <p>There are mainly four root directories for pkgsrc, which are all
                   3108: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
                   3109: When pkgsrc has been installed as root, the default locations
                   3110: are:</p>
                   3111: <pre class="programlisting">
1.100   ! rillig   3112: LOCALBASE=              /usr/pkg
        !          3113: PKG_SYSCONFBASE=        /usr/pkg/etc
        !          3114: VARBASE=                /var
        !          3115: PKG_DBDIR=              /var/db/pkg
1.91      rillig   3116: </pre>
                   3117: <p>In unprivileged mode (when pkgsrc has been installed as any other
                   3118: user), the default locations are:</p>
                   3119: <pre class="programlisting">
1.100   ! rillig   3120: LOCALBASE=              ${HOME}/pkg
        !          3121: PKG_SYSCONFBASE=        ${HOME}/pkg/etc
        !          3122: VARBASE=                ${HOME}/pkg/var
        !          3123: PKG_DBDIR=              ${HOME}/pkg/var/db/pkg
1.91      rillig   3124: </pre>
                   3125: <p>What these four directories are for, and what they look like is
                   3126: explained below.</p>
1.90      rillig   3127: <div class="itemizedlist"><ul type="disc">
                   3128: <li><p><code class="varname">LOCALBASE</code> corresponds to the
                   3129: <code class="filename">/usr</code> directory in the base system. It is the
                   3130: &#8220;<span class="quote">main</span>&#8221; directory where the files are installed and contains
                   3131: the well-known subdirectories like <code class="filename">bin</code>,
                   3132: <code class="filename">include</code>, <code class="filename">lib</code>,
                   3133: <code class="filename">share</code> and
                   3134: <code class="filename">sbin</code>.</p></li>
                   3135: <li><p><code class="varname">VARBASE</code> corresponds to
                   3136: <code class="filename">/var</code> in the base system. Some programs (especially
                   3137: games, network daemons) need write access to it during normal
                   3138: operation.</p></li>
                   3139: <li><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
                   3140: <code class="filename">/etc</code> in the base system. It contains configuration
                   3141: files of the packages, as well as pkgsrc's <code class="filename">mk.conf</code>
                   3142: itself.</p></li>
                   3143: </ul></div>
                   3144: <div class="sect1" lang="en">
                   3145: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   3146: <a name="files.localbase"></a>7.1. File system layout in <code class="literal">${LOCALBASE}</code>
                   3147: </h2></div></div></div>
1.90      rillig   3148: <p>The following directories exist in a typical pkgsrc installation
1.91      rillig   3149: in <code class="filename">${LOCALBASE}</code>.</p>
1.90      rillig   3150: <div class="variablelist"><dl>
                   3151: <dt><span class="term"><code class="filename">bin</code></span></dt>
                   3152: <dd><p>Contains executable programs that are intended to be
                   3153: directly used by the end user.</p></dd>
                   3154: <dt><span class="term"><code class="filename">emul</code></span></dt>
                   3155: <dd><p>Contains files for the emulation layers of various other
                   3156: operating systems, especially for
                   3157: NetBSD.</p></dd>
                   3158: <dt><span class="term"><code class="filename">etc</code> (the usual location of
                   3159: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
                   3160: <dd><p>Contains
                   3161: the configuration files.</p></dd>
                   3162: <dt><span class="term"><code class="filename">include</code></span></dt>
                   3163: <dd><p>Contains headers for the C and C++ programming
                   3164: languages.</p></dd>
                   3165: <dt><span class="term"><code class="filename">info</code></span></dt>
                   3166: <dd><p>Contains GNU info files of various
                   3167: packages.</p></dd>
                   3168: <dt><span class="term"><code class="filename">lib</code></span></dt>
                   3169: <dd><p>Contains shared and static
                   3170: libraries.</p></dd>
                   3171: <dt><span class="term"><code class="filename">libdata</code></span></dt>
                   3172: <dd><p>Contains data files that don't change after
                   3173: installation. Other data files belong into
                   3174: <code class="filename">${VARBASE}</code>.</p></dd>
                   3175: <dt><span class="term"><code class="filename">libexec</code></span></dt>
                   3176: <dd><p>Contains programs that are not intended to be used by
                   3177: end users, such as helper programs or network
                   3178: daemons.</p></dd>
                   3179: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
                   3180: <dd><p>Contains programs that are intended to be executed as
                   3181: CGI scripts by a web server.</p></dd>
                   3182: <dt><span class="term"><code class="filename">man</code> (the usual value of
                   3183: <code class="filename">${PKGMANDIR}</code>)</span></dt>
                   3184: <dd><p>Contains brief
                   3185: documentation in form of manual pages.</p></dd>
                   3186: <dt><span class="term"><code class="filename">sbin</code></span></dt>
                   3187: <dd><p>Contains programs that are intended to be used only by
                   3188: the super-user.</p></dd>
                   3189: <dt><span class="term"><code class="filename">share</code></span></dt>
                   3190: <dd><p>Contains platform-independent data files that don't
                   3191: change after installation.</p></dd>
                   3192: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
                   3193: <dd><p>Contains documentation files provided by the
                   3194: packages.</p></dd>
                   3195: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
                   3196: <dd><p>Contains example files provided by the packages. Among
                   3197: others, the original configuration files are saved here and copied to
                   3198: <code class="filename">${PKG_SYSCONFDIR}</code> during
                   3199: installation.</p></dd>
                   3200: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
                   3201: <dd><p>Contains the original files for rc.d
                   3202: scripts.</p></dd>
                   3203: <dt><span class="term"><code class="filename">var</code> (the usual location of
                   3204: <code class="filename">${VARBASE}</code>)</span></dt>
                   3205: <dd><p>Contains files
                   3206: that may be modified after
                   3207: installation.</p></dd>
                   3208: </dl></div>
                   3209: </div>
                   3210: <div class="sect1" lang="en">
                   3211: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   3212: <a name="files.varbase"></a>7.2. File system layout in <code class="literal">${VARBASE}</code>
                   3213: </h2></div></div></div>
1.90      rillig   3214: <div class="variablelist"><dl>
                   3215: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
                   3216: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
                   3217: <dd><p>Contains
                   3218: information about the currently installed
                   3219: packages.</p></dd>
                   3220: <dt><span class="term"><code class="filename">games</code></span></dt>
                   3221: <dd><p>Contains highscore
                   3222: files.</p></dd>
                   3223: <dt><span class="term"><code class="filename">log</code></span></dt>
                   3224: <dd><p>Contains log files.</p></dd>
                   3225: <dt><span class="term"><code class="filename">run</code></span></dt>
                   3226: <dd><p>Contains informational files about daemons that are
                   3227: currently running.</p></dd>
                   3228: </dl></div>
                   3229: </div>
                   3230: </div>
                   3231: <div class="chapter" lang="en">
                   3232: <div class="titlepage"><div><div><h2 class="title">
                   3233: <a name="faq"></a>Chapter 8. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   3234: <div class="toc">
                   3235: <p><b>Table of Contents</b></p>
                   3236: <dl>
1.90      rillig   3237: <dt><span class="sect1"><a href="#mailing-list-pointers">8.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                   3238: <dt><span class="sect1"><a href="#pkgviews-docs">8.2. Where's the pkgviews documentation?</a></span></dt>
                   3239: <dt><span class="sect1"><a href="#faq-pkgtools">8.3. Utilities for package management (pkgtools)</a></span></dt>
                   3240: <dt><span class="sect1"><a href="#non-root-pkgsrc">8.4. How to use pkgsrc as non-root</a></span></dt>
                   3241: <dt><span class="sect1"><a href="#resume-transfers">8.5. How to resume transfers when fetching distfiles?</a></span></dt>
                   3242: <dt><span class="sect1"><a href="#XFree86-from-pkgsrc">8.6. How can I install/use XFree86 from pkgsrc?</a></span></dt>
                   3243: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">8.7. How can I install/use X.org from pkgsrc?</a></span></dt>
                   3244: <dt><span class="sect1"><a href="#fetch-behind-firewall">8.8. How to fetch files from behind a firewall</a></span></dt>
                   3245: <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>
                   3246: <dt><span class="sect1"><a href="#fetching-all-distfiles">8.10. How to fetch all distfiles at once</a></span></dt>
                   3247: <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   3248: /usr/share/tmac/tmac.andoc</span>&#8221; mean?</a></span></dt>
1.90      rillig   3249: <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>
                   3250: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">8.13. Using 'sudo' with pkgsrc</a></span></dt>
                   3251: <dt><span class="sect1"><a href="#faq.conf">8.14. How do I change the location of configuration files?</a></span></dt>
                   3252: <dt><span class="sect1"><a href="#audit-packages">8.15. Automated security checks</a></span></dt>
                   3253: <dt><span class="sect1"><a href="#ufaq-cflags">8.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                   3254: <dt><span class="sect1"><a href="#ufaq-fail">8.17. A package does not build.  What shall I do?</a></span></dt>
                   3255: <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   3256: </dl>
                   3257: </div>
                   3258: <p>This section contains hints, tips &amp; tricks on special things in
                   3259: pkgsrc that we didn't find a better place for in the previous chapters, and
                   3260: it contains items for both pkgsrc users and developers.</p>
                   3261: <div class="sect1" lang="en">
                   3262: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3263: <a name="mailing-list-pointers"></a>8.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75      rillig   3264: <p>The following mailing lists may be of interest to pkgsrc users:</p>
                   3265: <div class="itemizedlist"><ul type="disc">
1.78      rillig   3266: <li><p><a href="http://www.NetBSD.org/MailingLists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
                   3267:          This is a general purpose list for most issues regarding
                   3268:          pkgsrc, regardless of platform, e.g. soliciting user help
                   3269:          for pkgsrc configuration, unexpected build failures, using
                   3270:          particular packages, upgrading pkgsrc installations,
                   3271:          questions regarding the pkgsrc release branches, etc.  General announcements or
                   3272:          proposals for changes that impact the pkgsrc user community,
                   3273:          e.g. major infrastructure changes, new features, package
                   3274:          removals, etc., may also be posted.</p></li>
1.75      rillig   3275: <li><p><a href="http://www.NetBSD.org/MailingLists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
                   3276:          A list where the results of pkgsrc bulk builds are sent and
                   3277:          discussed.</p></li>
                   3278: <li><p><a href="http://www.NetBSD.org/MailingLists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
                   3279:          This list is for those who are interested in getting a
                   3280:          commit message for every change committed to pkgsrc. It is
                   3281:          also available in digest form, meaning one daily message
                   3282:          containing all commit messages for changes to the package
                   3283:          source tree in that 24 hour period.</p></li>
                   3284: </ul></div>
                   3285: <p>To subscribe, do:</p>
                   3286: <pre class="programlisting">
1.100   ! rillig   3287: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75      rillig   3288: </pre>
                   3289: <p>Archives for all these mailing lists are available from
                   3290: <a href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
                   3291: </div>
                   3292: <div class="sect1" lang="en">
                   3293: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3294: <a name="pkgviews-docs"></a>8.2. Where's the pkgviews documentation?</h2></div></div></div>
1.75      rillig   3295: <p>Pkgviews is tightly integrated with buildlink.  You can find a
                   3296: pkgviews User's guide in
1.76      rillig   3297: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
1.75      rillig   3298: </div>
                   3299: <div class="sect1" lang="en">
                   3300: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3301: <a name="faq-pkgtools"></a>8.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.80      rillig   3302: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75      rillig   3303: a number of useful utilities for both users and developers of pkgsrc.  This
                   3304: section attempts only to make the reader aware of the utilities and when
                   3305: they might be useful, and not to duplicate the documentation that comes
                   3306: with each package.</p>
                   3307: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.91      rillig   3308: <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   3309:       Symlinks for use by buildlink.</p></li></ul></div>
                   3310: <p>OS tool augmentation (automatically installed when needed):</p>
                   3311: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3312: <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   3313:       Calculates various kinds of checksums (including SHA1).</p></li>
1.91      rillig   3314: <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   3315:       Compatibility library for pkgsrc tools.</p></li>
1.91      rillig   3316: <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      3317:       non-BSD systems due to lack of native mtree.</p></li>
1.91      rillig   3318: <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   3319:       Up-to-date replacement for
1.76      rillig   3320:       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75      rillig   3321:       systems where pkg_install is not present.</p></li>
                   3322: </ul></div>
                   3323: <p>Utilities used by pkgsrc (not automatically installed):</p>
                   3324: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3325: <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   3326:       Create a binary package from an
                   3327:       already-installed package.  Used by <span><strong class="command">make replace</strong></span> to
                   3328:       save the old package.</p></li>
1.91      rillig   3329: <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   3330:       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
                   3331:       from multiple locations. It currently supports the following
                   3332:       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.91      rillig   3333: <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   3334:       packages someplace else (enabled by default).</p></li>
1.91      rillig   3335: <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   3336:       best compiler flags to optimise code for your current CPU and
                   3337:       compiler.</p></li>
                   3338: </ul></div>
                   3339: <p>Utilities for keeping track of installed packages, being up to date,
                   3340: etc:</p>
                   3341: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3342: <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   3343:       packages whose installed versions do not match the latest pkgsrc
                   3344:       entries.</p></li>
1.91      rillig   3345: <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   3346:       dependency graphs of packages, to aid in choosing a strategy for
                   3347:       updating.</p></li>
1.91      rillig   3348: <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
                   3349:       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>
                   3350: <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   3351:       pkglint(1) program checks a pkgsrc entry for errors, lintpkgsrc(1)
                   3352:       does various checks on the complete pkgsrc system.</p></li>
1.91      rillig   3353: <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   3354:       packages you have installed.</p></li>
                   3355: </ul></div>
                   3356: <p>Utilities for people maintaining or creating individual packages:</p>
                   3357: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3358: <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   3359:       making and maintaining patches for a package (includes pkgdiff,
                   3360:       pkgvi, mkpatches, etc.).</p></li>
1.91      rillig   3361: <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>,
                   3362:       <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   3363:       converting to pkgsrc.</p></li>
1.91      rillig   3364: <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   3365:       pkgsrc to a Solaris package.</p></li>
                   3366: </ul></div>
                   3367: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
                   3368: utilities)</p>
                   3369: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3370: <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   3371:       packages in a chrooted area.</p></li>
1.91      rillig   3372: <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   3373:       kernel version for chrooted cross builds.</p></li>
                   3374: </ul></div>
                   3375: </div>
                   3376: <div class="sect1" lang="en">
                   3377: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3378: <a name="non-root-pkgsrc"></a>8.4. How to use pkgsrc as non-root</h2></div></div></div>
1.75      rillig   3379: <p>If you want to use pkgsrc as non-root user, you can set some
                   3380: variables to make pkgsrc work under these conditions.  At the very least,
                   3381: you need to set <code class="varname">UNPRIVILEGED</code> to &#8220;<span class="quote">yes</span>&#8221;; this
                   3382: will turn on unprivileged mode and set multiple related variables to allow
                   3383: installation of packages as non-root.</p>
                   3384: <p>In case the defaults are not enough, you may want to tune some other
                   3385: variables used.  For example, if the automatic user/group detection leads
                   3386: to incorrect values (or not the ones you would like to use), you can change
                   3387: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
                   3388: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
                   3389: <p>As regards bootstrapping, please note that the
                   3390: <span><strong class="command">bootstrap</strong></span> script will ease non-root configuration when
                   3391: given the &#8220;<span class="quote">--ignore-user-check</span>&#8221; flag, as it will choose and
1.76      rillig   3392: use multiple default directories under <code class="filename">~/pkg</code> as the
1.93      rillig   3393: installation targets.  These directories can be overridden by the
1.75      rillig   3394: &#8220;<span class="quote">--prefix</span>&#8221; flag provided by the script, as well as some others
                   3395: that allow finer tuning of the tree layout.</p>
                   3396: </div>
                   3397: <div class="sect1" lang="en">
                   3398: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3399: <a name="resume-transfers"></a>8.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75      rillig   3400: <p>By default, resuming transfers in pkgsrc is disabled, but you can
                   3401: enable this feature by adding the option
                   3402: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.76      rillig   3403: <code class="filename">/etc/mk.conf</code>.  If, during a fetch step, an incomplete
1.75      rillig   3404: distfile is found, pkgsrc will try to resume it.</p>
                   3405: <p>You can also
                   3406: 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
                   3407: <code class="varname">FETCH_CMD</code> variable.  Don't forget to set
                   3408: <code class="varname">FETCH_RESUME_ARGS</code> and
                   3409: <code class="varname">FETCH_OUTPUT_ARGS</code> if you are not using default
                   3410: values.</p>
                   3411: <p>For example, if you want to use
1.76      rillig   3412: <code class="filename">wget</code> to resume downloads, you'll have to use something
1.75      rillig   3413: like:</p>
                   3414: <pre class="programlisting">
1.100   ! rillig   3415: FETCH_CMD=             wget
        !          3416: FETCH_BEFORE_ARGS=     --passive-ftp
        !          3417: FETCH_RESUME_ARGS=     -c
        !          3418: FETCH_OUTPUT_ARGS=     -O
1.1       grant    3419: </pre>
1.75      rillig   3420: </div>
                   3421: <div class="sect1" lang="en">
                   3422: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3423: <a name="XFree86-from-pkgsrc"></a>8.6. How can I install/use XFree86 from pkgsrc?</h2></div></div></div>
1.75      rillig   3424: <p>If you want to use XFree86 from pkgsrc instead of your system's own
1.76      rillig   3425: X11 (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>,
1.75      rillig   3426: ...), you will have to add the following line into
1.76      rillig   3427: <code class="filename">/etc/mk.conf</code>:</p>
1.75      rillig   3428: <pre class="programlisting">
1.100   ! rillig   3429: X11_TYPE=XFree86
1.1       grant    3430: </pre>
1.75      rillig   3431: </div>
                   3432: <div class="sect1" lang="en">
                   3433: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3434: <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   3435: <p>If you want to use X.org from pkgsrc instead of your system's own X11
1.76      rillig   3436: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75      rillig   3437: you will have to add the following line into
1.76      rillig   3438: <code class="filename">/etc/mk.conf</code>:</p>
1.75      rillig   3439: <pre class="programlisting">
1.100   ! rillig   3440: X11_TYPE=xorg
1.1       grant    3441: </pre>
1.75      rillig   3442: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   3443: <h3 class="title">Note</h3>
                   3444: <p>The DragonFly operating system defaults to using
1.87      wiz      3445: this X.org X11 implementation from pkgsrc.</p>
1.75      rillig   3446: </div>
                   3447: </div>
                   3448: <div class="sect1" lang="en">
                   3449: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3450: <a name="fetch-behind-firewall"></a>8.8. How to fetch files from behind a firewall</h2></div></div></div>
1.75      rillig   3451: <p>If you are sitting behind a firewall which does not allow direct
                   3452: connections to Internet hosts (i.e. non-NAT), you may specify the
                   3453: relevant proxy hosts.  This is done using an environment variable in the
                   3454: form of a URL, e.g. in Amdahl, the machine
                   3455: &#8220;<span class="quote">orpheus.amdahl.com</span>&#8221; is one of the firewalls, and it uses
                   3456: port 80 as the proxy port number.  So the proxy environment variables
                   3457: are:</p>
                   3458: <pre class="programlisting">
1.100   ! rillig   3459: ftp_proxy=ftp://orpheus.amdahl.com:80/
        !          3460: http_proxy=http://orpheus.amdahl.com:80/
1.1       grant    3461: </pre>
1.75      rillig   3462: </div>
                   3463: <div class="sect1" lang="en">
                   3464: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3465: <a name="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   3466: <p>This depends on which utility is used to retrieve distfiles.  From
1.76      rillig   3467: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75      rillig   3468: the first available command from the following list:</p>
                   3469: <div class="itemizedlist"><ul type="disc">
1.76      rillig   3470: <li><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
                   3471: <li><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75      rillig   3472: </ul></div>
                   3473: <p>On a default NetBSD installation, this will be
1.76      rillig   3474: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75      rillig   3475: connections first, and falls back to active connections if the server
                   3476: refuses to do passive.  For the other tools, add the following to your
1.76      rillig   3477: <code class="filename">/etc/mk.conf</code> file:
1.75      rillig   3478: <code class="varname">PASSIVE_FETCH=1</code>.</p>
                   3479: <p>Having that option present will prevent
1.76      rillig   3480: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75      rillig   3481: transfers.</p>
                   3482: </div>
                   3483: <div class="sect1" lang="en">
                   3484: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3485: <a name="fetching-all-distfiles"></a>8.10. How to fetch all distfiles at once</h2></div></div></div>
1.88      wiz      3486: <p>You would like to download all the distfiles in a single batch
                   3487: from work or university, where you can't run a <span><strong class="command">make
                   3488: 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   3489: but downloading the entire directory may not be appropriate.</p>
                   3490: <p>The answer here is to do a <span><strong class="command">make fetch-list</strong></span> in
1.76      rillig   3491: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75      rillig   3492: resulting list to your machine at work/school and use it there.  If you
                   3493: 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
                   3494: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
                   3495: URL:</p>
                   3496: <p>At home:</p>
                   3497: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   3498: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
                   3499: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
                   3500: <p>At work:</p>
                   3501: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76      rillig   3502: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75      rillig   3503: home.</p>
                   3504: <p>If you have a machine running NetBSD, and you want to get
1.88      wiz      3505: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
                   3506: machine architecture), you can do so by using the above-mentioned
                   3507: <span><strong class="command">make fetch-list</strong></span> approach, or fetch the distfiles
                   3508: directly by running:</p>
1.75      rillig   3509: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
                   3510: <p>If you even decide to ignore
                   3511: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
                   3512: by running:</p>
                   3513: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
                   3514: </div>
                   3515: <div class="sect1" lang="en">
                   3516: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3517: <a name="tmac.andoc-missing"></a>8.11. What does &#8220;<span class="quote">Don't know how to make
1.75      rillig   3518: /usr/share/tmac/tmac.andoc</span>&#8221; mean?</h2></div></div></div>
1.91      rillig   3519: <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   3520: package, you get the error from make that it doesn't know how to make
1.76      rillig   3521: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.75      rillig   3522: you don't have installed the &#8220;<span class="quote">text</span>&#8221; set (nroff, ...) from
                   3523: the NetBSD base distribution on your machine.  It is recommended to do
                   3524: that to format man pages.</p>
1.91      rillig   3525: <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   3526: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.76      rillig   3527: environment or in <code class="filename">/etc/mk.conf</code>.</p>
1.75      rillig   3528: </div>
                   3529: <div class="sect1" lang="en">
                   3530: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3531: <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      3532: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75      rillig   3533: when you installed your NetBSD machine.  Please get and install it, by
1.76      rillig   3534: extracting it in <code class="filename">/</code>:</p>
1.75      rillig   3535: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   3536: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76      rillig   3537: <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
1.75      rillig   3538: the one that corresponds to your release (determine via <span><strong class="command">uname
                   3539: -r</strong></span>).</p>
                   3540: </div>
                   3541: <div class="sect1" lang="en">
                   3542: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3543: <a name="using-sudo-with-pkgsrc"></a>8.13. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75      rillig   3544: <p>When installing packages as non-root user and using the just-in-time
                   3545: <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
                   3546: password for each required package installed.  To avoid this, the sudo
                   3547: package can be used, which does password caching over a limited time.  To
                   3548: use it, install sudo (either as binary package or from
1.98      wiz      3549: <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
                   3550: following into your <code class="filename">/etc/mk.conf</code>, somewhere
                   3551: <span class="emphasis"><em>after</em></span> the definition of the
                   3552: <code class="varname">LOCALBASE</code> variable:</p>
1.75      rillig   3553: <pre class="programlisting">
1.100   ! rillig   3554: .if exists(${LOCALBASE}/bin/sudo)
        !          3555: SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
        !          3556: .endif
1.1       grant    3557: </pre>
1.75      rillig   3558: </div>
                   3559: <div class="sect1" lang="en">
                   3560: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3561: <a name="faq.conf"></a>8.14. How do I change the location of configuration files?</h2></div></div></div>
1.75      rillig   3562: <p>As the system administrator, you can choose where configuration files
                   3563: are installed.  The default settings make all these files go into
1.76      rillig   3564: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75      rillig   3565: be suboptimal depending on your expectations (e.g., a read-only,
                   3566: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
                   3567: configuration of the provided packages).</p>
                   3568: <p>In order to change the defaults, you can modify the
                   3569: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.76      rillig   3570: <code class="filename">/etc/mk.conf</code>) to point to your preferred configuration
                   3571: directory; some common examples include <code class="filename">/etc</code> or
                   3572: <code class="filename">/etc/pkg</code>.</p>
1.75      rillig   3573: <p>Furthermore, you can change this value on a per-package basis by
                   3574: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
                   3575: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
                   3576: package you would like to modify, that is, the contents of
                   3577: <code class="varname">PKGBASE</code>.</p>
                   3578: <p>Note that after changing these settings, you must rebuild and
                   3579: reinstall any affected packages.</p>
                   3580: </div>
                   3581: <div class="sect1" lang="en">
                   3582: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3583: <a name="audit-packages"></a>8.15. Automated security checks</h2></div></div></div>
1.75      rillig   3584: <p>Please be aware that there can often be bugs in third-party software,
                   3585: and some of these bugs can leave a machine vulnerable to exploitation by
                   3586: attackers.  In an effort to lessen the exposure, the NetBSD packages team
                   3587: maintains a database of known-exploits to packages which have at one time
                   3588: been included in pkgsrc.  The database can be downloaded automatically, and
                   3589: a security audit of all packages installed on a system can take place.  To
1.91      rillig   3590: 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   3591: components:</p>
                   3592: <div class="orderedlist"><ol type="1">
                   3593: <li>
                   3594: <p><span><strong class="command">download-vulnerability-list</strong></span>, an easy way to
                   3595:     download a list of the security vulnerabilities information.  This list
                   3596:     is kept up to date by the NetBSD security officer and the NetBSD
                   3597:     packages team, and is distributed from the NetBSD ftp server:</p>
                   3598: <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>
                   3599: </li>
                   3600: <li><p><span><strong class="command">audit-packages</strong></span>, an easy way to audit the
                   3601:     current machine, checking each vulnerability which is known.  If a
                   3602:     vulnerable package is installed, it will be shown by output to stdout,
                   3603:     including a description of the type of vulnerability, and a URL
                   3604:     containing more information.</p></li>
                   3605: </ol></div>
1.91      rillig   3606: <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   3607: package is strongly recommended!  After
                   3608: &#8220;<span class="quote">audit-packages</span>&#8221; is installed, please read
                   3609: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
                   3610: audit-packages</code></strong>.</p>
1.87      wiz      3611: <p>If this package is installed, pkgsrc builds will use it to
                   3612: 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
                   3613: check.</p>
1.75      rillig   3614: </div>
                   3615: <div class="sect1" lang="en">
                   3616: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3617: <a name="ufaq-cflags"></a>8.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.75      rillig   3618: <p>When you add your own preferences to the
                   3619:        <code class="varname">CFLAGS</code> variable in your
1.76      rillig   3620:        <code class="filename">mk.conf</code>, these flags are passed in
                   3621:        environment variables to the <code class="filename">./configure</code>
1.75      rillig   3622:        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
                   3623:        <code class="varname">CFLAGS</code> from the environment variable by
1.76      rillig   3624:        overriding them in the <code class="filename">Makefile</code>s of their
1.75      rillig   3625:        package.</p>
                   3626: <p>Currently there is no solution to this problem. If you
                   3627:        really need the package to use your <code class="varname">CFLAGS</code>
                   3628:        you should run <span><strong class="command">make patch</strong></span> in the package
1.76      rillig   3629:        directory and then inspect any <code class="filename">Makefile</code> and
                   3630:        <code class="filename">Makefile.in</code> for whether they define
1.75      rillig   3631:        <code class="varname">CFLAGS</code> explicitly. Usually you can remove
                   3632:        these lines. But be aware that some &#8220;<span class="quote">smart</span>&#8221;
                   3633:        programmers write so bad code that it only works for the
                   3634:        specific combination of <code class="varname">CFLAGS</code> they have
                   3635:        chosen.</p>
                   3636: </div>
1.80      rillig   3637: <div class="sect1" lang="en">
                   3638: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3639: <a name="ufaq-fail"></a>8.17. A package does not build.  What shall I do?</h2></div></div></div>
1.80      rillig   3640: <div class="procedure"><ol type="1">
                   3641: <li><p>Make sure that your copy of pkgsrc is consistent. A
                   3642:        case that occurs often is that people only update pkgsrc in
                   3643:        parts, because of performance reasons. Since pkgsrc is one large
                   3644:        system, not a collection of many small systems, there are
                   3645:        sometimes changes that only work when the whole pkgsrc tree is
                   3646:        updated.</p></li>
                   3647: <li><p>Make sure that you don't have any CVS conflicts.
                   3648:        Search for &#8220;<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>&#8221; or
                   3649:        &#8220;<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>&#8221; in all your pkgsrc
                   3650:        files.</p></li>
                   3651: <li><p>Make sure that you don't have old copies of the packages
                   3652:        extracted. Run <span><strong class="command">make clean clean-depends</strong></span> to
                   3653:        verify this.</p></li>
                   3654: <li><p>If the problem still exists, write a mail to the
                   3655:        <code class="literal">pkgsrc-users</code> mailing list.</p></li>
                   3656: </ol></div>
                   3657: </div>
1.88      wiz      3658: <div class="sect1" lang="en">
                   3659: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3660: <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   3661: <p>You have modified a file from pkgsrc, and someone else has
                   3662: modified that same file afterwards in the CVS repository. Both changes
                   3663: are in the same region of the file, so when you updated pkgsrc, the
                   3664: <code class="literal">cvs</code> command marked the conflicting changes in the
                   3665: file. Because of these markers, the file is no longer a valid
                   3666: <code class="filename">Makefile</code>.</p>
                   3667: <p>Have a look at that file, and if you don't need your local changes
                   3668: anymore, you can remove that file and run <span><strong class="command">cvs -q update
                   3669: -dP</strong></span> in that directory to download the current version.</p>
                   3670: </div>
1.75      rillig   3671: </div>
                   3672: </div>
                   3673: <div class="part" lang="en">
                   3674: <div class="titlepage"><div><div><h1 class="title">
                   3675: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.77      rillig   3676: <div class="partintro" lang="en">
                   3677: <div></div>
                   3678: <p>This part of the book deals with creating and
                   3679:        modifying packages. It starts with a &#8220;<span class="quote">HOWTO</span>&#8221;-like
                   3680:        guide on creating a new package. The remaining chapters are more
                   3681:        like a reference manual for pkgsrc.</p>
1.75      rillig   3682: <div class="toc">
                   3683: <p><b>Table of Contents</b></p>
                   3684: <dl>
1.90      rillig   3685: <dt><span class="chapter"><a href="#creating">9. Creating a new pkgsrc package from scratch</a></span></dt>
1.91      rillig   3686: <dd><dl>
                   3687: <dt><span class="sect1"><a href="#creating.common">9.1. Common types of packages</a></span></dt>
                   3688: <dd><dl>
                   3689: <dt><span class="sect2"><a href="#creating.perl-module">9.1.1. Perl modules</a></span></dt>
                   3690: <dt><span class="sect2"><a href="#creating.kde-app">9.1.2. KDE applications</a></span></dt>
                   3691: </dl></dd>
                   3692: <dt><span class="sect1"><a href="#creating.examples">9.2. Examples</a></span></dt>
                   3693: <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>
                   3694: </dl></dd>
1.90      rillig   3695: <dt><span class="chapter"><a href="#components">10. Package components - files, directories and contents</a></span></dt>
1.75      rillig   3696: <dd><dl>
1.90      rillig   3697: <dt><span class="sect1"><a href="#components.Makefile">10.1. <code class="filename">Makefile</code></a></span></dt>
                   3698: <dt><span class="sect1"><a href="#components.distinfo">10.2. <code class="filename">distinfo</code></a></span></dt>
                   3699: <dt><span class="sect1"><a href="#components.patches">10.3. patches/*</a></span></dt>
                   3700: <dd><dl>
1.93      rillig   3701: <dt><span class="sect2"><a href="#components.patch.structure">10.3.1. Structure of a single patch file</a></span></dt>
                   3702: <dt><span class="sect2"><a href="#components.patches.caveats">10.3.2. Creating patch files</a></span></dt>
                   3703: <dt><span class="sect2"><a href="#components.patches.sources">10.3.3. Sources where the patch files come from</a></span></dt>
                   3704: <dt><span class="sect2"><a href="#components.patches.guidelines">10.3.4. Patching guidelines</a></span></dt>
                   3705: <dt><span class="sect2"><a href="#components.patches.feedback">10.3.5. Feedback to the author</a></span></dt>
1.90      rillig   3706: </dl></dd>
                   3707: <dt><span class="sect1"><a href="#other-mandatory-files">10.4. Other mandatory files</a></span></dt>
                   3708: <dt><span class="sect1"><a href="#components.optional">10.5. Optional files</a></span></dt>
                   3709: <dd><dl>
                   3710: <dt><span class="sect2"><a href="#components.optional.bin">10.5.1. Files affecting the binary package</a></span></dt>
                   3711: <dt><span class="sect2"><a href="#components.optional.build">10.5.2. Files affecting the build process</a></span></dt>
                   3712: <dt><span class="sect2"><a href="#components.optional.none">10.5.3. Files affecting nothing at all</a></span></dt>
                   3713: </dl></dd>
                   3714: <dt><span class="sect1"><a href="#work-dir">10.6. <code class="filename">work*</code></a></span></dt>
                   3715: <dt><span class="sect1"><a href="#files-dir">10.7. <code class="filename">files/*</code></a></span></dt>
                   3716: </dl></dd>
                   3717: <dt><span class="chapter"><a href="#makefile">11. Programming in <code class="filename">Makefile</code>s</a></span></dt>
                   3718: <dd><dl>
1.97      rillig   3719: <dt><span class="sect1"><a href="#makefile.style">11.1. Caveats</a></span></dt>
                   3720: <dt><span class="sect1"><a href="#makefile.variables">11.2. <code class="filename">Makefile</code> variables</a></span></dt>
                   3721: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">11.2.1. Naming conventions</a></span></dt></dl></dd>
                   3722: <dt><span class="sect1"><a href="#makefile.code">11.3. Code snippets</a></span></dt>
                   3723: <dd><dl>
                   3724: <dt><span class="sect2"><a href="#adding-to-list">11.3.1. Adding things to a list</a></span></dt>
                   3725: <dt><span class="sect2"><a href="#converting-internal-to-external">11.3.2. Converting an internal list into an external list</a></span></dt>
                   3726: <dt><span class="sect2"><a href="#passing-variable-to-shell">11.3.3. Passing variables to a shell command</a></span></dt>
                   3727: <dt><span class="sect2"><a href="#quoting-guideline">11.3.4. Quoting guideline</a></span></dt>
                   3728: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">11.3.5. Workaround for a bug in BSD Make</a></span></dt>
1.90      rillig   3729: </dl></dd>
                   3730: </dl></dd>
                   3731: <dt><span class="chapter"><a href="#plist">12. PLIST issues</a></span></dt>
                   3732: <dd><dl>
                   3733: <dt><span class="sect1"><a href="#rcs-id">12.1. RCS ID</a></span></dt>
                   3734: <dt><span class="sect1"><a href="#automatic-plist-generation">12.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   3735: <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>
                   3736: <dt><span class="sect1"><a href="#plist.misc">12.4. Variable substitution in PLIST</a></span></dt>
                   3737: <dt><span class="sect1"><a href="#manpage-compression">12.5. Man page compression</a></span></dt>
                   3738: <dt><span class="sect1"><a href="#using-PLIST_SRC">12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   3739: <dt><span class="sect1"><a href="#platform-specific-plist">12.7. Platform-specific and differing PLISTs</a></span></dt>
                   3740: <dt><span class="sect1"><a href="#faq.common-dirs">12.8. Sharing directories between packages</a></span></dt>
                   3741: </dl></dd>
                   3742: <dt><span class="chapter"><a href="#buildlink">13. Buildlink methodology</a></span></dt>
                   3743: <dd><dl>
                   3744: <dt><span class="sect1"><a href="#converting-to-buildlink3">13.1. Converting packages to use buildlink3</a></span></dt>
                   3745: <dt><span class="sect1"><a href="#creating-buildlink3.mk">13.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
                   3746: <dd><dl>
                   3747: <dt><span class="sect2"><a href="#anatomy-of-bl3">13.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   3748: <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>
                   3749: </dl></dd>
                   3750: <dt><span class="sect1"><a href="#writing-builtin.mk">13.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
                   3751: <dd><dl>
                   3752: <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>
                   3753: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">13.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                   3754: </dl></dd>
                   3755: </dl></dd>
                   3756: <dt><span class="chapter"><a href="#pkginstall">14. The pkginstall framework</a></span></dt>
                   3757: <dd><dl>
                   3758: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">14.1. Files and directories outside the installation prefix</a></span></dt>
                   3759: <dd><dl>
                   3760: <dt><span class="sect2"><a href="#dirs-outside-prefix">14.1.1. Directory manipulation</a></span></dt>
                   3761: <dt><span class="sect2"><a href="#files-outside-prefix">14.1.2. File manipulation</a></span></dt>
                   3762: </dl></dd>
                   3763: <dt><span class="sect1"><a href="#conf-files">14.2. Configuration files</a></span></dt>
                   3764: <dd><dl>
                   3765: <dt><span class="sect2"><a href="#conf-files-sysconfdir">14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   3766: <dt><span class="sect2"><a href="#conf-files-configure">14.2.2. Telling the software where configuration files are</a></span></dt>
                   3767: <dt><span class="sect2"><a href="#conf-files-patching">14.2.3. Patching installations</a></span></dt>
                   3768: <dt><span class="sect2"><a href="#conf-files-disable">14.2.4. Disabling handling of configuration files</a></span></dt>
                   3769: </dl></dd>
                   3770: <dt><span class="sect1"><a href="#rcd-scripts">14.3. System startup scripts</a></span></dt>
                   3771: <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>
                   3772: <dt><span class="sect1"><a href="#users-and-groups">14.4. System users and groups</a></span></dt>
                   3773: <dt><span class="sect1"><a href="#shells">14.5. System shells</a></span></dt>
                   3774: <dd><dl><dt><span class="sect2"><a href="#shells-disable">14.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   3775: <dt><span class="sect1"><a href="#fonts">14.6. Fonts</a></span></dt>
                   3776: <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>
                   3777: </dl></dd>
                   3778: <dt><span class="chapter"><a href="#options">15. Options handling</a></span></dt>
                   3779: <dd><dl>
                   3780: <dt><span class="sect1"><a href="#global-default-options">15.1. Global default options</a></span></dt>
                   3781: <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>
                   3782: <dt><span class="sect1"><a href="#option-names">15.3. Option Names</a></span></dt>
                   3783: </dl></dd>
                   3784: <dt><span class="chapter"><a href="#build">16. The build process</a></span></dt>
                   3785: <dd><dl>
                   3786: <dt><span class="sect1"><a href="#build.intro">16.1. Introduction</a></span></dt>
                   3787: <dt><span class="sect1"><a href="#build.prefix">16.2. Program location</a></span></dt>
                   3788: <dt><span class="sect1"><a href="#build.builddirs">16.3. Directories used during the build process</a></span></dt>
                   3789: <dt><span class="sect1"><a href="#build.running">16.4. Running a phase</a></span></dt>
                   3790: <dt><span class="sect1"><a href="#build.fetch">16.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   3791: <dd><dl>
                   3792: <dt><span class="sect2"><a href="#build.fetch.what">16.5.1. What to fetch and where to get it from</a></span></dt>
                   3793: <dt><span class="sect2"><a href="#build.fetch.how">16.5.2. How are the files fetched?</a></span></dt>
                   3794: </dl></dd>
                   3795: <dt><span class="sect1"><a href="#build.checksum">16.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   3796: <dt><span class="sect1"><a href="#build.extract">16.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   3797: <dt><span class="sect1"><a href="#build.patch">16.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   3798: <dt><span class="sect1"><a href="#build.tools">16.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   3799: <dt><span class="sect1"><a href="#build.wrapper">16.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   3800: <dt><span class="sect1"><a href="#build.configure">16.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   3801: <dt><span class="sect1"><a href="#build.build">16.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   3802: <dt><span class="sect1"><a href="#build.test">16.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   3803: <dt><span class="sect1"><a href="#build.install">16.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   3804: <dt><span class="sect1"><a href="#build.package">16.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   3805: <dt><span class="sect1"><a href="#build.clean">16.16. Cleaning up</a></span></dt>
                   3806: <dt><span class="sect1"><a href="#build.helpful-targets">16.17. Other helpful targets</a></span></dt>
                   3807: </dl></dd>
                   3808: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
                   3809: <dd><dl>
                   3810: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                   3811: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                   3812: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.97      rillig   3813: <dt><span class="sect1"><a href="#tools.questions">17.4. Questions regarding the tools</a></span></dt>
1.90      rillig   3814: </dl></dd>
                   3815: <dt><span class="chapter"><a href="#fixes">18. Making your package work</a></span></dt>
                   3816: <dd><dl>
                   3817: <dt><span class="sect1"><a href="#general-operation">18.1. General operation</a></span></dt>
                   3818: <dd><dl>
                   3819: <dt><span class="sect2"><a href="#portability-of-packages">18.1.1. Portability of packages</a></span></dt>
                   3820: <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>
                   3821: <dt><span class="sect2"><a href="#user-interaction">18.1.3. User interaction</a></span></dt>
                   3822: <dt><span class="sect2"><a href="#handling-licenses">18.1.4. Handling licenses</a></span></dt>
                   3823: <dt><span class="sect2"><a href="#restricted-packages">18.1.5. Restricted packages</a></span></dt>
                   3824: <dt><span class="sect2"><a href="#dependencies">18.1.6. Handling dependencies</a></span></dt>
                   3825: <dt><span class="sect2"><a href="#conflicts">18.1.7. Handling conflicts with other packages</a></span></dt>
                   3826: <dt><span class="sect2"><a href="#not-building-packages">18.1.8. Packages that cannot or should not be built</a></span></dt>
                   3827: <dt><span class="sect2"><a href="#undeletable-packages">18.1.9. Packages which should not be deleted, once installed</a></span></dt>
                   3828: <dt><span class="sect2"><a href="#security-handling">18.1.10. Handling packages with security problems</a></span></dt>
                   3829: <dt><span class="sect2"><a href="#bumping-pkgrevision">18.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   3830: <dt><span class="sect2"><a href="#fixes.subst">18.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   3831: </dl></dd>
                   3832: <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>
                   3833: <dd><dl>
                   3834: <dt><span class="sect2"><a href="#no-plain-download">18.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   3835: <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>
                   3836: </dl></dd>
                   3837: <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>
                   3838: <dd><dl>
                   3839: <dt><span class="sect2"><a href="#fixes.libtool">18.3.1. Shared libraries - libtool</a></span></dt>
                   3840: <dt><span class="sect2"><a href="#using-libtool">18.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   3841: <dt><span class="sect2"><a href="#autoconf-automake">18.3.3. GNU Autoconf/Automake</a></span></dt>
                   3842: </dl></dd>
                   3843: <dt><span class="sect1"><a href="#programming-languages">18.4. Programming languages</a></span></dt>
                   3844: <dd><dl>
                   3845: <dt><span class="sect2"><a href="#basic-programming-languages">18.4.1. C, C++, and Fortran</a></span></dt>
                   3846: <dt><span class="sect2"><a href="#java-programming-language">18.4.2. Java</a></span></dt>
                   3847: <dt><span class="sect2"><a href="#perl-scripts">18.4.3. Packages containing perl scripts</a></span></dt>
                   3848: <dt><span class="sect2"><a href="#other-programming-languages">18.4.4. Other programming languages</a></span></dt>
                   3849: </dl></dd>
                   3850: <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>
                   3851: <dd><dl>
                   3852: <dt><span class="sect2"><a href="#fixes.build.cpp">18.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   3853: <dt><span class="sect2"><a href="#compiler-bugs">18.5.2. How to handle compiler bugs</a></span></dt>
                   3854: <dt><span class="sect2"><a href="#undefined-reference">18.5.3. Undefined reference to &#8220;<span class="quote">...</span>&#8221;</a></span></dt>
                   3855: <dt><span class="sect2"><a href="#out-of-memory">18.5.4. Running out of memory</a></span></dt>
                   3856: </dl></dd>
                   3857: <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>
                   3858: <dd><dl>
                   3859: <dt><span class="sect2"><a href="#install-scripts">18.6.1. Creating needed directories</a></span></dt>
                   3860: <dt><span class="sect2"><a href="#where-to-install-documentation">18.6.2. Where to install documentation</a></span></dt>
1.100   ! rillig   3861: <dt><span class="sect2"><a href="#installing-score-files">18.6.3. Installing highscore files</a></span></dt>
1.90      rillig   3862: <dt><span class="sect2"><a href="#hardcoded-paths">18.6.4. Packages with hardcoded paths to other interpreters</a></span></dt>
                   3863: <dt><span class="sect2"><a href="#perl-modules">18.6.5. Packages installing perl modules</a></span></dt>
                   3864: <dt><span class="sect2"><a href="#faq.info-files">18.6.6. Packages installing info files</a></span></dt>
                   3865: <dt><span class="sect2"><a href="#manpages">18.6.7. Packages installing man pages</a></span></dt>
                   3866: <dt><span class="sect2"><a href="#gconf2-data-files">18.6.8. Packages installing GConf2 data files</a></span></dt>
                   3867: <dt><span class="sect2"><a href="#scrollkeeper-data-files">18.6.9. Packages installing scrollkeeper data files</a></span></dt>
                   3868: <dt><span class="sect2"><a href="#x11-fonts">18.6.10. Packages installing X11 fonts</a></span></dt>
                   3869: <dt><span class="sect2"><a href="#gtk2-modules">18.6.11. Packages installing GTK2 modules</a></span></dt>
                   3870: <dt><span class="sect2"><a href="#sgml-xml-data">18.6.12. Packages installing SGML or XML data</a></span></dt>
                   3871: <dt><span class="sect2"><a href="#mime-database">18.6.13. Packages installing extensions to the MIME database</a></span></dt>
                   3872: <dt><span class="sect2"><a href="#intltool">18.6.14. Packages using intltool</a></span></dt>
                   3873: <dt><span class="sect2"><a href="#startup-scripts">18.6.15. Packages installing startup scripts</a></span></dt>
                   3874: <dt><span class="sect2"><a href="#tex-packages">18.6.16. Packages installing TeX modules</a></span></dt>
                   3875: <dt><span class="sect2"><a href="#emulation-packages">18.6.17. Packages supporting running binaries in
1.87      wiz      3876:     emulation</a></span></dt>
1.90      rillig   3877: <dt><span class="sect2"><a href="#hicolor-theme">18.6.18. Packages installing hicolor theme icons</a></span></dt>
                   3878: <dt><span class="sect2"><a href="#desktop-files">18.6.19. Packages installing desktop files</a></span></dt>
1.77      rillig   3879: </dl></dd>
1.90      rillig   3880: <dt><span class="sect1"><a href="#punting">18.7. Marking packages as having problems</a></span></dt>
1.77      rillig   3881: </dl></dd>
1.90      rillig   3882: <dt><span class="chapter"><a href="#debug">19. Debugging</a></span></dt>
                   3883: <dt><span class="chapter"><a href="#submit">20. Submitting and Committing</a></span></dt>
1.77      rillig   3884: <dd><dl>
1.90      rillig   3885: <dt><span class="sect1"><a href="#submitting-binary-packages">20.1. Submitting binary packages</a></span></dt>
                   3886: <dt><span class="sect1"><a href="#submitting-your-package">20.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   3887: <dt><span class="sect1"><a href="#general-notes-for-changes">20.3. General notes when adding, updating, or removing packages</a></span></dt>
                   3888: <dt><span class="sect1"><a href="#committing-importing">20.4. Committing: Importing a package into CVS</a></span></dt>
                   3889: <dt><span class="sect1"><a href="#updating-package">20.5. Updating a package to a newer version</a></span></dt>
                   3890: <dt><span class="sect1"><a href="#moving-package">20.6. Moving a package in pkgsrc</a></span></dt>
                   3891: </dl></dd>
                   3892: <dt><span class="chapter"><a href="#devfaq">21. Frequently Asked Questions</a></span></dt>
                   3893: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
                   3894: <dd><dl>
                   3895: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                   3896: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                   3897: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                   3898: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
1.85      jmmv     3899: </dl></dd>
1.75      rillig   3900: </dl>
                   3901: </div>
1.77      rillig   3902: </div>
                   3903: <div class="chapter" lang="en">
                   3904: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   3905: <a name="creating"></a>Chapter 9. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91      rillig   3906: <div class="toc">
                   3907: <p><b>Table of Contents</b></p>
                   3908: <dl>
                   3909: <dt><span class="sect1"><a href="#creating.common">9.1. Common types of packages</a></span></dt>
                   3910: <dd><dl>
                   3911: <dt><span class="sect2"><a href="#creating.perl-module">9.1.1. Perl modules</a></span></dt>
                   3912: <dt><span class="sect2"><a href="#creating.kde-app">9.1.2. KDE applications</a></span></dt>
                   3913: </dl></dd>
                   3914: <dt><span class="sect1"><a href="#creating.examples">9.2. Examples</a></span></dt>
                   3915: <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>
                   3916: </dl>
                   3917: </div>
1.77      rillig   3918: <p>When you find a package that is not yet in pkgsrc, you
1.91      rillig   3919: most likely have a URL from where you can download the source
                   3920: code. Starting with this URL, creating a package involves only a
                   3921: few steps.</p>
1.77      rillig   3922: <div class="procedure"><ol type="1">
1.91      rillig   3923: <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   3924: <li><p>Then, choose one of the top-level directories as the
1.91      rillig   3925: category in which you want to place your package. You can also create a
                   3926: directory of your own (maybe called <code class="filename">local</code>). In that
                   3927: category directory, create another directory for your package and change
                   3928: into it.</p></li>
                   3929: <li><p>Run the program <span><strong class="command">url2pkg</strong></span>, which will ask
                   3930: you for a URL. Enter the URL of the distribution file (in most cases a
                   3931: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
                   3932: of your package are created automatically. The distribution file is
                   3933: extracted automatically to fill in some details in the
                   3934: <code class="filename">Makefile</code> that would otherwise have to be done
                   3935: manually.</p></li>
                   3936: <li>
                   3937: <p>Examine the extracted files to determine the dependencies of
                   3938: your package. Ideally, this is mentioned in some
                   3939: <code class="filename">README</code> file, but things may differ. For each of
                   3940: these dependencies, look where it exists in pkgsrc, and if there is a
                   3941: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   3942: line to your package <code class="filename">Makefile</code> which includes that
                   3943: file just before the last line. If the
                   3944: <code class="filename">buildlink3.mk</code> file does not exist, add a
                   3945: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   3946: version of the dependency and where it can be found in pkgsrc. This line
                   3947: should be placed in the third paragraph. If the dependency is only
                   3948: needed for building the package, but not when using it, use
                   3949: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
                   3950: Your package may then look like this:</p>
1.77      rillig   3951: <pre class="programlisting">
1.100   ! rillig   3952: [...]
1.77      rillig   3953: 
1.100   ! rillig   3954: BUILD_DEPENDS+= lua&gt;=5.0:../../lang/lua
        !          3955: DEPENDS+=       screen-[0-9]*:../../misc/screen
        !          3956: DEPENDS+=       screen&gt;=4.0:../../misc/screen
1.77      rillig   3957: 
1.100   ! rillig   3958: [...]
1.77      rillig   3959: 
1.100   ! rillig   3960: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
        !          3961: .include "../../devel/glib2/buildlink3.mk"
        !          3962: .include "../../mk/bsd.pkg.mk"
1.77      rillig   3963: </pre>
                   3964: </li>
1.91      rillig   3965: <li><p>Run <span><strong class="command">pkglint</strong></span> to see what things still need
                   3966: to be done to make your package a &#8220;<span class="quote">good</span>&#8221; one. If you don't
                   3967: know what pkglint's warnings want to tell you, try <span><strong class="command">pkglint
                   3968: --explain</strong></span> or <span><strong class="command">pkglint
                   3969: -e</strong></span>, which outputs additional
                   3970: explanations.</p></li>
                   3971: <li><p>In many cases the package is not yet ready to build. You can
                   3972: 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
                   3973: over there, you can hopefully continue here.</p></li>
                   3974: <li><p>Run <span><strong class="command">bmake clean</strong></span> to clean the working
                   3975: directory from the extracted files. Besides these files, a lot of cache
                   3976: files and other system information has been saved in the working
                   3977: directory, which may become wrong after you edited the
                   3978: <code class="filename">Makefile</code>.</p></li>
                   3979: <li><p>Now, run <span><strong class="command">bmake</strong></span> to build the package. For
                   3980: 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>
                   3981: <li><p>When the package builds fine, the next step is to install
                   3982: the package. Run <span><strong class="command">bmake install</strong></span> and hope that
                   3983: everything works.</p></li>
                   3984: <li><p>Up to now, the file <code class="filename">PLIST</code>, which
                   3985: contains a list of the files that are installed by the package, is
                   3986: nearly empty. Run <span><strong class="command">bmake print-PLIST
                   3987: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   3988: the file using your preferred text editor to see if the list of
                   3989: files looks plausible.</p></li>
                   3990: <li><p>Run <span><strong class="command">pkglint</strong></span> again to see if the generated
                   3991: <code class="filename">PLIST</code> contains garbage or not.</p></li>
                   3992: <li><p>When you ran <span><strong class="command">bmake install</strong></span>, the package
                   3993: has been registered in the database of installed files, but with an
                   3994: empty list of files. To fix this, run <span><strong class="command">bmake deinstall</strong></span>
                   3995: and <span><strong class="command">bmake install</strong></span> again. Now the package is
                   3996: registered with the list of files from
                   3997: <code class="filename">PLIST</code>.</p></li>
                   3998: <li><p>Run <span><strong class="command">bmake package</strong></span> to create a binary
                   3999: package from the set of installed files.</p></li>
1.77      rillig   4000: </ol></div>
1.91      rillig   4001: <div class="sect1" lang="en">
                   4002: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4003: <a name="creating.common"></a>9.1. Common types of packages</h2></div></div></div>
                   4004: <div class="sect2" lang="en">
                   4005: <div class="titlepage"><div><div><h3 class="title">
                   4006: <a name="creating.perl-module"></a>9.1.1. Perl modules</h3></div></div></div>
                   4007: <p>Simple Perl modules are handled automatically by
                   4008: <span><strong class="command">url2pkg</strong></span>, including dependencies.</p>
                   4009: </div>
                   4010: <div class="sect2" lang="en">
                   4011: <div class="titlepage"><div><div><h3 class="title">
                   4012: <a name="creating.kde-app"></a>9.1.2. KDE applications</h3></div></div></div>
                   4013: <p>KDE applications should always include
                   4014: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
                   4015: settings that are typical of KDE packages.</p>
                   4016: </div>
                   4017: </div>
                   4018: <div class="sect1" lang="en">
                   4019: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4020: <a name="creating.examples"></a>9.2. Examples</h2></div></div></div>
                   4021: <div class="sect2" lang="en">
                   4022: <div class="titlepage"><div><div><h3 class="title">
                   4023: <a name="creating.nvu"></a>9.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
                   4024: <div class="sect3" lang="en">
                   4025: <div class="titlepage"><div><div><h4 class="title">
                   4026: <a name="creating.nvu.init"></a>9.2.1.1. The initial package</h4></div></div></div>
                   4027: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
                   4028: that the &#8220;<span class="quote">nvu</span>&#8221; package has not yet been imported into
                   4029: pkgsrc. As the description says it has to do with the web, the obvious
                   4030: choice for the category is &#8220;<span class="quote">www</span>&#8221;.</p>
                   4031: <pre class="programlisting">
1.100   ! rillig   4032: <code class="prompt">$</code> mkdir www/nvu
        !          4033: <code class="prompt">$</code> cd www/nvu
1.91      rillig   4034: </pre>
                   4035: <p>The web site says that the sources are available as a tar file, so
                   4036: I fed that URL to the <span><strong class="command">url2pkg</strong></span> program:</p>
                   4037: <pre class="programlisting">
1.100   ! rillig   4038: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91      rillig   4039: </pre>
                   4040: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   4041: below the <code class="varname">DISTNAME</code> line, as the package name should
                   4042: not have the word &#8220;<span class="quote">sources</span>&#8221; in it. I also filled in the
                   4043: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   4044: <code class="varname">COMMENT</code> fields. Then the package
                   4045: <code class="filename">Makefile</code> looked like that:</p>
                   4046: <pre class="programlisting">
1.100   ! rillig   4047: # $NetBSD$
        !          4048: #
1.91      rillig   4049: 
1.100   ! rillig   4050: DISTNAME=       nvu-1.0-sources
        !          4051: PKGNAME=        nvu-1.0
        !          4052: CATEGORIES=     www
        !          4053: MASTER_SITES=   http://cvs.nvu.com/download/
        !          4054: EXTRACT_SUFX=   .tar.bz2
        !          4055: 
        !          4056: MAINTAINER=     rillig@NetBSD.org
        !          4057: HOMEPAGE=       http://cvs.nvu.com/
        !          4058: COMMENT=        Web Authoring System
1.91      rillig   4059: 
1.100   ! rillig   4060: # url2pkg-marker (please do not remove this line.)
        !          4061: .include "../../mk/bsd.pkg.mk"
1.91      rillig   4062: </pre>
                   4063: <p>Then, I quit the editor and watched pkgsrc downloading a large
                   4064: source archive:</p>
                   4065: <pre class="programlisting">
1.100   ! rillig   4066: url2pkg&gt; Running "make makesum" ...
        !          4067: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
        !          4068: =&gt; Fetching nvu-1.0-sources.tar.bz2
        !          4069: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
        !          4070: 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
        !          4071: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
        !          4072: url2pkg&gt; Running "make extract" ...
        !          4073: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
        !          4074: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
        !          4075: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
        !          4076: work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
        !          4077: ===&gt; Installing dependencies for nvu-1.0
        !          4078: ===&gt; Overriding tools for nvu-1.0
        !          4079: ===&gt; Extracting for nvu-1.0
        !          4080: url2pkg&gt; Adjusting the Makefile.
1.91      rillig   4081: 
1.100   ! rillig   4082: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.91      rillig   4083: 
1.100   ! rillig   4084: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.91      rillig   4085: </pre>
                   4086: </div>
                   4087: <div class="sect3" lang="en">
                   4088: <div class="titlepage"><div><div><h4 class="title">
                   4089: <a name="creating.nvu.problems"></a>9.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
                   4090: <p>Now that the package has been extracted, let's see what's inside
                   4091: it. The package has a <code class="filename">README.txt</code>, but that only
                   4092: says something about mozilla, so it's probably useless for seeing what
                   4093: dependencies this package has. But since there is a GNU configure script
                   4094: in the package, let's hope that it will complain about everything it
                   4095: needs.</p>
                   4096: <pre class="programlisting">
1.100   ! rillig   4097: <code class="prompt">$</code> bmake
        !          4098: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
        !          4099: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
        !          4100: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
        !          4101: ===&gt; Patching for nvu-1.0
        !          4102: ===&gt; Creating toolchain wrappers for nvu-1.0
        !          4103: ===&gt; Configuring for nvu-1.0
        !          4104: [...]
        !          4105: configure: error: Perl 5.004 or higher is required.
        !          4106: [...]
        !          4107: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
        !          4108: [...]
1.91      rillig   4109: </pre>
                   4110: <p>That worked quite well. So I opened the package Makefile in my
                   4111: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
                   4112: just appended &#8220;<span class="quote">perl</span>&#8221; to it. Since the dependencies of the
                   4113: package have changed now, and since a perl wrapper is automatically
                   4114: installed in the &#8220;<span class="quote">tools</span>&#8221; phase, I need to build the package
                   4115: from scratch.</p>
                   4116: <pre class="programlisting">
1.100   ! rillig   4117: <code class="prompt">$</code> bmake clean
        !          4118: ===&gt; Cleaning for nvu-1.0
        !          4119: <code class="prompt">$</code> bmake
        !          4120: [...]
        !          4121: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
        !          4122: GNU Make.  You will not be able to build Mozilla without GNU Make.
        !          4123: [...]
1.91      rillig   4124: </pre>
                   4125: <p>So I added &#8220;<span class="quote">gmake</span>&#8221; to the
                   4126: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
                   4127: <pre class="programlisting">
1.100   ! rillig   4128: [...]
        !          4129: checking for GTK - version &gt;= 1.2.0... no
        !          4130: *** Could not run GTK test program, checking why...
        !          4131: [...]
1.91      rillig   4132: </pre>
                   4133: <p>Now to the other dependencies. The first question is: Where is the
                   4134: GTK package hidden in pkgsrc?</p>
                   4135: <pre class="programlisting">
1.100   ! rillig   4136: <code class="prompt">$</code> echo ../../*/gtk*
        !          4137: [many packages ...]
        !          4138: <code class="prompt">$</code> echo ../../*/gtk
        !          4139: ../../x11/gtk
        !          4140: <code class="prompt">$</code> echo ../../*/gtk2
        !          4141: ../../x11/gtk2
        !          4142: <code class="prompt">$</code> echo ../../*/gtk2/bui*
        !          4143: ../../x11/gtk2/buildlink3.mk
1.91      rillig   4144: </pre>
                   4145: <p>The first try was definitely too broad. The second one had exactly
                   4146: one result, which is very good. But there is one pitfall with GNOME
                   4147: packages. Before GNOME 2 had been released, there were already many
                   4148: GNOME 1 packages in pkgsrc. To be able to continue to use these
                   4149: packages, the GNOME 2 packages were imported as separate packages, and
                   4150: their names usually have a &#8220;<span class="quote">2</span>&#8221; appended. So I checked
                   4151: whether this was the case here, and indeed it was.</p>
                   4152: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
                   4153: file, adding the dependency is very easy. I just inserted an
                   4154: <code class="literal">.include</code> line before the last line of the package
                   4155: <code class="filename">Makefile</code>, so that it now looks like this:</p>
                   4156: <pre class="programlisting">
1.100   ! rillig   4157: [...]
        !          4158: .include "../../x11/gtk2/buildlink3.mk"
        !          4159: .include "../../mk/bsd.pkg.mk
1.91      rillig   4160: </pre>
                   4161: <p>After another <span><strong class="command">bmake clean &amp;&amp; bmake</strong></span>, the answer
                   4162: was:</p>
                   4163: <pre class="programlisting">
1.100   ! rillig   4164: [...]
        !          4165: checking for gtk-config... /home/roland/pkg/bin/gtk-config
        !          4166: checking for GTK - version &gt;= 1.2.0... no
        !          4167: *** Could not run GTK test program, checking why...
        !          4168: *** The test program failed to compile or link. See the file config.log for the
        !          4169: *** exact error that occured. This usually means GTK was incorrectly installed
        !          4170: *** or that you have moved GTK since it was installed. In the latter case, you
        !          4171: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
        !          4172: configure: error: Test for GTK failed.
        !          4173: [...]
1.91      rillig   4174: </pre>
                   4175: <p>In this particular case, the assumption that &#8220;<span class="quote">every package
                   4176: prefers GNOME 2</span>&#8221; had been wrong. The first of the lines above
                   4177: told me that this package really wanted to have the GNOME 1 version of
                   4178: GTK. If the package had looked for GTK2, it would have looked for
                   4179: <span><strong class="command">pkg-config</strong></span> instead of <span><strong class="command">gtk-config</strong></span>.
                   4180: So I changed the <code class="literal">x11/gtk2</code> to
                   4181: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
                   4182: and tried again.</p>
                   4183: <pre class="programlisting">
1.100   ! rillig   4184: [...]
        !          4185: 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
        !          4186: In file included from xpidl.c:42:
        !          4187: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
        !          4188: In file included from xpidl.c:42:
        !          4189: xpidl.h:132: error: parse error before "IDL_ns"
        !          4190: [...]
1.91      rillig   4191: </pre>
                   4192: <p>The package still does not find all of its dependencies. Now the
                   4193: question is: Which package provides the
                   4194: <code class="filename">libIDL/IDL.h</code> header file?</p>
                   4195: <pre class="programlisting">
1.100   ! rillig   4196: <code class="prompt">$</code> echo ../../*/*idl*
        !          4197: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
        !          4198: <code class="prompt">$</code> echo ../../*/*IDL*
        !          4199: ../../net/libIDL
1.91      rillig   4200: </pre>
                   4201: <p>Let's take the one from the second try. So I included the
                   4202: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
                   4203: again. But the error didn't change. After digging through some of the
                   4204: code, I concluded that the build process of the package was broken and
                   4205: couldn't have ever worked, but since the Mozilla source tree is quite
                   4206: large, I didn't want to fix it. So I added the following to the package
                   4207: <code class="filename">Makefile</code> and tried again:</p>
                   4208: <pre class="programlisting">
1.100   ! rillig   4209: CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
        !          4210: BUILDLINK_TRANSFORM+=   -l:IDL:IDL-2
1.91      rillig   4211: </pre>
                   4212: <p>The latter line is needed because the package expects the library
                   4213: <code class="filename">libIDL.so</code>, but only
                   4214: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
                   4215: wrapper to rewrite that on the fly.</p>
                   4216: <p>The next problem was related to a recent change of the FreeType
                   4217: 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>
                   4218: which patch files were relevant for this issue and copied them to the
                   4219: <code class="filename">patches</code> directory. Then I retried, fixed the
                   4220: patches so that they applied cleanly and retried again. This time,
                   4221: everything worked.</p>
                   4222: </div>
                   4223: <div class="sect3" lang="en">
                   4224: <div class="titlepage"><div><div><h4 class="title">
                   4225: <a name="creating.nvu.inst"></a>9.2.1.3. Installing the package</h4></div></div></div>
                   4226: <pre class="programlisting">
1.100   ! rillig   4227: <code class="prompt">$</code> bmake CHECK_FILES=no install
        !          4228: [...]
        !          4229: <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
        !          4230: <code class="prompt">$</code> bmake deinstall
        !          4231: <code class="prompt">$</code> bmake install
1.91      rillig   4232: </pre>
                   4233: </div>
                   4234: </div>
                   4235: </div>
1.77      rillig   4236: </div>
1.75      rillig   4237: <div class="chapter" lang="en">
                   4238: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   4239: <a name="components"></a>Chapter 10. Package components - files, directories and contents</h2></div></div></div>
1.75      rillig   4240: <div class="toc">
                   4241: <p><b>Table of Contents</b></p>
                   4242: <dl>
1.90      rillig   4243: <dt><span class="sect1"><a href="#components.Makefile">10.1. <code class="filename">Makefile</code></a></span></dt>
                   4244: <dt><span class="sect1"><a href="#components.distinfo">10.2. <code class="filename">distinfo</code></a></span></dt>
                   4245: <dt><span class="sect1"><a href="#components.patches">10.3. patches/*</a></span></dt>
                   4246: <dd><dl>
1.93      rillig   4247: <dt><span class="sect2"><a href="#components.patch.structure">10.3.1. Structure of a single patch file</a></span></dt>
                   4248: <dt><span class="sect2"><a href="#components.patches.caveats">10.3.2. Creating patch files</a></span></dt>
                   4249: <dt><span class="sect2"><a href="#components.patches.sources">10.3.3. Sources where the patch files come from</a></span></dt>
                   4250: <dt><span class="sect2"><a href="#components.patches.guidelines">10.3.4. Patching guidelines</a></span></dt>
                   4251: <dt><span class="sect2"><a href="#components.patches.feedback">10.3.5. Feedback to the author</a></span></dt>
1.90      rillig   4252: </dl></dd>
                   4253: <dt><span class="sect1"><a href="#other-mandatory-files">10.4. Other mandatory files</a></span></dt>
                   4254: <dt><span class="sect1"><a href="#components.optional">10.5. Optional files</a></span></dt>
                   4255: <dd><dl>
                   4256: <dt><span class="sect2"><a href="#components.optional.bin">10.5.1. Files affecting the binary package</a></span></dt>
                   4257: <dt><span class="sect2"><a href="#components.optional.build">10.5.2. Files affecting the build process</a></span></dt>
                   4258: <dt><span class="sect2"><a href="#components.optional.none">10.5.3. Files affecting nothing at all</a></span></dt>
1.78      rillig   4259: </dl></dd>
1.90      rillig   4260: <dt><span class="sect1"><a href="#work-dir">10.6. <code class="filename">work*</code></a></span></dt>
                   4261: <dt><span class="sect1"><a href="#files-dir">10.7. <code class="filename">files/*</code></a></span></dt>
1.75      rillig   4262: </dl>
                   4263: </div>
1.87      wiz      4264: <p>Whenever you're preparing a package, there are a number of
                   4265: files involved which are described in the following
                   4266: sections.</p>
1.75      rillig   4267: <div class="sect1" lang="en">
                   4268: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   4269: <a name="components.Makefile"></a>10.1. <code class="filename">Makefile</code>
                   4270: </h2></div></div></div>
1.75      rillig   4271: <p>Building, installation and creation of a binary package are all
1.87      wiz      4272:   controlled by the package's <code class="filename">Makefile</code>.
                   4273:   The <code class="filename">Makefile</code> describes various things about
                   4274:   a package, for example from where to get it, how to configure,
                   4275:   build, and install it.</p>
1.76      rillig   4276: <p>A package <code class="filename">Makefile</code> contains several
1.87      wiz      4277:   sections that describe the package.</p>
1.75      rillig   4278: <p>In the first section there are the following variables, which
1.87      wiz      4279:   should appear exactly in the order given here.  The order and
                   4280:   grouping of the variables is mostly historical and has no further
                   4281:   meaning.</p>
1.75      rillig   4282: <div class="itemizedlist"><ul type="disc">
                   4283: <li><p><code class="varname">DISTNAME</code> is the basename of the
1.87      wiz      4284:     distribution file to be downloaded from the package's
                   4285:     website.</p></li>
1.75      rillig   4286: <li><p><code class="varname">PKGNAME</code> is the name of the
1.87      wiz      4287:     package, as used by pkgsrc. You only need to provide it if
                   4288:     <code class="varname">DISTNAME</code> (which is the default) is not a good
                   4289:     name for the package in pkgsrc.  Usually it is the pkgsrc
                   4290:     directory name together with the version number. It must match the
                   4291:     regular expression
                   4292:     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
                   4293:     starts with a letter or digit, and contains only letters, digits,
                   4294:     dashes, underscores, dots and plus signs.</p></li>
                   4295: <li><p><code class="varname">SVR4_PKGNAME</code> is the name of
                   4296:     the package file to create if the <code class="varname">PKGNAME</code>
                   4297:     isn't unique on a SVR4 system. The default is
                   4298:     <code class="varname">PKGNAME</code>, which may be shortened when you use
1.91      rillig   4299:     <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      4300:     <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
                   4301:     does not produce an unique package name on a SVR4 system.
                   4302:     The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
                   4303:     characters.</p></li>
1.75      rillig   4304: <li>
                   4305: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87      wiz      4306:     which the package fits in. You can choose any of the top-level
                   4307:     directories of pkgsrc for it.</p>
1.75      rillig   4308: <p>Currently the following values are available for
1.87      wiz      4309:     <code class="varname">CATEGORIES</code>. If more than
                   4310:     one is used, they need to be separated by spaces:</p>
1.75      rillig   4311: <pre class="programlisting">
1.100   ! rillig   4312: archivers     cross         geography     meta-pkgs     security
        !          4313: audio         databases     graphics      misc          shells
        !          4314: benchmarks    devel         ham           multimedia    sysutils
        !          4315: biology       editors       inputmethod   net           textproc
        !          4316: cad           emulators     lang          news          time
        !          4317: chat          finance       mail          parallel      wm
        !          4318: comms         fonts         math          pkgtools      www
        !          4319: converters    games         mbone         print         x11
        !          4320: </pre>
1.75      rillig   4321: </li>
1.81      rillig   4322: <li><p><code class="varname">MASTER_SITES</code>,
1.87      wiz      4323:     <code class="varname">DYNAMIC_MASTER_SITES</code>,
                   4324:     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
                   4325:     and <code class="varname">DISTFILES</code> are discussed in detail in
1.90      rillig   4326:     <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   4327: </ul></div>
                   4328: <p>The second section contains information about separately
1.87      wiz      4329:   downloaded patches, if any.
                   4330:   </p>
1.75      rillig   4331: <div class="itemizedlist"><ul type="disc">
                   4332: <li><p><code class="varname">PATCHFILES:</code>
1.87      wiz      4333:     Name(s) of additional files that contain distribution patches.
                   4334:     There is no default. pkgsrc will look for them at
                   4335:     <code class="varname">PATCH_SITES</code>.
                   4336:     They will automatically be uncompressed before patching if
                   4337:     the names end with <code class="filename">.gz</code> or
                   4338:     <code class="filename">.Z</code>.</p></li>
1.75      rillig   4339: <li><p><code class="varname">PATCH_SITES</code>:
1.87      wiz      4340:     Primary location(s) for distribution patch files (see
                   4341:     <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
1.75      rillig   4342: </ul></div>
                   4343: <p>The third section contains the following variables.
1.87      wiz      4344:   </p>
1.75      rillig   4345: <div class="itemizedlist"><ul type="disc">
                   4346: <li><p><code class="varname">MAINTAINER</code> is the email address
1.87      wiz      4347:     of the person who feels responsible for this package, and who is
                   4348:     most likely to look at problems or questions regarding this
                   4349:     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
                   4350:     developers should contact the <code class="varname">MAINTAINER</code> before
                   4351:     making major changes to the package. When packaging a new program,
                   4352:     set <code class="varname">MAINTAINER</code> to yourself. If you really can't
                   4353:     maintain the package for future updates, set it to
                   4354:     <code class="email">&lt;<a href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>&gt;</code>.</p></li>
1.75      rillig   4355: <li><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87      wiz      4356:     find more information about the package.</p></li>
1.75      rillig   4357: <li><p><code class="varname">COMMENT</code> is a one-line
1.87      wiz      4358:     description of the package (should not include the package
                   4359:     name).</p></li>
1.75      rillig   4360: </ul></div>
                   4361: <p>Other variables that affect the build:
1.87      wiz      4362:   </p>
1.75      rillig   4363: <div class="itemizedlist"><ul type="disc"><li>
                   4364: <p><code class="varname">WRKSRC</code>: The directory where the
1.87      wiz      4365:       interesting distribution files of the package are found. The
                   4366:       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
                   4367:       works for most packages.</p>
1.75      rillig   4368: <p>If a package doesn't create a subdirectory for itself
1.87      wiz      4369:       (most GNU software does, for instance), but extracts itself in
                   4370:       the current directory, you should set
                   4371:       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
                   4372: <p>If a package doesn't create a subdirectory with the
                   4373:       name of <code class="varname">DISTNAME</code> but some different name,
                   4374:       set <code class="varname">WRKSRC</code> to point to the proper name in
                   4375:       <code class="filename">${WRKDIR}</code>, for example
                   4376:       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.91      rillig   4377:       <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   4378: <p>The name of the working directory created by pkgsrc is
1.87      wiz      4379:       taken from the <code class="varname">WRKDIR_BASENAME</code>
                   4380:       variable. By default, its value is
                   4381:       <code class="filename">work</code>. If you want to use the same
                   4382:       pkgsrc tree for building different kinds of binary packages,
                   4383:       you can change the variable according to your needs. Two
                   4384:       other variables handle common cases of setting
                   4385:       <code class="varname">WRKDIR_BASENAME</code> individually. If
                   4386:       <code class="varname">OBJHOSTNAME</code> is defined in
                   4387:       <code class="filename">/etc/mk.conf</code>, the first component of
                   4388:       the host's name is attached to the directory name. If
                   4389:       <code class="varname">OBJMACHINE</code> is defined, the platform name
                   4390:       is attached, which might look like
                   4391:       <code class="filename">work.i386</code> or
                   4392:       <code class="filename">work.sparc</code>.</p>
1.75      rillig   4393: </li></ul></div>
                   4394: <p>Please pay attention to the following gotchas:</p>
                   4395: <div class="itemizedlist"><ul type="disc">
1.87      wiz      4396: <li><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88      wiz      4397:       installed in compressed form by the package.  For packages using
                   4398:       BSD-style makefiles which honor MANZ, there is
                   4399:       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.76      rillig   4400: <li><p>Replace <code class="filename">/usr/local</code> with
1.88      wiz      4401:       &#8220;<span class="quote">${PREFIX}</span>&#8221; in all files (see patches,
                   4402:       below).</p></li>
1.90      rillig   4403: <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   4404: </ul></div>
                   4405: </div>
                   4406: <div class="sect1" lang="en">
                   4407: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   4408: <a name="components.distinfo"></a>10.2. <code class="filename">distinfo</code>
                   4409: </h2></div></div></div>
1.76      rillig   4410: <p>The <code class="filename">distinfo</code> file contains the message
1.87      wiz      4411:   digest, or checksum, of each distfile needed for the package. This
                   4412:   ensures that the distfiles retrieved from the Internet have not been
                   4413:   corrupted during transfer or altered by a malign force to introduce
                   4414:   a security hole. Due to recent rumor about weaknesses of digest
                   4415:   algorithms, all distfiles are protected using both SHA1 and RMD160
                   4416:   message digests, as well as the file size.</p>
1.76      rillig   4417: <p>The <code class="filename">distinfo</code> file also contains the
1.87      wiz      4418:   checksums for all the patches found in the
1.90      rillig   4419:   <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   4420: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.87      wiz      4421:   <span><strong class="command">make makedistinfo</strong></span> or <span><strong class="command">make mdi</strong></span>
                   4422:   command.</p>
1.75      rillig   4423: <p>Some packages have different sets of distfiles depending on
1.91      rillig   4424:   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      4425:   <code class="filename">distinfo</code> file and care should be taken when
                   4426:   upgrading such a package to ensure distfile information is not
                   4427:   lost.</p>
1.75      rillig   4428: </div>
                   4429: <div class="sect1" lang="en">
                   4430: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   4431: <a name="components.patches"></a>10.3. patches/*</h2></div></div></div>
1.93      rillig   4432: <p>Many packages still don't work out-of-the box on the various
                   4433:   platforms that are supported by pkgsrc. Therefore, a number of custom
                   4434:   patch files are needed to make the package work. These patch files are
                   4435:   found in the <code class="filename">patches/</code> directory.</p>
                   4436: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
                   4437:   applied to the files in <code class="varname">WRKSRC</code> directory after
                   4438:   extracting them, in <a href="http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_13_03" target="_top">alphabetic
                   4439:   order</a>, so <code class="filename">patch-aa</code> is applied before
1.87      wiz      4440:   <code class="filename">patch-ab</code>, etc.</p>
1.93      rillig   4441: <div class="sect2" lang="en">
                   4442: <div class="titlepage"><div><div><h3 class="title">
                   4443: <a name="components.patch.structure"></a>10.3.1. Structure of a single patch file</h3></div></div></div>
1.76      rillig   4444: <p>The <code class="filename">patch-*</code> files should be in
1.87      wiz      4445:   <span><strong class="command">diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93      rillig   4446:   problems. (To force patches to apply with fuzz you can set
                   4447:   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94      dmcmahil 4448:   should contain only changes for a single file, and no file should be
1.93      rillig   4449:   patched by more than one patch file. This helps to keep future
                   4450:   modifications simple.</p>
                   4451: <p>Each patch file is structured as follows: In the first line,
                   4452:   there is the RCS Id of the patch itself. The second line should be
                   4453:   empty for aesthetic reasons. After that, there should be a comment for
                   4454:   each change that the patch does. There are a number of standard
                   4455:   cases:</p>
                   4456: <div class="itemizedlist"><ul type="disc">
                   4457: <li><p>Patches that replace the <code class="literal">==</code>
                   4458:   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
                   4459:   should contain a reference to , to avoid
                   4460:   redundant explanations.</p></li>
                   4461: <li><p>Patches for commonly known vulnerabilities should
                   4462:   mention the vulnerability ID (CAN, CVE).</p></li>
                   4463: <li><p>Patches that change source code should mention the
                   4464:   platform and other environment (for example, the compiler) that the
                   4465:   patch is needed for.</p></li>
                   4466: </ul></div>
                   4467: <p>In all other cases, the patch should be commented so that any
                   4468:   developer who knows the code of the application can make some use of
                   4469:   the patch. Special care should be taken for the upstream developers,
                   4470:   since we generally want that they accept our patches, so we have less
                   4471:   work in the future.</p>
                   4472: </div>
                   4473: <div class="sect2" lang="en">
                   4474: <div class="titlepage"><div><div><h3 class="title">
                   4475: <a name="components.patches.caveats"></a>10.3.2. Creating patch files</h3></div></div></div>
                   4476: <p>One important thing to mention is to pay attention that no RCS
                   4477:   IDs get stored in the patch files, as these will cause problems when
1.87      wiz      4478:   later checked into the NetBSD CVS tree. Use the
1.93      rillig   4479:   <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
                   4480:   problems.</p>
1.87      wiz      4481: <p>For even more automation, we recommend using
                   4482:   <span><strong class="command">mkpatches</strong></span> from the same package to make a
                   4483:   whole set of patches. You just have to backup files before you
                   4484:   edit them to <code class="filename">filename.orig</code>, e.g. with
                   4485:   <span><strong class="command">cp -p filename filename.orig</strong></span> or, easier, by
                   4486:   using <span><strong class="command">pkgvi</strong></span> again from the same package. If
                   4487:   you upgrade a package this way, you can easily compare the new
                   4488:   set of patches with the previously existing one with
                   4489:   <span><strong class="command">patchdiff</strong></span>. Copy the patches you want to use
                   4490:   or update from the <code class="filename">work/.newpatches</code>
                   4491:   directory to <code class="filename">patches/</code>.</p>
                   4492: <p>When you have finished a package, remember to generate
                   4493:   the checksums for the patch files by using the <span><strong class="command">make
1.90      rillig   4494:   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      4495: <p>When adding a patch that corrects a problem in the
                   4496:   distfile (rather than e.g. enforcing pkgsrc's view of where
                   4497:   man pages should go), send the patch as a bug report to the
                   4498:   maintainer.  This benefits non-pkgsrc users of the package,
                   4499:   and usually makes it possible to remove the patch in future
                   4500:   version.</p>
1.93      rillig   4501: </div>
                   4502: <div class="sect2" lang="en">
                   4503: <div class="titlepage"><div><div><h3 class="title">
                   4504: <a name="components.patches.sources"></a>10.3.3. Sources where the patch files come from</h3></div></div></div>
1.87      wiz      4505: <p>If you want to share patches between multiple packages
                   4506:   in pkgsrc, e.g. because they use the same distfiles, set
                   4507:   <code class="varname">PATCHDIR</code> to the path where the patch files
                   4508:   can be found, e.g.:</p>
                   4509: <pre class="programlisting">
1.100   ! rillig   4510: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93      rillig   4511: </pre>
1.75      rillig   4512: <p>Patch files that are distributed by the author or other
1.87      wiz      4513:     maintainers can be listed in
                   4514:     <code class="varname">PATCHFILES</code>.</p>
                   4515: <p>If it is desired to store any patches that should not be
                   4516:     committed into pkgsrc, they can be kept outside the pkgsrc
                   4517:     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
                   4518:     directory tree there is expected to have the same
                   4519:     &#8220;<span class="quote">category/package</span>&#8221; structure as pkgsrc, and
                   4520:     patches are expected to be stored inside these dirs (also
                   4521:     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
                   4522:     example, if you want to keep a private patch for
                   4523:     <code class="filename">pkgsrc/graphics/png</code>, keep it in
                   4524:     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
                   4525:     files in the named directory are expected to be patch files,
                   4526:     and <span class="emphasis"><em>they are applied after pkgsrc patches are
                   4527:     applied</em></span>.</p>
1.93      rillig   4528: </div>
1.85      jmmv     4529: <div class="sect2" lang="en">
                   4530: <div class="titlepage"><div><div><h3 class="title">
1.93      rillig   4531: <a name="components.patches.guidelines"></a>10.3.4. Patching guidelines</h3></div></div></div>
1.85      jmmv     4532: <p>When fixing a portability issue in the code do not use
                   4533:       preprocessor magic to check for the current operating system nor
                   4534:       platform.  Doing so hurts portability to other platforms because
                   4535:       the OS-specific details are not abstracted appropriately.</p>
                   4536: <p>The general rule to follow is: instead of checking for the
                   4537:       operating system the application is being built on, check for the
                   4538:       specific <span class="emphasis"><em>features</em></span> you need.  For example,
                   4539:       instead of assuming that kqueue is available under NetBSD and
                   4540:       using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.89      rillig   4541:       kqueue support, add a check that detects kqueue itself &mdash;
1.85      jmmv     4542:       yes, this generally involves patching the
                   4543:       <span><strong class="command">configure</strong></span> script.  There is absolutely nothing
                   4544:       that prevents some OSes from adopting interfaces from other OSes
                   4545:       (e.g. Linux implementing kqueue), something that the above checks
                   4546:       cannot take into account.</p>
                   4547: <p>Of course, checking for features generally involves more
                   4548:       work on the developer's side, but the resulting changes are
1.87      wiz      4549:       cleaner and there are chances they will work on many other
1.85      jmmv     4550:       platforms.  Not to mention that there are higher chances of being
                   4551:       later integrated into the mainstream sources.  Remember:
                   4552:       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
                   4553: <p>Some typical examples:</p>
                   4554: <div class="table">
1.90      rillig   4555: <a name="patch-examples"></a><p class="title"><b>Table 10.1. Patching examples</b></p>
1.91      rillig   4556: <div class="table-contents"><table summary="Patching examples" border="1">
1.85      jmmv     4557: <colgroup>
                   4558: <col>
                   4559: <col>
                   4560: <col>
                   4561: </colgroup>
                   4562: <thead><tr>
                   4563: <th>Where</th>
                   4564: <th>Incorrect</th>
                   4565: <th>Correct</th>
                   4566: </tr></thead>
                   4567: <tbody>
                   4568: <tr>
                   4569: <td>configure script</td>
                   4570: <td>
1.100   ! rillig   4571: <pre class="programlisting">
        !          4572: case ${target_os} in
        !          4573: netbsd*) have_kvm=yes ;;
        !          4574: *)       have_kvm=no  ;;
        !          4575: esac
        !          4576: </pre>
1.85      jmmv     4577:              </td>
                   4578: <td>
1.100   ! rillig   4579: <pre class="programlisting">
        !          4580: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
        !          4581: </pre>
1.85      jmmv     4582:              </td>
                   4583: </tr>
                   4584: <tr>
                   4585: <td>C source file</td>
                   4586: <td>
1.100   ! rillig   4587: <pre class="programlisting">
        !          4588: #if defined(__NetBSD__)
        !          4589: #  include &lt;sys/event.h&gt;
        !          4590: #endif
        !          4591: </pre>
1.85      jmmv     4592:              </td>
                   4593: <td>
1.100   ! rillig   4594: <pre class="programlisting">
        !          4595: #if defined(HAVE_SYS_EVENT_H)
        !          4596: #  include &lt;sys/event.h&gt;
        !          4597: #endif
        !          4598: </pre>
1.85      jmmv     4599:              </td>
                   4600: </tr>
                   4601: <tr>
                   4602: <td>C source file</td>
                   4603: <td>
1.100   ! rillig   4604: <pre class="programlisting">
        !          4605: int
        !          4606: monitor_file(...)
        !          4607: {
        !          4608: #if defined(__NetBSD__)
        !          4609:         int fd = kqueue();
        !          4610:         ...
        !          4611: #else
        !          4612:         ...
        !          4613: #endif
        !          4614: }
        !          4615: </pre>
1.85      jmmv     4616:              </td>
                   4617: <td>
1.100   ! rillig   4618: <pre class="programlisting">
        !          4619: int
        !          4620: monitor_file(...)
        !          4621: {
        !          4622: #if defined(HAVE_KQUEUE)
        !          4623:         int fd = kqueue();
        !          4624:         ...
        !          4625: #else
        !          4626:        ...
        !          4627: #endif
        !          4628: }
        !          4629: </pre>
1.85      jmmv     4630:              </td>
                   4631: </tr>
                   4632: </tbody>
1.91      rillig   4633: </table></div>
1.85      jmmv     4634: </div>
1.91      rillig   4635: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.85      jmmv     4636:       packager-friendly software</em></span> article (<a href="http://www.onlamp.com/pub/a/onlamp/2005/03/31/packaging.html" target="_top">part
                   4637:       1</a>, <a href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
                   4638:       2</a>).  It summarizes multiple details on how to make
                   4639:       software easier to package; all the suggestions in it were
                   4640:       collected from our experience in pkgsrc work, so they are possibly
                   4641:       helpful when creating patches too.</p>
                   4642: </div>
                   4643: <div class="sect2" lang="en">
                   4644: <div class="titlepage"><div><div><h3 class="title">
1.93      rillig   4645: <a name="components.patches.feedback"></a>10.3.5. Feedback to the author</h3></div></div></div>
1.85      jmmv     4646: <p>Always, always, <span class="strong"><strong>always</strong></span>
                   4647:       feed back any <span class="emphasis"><em>portability fixes</em></span> or
                   4648:       improvements you do to a package to the mainstream developers.
                   4649:       This is the only way to get their attention on portability issues
                   4650:       and to ensure that future versions can be built out-of-the box on
                   4651:       NetBSD.  Furthermore, any user that gets newer distfiles will get
                   4652:       the fixes straight from the packaged code.</p>
1.93      rillig   4653: <p>This generally involves cleaning up the patches
                   4654:       (because sometimes the patches that are
1.85      jmmv     4655:       added to pkgsrc are quick hacks), filling bug reports in the
                   4656:       appropriate trackers for the projects and working with the
                   4657:       mainstream authors to accept your changes.  It is
                   4658:       <span class="emphasis"><em>extremely important</em></span> that you do it so that
                   4659:       the packages in pkgsrc are kept simple and thus further changes
                   4660:       can be done without much hassle.</p>
                   4661: <p>Support the idea of free software!</p>
                   4662: </div>
1.75      rillig   4663: </div>
                   4664: <div class="sect1" lang="en">
                   4665: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   4666: <a name="other-mandatory-files"></a>10.4. Other mandatory files</h2></div></div></div>
1.75      rillig   4667: <div class="variablelist"><dl>
1.76      rillig   4668: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75      rillig   4669: <dd><p>A multi-line description of the piece of software.  This should include
1.87      wiz      4670:          any credits where they are due.  Please bear in mind that others do not
                   4671:          share your sense of humour (or spelling idiosyncrasies), and that others
                   4672:          will read everything that you write here.</p></dd>
1.76      rillig   4673: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87      wiz      4674: <dd><p>This file governs the files that are installed on your
                   4675:          system: all the binaries, manual pages, etc. There are other
                   4676:          directives which may be entered in this file, to control the
                   4677:          creation and deletion of directories, and the location of
1.90      rillig   4678:          inserted files.  See <a href="#plist" title="Chapter 12. PLIST issues">Chapter 12, <i>PLIST issues</i></a> for more
1.87      wiz      4679:          information.</p></dd>
1.75      rillig   4680: </dl></div>
                   4681: </div>
                   4682: <div class="sect1" lang="en">
                   4683: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   4684: <a name="components.optional"></a>10.5. Optional files</h2></div></div></div>
1.78      rillig   4685: <div class="sect2" lang="en">
                   4686: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   4687: <a name="components.optional.bin"></a>10.5.1. Files affecting the binary package</h3></div></div></div>
1.75      rillig   4688: <div class="variablelist"><dl>
1.76      rillig   4689: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.75      rillig   4690: <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      4691:            First time after package extraction and before files are
                   4692:            moved in place, the second time after the files to install
                   4693:            are moved in place. This can be used to do any custom
                   4694:            procedures not possible with @exec commands in
                   4695:            <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   4696:            <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   4697: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75      rillig   4698: <dd><p>This script is executed before and after any files are removed.  It is
1.87      wiz      4699:            this script's responsibility to clean up any additional messy details
                   4700:            around the package's installation, since all pkg_delete knows is how to
                   4701:            delete the files created in the original distribution.
                   4702:            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>
                   4703:            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   4704: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75      rillig   4705: <dd>
                   4706: <p>This file is displayed after installation of the package.
1.87      wiz      4707:            Useful for things like legal notices on almost-free
                   4708:            software and hints for updating config files after
                   4709:            installing modules for apache, PHP etc.
                   4710:            Please note that you can modify variables in it easily by using
                   4711:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   4712:            <code class="filename">Makefile</code>:</p>
1.75      rillig   4713: <pre class="programlisting">
1.100   ! rillig   4714: MESSAGE_SUBST+=  SOMEVAR="somevalue"
        !          4715: </pre>
1.75      rillig   4716: <p>replaces "${SOMEVAR}" with &#8220;<span class="quote">somevalue</span>&#8221; in
1.87      wiz      4717:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   4718:            performed for <code class="varname">PKGNAME</code>,
                   4719:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
                   4720:            <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
                   4721:            <code class="varname">X11BASE</code>,
                   4722:            <code class="varname">PKG_SYSCONFDIR</code>,
                   4723:            <code class="varname">ROOT_GROUP</code>, and
                   4724:            <code class="varname">ROOT_GROUP</code>.</p>
                   4725: <p>You can display a different or additional files by
                   4726:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   4727:            default is <code class="filename">MESSAGE</code>, if the file
                   4728:            exists.</p>
1.75      rillig   4729: </dd>
1.78      rillig   4730: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
                   4731: <dd><p>FIXME: There is no documentation on the
                   4732:        alternatives framework.</p></dd>
                   4733: </dl></div>
                   4734: </div>
                   4735: <div class="sect2" lang="en">
                   4736: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   4737: <a name="components.optional.build"></a>10.5.2. Files affecting the build process</h3></div></div></div>
1.78      rillig   4738: <div class="variablelist"><dl>
                   4739: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   4740: <dd><p>This file contains arbitrary things that could
                   4741:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   4742:        to be used by more than one package. This file should only be
                   4743:        used when the packages that will use the file are known in
                   4744:        advance. For other purposes it is often better to write a
                   4745:        <code class="filename">*.mk</code> file and give it a good name that
                   4746:        describes what it does.</p></dd>
                   4747: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   4748: <dd><p>This file contains the dependency information
1.90      rillig   4749:        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   4750: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   4751: <dd><p>This file contains workarounds for compiler bugs
                   4752:        and similar things. It is included automatically by the pkgsrc
                   4753:        infrastructure, so you don't need an extra
                   4754:        <code class="literal">.include</code> line for
                   4755:        it.</p></dd>
                   4756: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   4757: <dd><p>This file contains the code for the
1.90      rillig   4758:        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   4759:        selected by the user. If a package has only one or two options,
                   4760:        it is equally acceptable to put the code directly into the
                   4761:        <code class="filename">Makefile</code>.</p></dd>
                   4762: </dl></div>
                   4763: </div>
                   4764: <div class="sect2" lang="en">
                   4765: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   4766: <a name="components.optional.none"></a>10.5.3. Files affecting nothing at all</h3></div></div></div>
1.78      rillig   4767: <div class="variablelist"><dl>
                   4768: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   4769: <dd><p>These files do not take place in the creation of
                   4770:        a package and thus are purely informative to the package
                   4771:        developer.</p></dd>
                   4772: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   4773: <dd><p>This file contains things that need to be done
                   4774:        to make the package even
                   4775:        better.</p></dd>
1.75      rillig   4776: </dl></div>
                   4777: </div>
1.78      rillig   4778: </div>
1.75      rillig   4779: <div class="sect1" lang="en">
                   4780: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   4781: <a name="work-dir"></a>10.6. <code class="filename">work*</code>
                   4782: </h2></div></div></div>
1.75      rillig   4783: <p>When you type <span><strong class="command">make</strong></span>, the distribution files are
1.87      wiz      4784:     unpacked into the directory denoted by
                   4785:     <code class="varname">WRKDIR</code>. It can be removed by running
                   4786:     <span><strong class="command">make clean</strong></span>. Besides the sources, this
                   4787:     directory is also used to keep various timestamp files.
                   4788:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   4789:     The default is <code class="filename">${.CURDIR}/work</code>
                   4790:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   4791:     if <code class="varname">OBJMACHINE</code> is set.</p>
1.75      rillig   4792: </div>
                   4793: <div class="sect1" lang="en">
                   4794: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   4795: <a name="files-dir"></a>10.7. <code class="filename">files/*</code>
                   4796: </h2></div></div></div>
1.75      rillig   4797: <p>If you have any files that you wish to be placed in the package prior
1.87      wiz      4798:     to configuration or building, you could place these files here and use
                   4799:     a <span><strong class="command">${CP}</strong></span> command in the
                   4800:     &#8220;<span class="quote">pre-configure</span>&#8221; target to achieve
                   4801:     this. Alternatively, you could simply diff the file against
                   4802:     <code class="filename">/dev/null</code> and use the patch mechanism to manage
                   4803:     the creation of this file.</p>
                   4804: <p>If you want to share files in this way with other
                   4805:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   4806:     to the other package's <code class="filename">files</code> directory,
                   4807:     e.g.:</p>
                   4808: <pre class="programlisting">
1.100   ! rillig   4809: FILESDIR=${.CURDIR}/../xemacs/files
        !          4810: </pre>
1.75      rillig   4811: </div>
                   4812: </div>
                   4813: <div class="chapter" lang="en">
                   4814: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   4815: <a name="makefile"></a>Chapter 11. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75      rillig   4816: <div class="toc">
                   4817: <p><b>Table of Contents</b></p>
                   4818: <dl>
1.97      rillig   4819: <dt><span class="sect1"><a href="#makefile.style">11.1. Caveats</a></span></dt>
                   4820: <dt><span class="sect1"><a href="#makefile.variables">11.2. <code class="filename">Makefile</code> variables</a></span></dt>
                   4821: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">11.2.1. Naming conventions</a></span></dt></dl></dd>
                   4822: <dt><span class="sect1"><a href="#makefile.code">11.3. Code snippets</a></span></dt>
                   4823: <dd><dl>
                   4824: <dt><span class="sect2"><a href="#adding-to-list">11.3.1. Adding things to a list</a></span></dt>
                   4825: <dt><span class="sect2"><a href="#converting-internal-to-external">11.3.2. Converting an internal list into an external list</a></span></dt>
                   4826: <dt><span class="sect2"><a href="#passing-variable-to-shell">11.3.3. Passing variables to a shell command</a></span></dt>
                   4827: <dt><span class="sect2"><a href="#quoting-guideline">11.3.4. Quoting guideline</a></span></dt>
                   4828: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">11.3.5. Workaround for a bug in BSD Make</a></span></dt>
1.75      rillig   4829: </dl></dd>
                   4830: </dl>
                   4831: </div>
1.76      rillig   4832: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75      rillig   4833:   each of which forms a well-defined part of the pkgsrc system. Using
                   4834:   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
                   4835:   like pkgsrc requires some discipline to keep the code correct and
                   4836:   understandable.</p>
1.76      rillig   4837: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75      rillig   4838:   programming are variables (which are actually macros) and shell
                   4839:   commands. Among these shell commands may even be more complex ones
                   4840:   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
                   4841:   as intended it is necessary to quote all variables correctly when they
                   4842:   are used.</p>
                   4843: <p>This chapter describes some patterns, that appear quite often in
1.76      rillig   4844:   <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75      rillig   4845:   with them.</p>
                   4846: <div class="sect1" lang="en">
                   4847: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.97      rillig   4848: <a name="makefile.style"></a>11.1. Caveats</h2></div></div></div>
                   4849: <div class="itemizedlist"><ul type="disc"><li>
                   4850: <p>When you are creating a file as a
                   4851:     target of a rule, always write the data to a temporary file first
                   4852:     and finally rename that file. Otherwise there might occur an error
                   4853:     in the middle of generating the file, and when the user runs
                   4854:     <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
                   4855:     regenerated properly. Example:</p>
                   4856: <pre class="programlisting">
1.100   ! rillig   4857: wrong:
        !          4858:         @echo "line 1" &gt; ${.TARGET}
        !          4859:         @echo "line 2" &gt;&gt; ${.TARGET}
        !          4860:         @false
        !          4861: 
        !          4862: correct:
        !          4863:         @echo "line 1" &gt; ${.TARGET}.tmp
        !          4864:         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
        !          4865:         @false
        !          4866:         @mv ${.TARGET}.tmp ${.TARGET}
1.97      rillig   4867: </pre>
                   4868: <p>When you run <span><strong class="command">make wrong</strong></span> twice, the file
                   4869:     <code class="filename">wrong</code> will exist, although there was an error
                   4870:     message in the first run. On the other hand, running <span><strong class="command">make
                   4871:     correct</strong></span> gives an error message twice, as expected.</p>
                   4872: <p>You might remember that <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
                   4873:     <code class="literal">${.TARGET}</code> in case of error, but this only
                   4874:     happens when it is interrupted, for example by pressing
                   4875:     <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
                   4876:     when one of the commands fails (like <a href="http://netbsd.gw.com/cgi-bin/man-cgi?false+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
                   4877: </li></ul></div>
                   4878: </div>
                   4879: <div class="sect1" lang="en">
                   4880: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4881: <a name="makefile.variables"></a>11.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76      rillig   4882: <p><code class="filename">Makefile</code> variables contain strings that
1.75      rillig   4883:     can be processed using the five operators ``='', ``+='', ``?='',
                   4884:     ``:='', 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
                   4885:     page.</p>
                   4886: <p>When a variable's value is parsed from a
1.76      rillig   4887:     <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75      rillig   4888:     backslash character ``\'' are handled specially. If a backslash is
                   4889:     followed by a newline, any whitespace immediately in front of the
                   4890:     backslash, the backslash, the newline, and any whitespace
                   4891:     immediately behind the newline are replaced with a single space. A
                   4892:     backslash character and an immediately following hash character are
                   4893:     replaced with a single hash character. Otherwise, the backslash is
                   4894:     passed as is. In a variable assignment, any hash character that is
                   4895:     not preceded by a backslash starts a comment that continues upto the
                   4896:     end of the logical line.</p>
                   4897: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
                   4898:     the only way to create a variable consisting of a single backslash
                   4899:     is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
                   4900: <p>So far for defining variables. The other thing you can do with
                   4901:     variables is evaluating them. A variable is evaluated when it is
                   4902:     part of the right side of the ``:='' or the ``!='' operator, or
                   4903:     directly before executing a shell command which the variable is part
                   4904:     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
                   4905:     is, variables are not evaluated until there's no other way. The
                   4906:     ``modifiers'' mentioned in the man page also evaluate the
                   4907:     variable.</p>
                   4908: <p>Some of the modifiers split the string into words and then
                   4909:     operate on the words, others operate on the string as a whole. When
                   4910:     a string is split into words, it is split as you would expect
                   4911:     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   4912: <p>No rule without exception&mdash;the <span><strong class="command">.for</strong></span>
1.75      rillig   4913:     loop does not follow the shell quoting rules but splits at sequences
                   4914:     of whitespace.</p>
                   4915: <p>There are several types of variables that should be handled
                   4916:     differently. Strings and two types of lists.</p>
                   4917: <div class="itemizedlist"><ul type="disc">
                   4918: <li><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
                   4919:       characters. Nevertheless, you should restrict yourself to only
                   4920:       using printable characters. Examples are
                   4921:       <code class="varname">PREFIX</code> and
                   4922:       <code class="varname">COMMENT</code>.</p></li>
                   4923: <li><p><span class="emphasis"><em>Internal lists</em></span> are lists that
                   4924:       are never exported to any shell command. Their elements are
                   4925:       separated by whitespace. Therefore, the elements themselves cannot
                   4926:       have embedded whitespace. Any other characters are allowed.
                   4927:       Internal lists can be used in <span><strong class="command">.for</strong></span> loops.
                   4928:       Examples are <code class="varname">DEPENDS</code> and
                   4929:       <code class="varname">BUILD_DEPENDS</code>.</p></li>
                   4930: <li><p><span class="emphasis"><em>External lists</em></span> are lists that
                   4931:       may be exported to a shell command. Their elements can contain any
                   4932:       characters, including whitespace. That's why they cannot be used
                   4933:       in <span><strong class="command">.for</strong></span> loops. Examples are
                   4934:       <code class="varname">DISTFILES</code> and
                   4935:       <code class="varname">MASTER_SITES</code>.</p></li>
                   4936: </ul></div>
                   4937: <div class="sect2" lang="en">
                   4938: <div class="titlepage"><div><div><h3 class="title">
1.97      rillig   4939: <a name="makefile.variables.names"></a>11.2.1. Naming conventions</h3></div></div></div>
1.75      rillig   4940: <div class="itemizedlist"><ul type="disc">
                   4941: <li><p>All variable names starting with an underscore
                   4942:        are reserved for use by the pkgsrc infrastructure. They shall
                   4943:        not be used by package
1.76      rillig   4944:        <code class="filename">Makefile</code>s.</p></li>
1.75      rillig   4945: <li><p>In <span><strong class="command">.for</strong></span> loops you should use
                   4946:        lowercase variable names for the iteration
                   4947:        variables.</p></li>
                   4948: <li><p>All list variables should have a ``plural''
                   4949:        name, e.g. <code class="varname">PKG_OPTIONS</code> or
                   4950:        <code class="varname">DISTFILES</code>.</p></li>
                   4951: </ul></div>
                   4952: </div>
                   4953: </div>
                   4954: <div class="sect1" lang="en">
                   4955: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.97      rillig   4956: <a name="makefile.code"></a>11.3. Code snippets</h2></div></div></div>
1.75      rillig   4957: <p>This section presents you with some code snippets you should
                   4958:     use in your own code. If you don't find anything appropriate here,
                   4959:     you should test your code and add it here.</p>
                   4960: <div class="sect2" lang="en">
                   4961: <div class="titlepage"><div><div><h3 class="title">
1.97      rillig   4962: <a name="adding-to-list"></a>11.3.1. Adding things to a list</h3></div></div></div>
1.75      rillig   4963: <pre class="programlisting">
1.100   ! rillig   4964: STRING=                 foo * bar `date`
        !          4965: INT_LIST=               # empty
        !          4966: ANOTHER_INT_LIST=       apache-[0-9]*:../../www/apache
        !          4967: EXT_LIST=               # empty
        !          4968: ANOTHER_EXT_LIST=       a=b c=d
        !          4969: 
        !          4970: INT_LIST+=              ${STRING}               # 1
        !          4971: INT_LIST+=              ${ANOTHER_INT_LIST}     # 2
        !          4972: EXT_LIST+=              ${STRING:Q}             # 3
        !          4973: EXT_LIST+=              ${ANOTHER_EXT_LIST}     # 4
1.1       grant    4974: </pre>
1.75      rillig   4975: <p>When you add a string to an external list (example 3), it
                   4976:       must be quoted. In all other cases, you must not add a quoting
                   4977:       level. You must not merge internal and external lists, unless you
                   4978:       are sure that all entries are correctly interpreted in both
                   4979:       lists.</p>
                   4980: </div>
                   4981: <div class="sect2" lang="en">
                   4982: <div class="titlepage"><div><div><h3 class="title">
1.97      rillig   4983: <a name="converting-internal-to-external"></a>11.3.2. Converting an internal list into an external list</h3></div></div></div>
1.75      rillig   4984: <pre class="programlisting">
1.100   ! rillig   4985: EXT_LIST=       # empty
        !          4986: .for i in ${INT_LIST}
        !          4987: EXT_LIST+=      ${i:Q}""
        !          4988: .endfor
1.1       grant    4989: </pre>
1.75      rillig   4990: <p>This code converts the internal list
                   4991:       <code class="varname">INT_LIST</code> into the external list
                   4992:       <code class="varname">EXT_LIST</code>. As the elements of an internal list
                   4993:       are unquoted they must be quoted here. The reason for appending
                   4994:       <code class="varname">""</code> is explained below.</p>
                   4995: </div>
                   4996: <div class="sect2" lang="en">
                   4997: <div class="titlepage"><div><div><h3 class="title">
1.97      rillig   4998: <a name="passing-variable-to-shell"></a>11.3.3. Passing variables to a shell command</h3></div></div></div>
1.79      rillig   4999: <p>Sometimes you may want to print an arbitrary string. There
                   5000:        are many ways to get it wrong and only few that can handle every
                   5001:        nastiness.</p>
1.75      rillig   5002: <pre class="programlisting">
1.100   ! rillig   5003: STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
        !          5004: EXT_LIST=       string=${STRING:Q} x=second\ item
1.1       grant    5005: 
1.100   ! rillig   5006: all:
        !          5007:         echo ${STRING}                  # 1
        !          5008:         echo "${STRING}"                # 2
        !          5009:         echo "${STRING:Q}"              # 3
        !          5010:         echo ${STRING:Q}                # 4
        !          5011:         echo x${STRING:Q} | sed 1s,.,,  # 5
        !          5012:         printf "%s\\n" ${STRING:Q}""    # 6
        !          5013:         env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
1.1       grant    5014: </pre>
1.75      rillig   5015: <p>Example 1 leads to a syntax error in the shell, as the
                   5016:       characters are just copied.</p>
                   5017: <p>Example 2 leads to a syntax error too, and if you leave out
                   5018:       the last " character from <code class="varname">${STRING}</code>,
                   5019:       <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
                   5020:       variable would be evaluated, too.</p>
                   5021: <p>Example 3 outputs each space character preceded by a
                   5022:       backslash (or not), depending on the implementation of the
                   5023:       <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>
                   5024: <p>Example 4 handles correctly every string that does not start
                   5025:       with a dash. In that case, the result depends on the
                   5026:       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
                   5027:       guarantee that your input does not start with a dash, this form is
                   5028:       appropriate.</p>
                   5029: <p>Example 5 handles even the case of a leading dash
                   5030:       correctly.</p>
1.79      rillig   5031: <p>Example 6 also works with every string and is the
                   5032:       light-weight solution, since it does not involve a pipe, which has
                   5033:       its own problems.</p>
1.75      rillig   5034: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
                   5035:       because the quoting has already been done when adding elements to
                   5036:       the list.</p>
                   5037: <p>As internal lists shall not be passed to the shell, there is
                   5038:       no example for it.</p>
                   5039: </div>
                   5040: <div class="sect2" lang="en">
                   5041: <div class="titlepage"><div><div><h3 class="title">
1.97      rillig   5042: <a name="quoting-guideline"></a>11.3.4. Quoting guideline</h3></div></div></div>
1.75      rillig   5043: <p>There are many possible sources of wrongly quoted variables.
                   5044:       This section lists some of the commonly known ones.</p>
                   5045: <div class="itemizedlist"><ul type="disc">
                   5046: <li>
                   5047: <p>Whenever you use the value of a list, think
                   5048:        about what happens to leading or trailing whitespace. If the
                   5049:        list is a well-formed shell expression, you can apply the
                   5050:        <code class="varname">:M*</code> modifier to strip leading and trailing
                   5051:        whitespace from each word. The <code class="varname">:M</code> operator
                   5052:        first splits its argument according to the rules of the shell,
                   5053:        and then creates a new list consisting of all words that match
                   5054:        the shell glob expression <code class="varname">*</code>, that is: all.
                   5055:        One class of situations where this is needed is when adding a
                   5056:        variable like <code class="varname">CPPFLAGS</code> to
                   5057:        <code class="varname">CONFIGURE_ARGS</code>. If the configure script
                   5058:        invokes other configure scripts, it strips the leading and
                   5059:        trailing whitespace from the variable and then passes it to the
                   5060:        other configure scripts. But these configure scripts expect the
                   5061:        (child) <code class="varname">CPPFLAGS</code> variable to be the same as
                   5062:        the parent <code class="varname">CPPFLAGS</code>. That's why we better
                   5063:        pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
                   5064:        here is how we do it:</p>
                   5065: <pre class="programlisting">
1.100   ! rillig   5066: CPPFLAGS=               # empty
        !          5067: CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX:Q}\"
        !          5068: CPPFLAGS+=              ${MY_CPPFLAGS}
        !          5069: 
        !          5070: CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
        !          5071: 
        !          5072: all:
        !          5073:         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
        !          5074:         echo x${CONFIGURE_ARGS}x        # properly trimmed
1.1       grant    5075: </pre>
1.75      rillig   5076: </li>
                   5077: <li><p>The example above contains one bug: The
                   5078:        <code class="varname">${PREFIX}</code> is a properly quoted shell
                   5079:        expression, but there is the C compiler after it, which also
                   5080:        expects a properly quoted string (this time in C syntax). The
                   5081:        version above is therefore only correct if
                   5082:        <code class="varname">${PREFIX}</code> does not have embedded backslashes
                   5083:        or double quotes. If you want to allow these, you have to add
                   5084:        another layer of quoting to each variable that is used as a C
                   5085:        string literal. You cannot use the <code class="varname">:Q</code>
                   5086:        operator for it, as this operator only works for the
                   5087:        shell.</p></li>
                   5088: <li>
                   5089: <p>Whenever a variable can be empty, the
                   5090:        <code class="varname">:Q</code> operator can have surprising results. Here
                   5091:        are two completely different cases which can be solved with the
                   5092:        same trick.</p>
                   5093: <pre class="programlisting">
1.100   ! rillig   5094: EMPTY=                  # empty
        !          5095: empty_test:
        !          5096:         for i in a ${EMPTY:Q} c; do \
        !          5097:             echo "$$i"; \
        !          5098:         done
        !          5099: 
        !          5100: for_test:
        !          5101: .for i in a:\ a:\test.txt
        !          5102:         echo ${i:Q}
        !          5103:         echo "foo"
        !          5104: .endfor
1.1       grant    5105: </pre>
1.75      rillig   5106: <p>The first example will only print two of the three lines
                   5107:        we might have expected. This is because
                   5108:        <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
                   5109:        the shell cannot see. The workaround is to write
                   5110:        <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
                   5111:        as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
                   5112:        -f ${FNAME:Q}</code> (both of these are wrong).</p>
                   5113: <p>The second example will only print three lines instead of
                   5114:        four. The first line looks like <code class="varname">a:\ echo foo</code>.
                   5115:        This is because the backslash of the value
                   5116:        <code class="varname">a:\</code> is interpreted as a line-continuation by
                   5117:        <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
                   5118:        <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
                   5119:        <code class="varname">${i:Q}""</code>.</p>
                   5120: </li>
                   5121: </ul></div>
                   5122: </div>
                   5123: <div class="sect2" lang="en">
                   5124: <div class="titlepage"><div><div><h3 class="title">
1.97      rillig   5125: <a name="bsd-make-bug-workaround"></a>11.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.75      rillig   5126: <p>The pkgsrc bmake program does not handle the following
                   5127:       assignment correctly. In case <code class="varname">_othervar_</code>
                   5128:       contains a ``-'' character, one of the closing braces is included
                   5129:       in <code class="varname">${VAR}</code> after this code executes.</p>
                   5130: <pre class="programlisting">
1.100   ! rillig   5131: VAR:=   ${VAR:N${_othervar_:C/-//}}
1.1       grant    5132: </pre>
1.75      rillig   5133: <p>For a more complex code snippet and a workaround, see the
1.91      rillig   5134:       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   5135:       <code class="varname">bug1</code>.</p>
                   5136: </div>
                   5137: </div>
                   5138: </div>
                   5139: <div class="chapter" lang="en">
                   5140: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   5141: <a name="plist"></a>Chapter 12. PLIST issues</h2></div></div></div>
1.75      rillig   5142: <div class="toc">
                   5143: <p><b>Table of Contents</b></p>
                   5144: <dl>
1.90      rillig   5145: <dt><span class="sect1"><a href="#rcs-id">12.1. RCS ID</a></span></dt>
                   5146: <dt><span class="sect1"><a href="#automatic-plist-generation">12.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   5147: <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>
                   5148: <dt><span class="sect1"><a href="#plist.misc">12.4. Variable substitution in PLIST</a></span></dt>
                   5149: <dt><span class="sect1"><a href="#manpage-compression">12.5. Man page compression</a></span></dt>
                   5150: <dt><span class="sect1"><a href="#using-PLIST_SRC">12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   5151: <dt><span class="sect1"><a href="#platform-specific-plist">12.7. Platform-specific and differing PLISTs</a></span></dt>
                   5152: <dt><span class="sect1"><a href="#faq.common-dirs">12.8. Sharing directories between packages</a></span></dt>
1.75      rillig   5153: </dl>
                   5154: </div>
1.87      wiz      5155: <p>The <code class="filename">PLIST</code> file contains a package's
                   5156:   &#8220;<span class="quote">packing list</span>&#8221;, i.e. a list of files that belong to
                   5157:   the package (relative to the <code class="filename">${PREFIX}</code>
                   5158:   directory it's been installed in) plus some additional statements
                   5159:   - 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.
                   5160:   This chapter addresses some issues that need attention when
                   5161:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   5162:   below!).</p>
1.75      rillig   5163: <div class="sect1" lang="en">
                   5164: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5165: <a name="rcs-id"></a>12.1. RCS ID</h2></div></div></div>
1.87      wiz      5166: <p>Be sure to add a RCS ID line as the first thing in any
                   5167:     <code class="filename">PLIST</code> file you write:</p>
1.75      rillig   5168: <pre class="programlisting">
1.100   ! rillig   5169: @comment $NetBSD$
1.87      wiz      5170:     </pre>
1.75      rillig   5171: </div>
                   5172: <div class="sect1" lang="en">
                   5173: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5174: <a name="automatic-plist-generation"></a>12.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.75      rillig   5175: <p>You can use the <span><strong class="command">make print-PLIST</strong></span> command
1.87      wiz      5176:     to output a PLIST that matches any new files since the package
1.90      rillig   5177:     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      5178:     more information on this target.</p>
1.75      rillig   5179: </div>
                   5180: <div class="sect1" lang="en">
                   5181: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   5182: <a name="print-PLIST"></a>12.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span>
                   5183: </h2></div></div></div>
1.87      wiz      5184: <p>If you have used any of the *-dirs packages, as explained in
1.90      rillig   5185:     <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      5186:     <span><strong class="command">make print-PLIST</strong></span> outputs a set of
                   5187:     <code class="varname">@comment</code>s instead of real
                   5188:     <code class="varname">@dirrm</code> lines.  You can also do this for
                   5189:     specific directories and files, so that the results of that
                   5190:     command are very close to reality. This helps <span class="emphasis"><em>a
                   5191:     lot</em></span> during the update of packages.</p>
                   5192: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   5193:     of AWK patterns and actions that are used to filter the output of
                   5194:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   5195:     scripting you like to it, but be careful with quoting.</p>
                   5196: <p>For example, to get all files inside the
                   5197:     <code class="filename">libdata/foo</code> directory removed from the
                   5198:     resulting PLIST:</p>
                   5199: <pre class="programlisting">
1.100   ! rillig   5200: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
1.87      wiz      5201:     </pre>
                   5202: <p>And to get all the <code class="varname">@dirrm</code> lines referring
                   5203:     to a specific (shared) directory converted to
                   5204:     <code class="varname">@comment</code>s:</p>
1.75      rillig   5205: <pre class="programlisting">
1.100   ! rillig   5206: PRINT_PLIST_AWK+=       /^@dirrm share\/specific/ { print "@comment " $$0; next; }
1.87      wiz      5207:     </pre>
1.75      rillig   5208: </div>
                   5209: <div class="sect1" lang="en">
                   5210: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5211: <a name="plist.misc"></a>12.4. Variable substitution in PLIST</h2></div></div></div>
1.87      wiz      5212: <p>A number of variables are substituted automatically in
                   5213:     PLISTs when a package is installed on a system. This includes the
                   5214:     following variables:</p>
1.75      rillig   5215: <div class="variablelist"><dl>
                   5216: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   5217: <dd>
                   5218: <p>Some packages like emacs and perl embed information
1.87      wiz      5219:          about which architecture they were built on into the
                   5220:          pathnames where they install their files. To handle this
                   5221:          case, PLIST will be preprocessed before actually used, and
                   5222:          the symbol
                   5223:          &#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221; will be
                   5224:          replaced by what <span><strong class="command">uname -p</strong></span> gives. The
                   5225:          same is done if the string
                   5226:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   5227:          PLIST somewhere - use this on packages that have GNU
                   5228:          autoconf-created configure scripts.</p>
1.75      rillig   5229: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   5230: <h3 class="title">Legacy note</h3>
                   5231: <p>There used to be a symbol
1.87      wiz      5232:            &#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221; that
                   5233:            was replaced by the output of <span><strong class="command">uname
                   5234:            -m</strong></span>, but that's no longer supported and has
                   5235:            been removed.</p>
1.75      rillig   5236: </div>
                   5237: </dd>
                   5238: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   5239: <dd>
                   5240: <p>Some packages want to embed the OS name and version
1.87      wiz      5241:          into some paths.  To do this, use these variables in the
                   5242:          <code class="filename">PLIST</code>:
                   5243:          </p>
1.75      rillig   5244: <div class="itemizedlist"><ul type="disc">
                   5245: <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>
                   5246: <li><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. &#8220;<span class="quote">solaris</span>&#8221;)</p></li>
                   5247: <li><p><code class="varname">${OS_VERSION}</code> - &#8220;<span class="quote"><span><strong class="command">uname -r</strong></span></span>&#8221;</p></li>
                   5248: </ul></div>
                   5249: </dd>
                   5250: </dl></div>
1.87      wiz      5251: <p>For a complete list of values which are replaced by
                   5252:     default, please look in <code class="filename">bsd.pkg.mk</code> (and
                   5253:     search for <code class="varname">PLIST_SUBST</code>).</p>
                   5254: <p>If you want to change other variables not listed above, you
                   5255:     can add variables and their expansions to this variable in the
1.90      rillig   5256:     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   5257: <pre class="programlisting">
1.100   ! rillig   5258: PLIST_SUBST+=   SOMEVAR="somevalue"
1.87      wiz      5259:     </pre>
1.75      rillig   5260: <p>This replaces all occurrences of &#8220;<span class="quote">${SOMEVAR}</span>&#8221;
1.87      wiz      5261:     in the <code class="filename">PLIST</code> with
                   5262:     &#8220;<span class="quote">somevalue</span>&#8221;.</p>
1.75      rillig   5263: </div>
                   5264: <div class="sect1" lang="en">
                   5265: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5266: <a name="manpage-compression"></a>12.5. Man page compression</h2></div></div></div>
1.75      rillig   5267: <p>Man pages should be installed in compressed form if
1.87      wiz      5268:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   5269:     and uncompressed otherwise. To handle this in the
                   5270:     <code class="filename">PLIST</code> file, the suffix &#8220;<span class="quote">.gz</span>&#8221; is
                   5271:     appended/removed automatically for man pages according to
                   5272:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   5273:     or not, see above for details. This modification of the
                   5274:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   5275:     <code class="filename">PLIST</code> itself.</p>
1.75      rillig   5276: </div>
                   5277: <div class="sect1" lang="en">
                   5278: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   5279: <a name="using-PLIST_SRC"></a>12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
                   5280: </h2></div></div></div>
1.76      rillig   5281: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87      wiz      5282:     in generating the binary package, set the variable
                   5283:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
                   5284:     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
                   5285:     important. The default for <code class="varname">PLIST_SRC</code> is
                   5286:     <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75      rillig   5287: </div>
                   5288: <div class="sect1" lang="en">
                   5289: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5290: <a name="platform-specific-plist"></a>12.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75      rillig   5291: <p>Some packages decide to install a different set of files based on
1.87      wiz      5292:     the operating system being used. These differences can be
                   5293:     automatically handled by using the following files:</p>
1.75      rillig   5294: <div class="itemizedlist"><ul type="disc">
1.76      rillig   5295: <li><p><code class="filename">PLIST.common</code></p></li>
                   5296: <li><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   5297: <li><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   5298: <li><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   5299: <li><p><code class="filename">PLIST.common_end</code></p></li>
1.75      rillig   5300: </ul></div>
                   5301: </div>
                   5302: <div class="sect1" lang="en">
                   5303: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5304: <a name="faq.common-dirs"></a>12.8. Sharing directories between packages</h2></div></div></div>
1.87      wiz      5305: <p>A &#8220;<span class="quote">shared directory</span>&#8221; is a directory where
                   5306:     multiple (and unrelated) packages install files.  These
                   5307:     directories are problematic because you have to add special tricks
                   5308:     in the PLIST to conditionally remove them, or have some
                   5309:     centralized package handle them.</p>
                   5310: <p>Within pkgsrc, you'll find both approaches.  If a directory
                   5311:     is shared by a few unrelated packages, it's often not worth to add
                   5312:     an extra package to remove it.  Therefore, one simply does:</p>
                   5313: <pre class="programlisting">
1.100   ! rillig   5314: @unexec ${RMDIR} %D/path/to/shared/directory 2&gt;/dev/null || ${TRUE}
1.87      wiz      5315:     </pre>
                   5316: <p>in the PLISTs of all affected packages, instead of the
                   5317:     regular "@dirrm" line.</p>
                   5318: <p>However, if the directory is shared across many packages, two
                   5319:     different solutions are available:</p>
1.75      rillig   5320: <div class="orderedlist"><ol type="1">
1.87      wiz      5321: <li><p>If the packages have a common dependency, the directory
                   5322:        can be removed in that.  For example, see
1.91      rillig   5323:        <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      5324:        removes the shared directory
                   5325:        <code class="filename">share/omf</code>.</p></li>
                   5326: <li><p>If the packages using the directory are not related at
                   5327:        all (they have no common dependencies), a *-dirs package is
                   5328:        used.</p></li>
1.75      rillig   5329: </ol></div>
1.87      wiz      5330: <p>From now on, we'll discuss the second solution.  To get an
                   5331:     idea of the *-dirs packages available, issue:</p>
1.75      rillig   5332: <pre class="programlisting">
1.100   ! rillig   5333: <code class="prompt">%</code> cd .../pkgsrc
        !          5334: <code class="prompt">%</code> ls -d */*-dirs
1.87      wiz      5335:     </pre>
                   5336: <p>Their use from other packages is very simple.  The
                   5337:     <code class="varname">USE_DIRS</code> variable takes a list of package names
                   5338:     (without the &#8220;<span class="quote">-dirs</span>&#8221; part) together with the required
                   5339:     version number (always pick the latest one when writing new
                   5340:     packages).</p>
                   5341: <p>For example, if a package installs files under
                   5342:     <code class="filename">share/applications</code>, it should have the
                   5343:     following line in it:</p>
                   5344: <pre class="programlisting">
1.100   ! rillig   5345: USE_DIRS+=      xdg-1.1
1.87      wiz      5346:     </pre>
                   5347: <p>After regenerating the PLIST using <span><strong class="command">make
                   5348:     print-PLIST</strong></span>, you should get the right (commented out)
                   5349:     lines.</p>
                   5350: <p>Note that even if your package is using
                   5351:     <code class="filename">$X11BASE</code>, it must not depend on the
                   5352:     *-x11-dirs packages.  Just specify the name without that part and
                   5353:     pkgsrc (in particular, <code class="filename">mk/dirs.mk</code>) will take
                   5354:     care of it.</p>
1.75      rillig   5355: </div>
                   5356: </div>
                   5357: <div class="chapter" lang="en">
                   5358: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   5359: <a name="buildlink"></a>Chapter 13. Buildlink methodology</h2></div></div></div>
1.75      rillig   5360: <div class="toc">
                   5361: <p><b>Table of Contents</b></p>
                   5362: <dl>
1.90      rillig   5363: <dt><span class="sect1"><a href="#converting-to-buildlink3">13.1. Converting packages to use buildlink3</a></span></dt>
                   5364: <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   5365: <dd><dl>
1.90      rillig   5366: <dt><span class="sect2"><a href="#anatomy-of-bl3">13.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   5367: <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   5368: </dl></dd>
1.90      rillig   5369: <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   5370: <dd><dl>
1.90      rillig   5371: <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>
                   5372: <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   5373: </dl></dd>
                   5374: </dl>
                   5375: </div>
                   5376: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87      wiz      5377:   are seen by a package's configure and build processes.  This is implemented
                   5378:   in a two step process:</p>
1.75      rillig   5379: <div class="orderedlist"><ol type="1">
                   5380: <li><p>Symlink headers and libraries for dependencies into
1.87      wiz      5381:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   5382:       of <code class="varname">WRKDIR</code>.</p></li>
1.75      rillig   5383: <li><p>Create wrapper scripts that are used in place of the normal compiler
1.87      wiz      5384:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   5385:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   5386:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   5387:       native compiler on some operating systems look like GCC, so that
                   5388:       packages that expect GCC won't require modifications to build with
                   5389:       those native compilers.</p></li>
1.75      rillig   5390: </ol></div>
                   5391: <p>This normalizes the environment in which a package is built so that the
1.87      wiz      5392:   package may be built consistently despite what other software may be
                   5393:   installed. Please note that the normal system header and library paths,
                   5394:   e.g. <code class="filename">/usr/include</code>,
                   5395:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   5396:   designed to insulate the package build from non-system-supplied
                   5397:   software.</p>
1.75      rillig   5398: <div class="sect1" lang="en">
                   5399: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5400: <a name="converting-to-buildlink3"></a>13.1. Converting packages to use buildlink3</h2></div></div></div>
1.75      rillig   5401: <p>The process of converting packages to use the buildlink3
1.87      wiz      5402:     framework (&#8220;<span class="quote">bl3ifying</span>&#8221;) is fairly straightforward.
                   5403:     The things to keep in mind are:</p>
1.75      rillig   5404: <div class="orderedlist"><ol type="1">
1.87      wiz      5405: <li><p>Ensure that the build always calls the wrapper scripts
                   5406:        instead of the actual toolchain.  Some packages are tricky,
                   5407:        and the only way to know for sure is the check
                   5408:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   5409:        wrappers are being invoked.</p></li>
                   5410: <li><p>Don't override <code class="varname">PREFIX</code> from within
                   5411:        the package Makefile, e.g. Java VMs, standalone shells,
                   5412:        etc., because the code to symlink files into
                   5413:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
                   5414:        relative to &#8220;<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>&#8221;.
                   5415:        </p></li>
                   5416: <li><p>Remember that <span class="emphasis"><em>only</em></span> the
                   5417:        <code class="filename">buildlink3.mk</code> files that you list in a
                   5418:        package's Makefile are added as dependencies for that package.
                   5419:        </p></li>
1.75      rillig   5420: </ol></div>
1.87      wiz      5421: <p>If a dependency on a particular package is required for its libraries and
                   5422:     headers, then we replace:</p>
1.75      rillig   5423: <pre class="programlisting">
1.100   ! rillig   5424: DEPENDS+=       foo&gt;=1.1.0:../../category/foo
        !          5425: </pre>
1.75      rillig   5426: <p>with</p>
                   5427: <pre class="programlisting">
1.100   ! rillig   5428: .include "../../category/foo/buildlink3.mk"
        !          5429: </pre>
1.75      rillig   5430: <p>The buildlink3.mk files usually define the required dependencies.
                   5431:     If you need a newer version of the dependency when using buildlink3.mk
1.87      wiz      5432:     files, then you can define it in your Makefile; for example:</p>
1.75      rillig   5433: <pre class="programlisting">
1.100   ! rillig   5434: BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
        !          5435: .include "../../category/foo/buildlink3.mk"
        !          5436: </pre>
1.76      rillig   5437: <p>There are several <code class="filename">buildlink3.mk</code>
1.87      wiz      5438:     files in <code class="filename">pkgsrc/mk</code>
                   5439:     that handle special package issues:</p>
1.75      rillig   5440: <div class="itemizedlist"><ul type="disc">
1.76      rillig   5441: <li><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87      wiz      5442:        the native or a pkgsrc Berkeley DB implementation based on
                   5443:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   5444:        <code class="varname">BDB_DEFAULT</code>.</p></li>
1.76      rillig   5445: <li><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87      wiz      5446:        comes with neither Curses nor NCurses, this will take care
1.91      rillig   5447:        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   5448: <li><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87      wiz      5449:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   5450:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   5451:        require a Kerberos 5 implementation.</p></li>
1.88      wiz      5452: <li><p><code class="filename">motif.buildlink3.mk</code> checks for a
                   5453:        system-provided Motif installation or adds a dependency on
1.91      rillig   5454:        <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      5455:        <code class="varname">MOTIF_TYPE</code> to &#8220;<span class="quote">dt</span>&#8221;,
                   5456:        &#8220;<span class="quote">lesstif</span>&#8221;, or &#8220;<span class="quote">openmotif</span>&#8221; to choose
                   5457:        which Motif version will be used.</p></li>
1.76      rillig   5458: <li><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87      wiz      5459:        variables that may be used by packages that use the
                   5460:        Open Sound System (OSS) API.</p></li>
1.76      rillig   5461: <li><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.93      rillig   5462:        either Postgres 8.0, 8.1, or 8.2, whichever is found installed. See
1.87      wiz      5463:        the file for more information.</p></li>
1.76      rillig   5464: <li><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87      wiz      5465:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.91      rillig   5466:        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   5467: <li><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87      wiz      5468:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   5469:        library.</p></li>
1.75      rillig   5470: </ul></div>
1.76      rillig   5471: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87      wiz      5472:     files provide a more complete
                   5473:     description of how to use them properly.</p>
1.75      rillig   5474: </div>
                   5475: <div class="sect1" lang="en">
                   5476: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5477: <a name="creating-buildlink3.mk"></a>13.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.87      wiz      5478: <p>A package's <code class="filename">buildlink3.mk</code> file is
                   5479:     included by Makefiles to indicate the need to compile and link
                   5480:     against header files and libraries provided by the package.  A
                   5481:     <code class="filename">buildlink3.mk</code> file should always provide
                   5482:     enough information to add the correct type of dependency
                   5483:     relationship and include any other
                   5484:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   5485:     headers and libraries that it needs in turn.</p>
                   5486: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.91      rillig   5487:     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      5488:     package is highly recommended.  For most packages, the following
                   5489:     command will generate a good starting point for
                   5490:     <code class="filename">buildlink3.mk</code> files:</p>
                   5491: <pre class="screen">
                   5492: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   5493: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   5494:     </pre>
1.75      rillig   5495: <div class="sect2" lang="en">
                   5496: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   5497: <a name="anatomy-of-bl3"></a>13.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75      rillig   5498: <p>The following real-life example
1.87      wiz      5499:       <code class="filename">buildlink3.mk</code> is taken
                   5500:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75      rillig   5501: <pre class="programlisting">
1.100   ! rillig   5502: # $NetBSD: buildlink3.mk,v 1.7 2004/03/18 09:12:12 jlam Exp $
1.1       grant    5503: 
1.100   ! rillig   5504: BUILDLINK_DEPTH:=       ${BUILDLINK_DEPTH}+
        !          5505: TIFF_BUILDLINK3_MK:=    ${TIFF_BUILDLINK3_MK}+
1.1       grant    5506: 
1.100   ! rillig   5507: .if ${BUILDLINK_DEPTH} == "+"
        !          5508: BUILDLINK_DEPENDS+=     tiff
        !          5509: .endif
1.87      wiz      5510: 
1.100   ! rillig   5511: BUILDLINK_PACKAGES:=    ${BUILDLINK_PACKAGES:Ntiff}
        !          5512: BUILDLINK_PACKAGES+=    tiff
1.87      wiz      5513: 
1.100   ! rillig   5514: .if ${TIFF_BUILDLINK3_MK} == "+"
        !          5515: BUILDLINK_API_DEPENDS.tiff+=        tiff&gt;=3.6.1
        !          5516: BUILDLINK_PKGSRCDIR.tiff?=      ../../graphics/tiff
        !          5517: .endif  # TIFF_BUILDLINK3_MK
1.87      wiz      5518: 
1.100   ! rillig   5519: .include "../../devel/zlib/buildlink3.mk"
        !          5520: .include "../../graphics/jpeg/buildlink3.mk"
1.87      wiz      5521: 
1.100   ! rillig   5522: BUILDLINK_DEPTH:=       ${BUILDLINK_DEPTH:S/+$//}
        !          5523: </pre>
1.87      wiz      5524: <p>The header and footer manipulate
                   5525:       <code class="varname">BUILDLINK_DEPTH</code>, which is common across all
                   5526:       <code class="filename">buildlink3.mk</code> files and is used to track
                   5527:       at what depth we are including
                   5528:       <code class="filename">buildlink3.mk</code> files.</p>
                   5529: <p>The first section controls if the dependency on
                   5530:       <em class="replaceable"><code>pkg</code></em> is added.
                   5531:       <code class="varname">BUILDLINK_DEPENDS</code> is the global list of
                   5532:       packages for which dependencies are added by
                   5533:       buildlink3.</p>
                   5534: <p>The second section advises pkgsrc that the
                   5535:       <code class="filename">buildlink3.mk</code> file for
                   5536:       <em class="replaceable"><code>pkg</code></em> has been included at some point.
                   5537:       <code class="varname">BUILDLINK_PACKAGES</code> is the global list of
                   5538:       packages for which <code class="filename">buildlink3.mk</code> files
                   5539:       have been included.  It must <span class="emphasis"><em>always</em></span> be
                   5540:       appended to within a <code class="filename">buildlink3.mk</code>
                   5541:       file.</p>
                   5542: <p>The third section is protected from multiple inclusion
                   5543:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   5544:       added.  Several important variables are set in the section:</p>
                   5545: <div class="itemizedlist"><ul type="disc">
                   5546: <li><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5547:          is the actual dependency recorded in the installed
                   5548:          package; this should always be set using
                   5549:          <span><strong class="command">+=</strong></span> to ensure that
                   5550:          we're appending to any pre-existing list of values.  This
                   5551:          variable should be set to the first version of the
                   5552:          package that had an API change.
                   5553:          </p></li>
                   5554: <li><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
                   5555:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   5556:          pkgsrc directory.</p></li>
                   5557: <li><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   5558:          (not shown above) controls whether we use
                   5559:          <code class="varname">BUILD_DEPENDS</code> or
                   5560:          <code class="varname">DEPENDS</code> to add the dependency on
                   5561:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   5562:          selected by setting
                   5563:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   5564:          to &#8220;<span class="quote">build</span>&#8221;.  By default, the full dependency is
                   5565:          used.</p></li>
                   5566: <li><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5567:            and
                   5568:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   5569:            (not shown above) are lists of subdirectories of
1.76      rillig   5570:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   5571:            to add to the header and library search paths.  These
                   5572:            default to &#8220;<span class="quote">include</span>&#8221; and &#8220;<span class="quote">lib</span>&#8221;
1.87      wiz      5573:          respectively.</p></li>
                   5574: <li><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5575:            (not shown above) is the list of preprocessor flags to add
                   5576:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
                   5577:            configure and build phases.  The &#8220;<span class="quote">-I</span>&#8221; option
                   5578:            should be avoided and instead be handled using
                   5579:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87      wiz      5580:          above.</p></li>
1.75      rillig   5581: </ul></div>
1.87      wiz      5582: <p>The following variables are all optionally defined within
                   5583:       this second section (protected against multiple inclusion) and
                   5584:       control which package files are symlinked into
                   5585:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   5586:       transformed during the symlinking:</p>
1.75      rillig   5587: <div class="itemizedlist"><ul type="disc">
1.87      wiz      5588: <li><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5589:            (not shown above) is a shell glob pattern relative to
1.76      rillig   5590:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   5591:            to be symlinked into
1.76      rillig   5592:            <code class="filename">${BUILDLINK_DIR}</code>,
1.87      wiz      5593:          e.g. <code class="filename">include/*.h</code>.</p></li>
                   5594: <li><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
                   5595:            (not shown above) is a shell pipeline that
                   5596:            outputs to stdout a list of files relative to
                   5597:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   5598:            The resulting files are to be symlinked
                   5599:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   5600:            this takes the <code class="filename">+CONTENTS</code> of a
                   5601:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   5602:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
                   5603: <li><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5604:            (not shown above) is a filter command that filters
1.76      rillig   5605:            <code class="filename">+CONTENTS</code> input into a list of files
1.75      rillig   5606:            relative to
1.76      rillig   5607:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   5608:            on stdout.  By default for overwrite packages,
                   5609:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76      rillig   5610:            outputs the contents of the <code class="filename">include</code>
                   5611:            and <code class="filename">lib</code> directories in the package
                   5612:            <code class="filename">+CONTENTS</code>, and for pkgviews packages,
1.75      rillig   5613:            it outputs any libtool archives in
1.87      wiz      5614:            <code class="filename">lib</code> directories.</p></li>
1.95      tron     5615: <li><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5616:            (not shown above) is a list of sed arguments used to
                   5617:            transform the name of the source filename into a
                   5618:            destination filename, e.g. <span><strong class="command">-e
1.87      wiz      5619:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75      rillig   5620: </ul></div>
1.87      wiz      5621: <p>The last section includes any
                   5622:       <code class="filename">buildlink3.mk</code> needed for
                   5623:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   5624:       Including these <code class="filename">buildlink3.mk</code> files
                   5625:       means that the headers and libraries for these
                   5626:       dependencies are also symlinked into
                   5627:       <code class="filename">${BUILDLINK_DIR}</code>
                   5628:       whenever the <em class="replaceable"><code>pkg</code></em>
                   5629:       <code class="filename">buildlink3.mk</code>
                   5630:       file is included.</p>
1.75      rillig   5631: </div>
                   5632: <div class="sect2" lang="en">
                   5633: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   5634: <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      5635: <p>The situation that requires increasing the dependency listed in
1.75      rillig   5636:        <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5637:        after a package update is when the API or interface to the
1.87      wiz      5638:       header files change.</p>
                   5639: <p>In this case,
                   5640:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5641:       should be adjusted to require at least the new package
                   5642:       version.  In some cases, the packages that depend on this new
                   5643:       version may need their <code class="varname">PKGREVISION</code>s
                   5644:       increased and, if they have <code class="filename">buildlink3.mk</code>
                   5645:       files, their
                   5646:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5647:       adjusted, too.  This is needed so pkgsrc will require the
                   5648:       correct package dependency and not settle for an older one
                   5649:       when building the source.</p>
                   5650: <p><code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5651:        should be increased when the binary interface or sonames
                   5652:        (major number of the library version) of any installed
                   5653:        shared libraries change.  This is needed so that binary
                   5654:        packages made using it will require the correct package
                   5655:        dependency and not settle for an older one which will not
1.87      wiz      5656:       contain the necessary shared libraries.</p>
1.90      rillig   5657: <p>See <a href="#dependencies" title="18.1.6. Handling dependencies">Section 18.1.6, &#8220;Handling dependencies&#8221;</a> for
1.75      rillig   5658:        more information about dependencies on other packages,
                   5659:        including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87      wiz      5660:       <code class="varname">ABI_DEPENDS</code> definitions.</p>
                   5661: <p>Please take careful consideration before adjusting
                   5662:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5663:       or
                   5664:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5665:       as we don't want to cause unneeded package deletions and
                   5666:       rebuilds.  In many cases, new versions of packages work just
                   5667:       fine with older dependencies.</p>
                   5668: <p>Also it is not needed to set
1.75      rillig   5669:        <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5670:        when it is identical to
1.87      wiz      5671:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.        </p>
1.75      rillig   5672: </div>
                   5673: </div>
                   5674: <div class="sect1" lang="en">
                   5675: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5676: <a name="writing-builtin.mk"></a>13.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87      wiz      5677: <p>Some packages in pkgsrc install headers and libraries that
1.75      rillig   5678:       coincide with headers and libraries present in the base system.
1.76      rillig   5679:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   5680:       packages should also include a <code class="filename">builtin.mk</code>
1.75      rillig   5681:       file that includes the necessary checks to decide whether using
                   5682:       the built-in software or the pkgsrc software is
1.87      wiz      5683:     appropriate.</p>
                   5684: <p>The only requirements of a builtin.mk file for
                   5685:     <em class="replaceable"><code>pkg</code></em> are:</p>
1.75      rillig   5686: <div class="orderedlist"><ol type="1">
1.87      wiz      5687: <li><p>It should set
                   5688:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5689:        to either &#8220;<span class="quote">yes</span>&#8221; or &#8220;<span class="quote">no</span>&#8221;
                   5690:        after it is included.</p></li>
                   5691: <li><p>It should <span class="emphasis"><em>not</em></span> override any
                   5692:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5693:        which is already set before the
                   5694:        <code class="filename">builtin.mk</code> file is included.</p></li>
                   5695: <li><p>It should be written to allow multiple inclusion.  This
                   5696:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   5697:        attention to <code class="filename">Makefile</code> coding.</p></li>
1.75      rillig   5698: </ol></div>
                   5699: <div class="sect2" lang="en">
                   5700: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   5701: <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   5702: <p>The following is the recommended template for builtin.mk
1.87      wiz      5703:       files:</p>
1.75      rillig   5704: <pre class="programlisting">
1.100   ! rillig   5705: .if !defined(IS_BUILTIN.foo)
        !          5706: #
        !          5707: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
        !          5708: # genuinely exists in the system or not.
        !          5709: #
        !          5710: IS_BUILTIN.foo?=        no
        !          5711: 
        !          5712: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
        !          5713: # version can be determined.
        !          5714: #
        !          5715: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
        !          5716: BUILTIN_PKG.foo?=       foo-1.0
        !          5717: .  endif
        !          5718: .endif  # IS_BUILTIN.foo
        !          5719: 
        !          5720: .if !defined(USE_BUILTIN.foo)
        !          5721: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
        !          5722: .  if defined(BUILTIN_PKG.foo)
        !          5723: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
        !          5724: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
        !          5725: USE_BUILTIN.foo!=                                                       \
        !          5726:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
        !          5727:         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
        !          5728: .      endif
        !          5729: .    endfor
        !          5730: .  endif
        !          5731: .endif  # USE_BUILTIN.foo
        !          5732: 
        !          5733: CHECK_BUILTIN.foo?=     no
        !          5734: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
        !          5735: #
        !          5736: # Here we place code that depends on whether USE_BUILTIN.foo is set to
        !          5737: # "yes" or "no".
        !          5738: #
        !          5739: .endif  # CHECK_BUILTIN.foo
        !          5740: </pre>
1.87      wiz      5741: <p>The first section sets
                   5742:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5743:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   5744:       in the base system.  This should not be a base system software
                   5745:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
                   5746:       it should only be &#8220;<span class="quote">yes</span>&#8221; if the actual package is
                   5747:       included as part of the base system.  This variable is only
                   5748:       used internally within the <code class="filename">builtin.mk</code>
                   5749:       file.</p>
                   5750: <p>The second section sets
                   5751:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5752:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   5753:       system if it exists (if
                   5754:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5755:       is &#8220;<span class="quote">yes</span>&#8221;).  This variable is only used internally
                   5756:       within the <code class="filename">builtin.mk</code> file.</p>
                   5757: <p>The third section sets
                   5758:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5759:       and is <span class="emphasis"><em>required</em></span> in all
                   5760:       <code class="filename">builtin.mk</code> files.  The code in this
                   5761:       section must make the determination whether the built-in
                   5762:       software is adequate to satisfy the dependencies listed in
                   5763:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5764:       This is typically done by comparing
                   5765:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5766:       against each of the dependencies in
                   5767:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5768:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5769:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   5770:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   5771:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5772:       may be &#8220;<span class="quote">yes</span>&#8221; even if
                   5773:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5774:       is &#8220;<span class="quote">no</span>&#8221; because we may make the determination
                   5775:       that the built-in version of the software is similar enough to
                   5776:       be used as a replacement.</p>
                   5777: <p>The last section is guarded by
                   5778:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   5779:       and includes code that uses the value of
                   5780:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5781:       set in the previous section.  This typically includes, e.g.,
                   5782:       adding additional dependency restrictions and listing additional
                   5783:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   5784:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75      rillig   5785: </div>
                   5786: <div class="sect2" lang="en">
                   5787: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   5788: <a name="native-or-pkgsrc-preference"></a>13.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87      wiz      5789: <p>When building packages, it's possible to choose whether to set
                   5790:        a global preference for using either the built-in (native)
                   5791:        version or the pkgsrc version of software to satisfy a
                   5792:        dependency.  This is controlled by setting
                   5793:        <code class="varname">PREFER_PKGSRC</code> and
                   5794:        <code class="varname">PREFER_NATIVE</code>.  These variables take values
                   5795:        of either &#8220;<span class="quote">yes</span>&#8221;, &#8220;<span class="quote">no</span>&#8221;, or a list of
                   5796:        packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
                   5797:        use the pkgsrc versions of software, while
                   5798:        <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
                   5799:        built-in versions.  Preferences are determined by the most
                   5800:        specific instance of the package in either
                   5801:        <code class="varname">PREFER_PKGSRC</code> or
                   5802:        <code class="varname">PREFER_NATIVE</code>.  If a package is specified
                   5803:        in neither or in both variables, then
                   5804:        <code class="varname">PREFER_PKGSRC</code> has precedence over
                   5805:        <code class="varname">PREFER_NATIVE</code>.  For example, to require
                   5806:        using pkgsrc versions of software for all but the most basic
                   5807:       bits on a NetBSD system, you can set:</p>
                   5808: <pre class="programlisting">
1.100   ! rillig   5809: PREFER_PKGSRC=  yes
        !          5810: PREFER_NATIVE=  getopt skey tcp_wrappers
        !          5811: </pre>
1.87      wiz      5812: <p>A package <span class="emphasis"><em>must</em></span> have a
                   5813:       <code class="filename">builtin.mk</code>
                   5814:       file to be listed in <code class="varname">PREFER_NATIVE</code>,
                   5815:       otherwise it is simply ignored in that list.</p>
1.75      rillig   5816: </div>
                   5817: </div>
                   5818: </div>
                   5819: <div class="chapter" lang="en">
                   5820: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   5821: <a name="pkginstall"></a>Chapter 14. The pkginstall framework</h2></div></div></div>
1.75      rillig   5822: <div class="toc">
                   5823: <p><b>Table of Contents</b></p>
                   5824: <dl>
1.90      rillig   5825: <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   5826: <dd><dl>
1.90      rillig   5827: <dt><span class="sect2"><a href="#dirs-outside-prefix">14.1.1. Directory manipulation</a></span></dt>
                   5828: <dt><span class="sect2"><a href="#files-outside-prefix">14.1.2. File manipulation</a></span></dt>
1.75      rillig   5829: </dl></dd>
1.90      rillig   5830: <dt><span class="sect1"><a href="#conf-files">14.2. Configuration files</a></span></dt>
1.75      rillig   5831: <dd><dl>
1.90      rillig   5832: <dt><span class="sect2"><a href="#conf-files-sysconfdir">14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   5833: <dt><span class="sect2"><a href="#conf-files-configure">14.2.2. Telling the software where configuration files are</a></span></dt>
                   5834: <dt><span class="sect2"><a href="#conf-files-patching">14.2.3. Patching installations</a></span></dt>
                   5835: <dt><span class="sect2"><a href="#conf-files-disable">14.2.4. Disabling handling of configuration files</a></span></dt>
                   5836: </dl></dd>
                   5837: <dt><span class="sect1"><a href="#rcd-scripts">14.3. System startup scripts</a></span></dt>
                   5838: <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>
                   5839: <dt><span class="sect1"><a href="#users-and-groups">14.4. System users and groups</a></span></dt>
                   5840: <dt><span class="sect1"><a href="#shells">14.5. System shells</a></span></dt>
                   5841: <dd><dl><dt><span class="sect2"><a href="#shells-disable">14.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   5842: <dt><span class="sect1"><a href="#fonts">14.6. Fonts</a></span></dt>
                   5843: <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   5844: </dl>
                   5845: </div>
                   5846: <p>This chapter describes the framework known as
                   5847: <code class="literal">pkginstall</code>, whose key features are:</p>
                   5848: <div class="itemizedlist"><ul type="disc">
                   5849: <li><p>Generic installation and manipulation of directories and files
                   5850:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
                   5851: <li><p>Automatic handling of configuration files during installation,
                   5852:     provided that packages are correctly designed.</p></li>
                   5853: <li><p>Generation and installation of system startup scripts.</p></li>
                   5854: <li><p>Registration of system users and groups.</p></li>
                   5855: <li><p>Registration of system shells.</p></li>
                   5856: <li><p>Automatic updating of fonts databases.</p></li>
                   5857: </ul></div>
                   5858: <p>The following sections inspect each of the above points in detail.</p>
                   5859: <p>You may be thinking that many of the things described here could be
                   5860: easily done with simple code in the package's post-installation target
                   5861: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   5862: as the code in them is only executed when building from source.  Machines
                   5863: using binary packages could not benefit from it at all (as the code itself
                   5864: could be unavailable).  Therefore, the only way to achieve any of the items
                   5865: described above is by means of the installation scripts, which are
                   5866: automatically generated by pkginstall.</p>
                   5867: <div class="sect1" lang="en">
                   5868: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5869: <a name="files-and-dirs-outside-prefix"></a>14.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76      rillig   5870: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75      rillig   5871: of files and directories that belong to a package.  The names used in it
1.76      rillig   5872: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75      rillig   5873: which means that it cannot register files outside this directory (absolute
                   5874: path names are not allowed).  Despite this restriction, some packages need
                   5875: to install files outside this location; e.g., under
1.76      rillig   5876: <code class="filename">${VARBASE}</code> or
1.87      wiz      5877: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   5878: is to create such files during installation time by using
                   5879: installation scripts.</p>
                   5880: <p>The generic installation scripts are shell scripts that can
                   5881: contain arbitrary code.  The list of scripts to execute is taken from
                   5882: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   5883: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   5884: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   5885: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   5886: commands, so they have the potential to create and manage files
                   5887: anywhere in the file system.</p>
                   5888: <p>Using these general installation files is not recommended, but
                   5889: may be needed in some special cases.  One reason for avoiding them is
                   5890: that the user has to trust the packager that there is no unwanted or
                   5891: simply erroneous code included in the installation script. Also,
                   5892: previously there were many similar scripts for the same functionality,
                   5893: and fixing a common error involved finding and changing all of
                   5894: them.</p>
                   5895: <p>The pkginstall framework offers another, standardized way.  It
                   5896: provides generic scripts to abstract the manipulation of such files
                   5897: and directories based on variables set in the package's
                   5898: <code class="filename">Makefile</code>.  The rest of this section describes
                   5899: these variables.</p>
1.75      rillig   5900: <div class="sect2" lang="en">
                   5901: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   5902: <a name="dirs-outside-prefix"></a>14.1.1. Directory manipulation</h3></div></div></div>
1.75      rillig   5903: <p>The following variables can be set to request the creation of
                   5904: directories anywhere in the file system:</p>
                   5905: <div class="itemizedlist"><ul type="disc">
                   5906: <li><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
                   5907:     contain a list of directories that should be created and should attempt
                   5908:     to be destroyed by the installation scripts.  The difference between
                   5909:     the two is that the latter prompts the administrator to remove any
                   5910:     directories that may be left after deinstallation (because they were
                   5911:     not empty), while the former does not.</p></li>
                   5912: <li>
                   5913: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   5914:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   5915:     which directories should be created and should attempt to be destroyed
                   5916:     by the installation scripts.  Each tuple holds the following values,
                   5917:     separated by spaces: the directory name, its owner, its group and its
                   5918:     numerical mode.  For example:</p>
                   5919: <pre class="programlisting">
1.100   ! rillig   5920: MAKE_DIRS_PERMS+=         ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
1.1       grant    5921: </pre>
1.75      rillig   5922: <p>The difference between the two is exactly the same as their
                   5923:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5924: </li>
                   5925: </ul></div>
                   5926: </div>
                   5927: <div class="sect2" lang="en">
                   5928: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   5929: <a name="files-outside-prefix"></a>14.1.2. File manipulation</h3></div></div></div>
1.75      rillig   5930: <p>Creating non-empty files outside the installation prefix is tricky
1.76      rillig   5931: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75      rillig   5932: To overcome this problem, the only solution is to extract the file in the
                   5933: known place (i.e., inside the installation prefix) and copy it to the
                   5934: appropriate location during installation (done by the installation scripts
                   5935: generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
                   5936: file</em></span> in the following paragraphs, which describe the variables
                   5937: that can be used to automatically and consistently handle files outside the
                   5938: installation prefix:</p>
                   5939: <div class="itemizedlist"><ul type="disc">
                   5940: <li>
                   5941: <p><code class="varname">CONF_FILES</code> and
                   5942:     <code class="varname">SUPPORT_FILES</code> are pairs of master and target files.
                   5943:     During installation time, the master file is copied to the target one
                   5944:     if and only if the latter does not exist.  Upon deinstallation, the
                   5945:     target file is removed provided that it was not modified by the
                   5946:     installation.</p>
                   5947: <p>The difference between the two is that the latter prompts the
                   5948:     administrator to remove any files that may be left after
                   5949:     deinstallation (because they were not empty), while the former does
                   5950:     not.</p>
                   5951: </li>
                   5952: <li>
                   5953: <p><code class="varname">CONF_FILES_PERMS</code> and
                   5954:     <code class="varname">SUPPORT_FILES_PERMS</code> contain tuples describing master
                   5955:     files as well as their target locations.  For each of them, it also
                   5956:     specifies their owner, their group and their numeric permissions, in
                   5957:     this order.  For example:</p>
                   5958: <pre class="programlisting">
1.100   ! rillig   5959: SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1       grant    5960: </pre>
1.75      rillig   5961: <p>The difference between the two is exactly the same as their
                   5962:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5963: </li>
                   5964: </ul></div>
                   5965: </div>
                   5966: </div>
                   5967: <div class="sect1" lang="en">
                   5968: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5969: <a name="conf-files"></a>14.2. Configuration files</h2></div></div></div>
1.75      rillig   5970: <p>Configuration files are special in the sense that they are installed
                   5971: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
                   5972: need special treatment during installation (most of which is automated by
                   5973: pkginstall).  The main concept you must bear in mind is that files marked
                   5974: as configuration files are automatically copied to the right place (somewhere
                   5975: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
                   5976: and only if</em></span> they didn't exist before.  Similarly, they will not
                   5977: be removed if they have local modifications.  This ensures that
                   5978: administrators never lose any custom changes they may have made.</p>
                   5979: <div class="sect2" lang="en">
                   5980: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   5981: <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   5982: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   5983: specifies where configuration files shall be installed.  Its contents are
                   5984: set based upon the following variables:</p>
                   5985: <div class="itemizedlist"><ul type="disc">
                   5986: <li><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76      rillig   5987:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75      rillig   5988:     be overridden by the user to point to his preferred location (e.g.,
1.76      rillig   5989:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75      rillig   5990:     Packages must not use it directly.</p></li>
                   5991: <li>
                   5992: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   5993:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   5994:     for the package being built shall be installed.  The definition of this
                   5995:     variable only makes sense in the package's
1.76      rillig   5996:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75      rillig   5997: <p>As an example, consider the Apache package,
1.91      rillig   5998:     <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   5999:     configuration files under the
1.76      rillig   6000:     <code class="filename">httpd/</code> subdirectory of
1.75      rillig   6001:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   6002:     Makefile.</p>
                   6003: </li>
                   6004: <li><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
                   6005:     variable that holds this package's configuration directory (if
                   6006:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   6007:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   6008:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
                   6009: <li><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
                   6010:     directory where the configuration files for the package identified by
                   6011:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   6012: </ul></div>
                   6013: <p>Based on the above variables, pkginstall determines the value of
                   6014: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
                   6015: variable that can be used within a package to refer to its configuration
                   6016: directory.  The algorithm used to set its value is basically the
                   6017: following:</p>
                   6018: <div class="orderedlist"><ol type="1">
                   6019: <li><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
                   6020:     its value is used.</p></li>
                   6021: <li><p>If the previous variable is not defined but
                   6022:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76      rillig   6023:     <code class="filename">Makefile</code>, the resulting value is
                   6024:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.75      rillig   6025: <li><p>Otherwise, it is set to
1.76      rillig   6026:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75      rillig   6027: </ol></div>
1.76      rillig   6028: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.90      rillig   6029: 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   6030: </div>
                   6031: <div class="sect2" lang="en">
                   6032: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   6033: <a name="conf-files-configure"></a>14.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75      rillig   6034: <p>Given that pkgsrc (and users!) expect configuration files to be in a
                   6035: known place, you need to teach each package where it shall install its
                   6036: files.  In some cases you will have to patch the package Makefiles to
                   6037: achieve it.  If you are lucky, though, it may be as easy as passing an
                   6038: extra flag to the configuration script; this is the case of GNU Autoconf-
                   6039: generated files:</p>
                   6040: <pre class="programlisting">
1.100   ! rillig   6041: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1       grant    6042: </pre>
1.75      rillig   6043: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
                   6044: for</em></span> its configuration files, not where they will be originally
                   6045: installed (although the difference is never explicit,
                   6046: unfortunately).</p>
                   6047: </div>
                   6048: <div class="sect2" lang="en">
                   6049: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   6050: <a name="conf-files-patching"></a>14.2.3. Patching installations</h3></div></div></div>
1.75      rillig   6051: <p>As said before, pkginstall automatically handles configuration files.
                   6052: This means that <span class="strong"><strong>the packages themselves must not
1.76      rillig   6053: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75      rillig   6054: directly</strong></span>.  Bad news is that many software installation scripts
                   6055: will, out of the box, mess with the contents of that directory.  So what is
                   6056: the correct procedure to fix this issue?</p>
                   6057: <p>You must teach the package (usually by manually patching it) to
                   6058: install any configuration files under the examples hierarchy,
1.76      rillig   6059: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   6060: <code class="filename">PLIST</code> registers them and the administrator always
1.75      rillig   6061: has the original copies available.</p>
                   6062: <p>Once the required configuration files are in place (i.e., under the
                   6063: examples hierarchy), the pkginstall framework can use them as master copies
                   6064: during the package installation to update what is in
1.76      rillig   6065: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
1.75      rillig   6066: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.90      rillig   6067: 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   6068: about their syntax and their purpose.  Here is an example, taken from the
1.91      rillig   6069: <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   6070: <pre class="programlisting">
1.100   ! rillig   6071: EGDIR=        ${PREFIX}/share/doc/mutt/samples
        !          6072: CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1       grant    6073: </pre>
1.75      rillig   6074: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
                   6075: package and has no meaning outside it.</p>
                   6076: </div>
                   6077: <div class="sect2" lang="en">
                   6078: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   6079: <a name="conf-files-disable"></a>14.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75      rillig   6080: <p>The automatic copying of config files can be toggled by setting the
                   6081: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   6082: installation.</p>
                   6083: </div>
                   6084: </div>
                   6085: <div class="sect1" lang="en">
                   6086: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6087: <a name="rcd-scripts"></a>14.3. System startup scripts</h2></div></div></div>
1.75      rillig   6088: <p>System startup scripts are special files because they must be
                   6089: installed in a place known by the underlying OS, usually outside the
1.90      rillig   6090: 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   6091: can be used.  However, pkginstall provides a special mechanism to handle
                   6092: these files.</p>
                   6093: <p>In order to provide system startup scripts, the package has
                   6094: to:</p>
                   6095: <div class="orderedlist"><ol type="1">
1.76      rillig   6096: <li><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75      rillig   6097:     the <code class="literal">.sh</code> suffix appended.  Considering the
1.91      rillig   6098:     <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   6099:     <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.75      rillig   6100: <li>
                   6101: <p>Tell pkginstall to handle it, appending the name of the script,
                   6102:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   6103:     Continuing the previous example:</p>
                   6104: <pre class="programlisting">
1.100   ! rillig   6105: RCD_SCRIPTS+=   cupsd
1.1       grant    6106: </pre>
1.75      rillig   6107: </li>
                   6108: </ol></div>
                   6109: <p>Once this is done, pkginstall will do the following steps for each
                   6110: script in an automated fashion:</p>
                   6111: <div class="orderedlist"><ol type="1">
                   6112: <li><p>Process the file found in the files directory applying all the
1.76      rillig   6113:     substitutions described in the <code class="filename">FILES_SUBST</code>
1.75      rillig   6114:     variable.</p></li>
                   6115: <li><p>Copy the script from the files directory to the examples
1.76      rillig   6116:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
1.75      rillig   6117:     that this master file must be explicitly registered in the
1.76      rillig   6118:     <code class="filename">PLIST</code>.</p></li>
1.75      rillig   6119: <li><p>Add code to the installation scripts to copy the startup script
                   6120:     from the examples hierarchy into the system-wide startup scripts
                   6121:     directory.</p></li>
                   6122: </ol></div>
                   6123: <div class="sect2" lang="en">
                   6124: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   6125: <a name="rcd-scripts-disable"></a>14.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75      rillig   6126: <p>The automatic copying of config files can be toggled by setting the
                   6127: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   6128: installation.  Note that the scripts will be always copied inside the
1.76      rillig   6129: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75      rillig   6130: matter what the value of this variable is.</p>
                   6131: </div>
                   6132: </div>
                   6133: <div class="sect1" lang="en">
                   6134: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6135: <a name="users-and-groups"></a>14.4. System users and groups</h2></div></div></div>
1.75      rillig   6136: <p>If a package needs to create special users and/or groups during
                   6137: installation, it can do so by using the pkginstall framework.</p>
                   6138: <p>Users can be created by adding entries to the
                   6139: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   6140: syntax:</p>
                   6141: <pre class="programlisting">
1.100   ! rillig   6142: user:group
1.1       grant    6143: </pre>
1.87      wiz      6144: <p>Further specification of user details may be done by setting
                   6145: per-user variables.
                   6146: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   6147: numeric UID for the user.
                   6148: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   6149: user's description or comment.
                   6150: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   6151: user's home directory, and defaults to
                   6152: <code class="filename">/nonexistent</code> if not specified.
                   6153: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94      dmcmahil 6154: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87      wiz      6155: not specified.</p>
1.75      rillig   6156: <p>Similarly, groups can be created by adding entries to the
                   6157: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   6158: <pre class="programlisting">
1.100   ! rillig   6159: group
1.1       grant    6160: </pre>
1.93      rillig   6161: <p>The numeric GID of the group may be set by defining
1.75      rillig   6162: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   6163: <p>If a package needs to create the users and groups at an earlier
                   6164: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
                   6165: either <code class="literal">configure</code> or <code class="literal">build</code> to
                   6166: indicate the phase before which the users and groups are created.  In
                   6167: this case, the numeric UIDs and GIDs of the created users and groups
                   6168: are automatically hardcoded into the final installation scripts.</p>
                   6169: </div>
                   6170: <div class="sect1" lang="en">
                   6171: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6172: <a name="shells"></a>14.5. System shells</h2></div></div></div>
1.75      rillig   6173: <p>Packages that install system shells should register them in the shell
1.76      rillig   6174: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75      rillig   6175: administrator.  This must be done from the installation scripts to keep
                   6176: binary packages working on any system.  pkginstall provides an easy way to
                   6177: accomplish this task.</p>
                   6178: <p>When a package provides a shell interpreter, it has to set the
                   6179: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   6180: add some hooks to the installation scripts to handle it.  Consider the
1.91      rillig   6181: 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   6182: <pre class="programlisting">
1.100   ! rillig   6183: PKG_SHELL=      ${PREFIX}/bin/zsh
1.1       grant    6184: </pre>
1.75      rillig   6185: <div class="sect2" lang="en">
                   6186: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   6187: <a name="shells-disable"></a>14.5.1. Disabling shell registration</h3></div></div></div>
1.75      rillig   6188: <p>The automatic registration of shell interpreters can be disabled by
1.76      rillig   6189: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75      rillig   6190: environment variable to <code class="literal">NO</code>.</p>
                   6191: </div>
                   6192: </div>
                   6193: <div class="sect1" lang="en">
                   6194: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6195: <a name="fonts"></a>14.6. Fonts</h2></div></div></div>
1.75      rillig   6196: <p>Packages that install X11 fonts should update the database files
                   6197: that index the fonts within each fonts directory.  This can easily be
                   6198: accomplished within the pkginstall framework.</p>
                   6199: <p>When a package installs X11 fonts, it must list the directories in
                   6200: which fonts are installed in the
                   6201: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
                   6202: where <em class="replaceable"><code>type</code></em> can be one of &#8220;<span class="quote">ttf</span>&#8221;,
                   6203: &#8220;<span class="quote">type1</span>&#8221; or &#8220;<span class="quote">x11</span>&#8221;.  This will add hooks to the
                   6204: installation scripts to run the appropriate commands to update the fonts
                   6205: database files within each of those directories.  For convenience, if the
                   6206: directory path is relative, it is taken to be relative to the package's
1.91      rillig   6207: 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   6208: <pre class="programlisting">
1.100   ! rillig   6209: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
1.1       grant    6210: </pre>
1.75      rillig   6211: <div class="sect2" lang="en">
                   6212: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   6213: <a name="fonts-disable"></a>14.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75      rillig   6214: <p>The automatic update of fonts databases can be disabled by
1.76      rillig   6215: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75      rillig   6216: environment variable to <code class="literal">NO</code>.</p>
                   6217: </div>
                   6218: </div>
                   6219: </div>
                   6220: <div class="chapter" lang="en">
                   6221: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   6222: <a name="options"></a>Chapter 15. Options handling</h2></div></div></div>
1.75      rillig   6223: <div class="toc">
                   6224: <p><b>Table of Contents</b></p>
                   6225: <dl>
1.90      rillig   6226: <dt><span class="sect1"><a href="#global-default-options">15.1. Global default options</a></span></dt>
                   6227: <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>
                   6228: <dt><span class="sect1"><a href="#option-names">15.3. Option Names</a></span></dt>
1.75      rillig   6229: </dl>
                   6230: </div>
                   6231: <p>Many packages have the ability to be built to support different
1.76      rillig   6232: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
1.75      rillig   6233: in pkgsrc that provides generic handling of those options that
                   6234: determine different ways in which the packages can be built.  It's
                   6235: possible for the user to specify exactly which sets of options will be
                   6236: built into a package or to allow a set of global default options
                   6237: apply.</p>
                   6238: <div class="sect1" lang="en">
                   6239: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6240: <a name="global-default-options"></a>15.1. Global default options</h2></div></div></div>
1.75      rillig   6241: <p>Global default options are listed in
                   6242: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   6243: that should be built into every package if that option is supported.
1.76      rillig   6244: This variable should be set in <code class="filename">/etc/mk.conf</code>.</p>
1.75      rillig   6245: </div>
                   6246: <div class="sect1" lang="en">
                   6247: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   6248: <a name="converting-to-options"></a>15.2. Converting packages to use <code class="filename">bsd.options.mk</code>
                   6249: </h2></div></div></div>
1.75      rillig   6250: <p>The following example shows how
1.76      rillig   6251: <code class="filename">bsd.options.mk</code> should be used
1.75      rillig   6252: by the hypothetical ``wibble'' package, either in the package
1.76      rillig   6253: <code class="filename">Makefile</code>, or in a file,
                   6254: e.g. <code class="filename">options.mk</code>, that is included by the
                   6255: main package <code class="filename">Makefile</code>.</p>
1.75      rillig   6256: <pre class="programlisting">
1.100   ! rillig   6257: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
        !          6258: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
        !          6259: PKG_OPTIONS_OPTIONAL_GROUPS=    database
        !          6260: PKG_OPTIONS_GROUP.database=     mysql pgsql
        !          6261: PKG_SUGGESTED_OPTIONS=          wibble-foo
        !          6262: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
        !          6263: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
        !          6264: 
        !          6265: .include "../../mk/bsd.prefs.mk"
        !          6266: 
        !          6267: # this package was previously named wibble2
        !          6268: .if defined(PKG_OPTIONS.wibble2)
        !          6269: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
        !          6270: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
        !          6271:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
        !          6272: .endif
        !          6273: 
        !          6274: .include "../../mk/bsd.options.mk"
        !          6275: 
        !          6276: # Package-specific option-handling
        !          6277: 
        !          6278: ###
        !          6279: ### FOO support
        !          6280: ###
        !          6281: .if !empty(PKG_OPTIONS:Mwibble-foo)
        !          6282: CONFIGURE_ARGS+=    --enable-foo
        !          6283: .endif
        !          6284: 
        !          6285: ###
        !          6286: ### LDAP support
        !          6287: ###
        !          6288: .if !empty(PKG_OPTIONS:Mldap)
        !          6289: .  include "../../databases/openldap-client/buildlink3.mk"
        !          6290: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
        !          6291: .endif
        !          6292: 
        !          6293: ###
        !          6294: ### database support
        !          6295: ###
        !          6296: .if !empty(PKG_OPTIONS:Mmysql)
        !          6297: .  include "../../mk/mysql.buildlink3.mk"
        !          6298: .endif
        !          6299: .if !empty(PKG_OPTIONS:Mpgsql)
        !          6300: .  include "../../mk/pgsql.buildlink3.mk"
        !          6301: .endif
1.75      rillig   6302: </pre>
                   6303: <p>The first section contains the information about which build
                   6304: options are supported by the package, and any default options settings
                   6305: if needed.</p>
                   6306: <div class="orderedlist"><ol type="1">
                   6307: <li><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
                   6308: <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
                   6309: options.  It should be set to
1.78      rillig   6310: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   6311: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   6312: at the point where the options are processed.</p></li>
1.75      rillig   6313: <li><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
                   6314: build options supported by the package.</p></li>
                   6315: <li><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
                   6316: list of names of groups of mutually exclusive options.  The options in
                   6317: each group are listed in
                   6318: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   6319: The most specific setting of any option from the group takes
                   6320: precedence over all other options in the group.  Options from the
                   6321: groups will be automatically added to
                   6322: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
                   6323: <li><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
                   6324: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   6325: packages will fail if no option from the group is
                   6326: selected.</p></li>
                   6327: <li><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
                   6328: of names of sets of options.  At least one option from each set must
                   6329: be selected.  The options in each set are listed in
                   6330: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   6331: Options from the sets will be automatically added to
                   6332: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   6333: fail if no option from the set is selected.</p></li>
                   6334: <li><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
                   6335: build options which are enabled by default.</p></li>
                   6336: <li><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
                   6337: of
                   6338: &#8220;<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>&#8221;
1.76      rillig   6339: pairs that map legacy <code class="filename">/etc/mk.conf</code> variables to
1.75      rillig   6340: their option counterparts.  Pairs should be added with
                   6341: &#8220;<span class="quote">+=</span>&#8221; to keep the listing of global legacy variables.  A
                   6342: warning will be issued if the user uses a legacy
                   6343: variable.</p></li>
                   6344: <li><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
                   6345: of
                   6346: &#8220;<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>&#8221;
                   6347: pairs that map options that have been renamed to their new
                   6348: counterparts.  Pairs should be added with &#8220;<span class="quote">+=</span>&#8221; to keep
                   6349: the listing of global legacy options.  A warning will be issued if
                   6350: the user uses a legacy option.</p></li>
                   6351: <li><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
                   6352: options implied by deprecated variables used.  This can be used for
                   6353: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   6354: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   6355: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
                   6356: <li><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
                   6357: a list of warnings about deprecated variables or options used, and
                   6358: what to use instead.</p></li>
                   6359: </ol></div>
                   6360: <p>A package should never modify
                   6361: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   6362: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   6363: To suggest a default set of options, use
                   6364: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   6365: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76      rillig   6366: including <code class="filename">bsd.options.mk</code>.  If none of
1.75      rillig   6367: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   6368: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   6369: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   6370: happen with platform-specific options if none of them is supported on
                   6371: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   6372: empty list and the package is otherwise treated as not using the
                   6373: options framework.</p>
1.76      rillig   6374: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75      rillig   6375: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   6376: build options, properly filtered to remove unsupported and duplicate
                   6377: options.</p>
                   6378: <p>The remaining sections contain the logic that is specific to
                   6379: each option.  The correct way to check for an option is to check
                   6380: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   6381: <pre class="programlisting">
1.100   ! rillig   6382: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75      rillig   6383: </pre>
                   6384: </div>
                   6385: <div class="sect1" lang="en">
                   6386: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6387: <a name="option-names"></a>15.3. Option Names</h2></div></div></div>
1.75      rillig   6388: <p>Options that enable similar features in different packages (like
                   6389: optional support for a library) should use a common name in all
                   6390: packages that support it (like the name of the library).  If another
                   6391: package already has an option with the same meaning, use the same
                   6392: name.</p>
                   6393: <p>Options that enable features specific to one package, where it's
                   6394: unlikely that another (unrelated) package has the same (or a similar)
                   6395: optional feature, should use a name prefixed with
                   6396: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   6397: <p>If a group of related packages share an optional feature
                   6398: specific to that group, prefix it with the name of the
                   6399: &#8220;<span class="quote">main</span>&#8221; package
                   6400: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   6401: <p>For new options, add a line to
1.76      rillig   6402: <code class="filename">mk/defaults/options.description</code>.  Lines have two
1.75      rillig   6403: fields, separated by tab.  The first field is the option name, the
                   6404: second its description.  The description should be a whole sentence
                   6405: (starting with an uppercase letter and ending with a period) that
                   6406: describes what enabling the option does.  E. g. &#8220;<span class="quote">Enable ispell
                   6407: support.</span>&#8221; The file is sorted by option names.</p>
                   6408: </div>
                   6409: </div>
                   6410: <div class="chapter" lang="en">
                   6411: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   6412: <a name="build"></a>Chapter 16. The build process</h2></div></div></div>
1.75      rillig   6413: <div class="toc">
                   6414: <p><b>Table of Contents</b></p>
                   6415: <dl>
1.90      rillig   6416: <dt><span class="sect1"><a href="#build.intro">16.1. Introduction</a></span></dt>
                   6417: <dt><span class="sect1"><a href="#build.prefix">16.2. Program location</a></span></dt>
                   6418: <dt><span class="sect1"><a href="#build.builddirs">16.3. Directories used during the build process</a></span></dt>
                   6419: <dt><span class="sect1"><a href="#build.running">16.4. Running a phase</a></span></dt>
                   6420: <dt><span class="sect1"><a href="#build.fetch">16.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   6421: <dd><dl>
                   6422: <dt><span class="sect2"><a href="#build.fetch.what">16.5.1. What to fetch and where to get it from</a></span></dt>
                   6423: <dt><span class="sect2"><a href="#build.fetch.how">16.5.2. How are the files fetched?</a></span></dt>
                   6424: </dl></dd>
                   6425: <dt><span class="sect1"><a href="#build.checksum">16.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   6426: <dt><span class="sect1"><a href="#build.extract">16.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   6427: <dt><span class="sect1"><a href="#build.patch">16.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   6428: <dt><span class="sect1"><a href="#build.tools">16.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   6429: <dt><span class="sect1"><a href="#build.wrapper">16.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   6430: <dt><span class="sect1"><a href="#build.configure">16.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   6431: <dt><span class="sect1"><a href="#build.build">16.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   6432: <dt><span class="sect1"><a href="#build.test">16.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   6433: <dt><span class="sect1"><a href="#build.install">16.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   6434: <dt><span class="sect1"><a href="#build.package">16.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   6435: <dt><span class="sect1"><a href="#build.clean">16.16. Cleaning up</a></span></dt>
                   6436: <dt><span class="sect1"><a href="#build.helpful-targets">16.17. Other helpful targets</a></span></dt>
1.75      rillig   6437: </dl>
                   6438: </div>
                   6439: <div class="sect1" lang="en">
                   6440: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6441: <a name="build.intro"></a>16.1. Introduction</h2></div></div></div>
1.75      rillig   6442: <p>This chapter gives a detailed description on how a package is
1.87      wiz      6443:     built. Building a package is separated into different
                   6444:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   6445:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
                   6446:     described in the following sections. Each phase is splitted into
                   6447:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   6448:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   6449:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   6450:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   6451:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97      rillig   6452: <p>Never override the regular targets (like
                   6453:     <code class="varname">fetch</code>), if you have to, override the
                   6454:     <code class="varname">do-*</code> ones instead.</p>
1.75      rillig   6455: <p>The basic steps for building a program are always the same.  First
1.87      wiz      6456:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   6457:     the local system and then extracted. After any pkgsrc-specific patches
                   6458:     to compile properly are applied, the software can be configured, then
                   6459:     built (usually by compiling), and finally the generated binaries, etc.
                   6460:     can be put into place on the system.</p>
1.97      rillig   6461: <p>To get more details about what is happening at each step,
                   6462:     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
                   6463:     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
                   6464:     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75      rillig   6465: </div>
                   6466: <div class="sect1" lang="en">
                   6467: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6468: <a name="build.prefix"></a>16.2. Program location</h2></div></div></div>
1.75      rillig   6469: <p>Before outlining the process performed by the NetBSD package system in
1.87      wiz      6470:     the next section, here's a brief discussion on where programs are
                   6471:     installed, and which variables influence this.</p>
1.75      rillig   6472: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87      wiz      6473:     where all files of the final program shall be installed. It is
                   6474:     usually set to <code class="varname">LOCALBASE</code>
                   6475:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88      wiz      6476:     for pkgs in the <code class="filename">cross</code> category.  The value of
1.87      wiz      6477:     <code class="varname">PREFIX</code> needs to be put
                   6478:     into the various places in the program's source where paths to
1.90      rillig   6479:     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   6480: <p>When choosing which of these variables to use,
1.87      wiz      6481:     follow the following rules:</p>
1.75      rillig   6482: <div class="itemizedlist"><ul type="disc">
1.88      wiz      6483: <li><p><code class="varname">PREFIX</code> always points to the location
                   6484:        where the current pkg will be installed.  When referring to a
                   6485:        pkg's own installation path, use
                   6486:        &#8220;<span class="quote">${PREFIX}</span>&#8221;.</p></li>
                   6487: <li><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
                   6488:        are installed.  If you need to construct a -I or -L argument
                   6489:        to the compiler to find includes and libraries installed by
                   6490:        another non-X11 pkg, use &#8220;<span class="quote">${LOCALBASE}</span>&#8221;. The name
1.87      wiz      6491:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   6492:        installed all packages in <code class="filename">/usr/local</code>. As
                   6493:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   6494:        administrator, this variable is a misnomer.</p></li>
1.88      wiz      6495: <li><p><code class="varname">X11BASE</code> is where the actual X11
                   6496:        distribution (from xsrc, etc.) is installed. When looking for
                   6497:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
                   6498:        installed by a package), use &#8220;<span class="quote">${X11BASE}</span>&#8221;.</p></li>
                   6499: <li>
                   6500: <p>X11-based packages are special in that they may be
                   6501:        installed in either <code class="varname">X11BASE</code> or
                   6502:        <code class="varname">LOCALBASE</code>.</p>
1.75      rillig   6503: <p>Usually, X11 packages should be installed under
1.88      wiz      6504:        <code class="varname">LOCALBASE</code> whenever possible.  Note that you
                   6505:        will need to include
                   6506:        <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
                   6507:        request the presence of X11 and to get the right compilation
                   6508:        flags.</p>
1.75      rillig   6509: <p>Even though, there are some packages that cannot be installed
1.87      wiz      6510:        under <code class="varname">LOCALBASE</code>: those that come with app-defaults
                   6511:        files. These packages are special and they must be placed under
                   6512:        <code class="varname">X11BASE</code>. To accomplish this, set either
                   6513:        <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
                   6514:        your package.</p>
1.75      rillig   6515: <p>Some notes: If you need
1.87      wiz      6516:        to find includes or libraries installed by a pkg that has
                   6517:        <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
                   6518:        its pkg <code class="filename">Makefile</code>, you need to look in
                   6519:        <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
                   6520:        <code class="filename">${LOCALBASE}</code>. To force installation of
                   6521:        all X11 packages in <code class="varname">LOCALBASE</code>, the
1.91      rillig   6522:        <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      6523:        is enabled by default.</p>
1.75      rillig   6524: </li>
1.88      wiz      6525: <li><p><code class="varname">X11PREFIX</code> should be used to refer to
                   6526:        the installed location of an X11
                   6527:        package. <code class="varname">X11PREFIX</code> will be set to
                   6528:        <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
                   6529:        to <code class="varname">LOCALBASE</code> if xpkgwedge is
                   6530:        installed.</p></li>
                   6531: <li>
                   6532: <p>If xpkgwedge is installed, it is possible to have some
                   6533:        packages installed in <code class="varname">X11BASE</code> and some in
                   6534:        <code class="varname">LOCALBASE</code>.  To determine the prefix of an
                   6535:        installed package, the <code class="varname">EVAL_PREFIX</code>
                   6536:        definition can be used. It takes pairs in the format
                   6537:        &#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>
                   6538:        variable <code class="varname">DIRNAME</code> will be set to the prefix
                   6539:        of the installed package &lt;package&gt;, or
                   6540:        &#8220;<span class="quote">${X11PREFIX}</span>&#8221; if the package is not
                   6541:        installed.</p>
1.75      rillig   6542: <p>This is best illustrated by example.</p>
                   6543: <p>The following lines are taken from
1.87      wiz      6544:        <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75      rillig   6545: <pre class="programlisting">
1.100   ! rillig   6546: EVAL_PREFIX+=           GTKDIR=gtk+
        !          6547: CONFIGURE_ARGS+=        --with-guile-prefix=${LOCALBASE:Q}
        !          6548: CONFIGURE_ARGS+=        --with-gtk-prefix=${GTKDIR:Q}
        !          6549: CONFIGURE_ARGS+=        --enable-multibyte
        !          6550: </pre>
1.88      wiz      6551: <p>Specific defaults can be defined for the packages
                   6552:        evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
                   6553:        definition of the form:</p>
1.75      rillig   6554: <pre class="programlisting">
1.100   ! rillig   6555: GTKDIR_DEFAULT= ${LOCALBASE}
        !          6556: </pre>
1.75      rillig   6557: <p>where <code class="varname">GTKDIR</code> corresponds
1.87      wiz      6558:        to the first definition in
                   6559:        the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75      rillig   6560: </li>
1.76      rillig   6561: <li><p>Within <code class="filename">${PREFIX}</code>, packages should
1.87      wiz      6562:        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
                   6563:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   6564:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75      rillig   6565: </ul></div>
                   6566: </div>
                   6567: <div class="sect1" lang="en">
                   6568: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6569: <a name="build.builddirs"></a>16.3. Directories used during the build process</h2></div></div></div>
1.75      rillig   6570: <p>When building a package, a number of directories is used to store
1.87      wiz      6571:     source files, temporary files, pkgsrc-internal files, and so on. These
                   6572:     directories are explained here.</p>
1.75      rillig   6573: <p>Some of the directory variables contain relative pathnames. There
1.87      wiz      6574:     are two common base directories for these relative directories:
                   6575:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   6576:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   6577:     inside the package itself.</p>
1.75      rillig   6578: <div class="variablelist"><dl>
                   6579: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   6580: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87      wiz      6581:       root directory. Generally, you don't need
                   6582:       it.</p></dd>
1.97      rillig   6583: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
                   6584: <dd><p>This is an absolute pathname that points to the
                   6585:       current package.</p></dd>
1.75      rillig   6586: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
                   6587: <dd><p>This is a pathname relative to
1.87      wiz      6588:       <code class="varname">PKGSRCDIR</code> that points to the current
                   6589:       package.</p></dd>
1.75      rillig   6590: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   6591: <dd><p>This is an absolute pathname pointing to the directory
1.93      rillig   6592:       where all work takes place. The distfiles are extracted to this
1.87      wiz      6593:       directory. It also contains temporary directories and log files used by
                   6594:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   6595:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75      rillig   6596: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   6597: <dd><p>This is an absolute pathname pointing to the directory
1.87      wiz      6598:       where the distfiles are extracted. It is usually a direct subdirectory
                   6599:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   6600:       that isn't hidden. This variable may be changed by a package
                   6601:       <code class="filename">Makefile</code>.</p></dd>
1.75      rillig   6602: </dl></div>
                   6603: </div>
                   6604: <div class="sect1" lang="en">
                   6605: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6606: <a name="build.running"></a>16.4. Running a phase</h2></div></div></div>
1.75      rillig   6607: <p>You can run a particular phase by typing <span><strong class="command">make
1.87      wiz      6608:     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
                   6609:     phase. This will automatically run all phases that are required for this
                   6610:     phase. The default phase is <code class="varname">build</code>, that is, when you
                   6611:     run <span><strong class="command">make</strong></span> without parameters in a package directory,
                   6612:     the package will be built, but not installed.</p>
1.75      rillig   6613: </div>
                   6614: <div class="sect1" lang="en">
                   6615: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6616: <a name="build.fetch"></a>16.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81      rillig   6617: <p>The first step in building a package is to fetch the
1.88      wiz      6618:     distribution files (distfiles) from the sites that are providing
                   6619:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   6620:     phase.</p>
1.81      rillig   6621: <div class="sect2" lang="en">
                   6622: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   6623: <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      6624: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   6625:       defines all URLs from where the distfile, whose name is
                   6626:       derived from the <code class="varname">DISTNAME</code> variable, is
                   6627:       fetched. The more complicated cases are described
                   6628:       below.</p>
                   6629: <p>The variable <code class="varname">DISTFILES</code> specifies
                   6630:       the list of distfiles that have to be fetched. Its value
                   6631:       defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
                   6632:       so that most packages don't need to define it at all.
                   6633:       <code class="varname">EXTRACT_SUFX</code> is
                   6634:       <code class="literal">.tar.gz</code> by default, but can be changed
                   6635:       freely. Note that if your package requires additional
                   6636:       distfiles to the default one, you cannot just append the
                   6637:       additional filenames using the <code class="literal">+=</code>
                   6638:       operator, but you have write for example:</p>
1.81      rillig   6639: <pre class="programlisting">
1.100   ! rillig   6640: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
        !          6641: </pre>
1.88      wiz      6642: <p>Each distfile is fetched from a list of sites, usually
                   6643:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   6644:       <code class="varname">DISTFILES</code> or multiple
                   6645:       <code class="varname">PATCHFILES</code> from different sites, you can
                   6646:       set
                   6647:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   6648:       to the list of URLs where the file
                   6649:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   6650:       (including the suffix) can be found.</p>
                   6651: <pre class="programlisting">
1.100   ! rillig   6652: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
        !          6653: DISTFILES+=     foo-file.tar.gz
        !          6654: SITES.foo-file.tar.gz= \
        !          6655: http://www.somewhere.com/somehow/ \
        !          6656: http://www.somewhereelse.com/mirror/somehow/
        !          6657: </pre>
1.81      rillig   6658: <p>When actually fetching the distfiles, each item from
1.88      wiz      6659:       <code class="varname">MASTER_SITES</code> or
                   6660:       <code class="varname">SITES.*</code> gets the name of each distfile
                   6661:       appended to it, without an intermediate slash. Therefore,
                   6662:       all site values have to end with a slash or other separator
                   6663:       character. This allows for example to set
                   6664:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   6665:       that gets the name of the distfile as a parameter. In this
                   6666:       case, the definition would look like:</p>
1.81      rillig   6667: <pre class="programlisting">
1.100   ! rillig   6668: MASTER_SITES=   http://www.example.com/download.cgi?file=
        !          6669: </pre>
1.81      rillig   6670: <p>There are some predefined values for
1.88      wiz      6671:       <code class="varname">MASTER_SITES</code>, which can be used in
                   6672:       packages.  The names of the variables should speak for
                   6673:       themselves.</p>
                   6674: <pre class="programlisting">
1.100   ! rillig   6675: ${MASTER_SITE_APACHE}
        !          6676: ${MASTER_SITE_BACKUP}
        !          6677: ${MASTER_SITE_CYGWIN}
        !          6678: ${MASTER_SITE_DEBIAN}
        !          6679: ${MASTER_SITE_FREEBSD}
        !          6680: ${MASTER_SITE_FREEBSD_LOCAL}
        !          6681: ${MASTER_SITE_GENTOO}
        !          6682: ${MASTER_SITE_GNOME}
        !          6683: ${MASTER_SITE_GNU}
        !          6684: ${MASTER_SITE_GNUSTEP}
        !          6685: ${MASTER_SITE_IFARCHIVE}
        !          6686: ${MASTER_SITE_KDE}
        !          6687: ${MASTER_SITE_MOZILLA}
        !          6688: ${MASTER_SITE_MYSQL}
        !          6689: ${MASTER_SITE_OPENOFFICE}
        !          6690: ${MASTER_SITE_PERL_CPAN}
        !          6691: ${MASTER_SITE_PGSQL}
        !          6692: ${MASTER_SITE_R_CRAN}
        !          6693: ${MASTER_SITE_SOURCEFORGE}
        !          6694: ${MASTER_SITE_SOURCEFORGE_JP}
        !          6695: ${MASTER_SITE_SUNSITE}
        !          6696: ${MASTER_SITE_SUSE}
        !          6697: ${MASTER_SITE_TEX_CTAN}
        !          6698: ${MASTER_SITE_XCONTRIB}
        !          6699: ${MASTER_SITE_XEMACS}
        !          6700: </pre>
1.88      wiz      6701: <p>Some explanations for the less self-explaining ones:
                   6702:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.93      rillig   6703:       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
                   6704:       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      6705: <p>If you choose one of these predefined sites, you may
                   6706:       want to specify a subdirectory of that site. Since these
                   6707:       macros may expand to more than one actual site, you
                   6708:       <span class="emphasis"><em>must</em></span> use the following construct to
                   6709:       specify a subdirectory:</p>
1.81      rillig   6710: <pre class="programlisting">
1.100   ! rillig   6711: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
        !          6712: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
        !          6713: </pre>
1.81      rillig   6714: <p>Note the trailing slash after the subdirectory
1.88      wiz      6715:       name.</p>
1.81      rillig   6716: </div>
                   6717: <div class="sect2" lang="en">
                   6718: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   6719: <a name="build.fetch.how"></a>16.5.2. How are the files fetched?</h3></div></div></div>
1.88      wiz      6720: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   6721:       all the distfiles exist in a local directory
1.93      rillig   6722:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88      wiz      6723:       user). If the files do not exist, they are fetched using
                   6724:       commands of the form</p>
1.75      rillig   6725: <pre class="programlisting">
1.100   ! rillig   6726: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
        !          6727: </pre>
1.88      wiz      6728: <p>where <code class="literal">${site}</code> varies through
                   6729:       several possibilities in turn: first,
                   6730:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   6731:       sites specified in either <code class="varname">SITES.file</code> if
                   6732:       defined, else <code class="varname">MASTER_SITES</code> or
                   6733:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   6734:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91      rillig   6735:       all except the first and the last can be optionally sorted
                   6736:       by the user, via setting either
                   6737:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   6738:       <code class="varname">MASTER_SORT_AWK</code> or
1.88      wiz      6739:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.97      rillig   6740: <p>The distfiles mirror run by the NetBSD Foundation uses the
                   6741:       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
                   6742:       distfiles, if they are freely distributable.  Packages setting
                   6743:       <code class="varname">NO_SRC_ON_FTP</code> (usually to
                   6744:       &#8220;<span class="quote">${RESTRICTED}</span>&#8221;) will not have their distfiles
                   6745:       mirrored.</p>
1.81      rillig   6746: </div>
1.75      rillig   6747: </div>
                   6748: <div class="sect1" lang="en">
                   6749: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6750: <a name="build.checksum"></a>16.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88      wiz      6751: <p>After the distfile(s) are fetched, their checksum is
                   6752:     generated and compared with the checksums stored in the
                   6753:     distinfo file. If the checksums don't match, the build is
                   6754:     aborted. This is to ensure the same distfile is used for
                   6755:     building, and that the distfile wasn't changed, e.g. by some
                   6756:     malign force, deliberately changed distfiles on the master
                   6757:     distribution site or network lossage.</p>
1.75      rillig   6758: </div>
                   6759: <div class="sect1" lang="en">
                   6760: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6761: <a name="build.extract"></a>16.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75      rillig   6762: <p>When the distfiles are present on the local system, they
1.88      wiz      6763:     need to be extracted, as they usually come in the form of some
                   6764:     compressed archive format.</p>
1.75      rillig   6765: <p>By default, all <code class="varname">DISTFILES</code> are
1.88      wiz      6766:     extracted. If you only need some of them, you can set the
                   6767:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   6768:     files.</p>
                   6769: <p>Extracting the files is usually done by a little
1.93      rillig   6770:     program, <code class="filename">mk/extract/extract</code>, which
1.88      wiz      6771:     already knows how to extract various archive formats, so most
                   6772:     likely you will not need to change anything here. But if you
                   6773:     need, the following variables may help you:</p>
1.75      rillig   6774: <div class="variablelist"><dl>
                   6775: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   6776: <dd><p>Use these variables to override the default
1.88      wiz      6777:       options for an extract command, which are defined in
1.93      rillig   6778:       <code class="filename">mk/extract/extract</code>.</p></dd>
1.75      rillig   6779: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   6780: <dd><p>This variable can be set to
1.93      rillig   6781:       <code class="literal">gtar</code>, <code class="literal">nbtar</code> (which is the
                   6782:       default value), <code class="literal">pax</code>, or an
1.88      wiz      6783:       absolute pathname pointing to the command with which tar
                   6784:       archives should be
                   6785:       extracted.</p></dd>
1.75      rillig   6786: </dl></div>
1.88      wiz      6787: <p>If the <code class="filename">extract</code> program doesn't
                   6788:     serve your needs, you can also override the
                   6789:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   6790:     command used for extracting the files. This command is
                   6791:     executed in the <code class="filename">${WRKSRC}</code>
                   6792:     directory. During execution of this command, the shell
                   6793:     variable <code class="varname">extract_file</code> holds the absolute
                   6794:     pathname of the file that is going to be extracted.</p>
1.75      rillig   6795: <p>And if that still does not suffice, you can override the
1.88      wiz      6796:     <code class="varname">do-extract</code> target in the package
                   6797:     Makefile.</p>
1.75      rillig   6798: </div>
                   6799: <div class="sect1" lang="en">
                   6800: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6801: <a name="build.patch"></a>16.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75      rillig   6802: <p>After extraction, all the patches named by the
1.88      wiz      6803:     <code class="varname">PATCHFILES</code>, those present in the patches
                   6804:     subdirectory of the package as well as in
                   6805:     $LOCALPATCHES/$PKGPATH (e.g.
                   6806:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   6807:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   6808:     <code class="filename">.gz</code> are uncompressed before they are
                   6809:     applied, files ending in <code class="filename">.orig</code> or
                   6810:     <code class="filename">.rej</code> are ignored. Any special options to
                   6811:     <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   6812:     <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      6813: <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
                   6814:     it fail if the patches apply with some lines of fuzz. Please
                   6815:     fix (regen) the patches so that they apply cleanly. The
                   6816:     rationale behind this is that patches that don't apply cleanly
                   6817:     may end up being applied in the wrong place, and cause severe
                   6818:     harm there.</p>
1.75      rillig   6819: </div>
                   6820: <div class="sect1" lang="en">
                   6821: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6822: <a name="build.tools"></a>16.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
                   6823: <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      6824:     </p>
1.75      rillig   6825: </div>
                   6826: <div class="sect1" lang="en">
                   6827: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6828: <a name="build.wrapper"></a>16.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75      rillig   6829: <p>This phase creates wrapper programs for the compilers and
1.88      wiz      6830:     linkers. The following variables can be used to tweak the
                   6831:     wrappers.</p>
1.75      rillig   6832: <div class="variablelist"><dl>
                   6833: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   6834: <dd><p>The command used to print progress
1.88      wiz      6835:       messages. Does nothing by default. Set to
                   6836:       <code class="literal">${ECHO}</code> to see the progress
                   6837:       messages.</p></dd>
1.75      rillig   6838: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   6839: <dd><p>This variable can be set to
1.88      wiz      6840:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   6841:       depending on whether you want additional information in the
                   6842:       wrapper log file.</p></dd>
1.75      rillig   6843: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   6844: <dd><p>This variable can be set to
1.88      wiz      6845:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   6846:       on whether the wrapper should use its cache, which will
                   6847:       improve the speed. The default value is
                   6848:       <code class="literal">yes</code>, but is forced to
                   6849:       <code class="literal">no</code> if the platform does not support
                   6850:       it.</p></dd>
1.75      rillig   6851: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88      wiz      6852: <dd><p>A list of reordering commands. A reordering
                   6853:       command has the form
                   6854:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   6855:       It ensures that that
                   6856:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   6857:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   6858:       </p></dd>
1.75      rillig   6859: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
                   6860: <dd><p>A list of transformation commands. [TODO:
1.88      wiz      6861:       investigate further]</p></dd>
1.75      rillig   6862: </dl></div>
                   6863: </div>
                   6864: <div class="sect1" lang="en">
                   6865: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6866: <a name="build.configure"></a>16.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88      wiz      6867: <p>Most pieces of software need information on the header
                   6868:     files, system calls, and library routines which are available
                   6869:     on the platform they run on. The process of determining this
                   6870:     information is known as configuration, and is usually
                   6871:     automated. In most cases, a script is supplied with the
                   6872:     distfiles, and its invocation results in generation of header
                   6873:     files, Makefiles, etc.</p>
                   6874: <p>If the package contains a configure script, this can be
                   6875:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
                   6876:     &#8220;<span class="quote">yes</span>&#8221;. If the configure script is a GNU autoconf
                   6877:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
                   6878:     &#8220;<span class="quote">yes</span>&#8221; instead. What happens in the
                   6879:     <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
                   6880: <pre class="programlisting">
1.100   ! rillig   6881: .for d in ${CONFIGURE_DIRS}
        !          6882:         cd ${WRKSRC} \
        !          6883:         &amp;&amp; cd ${d} \
        !          6884:         &amp;&amp; env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
        !          6885: .endfor
        !          6886: </pre>
1.88      wiz      6887: <p><code class="varname">CONFIGURE_DIRS</code> (default:
                   6888:     &#8220;<span class="quote">.</span>&#8221;) is a list of pathnames relative to
                   6889:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   6890:     configure script is run with the environment
                   6891:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   6892:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   6893:     <code class="varname">CONFIGURE_ENV</code>,
                   6894:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
                   6895:     &#8220;<span class="quote">./configure</span>&#8221;) and
                   6896:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   6897:     package.</p>
                   6898: <p>If the program uses an <code class="filename">Imakefile</code>
                   6899:     for configuration, the appropriate steps can be invoked by
                   6900:     setting <code class="varname">USE_IMAKE</code> to
                   6901:     &#8220;<span class="quote">yes</span>&#8221;. (If you only want the package installed in
                   6902:     <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
1.97      rillig   6903:     <code class="varname">USE_X11BASE</code> instead.)  You can add variables to
                   6904:     xmkmf's environment by adding them to the
                   6905:     <code class="varname">SCRIPTS_ENV</code> variable.</p>
                   6906: <p>If there is no configure step at all, set
                   6907:     <code class="varname">NO_CONFIGURE</code> to &#8220;<span class="quote">yes</span>&#8221;.</p>
1.75      rillig   6908: </div>
                   6909: <div class="sect1" lang="en">
                   6910: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6911: <a name="build.build"></a>16.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88      wiz      6912: <p>For building a package, a rough equivalent of the
                   6913:     following code is executed.</p>
1.75      rillig   6914: <pre class="programlisting">
1.100   ! rillig   6915: .for d in ${BUILD_DIRS}
        !          6916:         cd ${WRKSRC} \
        !          6917:         &amp;&amp; cd ${d} \
        !          6918:         &amp;&amp; env ${MAKE_ENV} \
        !          6919:             ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
        !          6920:                 -f ${MAKE_FILE} \
        !          6921:                 ${BUILD_TARGET}
        !          6922: .endfor
        !          6923: </pre>
1.88      wiz      6924: <p><code class="varname">BUILD_DIRS</code> (default:
                   6925:     &#8220;<span class="quote">.</span>&#8221;) is a list of pathnames relative to
                   6926:     <code class="varname">WRKSRC</code>. In each of these directories,
                   6927:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   6928:     <code class="varname">MAKE_ENV</code> and arguments
                   6929:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   6930:     <code class="varname">MAKE_ENV</code>,
                   6931:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   6932:     <code class="varname">MAKE_FILE</code> and
                   6933:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   6934:     package.</p>
1.75      rillig   6935: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.88      wiz      6936:     &#8220;<span class="quote">gmake</span>&#8221; if <code class="varname">USE_TOOLS</code> contains
                   6937:     &#8220;<span class="quote">gmake</span>&#8221;, &#8220;<span class="quote">make</span>&#8221; otherwise. The
                   6938:     default value of <code class="varname">MAKE_FILE</code> is
                   6939:     &#8220;<span class="quote">Makefile</span>&#8221;, and <code class="varname">BUILD_TARGET</code>
                   6940:     defaults to &#8220;<span class="quote">all</span>&#8221;.</p>
1.97      rillig   6941: <p>If there is no build step at all, set
                   6942:     <code class="varname">NO_BUILD</code> to &#8220;<span class="quote">yes</span>&#8221;.</p>
1.75      rillig   6943: </div>
                   6944: <div class="sect1" lang="en">
                   6945: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6946: <a name="build.test"></a>16.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75      rillig   6947: <p>[TODO]</p>
                   6948: </div>
                   6949: <div class="sect1" lang="en">
                   6950: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6951: <a name="build.install"></a>16.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75      rillig   6952: <p>Once the build stage has completed, the final step is to
1.88      wiz      6953:     install the software in public directories, so users can
                   6954:     access the programs and files.</p>
1.75      rillig   6955: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88      wiz      6956:     equivalent of the following code is executed. Additionally,
                   6957:     before and after this code, much magic is performed to do
                   6958:     consistency checks, registering the package, and so on.</p>
                   6959: <pre class="programlisting">
1.100   ! rillig   6960: .for d in ${INSTALL_DIRS}
        !          6961:         cd ${WRKSRC} \
        !          6962:         &amp;&amp; cd ${d} \
        !          6963:         &amp;&amp; env ${MAKE_ENV} \
        !          6964:             ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
        !          6965:                 -f ${MAKE_FILE} \
        !          6966:                 ${INSTALL_TARGET}
        !          6967: .endfor
        !          6968: </pre>
1.75      rillig   6969: <p>The variable's meanings are analogous to the ones in the
1.88      wiz      6970:     <span class="emphasis"><em>build</em></span> phase.
                   6971:     <code class="varname">INSTALL_DIRS</code> defaults to
                   6972:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
                   6973:     is &#8220;<span class="quote">install</span>&#8221; by default, plus
                   6974:     &#8220;<span class="quote">install.man</span>&#8221; if <code class="varname">USE_IMAKE</code> is
                   6975:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   6976:     defined.</p>
1.75      rillig   6977: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88      wiz      6978:     variables are useful. They are all variations of the
                   6979:     <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
                   6980:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   6981:     install command. The specialized variants, together with their
                   6982:     intended use, are:</p>
1.75      rillig   6983: <div class="variablelist"><dl>
                   6984: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88      wiz      6985: <dd><p>directories that contain
                   6986:       binaries</p></dd>
1.75      rillig   6987: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88      wiz      6988: <dd><p>directories that contain
                   6989:       scripts</p></dd>
1.75      rillig   6990: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88      wiz      6991: <dd><p>directories that contain shared and static
                   6992:       libraries</p></dd>
1.75      rillig   6993: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88      wiz      6994: <dd><p>directories that contain data
                   6995:       files</p></dd>
1.75      rillig   6996: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88      wiz      6997: <dd><p>directories that contain man
                   6998:       pages</p></dd>
1.75      rillig   6999: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88      wiz      7000: <dd><p>binaries that can be stripped from debugging
                   7001:       symbols</p></dd>
1.75      rillig   7002: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88      wiz      7003: <dd><p>binaries that cannot be
                   7004:       stripped</p></dd>
1.75      rillig   7005: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88      wiz      7006: <dd><p>game
                   7007:       binaries</p></dd>
1.75      rillig   7008: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88      wiz      7009: <dd><p>shared and static
                   7010:       libraries</p></dd>
1.75      rillig   7011: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   7012: <dd><p>data files</p></dd>
                   7013: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88      wiz      7014: <dd><p>data files for
                   7015:       games</p></dd>
1.75      rillig   7016: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   7017: <dd><p>man pages</p></dd>
                   7018: </dl></div>
                   7019: <p>Some other variables are:</p>
                   7020: <div class="variablelist"><dl>
                   7021: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   7022: <dd><p>A list of directories relative to
1.88      wiz      7023:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98      wiz      7024:       beginning of the <span class="emphasis"><em>install</em></span> phase.
                   7025:       The package is supposed to create all needed directories itself
                   7026:       before installing files to it and list all other directories here.
                   7027:       </p></dd>
1.75      rillig   7028: </dl></div>
1.97      rillig   7029: <p>In the rare cases that a package shouldn't install anything,
                   7030:     set <code class="varname">NO_INSTALL</code> to &#8220;<span class="quote">yes</span>&#8221;. This is
                   7031:     mostly relevant for packages in the <code class="filename">regress</code>
                   7032:     category.</p>
1.75      rillig   7033: </div>
                   7034: <div class="sect1" lang="en">
                   7035: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   7036: <a name="build.package"></a>16.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88      wiz      7037: <p>Once the install stage has completed, a binary package of
                   7038:     the installed files can be built.  These binary packages can be
                   7039:     used for quick installation without previous compilation, e.g. by
                   7040:     the <span><strong class="command">make bin-install</strong></span> or by using
                   7041:     <span><strong class="command">pkg_add</strong></span>.</p>
                   7042: <p>By default, the binary packages are created in
                   7043:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   7044:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   7045:     one for each category in the <code class="varname">CATEGORIES</code>
                   7046:     variable.  <code class="varname">PACKAGES</code> defaults to
                   7047:     <code class="filename">pkgsrc/packages</code>.</p>
1.97      rillig   7048: <p>If there should be no binary package, set
                   7049:     <code class="varname">NO_PACKAGE</code> to &#8220;<span class="quote">yes</span>&#8221;.
                   7050:     This should only be used in rare cases, like when a package
                   7051:     definitely is only usable on the machine where it is built and even
                   7052:     then, a binary package can be useful.</p>
1.88      wiz      7053: </div>
                   7054: <div class="sect1" lang="en">
                   7055: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   7056: <a name="build.clean"></a>16.16. Cleaning up</h2></div></div></div>
1.88      wiz      7057: <p>Once you're finished with a package, you can clean the work
                   7058:     directory by running <span><strong class="command">make clean</strong></span>.  If you want
                   7059:     to clean the work directories of all dependencies too, use
                   7060:     <span><strong class="command">make clean-depends</strong></span>.</p>
1.75      rillig   7061: </div>
                   7062: <div class="sect1" lang="en">
                   7063: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   7064: <a name="build.helpful-targets"></a>16.17. Other helpful targets</h2></div></div></div>
1.75      rillig   7065: <div class="variablelist"><dl>
                   7066: <dt><span class="term">pre/post-*</span></dt>
1.88      wiz      7067: <dd><p>For any of the main targets described in the
                   7068:          previous section, two auxiliary targets exist with
1.87      wiz      7069:          &#8220;<span class="quote">pre-</span>&#8221; and &#8220;<span class="quote">post-</span>&#8221; used as a
                   7070:          prefix for the main target's name.  These targets are
1.88      wiz      7071:          invoked before and after the main target is called,
                   7072:          allowing extra configuration or installation steps be
                   7073:          performed from a package's Makefile, for example, which
                   7074:          a program's configure script or install target
                   7075:          omitted.</p></dd>
1.75      rillig   7076: <dt><span class="term">do-*</span></dt>
1.88      wiz      7077: <dd><p>Should one of the main targets do the wrong thing,
                   7078:          and should there be no variable to fix this, you can
                   7079:          redefine it with the do-* target.  (Note that redefining
                   7080:          the target itself instead of the do-* target is a bad
                   7081:          idea, as the pre-* and post-* targets won't be called
                   7082:          anymore, etc.) You will not usually need to do
                   7083:          this.</p></dd>
1.75      rillig   7084: <dt><span class="term">reinstall</span></dt>
1.88      wiz      7085: <dd>
                   7086: <p>If you did a <span><strong class="command">make install</strong></span> and
                   7087:          you noticed some file was not installed properly, you
                   7088:          can repeat the installation with this target, which will
                   7089:          ignore the &#8220;<span class="quote">already installed</span>&#8221; flag.</p>
                   7090: <p>This is the default value of
                   7091:          <code class="varname">DEPENDS_TARGET</code> except in the case of
                   7092:          <span><strong class="command">make update</strong></span> and <span><strong class="command">make
                   7093:          package</strong></span>, where the defaults are
                   7094:          &#8220;<span class="quote">package</span>&#8221; and &#8220;<span class="quote">update</span>&#8221;,
                   7095:          respectively.</p>
                   7096: </dd>
1.75      rillig   7097: <dt><span class="term">deinstall</span></dt>
                   7098: <dd>
1.88      wiz      7099: <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
                   7100:          current directory, effectively de-installing the
                   7101:          package. The following variables can be used to tune the
                   7102:          behaviour:</p>
1.75      rillig   7103: <div class="variablelist"><dl>
                   7104: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
                   7105: <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>
                   7106: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88      wiz      7107: <dd><p>Remove all packages that require (depend on)
                   7108:                the given package.  This can be used to remove any
                   7109:                packages that may have been pulled in by a given
                   7110:                package, e.g. if <span><strong class="command">make deinstall
1.87      wiz      7111:                DEINSTALLDEPENDS=1</strong></span> is done in
1.88      wiz      7112:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   7113:                likely to remove whole KDE. Works by adding
                   7114:                &#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>
                   7115:                command line.</p></dd>
1.75      rillig   7116: </dl></div>
                   7117: </dd>
1.88      wiz      7118: <dt><span class="term">bin-install</span></dt>
                   7119: <dd><p>Install a binary package from local disk and via FTP
                   7120:          from a list of sites (see the
                   7121:          <code class="varname">BINPKG_SITES</code> variable), and do a
                   7122:          <span><strong class="command">make package</strong></span> if no binary package is
                   7123:          available anywhere.  The arguments given to
                   7124:          <span><strong class="command">pkg_add</strong></span> can be set via
                   7125:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   7126:          operation, etc.</p></dd>
1.75      rillig   7127: <dt><span class="term">update</span></dt>
                   7128: <dd>
1.88      wiz      7129: <p>This target causes the current package to be
                   7130:          updated to the latest version.  The package and all
                   7131:          depending packages first get de-installed, then current
                   7132:          versions of the corresponding packages get compiled and
                   7133:          installed.  This is similar to manually noting which
                   7134:          packages are currently installed, then performing a
                   7135:          series of <span><strong class="command">make deinstall</strong></span> and
                   7136:          <span><strong class="command">make install</strong></span> (or whatever
                   7137:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   7138:          packages.</p>
                   7139: <p>You can use the &#8220;<span class="quote">update</span>&#8221; target to
                   7140:          resume package updating in case a previous <span><strong class="command">make
                   7141:          update</strong></span> was interrupted for some reason.
                   7142:          However, in this case, make sure you don't call
                   7143:          <span><strong class="command">make clean</strong></span> or otherwise remove the
                   7144:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   7145:          Otherwise, you lose the ability to automatically update
                   7146:          the current package along with the dependent packages
                   7147:          you have installed.</p>
                   7148: <p>Resuming an interrupted <span><strong class="command">make
                   7149:          update</strong></span> will only work as long as the package
                   7150:          tree remains unchanged.  If the source code for one of
                   7151:          the packages to be updated has been changed, resuming
                   7152:          <span><strong class="command">make update</strong></span> will most certainly
                   7153:          fail!</p>
                   7154: <p>The following variables can be used either on the
                   7155:          command line or in <code class="filename">/etc/mk.conf</code> to
                   7156:          alter the behaviour of <span><strong class="command">make
                   7157:          update</strong></span>:</p>
1.75      rillig   7158: <div class="variablelist"><dl>
                   7159: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88      wiz      7160: <dd><p>Install target to recursively use for the
                   7161:                updated package and the dependent packages.
                   7162:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
                   7163:                set, &#8220;<span class="quote">install</span>&#8221; otherwise for
                   7164:                <span><strong class="command">make update</strong></span>.  Other good
                   7165:                targets are &#8220;<span class="quote">package</span>&#8221; or
                   7166:                &#8220;<span class="quote">bin-install</span>&#8221;.  Do not set this to
                   7167:                &#8220;<span class="quote">update</span>&#8221; or you will get stuck in an
                   7168:                endless loop!</p></dd>
1.75      rillig   7169: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88      wiz      7170: <dd><p>Don't clean up after updating.  Useful if
                   7171:                you want to leave the work sources of the updated
                   7172:                packages around for inspection or other purposes.
                   7173:                Be sure you eventually clean up the source tree
                   7174:                (see the &#8220;<span class="quote">clean-update</span>&#8221; target below)
                   7175:                or you may run into troubles with old source code
                   7176:                still lying around on your next
                   7177:                <span><strong class="command">make</strong></span> or <span><strong class="command">make
                   7178:                update</strong></span>.</p></dd>
1.75      rillig   7179: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88      wiz      7180: <dd><p>Deinstall each package before installing
                   7181:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   7182:                may be necessary if the
                   7183:                &#8220;<span class="quote">clean-update</span>&#8221; target (see below) was
                   7184:                called after interrupting a running <span><strong class="command">make
                   7185:                update</strong></span>.</p></dd>
1.75      rillig   7186: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88      wiz      7187: <dd><p>Allows you to disable recursion and hardcode
                   7188:                the target for packages.  The default is
                   7189:                &#8220;<span class="quote">update</span>&#8221; for the update target,
                   7190:                facilitating a recursive update of prerequisite
                   7191:                packages.  Only set
                   7192:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   7193:                disable recursive updates. Use
                   7194:                <code class="varname">UPDATE_TARGET</code> instead to just
                   7195:                set a specific target for each package to be
                   7196:                installed during <span><strong class="command">make update</strong></span>
                   7197:                (see above).</p></dd>
1.75      rillig   7198: </dl></div>
                   7199: </dd>
                   7200: <dt><span class="term">clean-update</span></dt>
                   7201: <dd>
1.88      wiz      7202: <p>Clean the source tree for all packages that would
                   7203:          get updated if <span><strong class="command">make update</strong></span> was called
                   7204:          from the current directory.  This target should not be
                   7205:          used if the current package (or any of its depending
                   7206:          packages) have already been de-installed (e.g., after
                   7207:          calling <span><strong class="command">make update</strong></span>) or you may lose
                   7208:          some packages you intended to update. As a rule of
                   7209:          thumb: only use this target <span class="emphasis"><em>before</em></span>
                   7210:          the first time you run <span><strong class="command">make update</strong></span>
                   7211:          and only if you have a dirty package tree (e.g., if you
                   7212:          used <code class="varname">NOCLEAN</code>).</p>
                   7213: <p>If you are unsure about whether your tree is
                   7214:          clean, you can either perform a <span><strong class="command">make
                   7215:          clean</strong></span> at the top of the tree, or use the
                   7216:          following sequence of commands from the directory of the
                   7217:          package you want to update (<span class="emphasis"><em>before</em></span>
                   7218:          running <span><strong class="command">make update</strong></span> for the first
                   7219:          time, otherwise you lose all the packages you wanted to
                   7220:          update!):</p>
1.87      wiz      7221: <pre class="screen">
                   7222: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75      rillig   7223: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87      wiz      7224: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   7225:          </pre>
1.88      wiz      7226: <p>The following variables can be used either on the
                   7227:          command line or in <code class="filename">/etc/mk.conf</code> to
                   7228:          alter the behaviour of <span><strong class="command">make
                   7229:          clean-update</strong></span>:</p>
1.75      rillig   7230: <div class="variablelist"><dl>
                   7231: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.88      wiz      7232: <dd><p>After <span><strong class="command">make clean</strong></span>, do not
                   7233:                reconstruct the list of directories to update for
                   7234:                this package.  Only use this if <span><strong class="command">make
                   7235:                update</strong></span> successfully installed all
                   7236:                packages you wanted to update.  Normally, this is
                   7237:                done automatically on <span><strong class="command">make
                   7238:                update</strong></span>, but may have been suppressed by
                   7239:                the <code class="varname">NOCLEAN</code> variable (see
                   7240:                above).</p></dd>
1.75      rillig   7241: </dl></div>
                   7242: </dd>
1.88      wiz      7243: <dt><span class="term">replace</span></dt>
                   7244: <dd>
                   7245: <p>Update the installation of the current package.  This
                   7246:          differs from update in that it does not replace dependent
1.93      rillig   7247:          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      7248:          target to work.</p>
                   7249: <p><span class="emphasis"><em>Be careful when using this
                   7250:          target!</em></span> There are no guarantees that dependent
                   7251:          packages will still work, in particular they will most
                   7252:          certainly break if you <span><strong class="command">make replace</strong></span> a
                   7253:          library package whose shared library major version changed
                   7254:          between your installed version and the new one.  For this
                   7255:          reason, this target is not officially supported and only
                   7256:          recommended for advanced users.</p>
                   7257: </dd>
1.75      rillig   7258: <dt><span class="term">info</span></dt>
                   7259: <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      7260:          package. You can use this to check which version of a
                   7261:          package is installed.</p></dd>
                   7262: <dt><span class="term">index</span></dt>
                   7263: <dd>
                   7264: <p>This is a top-level command, i.e. it should be used in
                   7265:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   7266:          database of all packages in the local pkgsrc tree, including
                   7267:          dependencies, comment, maintainer, and some other useful
                   7268:          information.  Individual entries are created by running
                   7269:          <span><strong class="command">make describe</strong></span> in the packages'
                   7270:          directories.  This index file is saved as
                   7271:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
                   7272:          verbose format by running <span><strong class="command">make
                   7273:          print-index</strong></span>.  You can search in it with
                   7274:          <span><strong class="command">make search
                   7275:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   7276:          extract a list of all packages that depend on a particular
                   7277:          one by running <span><strong class="command">make show-deps
                   7278:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   7279: <p>Running this command takes a very long time, some
                   7280:          hours even on fast machines!</p>
                   7281: </dd>
1.75      rillig   7282: <dt><span class="term">readme</span></dt>
1.88      wiz      7283: <dd>
                   7284: <p>This target generates a
                   7285:          <code class="filename">README.html</code> file, which can be
1.91      rillig   7286:          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      7287:          contain references to any packages which are in the
                   7288:          <code class="varname">PACKAGES</code> directory on the local
                   7289:          host. The generated files can be made to refer to URLs
                   7290:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   7291:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
                   7292:          wanted to generate <code class="filename">README.html</code>
                   7293:          files which pointed to binary packages on the local
                   7294:          machine, in the directory
                   7295:          <code class="filename">/usr/packages</code>, set
                   7296:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   7297:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   7298:          <code class="varname">${PACKAGES}</code> directory and its
                   7299:          subdirectories will be searched for all the binary
                   7300:          packages.</p>
                   7301: <p>The target can be run at the toplevel or in category
                   7302:          directories, in which case it descends recursively.</p>
                   7303: </dd>
1.75      rillig   7304: <dt><span class="term">readme-all</span></dt>
1.88      wiz      7305: <dd><p>This is a top-level command, run it in
                   7306:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   7307:          file <code class="filename">README-all.html</code> which contains a
                   7308:          list of all packages currently available in the NetBSD
                   7309:          Packages Collection, together with the category they belong
                   7310:          to and a short description. This file is compiled from the
                   7311:          <code class="filename">pkgsrc/*/README.html</code> files, so be sure
                   7312:          to run this <span class="emphasis"><em>after</em></span> a <span><strong class="command">make
                   7313:          readme</strong></span>.</p></dd>
1.75      rillig   7314: <dt><span class="term">cdrom-readme</span></dt>
1.88      wiz      7315: <dd><p>This is very much the same as the
                   7316:          &#8220;<span class="quote">readme</span>&#8221; target (see above), but is to be
                   7317:          used when generating a pkgsrc tree to be written to a
                   7318:          CD-ROM.  This target also produces
                   7319:          <code class="filename">README.html</code> files, and can be made
                   7320:          to refer to URLs based on
                   7321:          <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87      wiz      7322:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75      rillig   7323: <dt><span class="term">show-distfiles</span></dt>
1.88      wiz      7324: <dd><p>This target shows which distfiles and patchfiles
                   7325:          are needed to build the package
                   7326:          (<code class="varname">ALLFILES</code>, which contains all
                   7327:          <code class="varname">DISTFILES</code> and
1.87      wiz      7328:          <code class="varname">PATCHFILES</code>, but not
                   7329:          <code class="filename">patches/*</code>).</p></dd>
1.75      rillig   7330: <dt><span class="term">show-downlevel</span></dt>
1.88      wiz      7331: <dd><p>This target shows nothing if the package is not
                   7332:          installed. If a version of this package is installed,
                   7333:          but is not the version provided in this version of
                   7334:          pkgsrc, then a warning message is displayed. This target
                   7335:          can be used to show which of your installed packages are
                   7336:          downlevel, and so the old versions can be deleted, and
                   7337:          the current ones added.</p></dd>
1.75      rillig   7338: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88      wiz      7339: <dd><p>This target shows the directory in the pkgsrc
                   7340:          hierarchy from which the package can be built and
                   7341:          installed. This may not be the same directory as the one
                   7342:          from which the package was installed. This target is
                   7343:          intended to be used by people who may wish to upgrade
                   7344:          many packages on a single host, and can be invoked from
                   7345:          the top-level pkgsrc Makefile by using the
1.87      wiz      7346:          &#8220;<span class="quote">show-host-specific-pkgs</span>&#8221; target.</p></dd>
1.75      rillig   7347: <dt><span class="term">show-installed-depends</span></dt>
1.88      wiz      7348: <dd><p>This target shows which installed packages match
                   7349:          the current package's <code class="varname">DEPENDS</code>. Useful
                   7350:          if out of date dependencies are causing build
                   7351:          problems.</p></dd>
1.75      rillig   7352: <dt><span class="term">check-shlibs</span></dt>
1.88      wiz      7353: <dd><p>After a package is installed, check all its
                   7354:          binaries and (on ELF platforms) shared libraries to see
                   7355:          if they find the shared libs they need.  Run by default
                   7356:          if <code class="varname">PKG_DEVELOPER</code> is set in
1.87      wiz      7357:          <code class="filename">/etc/mk.conf</code>.</p></dd>
1.75      rillig   7358: <dt><span class="term">print-PLIST</span></dt>
                   7359: <dd>
                   7360: <p>After a &#8220;<span class="quote">make install</span>&#8221; from a new or
1.88      wiz      7361:          upgraded pkg, this prints out an attempt to generate a
                   7362:          new <code class="filename">PLIST</code> from a <span><strong class="command">find
                   7363:          -newer work/.extract_done</strong></span>.  An attempt is made
                   7364:          to care for shared libs etc., but it is
1.87      wiz      7365:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   7366:          result before putting it into
                   7367:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   7368:          diff the output of this command against an already
                   7369:          existing <code class="filename">PLIST</code> file.</p>
1.88      wiz      7370: <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
                   7371:          other methods that don't update file access times, be
                   7372:          sure to add these files manually to your
1.87      wiz      7373:          <code class="filename">PLIST</code>, as the &#8220;<span class="quote">find
                   7374:          -newer</span>&#8221; command used by this target won't catch
                   7375:          them!</p>
1.90      rillig   7376: <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      7377:          information on this target.</p>
1.75      rillig   7378: </dd>
                   7379: <dt><span class="term">bulk-package</span></dt>
                   7380: <dd>
1.88      wiz      7381: <p>Used to do bulk builds. If an appropriate binary
                   7382:          package already exists, no action is taken. If not, this
                   7383:          target will compile, install and package it (and its
                   7384:          depends, if <code class="varname">PKG_DEPENDS</code> is set
                   7385:          properly. See <a href="#binary.configuration" title="6.3.1. Configuration">Section 6.3.1, &#8220;Configuration&#8221;</a>).
                   7386:          After creating the binary package, the sources, the
                   7387:          just-installed package and its required packages are
                   7388:          removed, preserving free disk space.</p>
                   7389: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7390:          all packages installed on a system!</em></span></p>
1.75      rillig   7391: </dd>
                   7392: <dt><span class="term">bulk-install</span></dt>
                   7393: <dd>
1.88      wiz      7394: <p>Used during bulk-installs to install required
                   7395:          packages. If an up-to-date binary package is available,
                   7396:          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,
                   7397:          <span><strong class="command">make bulk-package</strong></span> will be executed,
1.87      wiz      7398:          but the installed binary won't be removed.</p>
1.88      wiz      7399: <p>A binary package is considered
                   7400:          &#8220;<span class="quote">up-to-date</span>&#8221; to be installed via
                   7401:          <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>
                   7402: <div class="itemizedlist"><ul type="disc">
                   7403: <li><p>None of the package's files
                   7404:              (<code class="filename">Makefile</code>, ...) were modified
                   7405:              since it was built.</p></li>
                   7406: <li><p>None of the package's required (binary)
                   7407:              packages were modified since it was built.</p></li>
1.75      rillig   7408: </ul></div>
1.88      wiz      7409: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7410:          all packages installed on a system!</em></span></p>
1.75      rillig   7411: </dd>
                   7412: </dl></div>
                   7413: </div>
                   7414: </div>
                   7415: <div class="chapter" lang="en">
                   7416: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   7417: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.75      rillig   7418: <div class="toc">
                   7419: <p><b>Table of Contents</b></p>
                   7420: <dl>
1.90      rillig   7421: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                   7422: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                   7423: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.97      rillig   7424: <dt><span class="sect1"><a href="#tools.questions">17.4. Questions regarding the tools</a></span></dt>
1.75      rillig   7425: </dl>
                   7426: </div>
1.87      wiz      7427: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75      rillig   7428: by pkgsrc and also for individual packages to define what commands
                   7429: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
                   7430: or for later run-time of an installed packaged (such as
                   7431: <code class="varname">DEPENDS</code>).
                   7432: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87      wiz      7433: package will not be used.</p>
                   7434: <p>When building a package, the replacement tools are
1.75      rillig   7435: made available in a directory (as symlinks or wrapper scripts)
                   7436: that is early in the executable search path. Just like the buildlink
1.87      wiz      7437: system, this helps with consistent builds.</p>
                   7438: <p>A tool may be needed to help build a specific package. For example,
                   7439: perl, GNU make (gmake) or yacc may be needed.</p>
                   7440: <p>Also a tool may be needed, for example, because the native system's supplied
1.75      rillig   7441: tool may be inefficient for building a package with pkgsrc.
                   7442: For example, a package may need GNU awk, bison (instead of
1.87      wiz      7443: yacc) or a better sed.</p>
                   7444: <p>The tools used by a package can be listed by running
                   7445: <span><strong class="command">make show-tools</strong></span>.</p>
1.75      rillig   7446: <div class="sect1" lang="en">
                   7447: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   7448: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
1.87      wiz      7449: <p>The default set of tools used by pkgsrc is defined in
1.76      rillig   7450: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.75      rillig   7451: such as: <span><strong class="command">cat</strong></span>, <span><strong class="command">awk</strong></span>,
                   7452: <span><strong class="command">chmod</strong></span>, <span><strong class="command">test</strong></span>, and so on.
                   7453: These can be seen by running:
1.87      wiz      7454: <span><strong class="command">make show-var VARNAME=USE_TOOLS</strong></span>.</p>
                   7455: <p>If a package needs a specific program to build
1.75      rillig   7456: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87      wiz      7457: to define the tools needed.</p>
1.75      rillig   7458: </div>
                   7459: <div class="sect1" lang="en">
                   7460: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   7461: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
1.87      wiz      7462: <p>In the following examples, the :pkgsrc means to use the pkgsrc version
1.75      rillig   7463: and not the native version for a build dependency.
                   7464: And the :run means that it is used for a
                   7465: run-time dependencies also (and becomes a DEPENDS).
                   7466: The default is a build dependency which can be set with
                   7467: :build. (So in this example, it is the same as gmake:build
1.87      wiz      7468: and pkg-config:build.)</p>
1.75      rillig   7469: <pre class="programlisting">
                   7470: USE_TOOLS+=     mktemp:pkgsrc
                   7471: USE_TOOLS+=     gmake perl:run pkg-config
                   7472: </pre>
1.87      wiz      7473: <p>When using the tools framework, a
1.75      rillig   7474: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   7475: which contains the full path to the appropriate tool. For example,
                   7476: <code class="varname">TOOLS_PATH.bash</code> could be &#8220;<span class="quote">/bin/bash</span>&#8221;
1.87      wiz      7477: on Linux systems.</p>
                   7478: <p>If you always need a pkgsrc version of the
1.75      rillig   7479: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   7480: </p>
                   7481: </div>
                   7482: <div class="sect1" lang="en">
                   7483: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   7484: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
1.87      wiz      7485: <p>When improving or porting pkgsrc to a new platform, have a look
1.75      rillig   7486: at (or create) the corresponding platform specific make file fragment under
1.76      rillig   7487: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75      rillig   7488: the name of the common tools. For example:</p>
                   7489: <pre class="programlisting">
                   7490: .if exists(/usr/bin/bzcat)
                   7491: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   7492: .elif exists(/usr/bin/bzip2)
                   7493: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   7494: .endif
1.69      rillig   7495: 
1.75      rillig   7496: TOOLS_PLATFORM.true?=           true                    # shell builtin
                   7497: </pre>
                   7498: </div>
1.97      rillig   7499: <div class="sect1" lang="en">
                   7500: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   7501: <a name="tools.questions"></a>17.4. Questions regarding the tools</h2></div></div></div>
                   7502: <div class="qandaset">
                   7503: <dl>
                   7504: <dt>17.4.1. <a href="#tools.new">How do I add a new tool?</a>
                   7505: </dt>
                   7506: <dt>17.4.2. <a href="#tools.listall">How do I get a list of all available
                   7507:        tools?</a>
                   7508: </dt>
                   7509: <dt>17.4.3. <a href="#tools.used">How can I get a list of all the tools that a
                   7510:        package is using while being built? I want to know whether it
                   7511:        uses sed or not.</a>
                   7512: </dt>
                   7513: </dl>
                   7514: <table border="0" summary="Q and A Set">
                   7515: <col align="left" width="1%">
                   7516: <tbody>
                   7517: <tr class="question">
                   7518: <td align="left" valign="top">
1.100   ! rillig   7519: <a name="tools.new"></a><a name="id2707841"></a><b>17.4.1.</b>
1.97      rillig   7520: </td>
                   7521: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
                   7522: </tr>
                   7523: <tr class="answer">
                   7524: <td align="left" valign="top"></td>
                   7525: <td align="left" valign="top"><p>TODO</p></td>
                   7526: </tr>
                   7527: <tr class="question">
                   7528: <td align="left" valign="top">
1.100   ! rillig   7529: <a name="tools.listall"></a><a name="id2707850"></a><b>17.4.2.</b>
1.97      rillig   7530: </td>
                   7531: <td align="left" valign="top"><p>How do I get a list of all available
                   7532:        tools?</p></td>
                   7533: </tr>
                   7534: <tr class="answer">
                   7535: <td align="left" valign="top"></td>
                   7536: <td align="left" valign="top"><p>TODO</p></td>
                   7537: </tr>
                   7538: <tr class="question">
                   7539: <td align="left" valign="top">
1.100   ! rillig   7540: <a name="tools.used"></a><a name="id2707861"></a><b>17.4.3.</b>
1.97      rillig   7541: </td>
                   7542: <td align="left" valign="top"><p>How can I get a list of all the tools that a
                   7543:        package is using while being built? I want to know whether it
                   7544:        uses sed or not.</p></td>
                   7545: </tr>
                   7546: <tr class="answer">
                   7547: <td align="left" valign="top"></td>
                   7548: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
                   7549:        to do it.)</p></td>
                   7550: </tr>
                   7551: </tbody>
                   7552: </table>
                   7553: </div>
                   7554: </div>
1.75      rillig   7555: </div>
                   7556: <div class="chapter" lang="en">
                   7557: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   7558: <a name="fixes"></a>Chapter 18. Making your package work</h2></div></div></div>
1.75      rillig   7559: <div class="toc">
                   7560: <p><b>Table of Contents</b></p>
                   7561: <dl>
1.90      rillig   7562: <dt><span class="sect1"><a href="#general-operation">18.1. General operation</a></span></dt>
1.75      rillig   7563: <dd><dl>
1.90      rillig   7564: <dt><span class="sect2"><a href="#portability-of-packages">18.1.1. Portability of packages</a></span></dt>
                   7565: <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>
                   7566: <dt><span class="sect2"><a href="#user-interaction">18.1.3. User interaction</a></span></dt>
                   7567: <dt><span class="sect2"><a href="#handling-licenses">18.1.4. Handling licenses</a></span></dt>
                   7568: <dt><span class="sect2"><a href="#restricted-packages">18.1.5. Restricted packages</a></span></dt>
                   7569: <dt><span class="sect2"><a href="#dependencies">18.1.6. Handling dependencies</a></span></dt>
                   7570: <dt><span class="sect2"><a href="#conflicts">18.1.7. Handling conflicts with other packages</a></span></dt>
                   7571: <dt><span class="sect2"><a href="#not-building-packages">18.1.8. Packages that cannot or should not be built</a></span></dt>
                   7572: <dt><span class="sect2"><a href="#undeletable-packages">18.1.9. Packages which should not be deleted, once installed</a></span></dt>
                   7573: <dt><span class="sect2"><a href="#security-handling">18.1.10. Handling packages with security problems</a></span></dt>
                   7574: <dt><span class="sect2"><a href="#bumping-pkgrevision">18.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   7575: <dt><span class="sect2"><a href="#fixes.subst">18.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   7576: </dl></dd>
                   7577: <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>
                   7578: <dd><dl>
                   7579: <dt><span class="sect2"><a href="#no-plain-download">18.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   7580: <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>
                   7581: </dl></dd>
                   7582: <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>
                   7583: <dd><dl>
                   7584: <dt><span class="sect2"><a href="#fixes.libtool">18.3.1. Shared libraries - libtool</a></span></dt>
                   7585: <dt><span class="sect2"><a href="#using-libtool">18.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   7586: <dt><span class="sect2"><a href="#autoconf-automake">18.3.3. GNU Autoconf/Automake</a></span></dt>
                   7587: </dl></dd>
                   7588: <dt><span class="sect1"><a href="#programming-languages">18.4. Programming languages</a></span></dt>
                   7589: <dd><dl>
                   7590: <dt><span class="sect2"><a href="#basic-programming-languages">18.4.1. C, C++, and Fortran</a></span></dt>
                   7591: <dt><span class="sect2"><a href="#java-programming-language">18.4.2. Java</a></span></dt>
                   7592: <dt><span class="sect2"><a href="#perl-scripts">18.4.3. Packages containing perl scripts</a></span></dt>
                   7593: <dt><span class="sect2"><a href="#other-programming-languages">18.4.4. Other programming languages</a></span></dt>
                   7594: </dl></dd>
                   7595: <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>
                   7596: <dd><dl>
                   7597: <dt><span class="sect2"><a href="#fixes.build.cpp">18.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   7598: <dt><span class="sect2"><a href="#compiler-bugs">18.5.2. How to handle compiler bugs</a></span></dt>
                   7599: <dt><span class="sect2"><a href="#undefined-reference">18.5.3. Undefined reference to &#8220;<span class="quote">...</span>&#8221;</a></span></dt>
                   7600: <dt><span class="sect2"><a href="#out-of-memory">18.5.4. Running out of memory</a></span></dt>
                   7601: </dl></dd>
                   7602: <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>
                   7603: <dd><dl>
                   7604: <dt><span class="sect2"><a href="#install-scripts">18.6.1. Creating needed directories</a></span></dt>
                   7605: <dt><span class="sect2"><a href="#where-to-install-documentation">18.6.2. Where to install documentation</a></span></dt>
1.100   ! rillig   7606: <dt><span class="sect2"><a href="#installing-score-files">18.6.3. Installing highscore files</a></span></dt>
1.90      rillig   7607: <dt><span class="sect2"><a href="#hardcoded-paths">18.6.4. Packages with hardcoded paths to other interpreters</a></span></dt>
                   7608: <dt><span class="sect2"><a href="#perl-modules">18.6.5. Packages installing perl modules</a></span></dt>
                   7609: <dt><span class="sect2"><a href="#faq.info-files">18.6.6. Packages installing info files</a></span></dt>
                   7610: <dt><span class="sect2"><a href="#manpages">18.6.7. Packages installing man pages</a></span></dt>
                   7611: <dt><span class="sect2"><a href="#gconf2-data-files">18.6.8. Packages installing GConf2 data files</a></span></dt>
                   7612: <dt><span class="sect2"><a href="#scrollkeeper-data-files">18.6.9. Packages installing scrollkeeper data files</a></span></dt>
                   7613: <dt><span class="sect2"><a href="#x11-fonts">18.6.10. Packages installing X11 fonts</a></span></dt>
                   7614: <dt><span class="sect2"><a href="#gtk2-modules">18.6.11. Packages installing GTK2 modules</a></span></dt>
                   7615: <dt><span class="sect2"><a href="#sgml-xml-data">18.6.12. Packages installing SGML or XML data</a></span></dt>
                   7616: <dt><span class="sect2"><a href="#mime-database">18.6.13. Packages installing extensions to the MIME database</a></span></dt>
                   7617: <dt><span class="sect2"><a href="#intltool">18.6.14. Packages using intltool</a></span></dt>
                   7618: <dt><span class="sect2"><a href="#startup-scripts">18.6.15. Packages installing startup scripts</a></span></dt>
                   7619: <dt><span class="sect2"><a href="#tex-packages">18.6.16. Packages installing TeX modules</a></span></dt>
                   7620: <dt><span class="sect2"><a href="#emulation-packages">18.6.17. Packages supporting running binaries in
1.87      wiz      7621:     emulation</a></span></dt>
1.90      rillig   7622: <dt><span class="sect2"><a href="#hicolor-theme">18.6.18. Packages installing hicolor theme icons</a></span></dt>
                   7623: <dt><span class="sect2"><a href="#desktop-files">18.6.19. Packages installing desktop files</a></span></dt>
1.75      rillig   7624: </dl></dd>
1.90      rillig   7625: <dt><span class="sect1"><a href="#punting">18.7. Marking packages as having problems</a></span></dt>
1.75      rillig   7626: </dl>
                   7627: </div>
                   7628: <div class="sect1" lang="en">
                   7629: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   7630: <a name="general-operation"></a>18.1. General operation</h2></div></div></div>
1.75      rillig   7631: <div class="sect2" lang="en">
                   7632: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   7633: <a name="portability-of-packages"></a>18.1.1. Portability of packages</h3></div></div></div>
1.78      rillig   7634: <p>One appealing feature of pkgsrc is that it runs on many
1.87      wiz      7635:     different platforms. As a result, it is important to ensure,
                   7636:     where possible, that packages in pkgsrc are portable. This
                   7637:     chapter mentions some particular details you should pay
                   7638:     attention to while working on pkgsrc.</p>
1.78      rillig   7639: </div>
                   7640: <div class="sect2" lang="en">
                   7641: <div class="titlepage"><div><div><h3 class="title">
1.93      rillig   7642: <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>
                   7643: </h3></div></div></div>
1.78      rillig   7644: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87      wiz      7645:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
                   7646:     which is <code class="filename">/etc/mk.conf</code> by default. When you
                   7647:     want to use those variables in the preprocessor directives of
                   7648:     <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
                   7649:     <code class="literal">.for</code>), you need to include the file
                   7650:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   7651:     loads the user preferences.</p>
1.78      rillig   7652: <p>But note that some variables may not be completely defined
1.87      wiz      7653:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
                   7654:     included, as they may contain references to variables that are
                   7655:     not yet defined. In shell commands this is no problem, since
                   7656:     variables are actually macros, which are only expanded when they
                   7657:     are used. But in the preprocessor directives mentioned above and
                   7658:     in dependency lines (of the form <code class="literal">target:
                   7659:     dependencies</code>) the variables are expanded at load
                   7660:     time.</p>
1.78      rillig   7661: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   7662: <h3 class="title">Note</h3>
                   7663: <p>Currently there is no exhaustive list of all
1.87      wiz      7664:     variables that tells you whether they can be used at load time
                   7665:     or only at run time, but it is in preparation.</p>
1.78      rillig   7666: </div>
                   7667: </div>
                   7668: <div class="sect2" lang="en">
                   7669: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   7670: <a name="user-interaction"></a>18.1.3. User interaction</h3></div></div></div>
1.88      wiz      7671: <p>Occasionally, packages require interaction from the user,
                   7672:     and this can be in a number of ways:</p>
1.78      rillig   7673: <div class="itemizedlist"><ul type="disc">
1.79      rillig   7674: <li><p>When fetching the distfiles, some packages require user
1.87      wiz      7675:        interaction such as entering username/password or accepting a
                   7676:        license on a web page.</p></li>
1.88      wiz      7677: <li><p>When extracting the distfiles, some packages may ask for
                   7678:        passwords.</p></li>
1.78      rillig   7679: <li><p>help to configure the package before it is built</p></li>
                   7680: <li><p>help during the build process</p></li>
                   7681: <li><p>help during the installation of a package</p></li>
                   7682: </ul></div>
1.88      wiz      7683: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
                   7684:     provided to notify the pkgsrc mechanism of an interactive stage
                   7685:     which will be needed, and this should be set in the package's
                   7686:     <code class="filename">Makefile</code>, e.g.:</p>
1.75      rillig   7687: <pre class="programlisting">
1.100   ! rillig   7688: INTERACTIVE_STAGE=      build
1.87      wiz      7689:     </pre>
1.78      rillig   7690: <p>Multiple interactive stages can be specified:</p>
1.75      rillig   7691: <pre class="programlisting">
1.100   ! rillig   7692: INTERACTIVE_STAGE=      configure install
1.87      wiz      7693:     </pre>
1.88      wiz      7694: <p>The user can then decide to skip this package by setting the
                   7695:     <code class="varname">BATCH</code> variable.</p>
1.75      rillig   7696: </div>
                   7697: <div class="sect2" lang="en">
                   7698: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   7699: <a name="handling-licenses"></a>18.1.4. Handling licenses</h3></div></div></div>
1.98      wiz      7700: <p>Authors of software can choose the licence under which
                   7701:     software can be copied.  This is due to copyright law, and reasons
                   7702:     for license choices are outside the scope of pkgsrc.  The pkgsrc
                   7703:     system recognizes that there are a number of licenses which some
                   7704:     users may find objectionable or difficult or impossible to comply
                   7705:     with.  The Free Software Foundation has declared some licenses
                   7706:     "Free", and the Open Source Initiative has a definition of "Open
                   7707:     Source".  The pkgsrc system, as a policy choice, does not label
                   7708:     packages which have licenses that are Free or Open Source.
                   7709:     However, packages without a license meeting either of those tests
                   7710:     are labeled with a license tag denoting the license.  Note that a
                   7711:     package with no license to copy trivially does not meet either the
                   7712:     Free or Open Source test.</p>
                   7713: <p>For packages which are not Free or Open Source, pkgsrc will
                   7714:     not build the package unless the user has indicated to pkgsrc that
                   7715:     packages with that particular license may be built.  Note that
                   7716:     this documentation avoids the term "accepted the license".  The
                   7717:     pkgsrc system is merely providing a mechanism to avoid
1.99      rillig   7718:     accidentally building a package with a non-free license;
1.98      wiz      7719:     judgement and responsibility remain with the user.  (Installation
                   7720:     of binary packages are not currently subject to this mechanism;
                   7721:     this is a bug.)</p>
                   7722: <p>One might want to only install packages with a BSD license,
                   7723:     or the GPL, and not the other.  The pkgsrc license tag mechanism
                   7724:     does not provide a way to do this.  It might be possible to put in
                   7725:     tags for free licenses, and have a default
                   7726:     <code class="varname">ACCEPTABLE_LICENSES</code> variable value, but this is
                   7727:     widely viewed as having a very poor ratio of benefit to
                   7728:     work.</p>
1.78      rillig   7729: <p>The license tag mechanism is intended to address
1.87      wiz      7730:     copyright-related issues surrounding building, installing and
                   7731:     using a package, and not to address redistribution issues (see
                   7732:     <code class="varname">RESTRICTED</code> and
                   7733:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).  However, the above
                   7734:     definition of licenses for which tags are not needed implies
                   7735:     that packages with redistribution restrictions should have
1.98      wiz      7736:     tags, because Free or Open Source programs do not have
                   7737:     redistribution restrictions.</p>
                   7738: <p>Denoting that a package may be copied according to a
                   7739:     particular license is done by placing the license in
1.87      wiz      7740:     <code class="filename">pkgsrc/licenses</code> and setting the
                   7741:     <code class="varname">LICENSE</code> variable to a string identifying the
1.91      rillig   7742:     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      7743: <pre class="programlisting">
1.100   ! rillig   7744: LICENSE=        xv-license
1.87      wiz      7745:     </pre>
                   7746: <p>When trying to build, the user will get a notice that the
1.98      wiz      7747:     package is covered by a license which has not been placed in the
                   7748:     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87      wiz      7749: <pre class="programlisting">
1.100   ! rillig   7750: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
        !          7751: ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
        !          7752: ===&gt;     To view the license, enter "/usr/bin/make show-license".
        !          7753: ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
        !          7754: ===&gt;     ACCEPTABLE_LICENSES+=xv-license
        !          7755: *** Error code 1
1.87      wiz      7756:     </pre>
1.78      rillig   7757: <p>The license can be viewed with <span><strong class="command">make
1.98      wiz      7758:     show-license</strong></span>, and if the user so chooses, the line
                   7759:     printed above can be added to <code class="filename">/etc/mk.conf</code> to
                   7760:     convey to pkgsrc that it should not in the future fail because of
                   7761:     that license:</p>
1.78      rillig   7762: <pre class="programlisting">
1.100   ! rillig   7763: ACCEPTABLE_LICENSES+=xv-license
1.87      wiz      7764:     </pre>
1.98      wiz      7765: <p>When adding a package with a new license, the license text
                   7766:     should be added to <code class="filename">pkgsrc/licenses</code> for
                   7767:     displaying.  A list of known licenses can be seen in this
1.91      rillig   7768:     directory.</p>
1.98      wiz      7769: <p>When the license changes (in a way other than formatting),
                   7770:     please make sure that the new license has a different name (e.g.,
                   7771:     append the version number if it exists, or the date).  Just
                   7772:     because a user told pkgsrc to build programs under a previous
                   7773:     version of a license does not mean that pkgsrc should build
1.99      rillig   7774:     programs under the new licenses.  The higher-level point is that
1.98      wiz      7775:     pkgsrc does not evaluate licenses for reasonableness; the only
                   7776:     test is a mechanistic test of whether a particular text has been
                   7777:     approved by either of two bodies.</p>
1.78      rillig   7778: <p>The use of <code class="varname">LICENSE=shareware</code>,
1.98      wiz      7779:     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
                   7780:     is deprecated because it does not crisply refer to a particular
                   7781:     license text.  Another problem with such usage is that it does not
                   7782:     enable a user to tell pkgsrc to proceed for a single package
                   7783:     without also telling pkgsrc to proceed for all packages with that
                   7784:     tag.</p>
1.75      rillig   7785: </div>
                   7786: <div class="sect2" lang="en">
                   7787: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   7788: <a name="restricted-packages"></a>18.1.5. Restricted packages</h3></div></div></div>
1.75      rillig   7789: <p>Some licenses restrict how software may be re-distributed.
1.98      wiz      7790:     Because a license tag is required unless the package is Free or
                   7791:     Open Source, all packages with restrictions should have license
                   7792:     tags.  By declaring the restrictions, package tools can
                   7793:     automatically refrain from e.g. placing binary packages on FTP
                   7794:     sites.</p>
                   7795: <p>There are four restrictions that may be encoded, which are
                   7796:     the cross product of sources (distfiles) and binaries not being
                   7797:     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
                   7798:     language in any license, and because non-Free licenses tend to be
                   7799:     different from each other, pkgsrc adopts a definition of FTP and
                   7800:     CD-ROM.  Pkgsrc uses "FTP" to mean that the source or binary file
                   7801:     should not be made available over the Internet at no charge.
                   7802:     Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
                   7803:     made available on some kind of media, together with other source
                   7804:     and binary packages, and which is sold for a distribution charge.
                   7805:     </p>
                   7806: <p>In order to encode these restrictions, the package system
1.87      wiz      7807:     defines five make variables that can be set to note these
                   7808:     restrictions:</p>
1.75      rillig   7809: <div class="itemizedlist"><ul type="disc">
                   7810: <li>
                   7811: <p><code class="varname">RESTRICTED</code></p>
                   7812: <p>This variable should be set whenever a restriction
1.87      wiz      7813:        exists (regardless of its kind).  Set this variable to a
1.98      wiz      7814:        string containing the reason for the restriction.  It should
                   7815:        be understood that those wanting to understand the restriction
                   7816:        will have to read the license, and perhaps seek advice of
                   7817:        counsel.</p>
1.75      rillig   7818: </li>
                   7819: <li>
                   7820: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98      wiz      7821: <p>Binaries may not be placed on CD-ROM containing other
                   7822:        binary packages, for which a distribution charge may be made.
                   7823:        In this case, set this variable to
                   7824:        <code class="varname">${RESTRICTED}</code>.</p>
1.75      rillig   7825: </li>
                   7826: <li>
                   7827: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98      wiz      7828: <p>Binaries may not made available on the Internet without
                   7829:        charge.  In this case, set this variable to
                   7830:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7831:        binary packages will not be included on ftp.NetBSD.org.</p>
1.75      rillig   7832: </li>
                   7833: <li>
                   7834: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98      wiz      7835: <p>Distfiles may not be placed on CD-ROM, together with
                   7836:        other distfiles, for which a fee may be charged.  In this
                   7837:        case, set this variable to <code class="varname">${RESTRICTED}</code>.
                   7838:        </p>
1.75      rillig   7839: </li>
                   7840: <li>
                   7841: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98      wiz      7842: <p>Distfiles may not made available via FTP at no charge.
                   7843:        In this case, set this variable to
                   7844:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7845:        the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75      rillig   7846: </li>
                   7847: </ul></div>
                   7848: <p>Please note that the use of <code class="varname">NO_PACKAGE</code>,
1.87      wiz      7849:     <code class="varname">IGNORE</code>, <code class="varname">NO_CDROM</code>, or other
                   7850:     generic make variables to denote restrictions is deprecated,
                   7851:     because they unconditionally prevent users from generating
                   7852:     binary packages!</p>
1.75      rillig   7853: </div>
                   7854: <div class="sect2" lang="en">
                   7855: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   7856: <a name="dependencies"></a>18.1.6. Handling dependencies</h3></div></div></div>
1.75      rillig   7857: <p>Your package may depend on some other package being present
1.88      wiz      7858:     - and there are various ways of expressing this dependency.
                   7859:     pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
                   7860:     <code class="varname">DEPENDS</code> definitions, the
                   7861:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   7862:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   7863:     to handle dependencies, and which uses the variables named above.
1.90      rillig   7864:     See <a href="#buildlink" title="Chapter 13. Buildlink methodology">Chapter 13, <i>Buildlink methodology</i></a> for more information.</p>
1.75      rillig   7865: <p>The basic difference between the two variables is as
1.87      wiz      7866:     follows: The <code class="varname">DEPENDS</code> definition registers
                   7867:     that pre-requisite in the binary package so it will be pulled in
                   7868:     when the binary package is later installed, whilst the
                   7869:     <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
                   7870:     dependency that is only needed for building the package.</p>
1.75      rillig   7871: <p>This means that if you only need a package present whilst
1.87      wiz      7872:     you are building, it should be noted as a
                   7873:     <code class="varname">BUILD_DEPENDS</code>.</p>
1.75      rillig   7874: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87      wiz      7875:     <code class="varname">DEPENDS</code> definition is:</p>
1.75      rillig   7876: <pre class="programlisting">
1.100   ! rillig   7877: &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
1.87      wiz      7878:     </pre>
1.75      rillig   7879: <p>Please note that the &#8220;<span class="quote">pre-req-package-name</span>&#8221;
1.87      wiz      7880:     may include any of the wildcard version numbers recognized by
                   7881:     <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   7882: <div class="orderedlist"><ol type="1">
                   7883: <li>
                   7884: <p>If your package needs another package's binaries or
1.87      wiz      7885:        libraries to build or run, and if that package has a
                   7886:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75      rillig   7887: <pre class="programlisting">
1.100   ! rillig   7888: .include "../../graphics/jpeg/buildlink3.mk"
1.87      wiz      7889:        </pre>
1.75      rillig   7890: </li>
                   7891: <li>
                   7892: <p>If your package needs to use another package to build
1.87      wiz      7893:        itself and there is no <code class="filename">buildlink3.mk</code>
                   7894:        file available, use the <code class="varname">BUILD_DEPENDS</code>
                   7895:        definition:</p>
1.75      rillig   7896: <pre class="programlisting">
1.100   ! rillig   7897: BUILD_DEPENDS+= autoconf-2.13:../../devel/autoconf
1.87      wiz      7898:        </pre>
1.75      rillig   7899: </li>
                   7900: <li>
                   7901: <p>If your package needs a library with which to link and
1.76      rillig   7902:        again there is no <code class="filename">buildlink3.mk</code> file
1.87      wiz      7903:        available, this is specified using the
                   7904:        <code class="varname">DEPENDS</code> definition. For example:</p>
1.75      rillig   7905: <pre class="programlisting">
1.100   ! rillig   7906: DEPENDS+=       xpm-3.4j:../../graphics/xpm
1.87      wiz      7907:        </pre>
1.75      rillig   7908: <p>You can also use wildcards in package dependences:</p>
                   7909: <pre class="programlisting">
1.100   ! rillig   7910: DEPENDS+=       xpm-[0-9]*:../../graphics/xpm
1.87      wiz      7911:        </pre>
1.75      rillig   7912: <p>Note that such wildcard dependencies are retained when
1.87      wiz      7913:        creating binary packages.  The dependency is checked when
                   7914:        installing the binary package and any package which matches
                   7915:        the pattern will be used.  Wildcard dependencies should be
                   7916:        used with care.</p>
1.75      rillig   7917: <p>The &#8220;<span class="quote">-[0-9]*</span>&#8221; should be used instead of
1.87      wiz      7918:        &#8220;<span class="quote">-*</span>&#8221; to avoid potentially ambiguous matches
                   7919:        such as &#8220;<span class="quote">tk-postgresql</span>&#8221; matching a
                   7920:        &#8220;<span class="quote">tk-*</span>&#8221; <code class="varname">DEPENDS</code>.</p>
1.75      rillig   7921: <p>Wildcards can also be used to specify that a package
1.87      wiz      7922:        will only build against a certain minimum version of a
                   7923:        pre-requisite:</p>
1.75      rillig   7924: <pre class="programlisting">
1.100   ! rillig   7925: DEPENDS+=       tiff&gt;=3.5.4:../../graphics/tiff
1.87      wiz      7926:        </pre>
1.75      rillig   7927: <p>This means that the package will build against version
1.87      wiz      7928:        3.5.4 of the tiff library or newer.  Such a dependency may
                   7929:        be warranted if, for example, the API of the library has
                   7930:        changed with version 3.5.4 and a package would not compile
                   7931:        against an earlier version of tiff.</p>
1.75      rillig   7932: <p>Please note that such dependencies should only be
1.87      wiz      7933:        updated if a package requires a newer pre-requisite, but
1.93      rillig   7934:        not to denote recommendations such as
1.87      wiz      7935:        ABI changes that do not prevent a package from building
                   7936:        correctly.  Such recommendations can be expressed using
                   7937:        <code class="varname">ABI_DEPENDS</code>:</p>
1.75      rillig   7938: <pre class="programlisting">
1.100   ! rillig   7939: ABI_DEPENDS+=   tiff&gt;=3.6.1:../../graphics/tiff
1.87      wiz      7940:        </pre>
1.75      rillig   7941: <p>In addition to the above <code class="varname">DEPENDS</code>
1.87      wiz      7942:        line, this denotes that while a package will build against
                   7943:        tiff&gt;=3.5.4, at least version 3.6.1 is recommended.
                   7944:        <code class="varname">ABI_DEPENDS</code> entries will be turned into
                   7945:        dependencies unless explicitly ignored (in which case a
                   7946:        warning will be printed).</p>
1.75      rillig   7947: <p>To ignore these ABI dependency recommendations and just
1.87      wiz      7948:        use the required <code class="varname">DEPENDS</code>, set
                   7949:        <code class="varname">USE_ABI_DEPENDS=NO</code>.   This may make
                   7950:        it easier and faster to update packages built using pkgsrc,
                   7951:        since older compatible dependencies can continue to be
                   7952:        used. This is useful for people who watch their rebuilds
                   7953:        very carefully; it is not very good as a general-purpose
                   7954:        hammer.  If you use it, you need to be mindful of possible
                   7955:        ABI changes, including those from the underlying OS.</p>
1.75      rillig   7956: <p>Packages that are built with recommendations ignored
1.87      wiz      7957:        may not be uploaded to ftp.NetBSD.org by developers and
                   7958:        should not be used across different systems that may have
                   7959:        different versions of binary packages installed.</p>
1.75      rillig   7960: <p>For security fixes, please update the package
1.90      rillig   7961:        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      7962:        information.</p>
1.75      rillig   7963: </li>
                   7964: <li>
                   7965: <p>If your package needs some executable to be able to run
1.87      wiz      7966:        correctly and if there's no
                   7967:        <code class="filename">buildlink3.mk</code> file, this is specified
                   7968:        using the <code class="varname">DEPENDS</code> variable. The
1.91      rillig   7969:        <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      7970:        be able to execute the latex binary from the teTeX package
                   7971:        when it runs, and that is specified:</p>
1.75      rillig   7972: <pre class="programlisting">
1.100   ! rillig   7973: DEPENDS+=        teTeX-[0-9]*:../../print/teTeX
1.87      wiz      7974:        </pre>
1.75      rillig   7975: <p>The comment about wildcard dependencies from previous
1.87      wiz      7976:        paragraph applies here, too.</p>
1.75      rillig   7977: </li>
                   7978: </ol></div>
                   7979: <p>If your package needs files from another package to build,
1.87      wiz      7980:     add the relevant distribution files to
                   7981:     <code class="varname">DISTFILES</code>, so they will be extracted
1.91      rillig   7982:     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      7983:     (It relies on the jpeg sources being present in source form
                   7984:     during the build.)</p>
1.75      rillig   7985: </div>
                   7986: <div class="sect2" lang="en">
                   7987: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   7988: <a name="conflicts"></a>18.1.7. Handling conflicts with other packages</h3></div></div></div>
1.75      rillig   7989: <p>Your package may conflict with other packages a user might
1.87      wiz      7990:     already have installed on his system, e.g. if your package
1.88      wiz      7991:     installs the same set of files as another package in the pkgsrc
                   7992:     tree.</p>
1.75      rillig   7993: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
1.87      wiz      7994:     space-separated list of packages (including version string) your
                   7995:     package conflicts with.</p>
1.91      rillig   7996: <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>
                   7997:     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      7998:     install the same shared library, thus you set in
                   7999:     <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
                   8000: <pre class="programlisting">
1.100   ! rillig   8001: CONFLICTS=      Xaw-Xpm-[0-9]*
1.87      wiz      8002:     </pre>
                   8003: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
1.75      rillig   8004: <pre class="programlisting">
1.100   ! rillig   8005: CONFLICTS=      Xaw3d-[0-9]*
1.87      wiz      8006:     </pre>
1.75      rillig   8007: <p>Packages will automatically conflict with other packages
1.87      wiz      8008:     with the name prefix and a different version
                   8009:     string. &#8220;<span class="quote">Xaw3d-1.5</span>&#8221; e.g. will automatically
                   8010:     conflict with the older version &#8220;<span class="quote">Xaw3d-1.3</span>&#8221;.</p>
1.75      rillig   8011: </div>
                   8012: <div class="sect2" lang="en">
                   8013: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8014: <a name="not-building-packages"></a>18.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.75      rillig   8015: <p>There are several reasons why a package might be
1.88      wiz      8016:     instructed to not build under certain circumstances.  If the
1.87      wiz      8017:     package builds and runs on most platforms, the exceptions
                   8018:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
                   8019:     the package builds and runs on a small handful of platforms,
                   8020:     set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
                   8021:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   8022:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   8023:     (OS-version-platform) that can use glob-style
                   8024:     wildcards.</p>
1.88      wiz      8025: <p>Some packages are tightly bound to a specific version of an
1.91      rillig   8026:     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      8027:     backwards compatible with other versions of the OS, and should be
                   8028:     uploaded to a version specific directory on the FTP server.  Mark
                   8029:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
                   8030:     &#8220;<span class="quote">yes</span>&#8221;.  This variable is not currently used by any of
                   8031:     the package system internals, but may be used in the
                   8032:     future.</p>
1.75      rillig   8033: <p>If the package should be skipped (for example, because it
1.87      wiz      8034:     provides functionality already provided by the system), set
1.88      wiz      8035:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   8036:     the package should fail because some preconditions are not met,
                   8037:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87      wiz      8038:     message.</p>
1.75      rillig   8039: </div>
                   8040: <div class="sect2" lang="en">
                   8041: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8042: <a name="undeletable-packages"></a>18.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.75      rillig   8043: <p>To ensure that a package may not be deleted, once it has been
1.87      wiz      8044:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   8045:     be set in the package Makefile. This will be carried into any
                   8046:     binary package that is made from this pkgsrc entry. A
                   8047:     &#8220;<span class="quote">preserved</span>&#8221; package will
                   8048:     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
                   8049:     &#8220;<span class="quote">-f</span>&#8221; option is used.</p>
1.75      rillig   8050: </div>
                   8051: <div class="sect2" lang="en">
                   8052: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8053: <a name="security-handling"></a>18.1.10. Handling packages with security problems</h3></div></div></div>
1.75      rillig   8054: <p>When a vulnerability is found, this should be noted in
1.87      wiz      8055:     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
                   8056:     and after committing that file, use <span><strong class="command">make upload</strong></span>
                   8057:     in the same directory to update the file on ftp.NetBSD.org.</p>
1.75      rillig   8058: <p>After fixing the vulnerability by a patch, its
1.87      wiz      8059:     <code class="varname">PKGREVISION</code> should be increased (this
                   8060:     is of course not necessary if the problem is fixed by using
                   8061:     a newer release of the software).</p>
1.75      rillig   8062: <p>Also, if the fix should be applied to the stable pkgsrc
1.87      wiz      8063:     branch, be sure to submit a pullup request!</p>
1.75      rillig   8064: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87      wiz      8065:     semi-automatically by a weekly cron job.</p>
1.75      rillig   8066: </div>
                   8067: <div class="sect2" lang="en">
                   8068: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8069: <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   8070: <p>When making fixes to an existing package it can be useful
1.87      wiz      8071:     to change the version number in <code class="varname">PKGNAME</code>. To
                   8072:     avoid conflicting with future versions by the original author, a
                   8073:     &#8220;<span class="quote">nb1</span>&#8221;, &#8220;<span class="quote">nb2</span>&#8221;, ... suffix can be used
                   8074:     on package versions by setting <code class="varname">PKGREVISION=1</code>
                   8075:     (2, ...). The &#8220;<span class="quote">nb</span>&#8221; is treated like a
                   8076:     &#8220;<span class="quote">.</span>&#8221; by the package tools. e.g.</p>
                   8077: <pre class="programlisting">
1.100   ! rillig   8078: DISTNAME=       foo-17.42
        !          8079: PKGREVISION=    9
1.87      wiz      8080:     </pre>
1.75      rillig   8081: <p>will result in a <code class="varname">PKGNAME</code> of
1.87      wiz      8082:     &#8220;<span class="quote">foo-17.42nb9</span>&#8221;. If you want to use the original
                   8083:     value of <code class="varname">PKGNAME</code> without the &#8220;<span class="quote">nbX</span>&#8221;
                   8084:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   8085:     <code class="varname">PKGNAME_NOREV</code>.</p>
1.75      rillig   8086: <p>When a new release of the package is released, the
1.87      wiz      8087:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   8088:     minor release of the above package, things should be like:</p>
1.75      rillig   8089: <pre class="programlisting">
1.100   ! rillig   8090: DISTNAME=       foo-17.43
1.87      wiz      8091:     </pre>
                   8092: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   8093:     non-trivial change in the resulting binary package.  Without a
                   8094:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   8095:     version installed has no way of knowing that their package is out
                   8096:     of date.  Thus, changes without increasing
                   8097:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   8098:     trivial that no reasonable person would want to upgrade", and this
                   8099:     is the rough test for when increasing
                   8100:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   8101:     changes that do not merit increasing
                   8102:     <code class="varname">PKGREVISION</code> are:</p>
1.100   ! rillig   8103: <div class="itemizedlist"><ul type="disc">
        !          8104: <li><p>Changing <code class="varname">HOMEPAGE</code>, <code class="varname">MAINTAINER</code>,
        !          8105:       or comments in Makefile.</p></li>
        !          8106: <li><p>
        !          8107:       Changing build variables if the resulting binary package is the same.</p></li>
        !          8108: <li><p>
        !          8109:       Changing <code class="filename">DESCR</code>.</p></li>
        !          8110: <li><p>
        !          8111:       Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
        !          8112: </ul></div>
1.87      wiz      8113: <p>Examples of changes that do merit an increase to
                   8114:     <code class="varname">PKGREVISION</code> include:</p>
1.100   ! rillig   8115: <div class="itemizedlist"><ul type="disc">
        !          8116: <li><p>
        !          8117:       Security fixes</p></li>
        !          8118: <li><p>
        !          8119:       Changes or additions to a patch file</p></li>
        !          8120: <li><p>
        !          8121:       Changes to the <code class="filename">PLIST</code></p></li>
        !          8122: </ul></div>
1.78      rillig   8123: <p>PKGREVISION must also be incremented when dependencies have ABI
                   8124:     changes.</p>
1.75      rillig   8125: </div>
1.79      rillig   8126: <div class="sect2" lang="en">
                   8127: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8128: <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   8129: <p>When you want to replace the same text in multiple files
1.87      wiz      8130:     or when the replacement text varies, patches alone cannot help.
                   8131:     This is where the SUBST framework comes in. It provides an
                   8132:     easy-to-use interface for replacing text in files.
                   8133:     Example:</p>
                   8134: <pre class="programlisting">
1.100   ! rillig   8135: SUBST_CLASSES+=                 fix-paths
        !          8136: SUBST_STAGE.fix-paths=          pre-configure
        !          8137: SUBST_MESSAGE.fix-paths=        Fixing absolute paths.
        !          8138: SUBST_FILES.fix-paths=          src/*.c
        !          8139: SUBST_FILES.fix-paths+=         scripts/*.sh
        !          8140: SUBST_SED.fix-paths=            -e 's,"/usr/local,"${PREFIX},g'
        !          8141: SUBST_SED.fix-paths+=           -e 's,"/var/log,"${VARBASE}/log,g'
1.87      wiz      8142:     </pre>
1.79      rillig   8143: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87      wiz      8144:     that are used to identify the different SUBST blocks that are
                   8145:     defined. The SUBST framework is heavily used by pkgsrc, so it is
                   8146:     important to always use the <code class="literal">+=</code> operator with
                   8147:     this variable. Otherwise some substitutions may be
                   8148:     skipped.</p>
1.79      rillig   8149: <p>The remaining variables of each SUBST block are
1.87      wiz      8150:     parameterized with the identifier from the first line
                   8151:     (<code class="literal">fix-paths</code> in this case.) They can be seen as
                   8152:     parameters to a function call.</p>
1.79      rillig   8153: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87      wiz      8154:     which the replacement will take place. All combinations of
                   8155:     <code class="literal">pre-</code>, <code class="literal">do-</code> and
                   8156:     <code class="literal">post-</code> together with a phase name are
                   8157:     possible, though only few are actually used. Most commonly used
                   8158:     are <code class="literal">post-patch</code> and
                   8159:     <code class="literal">pre-configure</code>. Of these two,
                   8160:     <code class="literal">pre-configure</code> should be preferred because
                   8161:     then it is possible to run <span><strong class="command">bmake patch</strong></span> and
                   8162:     have the state after applying the patches but before making any
                   8163:     other changes. This is especially useful when you are debugging
                   8164:     a package in order to create new patches for it. Similarly,
                   8165:     <code class="literal">post-build</code> is preferred over
                   8166:     <code class="literal">pre-install</code>, because the install phase should
                   8167:     generally be kept as simple as possible. When you use
                   8168:     <code class="literal">post-build</code>, you have the same files in the
                   8169:     working directory that will be installed later, so you can check
                   8170:     if the substitution has succeeded.</p>
1.79      rillig   8171: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87      wiz      8172:     that is printed just before the substitution is done.</p>
1.79      rillig   8173: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87      wiz      8174:     globbing patterns that specifies the files in which the
                   8175:     substitution will take place. The patterns are interpreted
                   8176:     relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79      rillig   8177: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.87      wiz      8178:     <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
                   8179:     command should be prefixed with <code class="literal">-e</code>, so that
                   8180:     all SUBST blocks look uniform.</p>
1.79      rillig   8181: <p>There are some more variables, but they are so seldomly
1.87      wiz      8182:     used that they are only documented in the
                   8183:     <code class="filename">mk/subst.mk</code> file.</p>
1.79      rillig   8184: </div>
1.75      rillig   8185: </div>
                   8186: <div class="sect1" lang="en">
                   8187: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   8188: <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   8189: <div class="sect2" lang="en">
                   8190: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8191: <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   8192: <p>If you need to download from a dynamic URL you can set
1.87      wiz      8193:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span><strong class="command">make
                   8194:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   8195:     with the name of each file to download as an argument, expecting
                   8196:     it to output the URL of the directory from which to download
1.91      rillig   8197:     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      8198:     example of this usage.</p>
1.75      rillig   8199: <p>If the download can't be automated, because the user must
1.87      wiz      8200:     submit personal information to apply for a password, or must pay
                   8201:     for the source, or whatever, you can set
                   8202:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   8203:     displayed to the user before aborting the build. Example:</p>
                   8204: <pre class="programlisting">
1.100   ! rillig   8205: FETCH_MESSAGE=  "Please download the files"
        !          8206: FETCH_MESSAGE+= "    "${DISTFILES:Q}
        !          8207: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.87      wiz      8208:     </pre>
1.75      rillig   8209: </div>
                   8210: <div class="sect2" lang="en">
                   8211: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8212: <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   8213: <p>Sometimes authors of a software package make some
1.87      wiz      8214:     modifications after the software was released, and they put up a
                   8215:     new distfile without changing the package's version number. If a
                   8216:     package is already in pkgsrc at that time, the checksum will
                   8217:     no longer match. The contents of the new distfile should be
                   8218:     compared against the old one before changing anything, to make
                   8219:     sure the distfile was really updated on purpose, and that
                   8220:     no trojan horse or so crept in.
1.97      rillig   8221:     Please mention that the distfiles were compared and what was found
                   8222:     in your commit message.
1.87      wiz      8223:     Then, the correct way to work around this is to
                   8224:     set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
                   8225:     usually based on <code class="varname">PKGNAME_NOREV</code>. All
                   8226:     <code class="varname">DISTFILES</code> and
1.93      rillig   8227:     <code class="varname">PATCHFILES</code> for this package will be put in that
1.97      rillig   8228:     subdirectory of the local distfiles directory.
                   8229:     (See <a href="#bumping-pkgrevision" title="18.1.11. How to handle incrementing versions when fixing an existing package">Section 18.1.11, &#8220;How to handle incrementing versions when fixing an existing package&#8221;</a> for more details.)
                   8230:     In case this
1.87      wiz      8231:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
                   8232:     including the <code class="filename">nbX</code> suffix) or a date stamp
                   8233:     can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
                   8234:     Do not forget regenerating the <code class="filename">distinfo</code> file
                   8235:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   8236:     path in the filenames.
1.97      rillig   8237:     Also increase the PKGREVISION if the installed package is different.
1.87      wiz      8238:     Furthermore, a mail to the package's authors seems appropriate
                   8239:     telling them that changing distfiles after releases without
                   8240:     changing the file names is not good practice.</p>
1.75      rillig   8241: </div>
                   8242: </div>
                   8243: <div class="sect1" lang="en">
                   8244: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   8245: <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   8246: <div class="sect2" lang="en">
                   8247: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8248: <a name="fixes.libtool"></a>18.3.1. Shared libraries - libtool</h3></div></div></div>
1.75      rillig   8249: <p>pkgsrc supports many different machines, with different
1.87      wiz      8250:     object formats like a.out and ELF, and varying abilities to do
                   8251:     shared library and dynamic loading at all. To accompany this,
                   8252:     varying commands and options have to be passed to the
                   8253:     compiler, linker, etc. to get the Right Thing, which can be
                   8254:     pretty annoying especially if you don't have all the machines
                   8255:     at your hand to test things.  The
1.91      rillig   8256:     <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      8257:     can help here, as it just &#8220;<span class="quote">knows</span>&#8221; how to build
                   8258:     both static and dynamic libraries from a set of source files,
                   8259:     thus being platform-independent.</p>
                   8260: <p>Here's how to use libtool in a package in seven simple
                   8261:     steps:</p>
1.75      rillig   8262: <div class="orderedlist"><ol type="1">
                   8263: <li><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87      wiz      8264:        Makefile.</p></li>
1.75      rillig   8265: <li><p>For library objects, use &#8220;<span class="quote">${LIBTOOL} --mode=compile
1.87      wiz      8266:        ${CC}</span>&#8221; in place of &#8220;<span class="quote">${CC}</span>&#8221;. You could even
                   8267:        add it to the definition of <code class="varname">CC</code>, if only
                   8268:        libraries are being built in a given Makefile. This one command
                   8269:        will build both PIC and non-PIC library objects, so you need not
                   8270:        have separate shared and non-shared library rules.</p></li>
1.75      rillig   8271: <li>
                   8272: <p>For the linking of the library, remove any
1.87      wiz      8273:        &#8220;<span class="quote">ar</span>&#8221;, &#8220;<span class="quote">ranlib</span>&#8221;, and &#8220;<span class="quote">ld
                   8274:        -Bshareable</span>&#8221; commands, and instead use:</p>
1.75      rillig   8275: <pre class="programlisting">
1.100   ! rillig   8276: ${LIBTOOL} --mode=link \
        !          8277:     ${CC} -o ${.TARGET:.a=.la} \
        !          8278:         ${OBJS:.o=.lo} \
        !          8279:         -rpath ${PREFIX}/lib \
        !          8280:         -version-info major:minor
1.87      wiz      8281:        </pre>
1.75      rillig   8282: <p>Note that the library is changed to have a
1.87      wiz      8283:        <code class="filename">.la</code> extension, and the objects are
                   8284:        changed to have a <code class="filename">.lo</code>
                   8285:        extension. Change <code class="varname">OBJS</code> as
                   8286:        necessary. This automatically creates all of the
                   8287:        <code class="filename">.a</code>,
                   8288:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   8289:        necessary) in the build directory. Be sure to include
                   8290:        &#8220;<span class="quote">-version-info</span>&#8221;, especially when major and
                   8291:        minor are zero, as libtool will otherwise strip off the
                   8292:        shared library version.</p>
1.75      rillig   8293: <p>From the libtool manual:</p>
                   8294: <pre class="programlisting">
1.100   ! rillig   8295: So, libtool library versions are described by three integers:
1.69      rillig   8296: 
1.100   ! rillig   8297: CURRENT
        !          8298: The most recent interface number that this library implements.
1.69      rillig   8299: 
1.100   ! rillig   8300: REVISION
        !          8301: The implementation number of the CURRENT interface.
1.69      rillig   8302: 
1.100   ! rillig   8303: AGE
        !          8304: The difference between the newest and oldest interfaces that
        !          8305: this library implements.  In other words, the library implements
        !          8306: all the interface numbers in the range from number `CURRENT -
        !          8307: AGE' to `CURRENT'.
1.1       grant    8308: 
1.100   ! rillig   8309: If two libraries have identical CURRENT and AGE numbers, then the
        !          8310: dynamic linker chooses the library with the greater REVISION number.
1.87      wiz      8311:        </pre>
1.75      rillig   8312: <p>The &#8220;<span class="quote">-release</span>&#8221; option will produce
1.87      wiz      8313:        different results for a.out and ELF (excluding symlinks)
                   8314:        in only one case. An ELF library of the form
                   8315:        &#8220;<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;
                   8316:        will have a symlink of
                   8317:        &#8220;<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;
                   8318:        on an a.out platform. This is handled
                   8319:        automatically.</p>
1.75      rillig   8320: <p>The &#8220;<span class="quote">-rpath argument</span>&#8221; is the install
1.87      wiz      8321:        directory of the library being built.</p>
1.76      rillig   8322: <p>In the <code class="filename">PLIST</code>, include only the
1.87      wiz      8323:        <code class="filename">.la</code> file, the other files will be
                   8324:        added automatically.</p>
1.75      rillig   8325: </li>
                   8326: <li>
1.76      rillig   8327: <p>When linking shared object (<code class="filename">.so</code>)
1.87      wiz      8328:        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
                   8329:        shared libraries, use &#8220;<span class="quote">-module
                   8330:        -avoid-version</span>&#8221; to prevent them getting version
                   8331:        tacked on.</p>
1.76      rillig   8332: <p>The <code class="filename">PLIST</code> file gets the
1.87      wiz      8333:        <code class="filename">foo.so</code> entry.</p>
1.75      rillig   8334: </li>
                   8335: <li>
                   8336: <p>When linking programs that depend on these libraries
1.87      wiz      8337:        <span class="emphasis"><em>before</em></span> they are installed, preface
                   8338:        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}
                   8339:        --mode=link</span>&#8221;, and it will find the correct
                   8340:        libraries (static or shared), but please be aware that
                   8341:        libtool will not allow you to specify a relative path in
                   8342:        -L (such as &#8220;<span class="quote">-L../somelib</span>&#8221;), because it
                   8343:        expects you to change that argument to be the
                   8344:        <code class="filename">.la</code> file. e.g.</p>
1.75      rillig   8345: <pre class="programlisting">
1.100   ! rillig   8346: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.87      wiz      8347:        </pre>
1.75      rillig   8348: <p>should be changed to:</p>
                   8349: <pre class="programlisting">
1.100   ! rillig   8350: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.87      wiz      8351:        </pre>
1.75      rillig   8352: <p>and it will do the right thing with the libraries.</p>
                   8353: </li>
                   8354: <li>
                   8355: <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      8356:        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}
                   8357:        --mode=install</span>&#8221;, and change the library name to
                   8358:        <code class="filename">.la</code>. e.g.</p>
1.75      rillig   8359: <pre class="programlisting">
1.100   ! rillig   8360: ${LIBTOOL} --mode=install ${BSD_INSTALL_DATA} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.87      wiz      8361:        </pre>
1.76      rillig   8362: <p>This will install the static <code class="filename">.a</code>,
1.87      wiz      8363:        shared library, any needed symlinks, and run
                   8364:        <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   8365: </li>
1.76      rillig   8366: <li><p>In your <code class="filename">PLIST</code>, include only
1.87      wiz      8367:        the <code class="filename">.la</code>
                   8368:        file (this is a change from previous behaviour).</p></li>
1.75      rillig   8369: </ol></div>
                   8370: </div>
                   8371: <div class="sect2" lang="en">
                   8372: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8373: <a name="using-libtool"></a>18.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75      rillig   8374: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87      wiz      8375:     package Makefile. This will override the package's own libtool
                   8376:     in most cases.  For older libtool using packages,  libtool is
                   8377:     made by ltconfig script during the do-configure step; you can
                   8378:     check the libtool script location by doing <span><strong class="command">make
                   8379:     configure; find work*/ -name libtool</strong></span>.</p>
1.75      rillig   8380: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87      wiz      8381:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
                   8382:     default, it is set to &#8220;<span class="quote">libtool */libtool
                   8383:     */*/libtool</span>&#8221;.  If this does not match the location of the
                   8384:     package's libtool script(s), set it as appropriate.</p>
1.76      rillig   8385: <p>If you do not need <code class="filename">*.a</code> static
1.87      wiz      8386:     libraries built and installed, then use
                   8387:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75      rillig   8388: <p>If your package makes use of the platform-independent library
1.87      wiz      8389:     for loading dynamic shared objects, that comes with libtool
                   8390:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   8391: <p>Some packages use libtool incorrectly so that the package
                   8392:     may not work or build in some circumstances. Some of the more
                   8393:     common errors are:</p>
1.75      rillig   8394: <div class="itemizedlist"><ul type="disc">
                   8395: <li>
                   8396: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87      wiz      8397:        executable or library. This in itself isn't a problem if one of two things
                   8398:        has been done:</p>
1.75      rillig   8399: <div class="orderedlist"><ol type="1">
                   8400: <li><p>The shared object is named correctly, i.e.
1.87      wiz      8401:            <code class="filename">libfoo.la</code>, not
                   8402:            <code class="filename">foo.la</code></p></li>
1.75      rillig   8403: <li><p>The -dlopen option is used when linking an executable.</p></li>
                   8404: </ol></div>
                   8405: </li>
                   8406: <li><p>The use of libltdl without the correct calls to initialisation routines.
1.87      wiz      8407:        The function lt_dlinit() should be called and the macro
                   8408:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   8409:        executables.</p></li>
1.75      rillig   8410: </ul></div>
                   8411: </div>
                   8412: <div class="sect2" lang="en">
                   8413: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8414: <a name="autoconf-automake"></a>18.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75      rillig   8415: <p>If a package needs GNU autoconf or automake to be executed
1.87      wiz      8416:     to regenerate the configure script and Makefile.in makefile
                   8417:     templates, then they should be executed in a pre-configure
                   8418:     target.</p>
1.75      rillig   8419: <p>For packages that need only autoconf:</p>
                   8420: <pre class="programlisting">
1.100   ! rillig   8421: AUTOCONF_REQD=  2.50            # if default version is not good enough
        !          8422: USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
        !          8423: ...
1.1       grant    8424: 
1.100   ! rillig   8425: pre-configure:
        !          8426:         cd ${WRKSRC} &amp;&amp; autoconf
1.1       grant    8427: 
1.100   ! rillig   8428: ...
1.87      wiz      8429:     </pre>
1.75      rillig   8430: <p>and for packages that need automake and autoconf:</p>
                   8431: <pre class="programlisting">
1.100   ! rillig   8432: AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
        !          8433: USE_TOOLS+=     automake        # use "automake14" for automake-1.4
        !          8434: ...
        !          8435: 
        !          8436: pre-configure:
        !          8437:         set -e; cd ${WRKSRC}; \
        !          8438:         aclocal; autoheader; automake -a --foreign -i; autoconf
1.1       grant    8439: 
1.100   ! rillig   8440: ...
1.87      wiz      8441:     </pre>
1.75      rillig   8442: <p>Packages which use GNU Automake will almost certainly
1.87      wiz      8443:     require GNU Make.</p>
1.75      rillig   8444: <p>There are times when the configure process makes
1.87      wiz      8445:     additional changes to the generated files, which then causes
                   8446:     the build process to try to re-execute the automake sequence.
                   8447:     This is prevented by touching various files in the configure
                   8448:     stage. If this causes problems with your package you can set
                   8449:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   8450:     Makefile.</p>
1.75      rillig   8451: </div>
                   8452: </div>
                   8453: <div class="sect1" lang="en">
                   8454: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   8455: <a name="programming-languages"></a>18.4. Programming languages</h2></div></div></div>
1.87      wiz      8456: <div class="sect2" lang="en">
                   8457: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8458: <a name="basic-programming-languages"></a>18.4.1. C, C++, and Fortran</h3></div></div></div>
1.87      wiz      8459: <p>Compilers for the C, C++, and Fortran languages comes with
                   8460:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   8461:     is written in C and will hide all other compilers (via the wrapper
1.90      rillig   8462:     framework, see <a href="#buildlink" title="Chapter 13. Buildlink methodology">Chapter 13, <i>Buildlink methodology</i></a>).</p>
1.87      wiz      8463: <p>To declare which language's compiler a package needs, set
                   8464:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
                   8465:     currently are &#8220;<span class="quote">c</span>&#8221;, &#8220;<span class="quote">c++</span>&#8221;, and
                   8466:     &#8220;<span class="quote">fortran</span>&#8221; (and any combination).  The default is
                   8467:     &#8220;<span class="quote">c</span>&#8221;.  Packages using GNU configure scripts, even if
                   8468:     written in C++, usually need a C compiler for the configure
                   8469:     phase.</p>
                   8470: </div>
                   8471: <div class="sect2" lang="en">
                   8472: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8473: <a name="java-programming-language"></a>18.4.2. Java</h3></div></div></div>
1.87      wiz      8474: <p>If a program is written in Java, use the Java framework in
                   8475:     pkgsrc.  The package must include
                   8476:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   8477:     provides the following variables:</p>
                   8478: <div class="itemizedlist"><ul type="disc">
                   8479: <li><p><code class="varname">USE_JAVA</code> defines if a build
                   8480:       dependency on the JDK is added.  If
                   8481:       <code class="varname">USE_JAVA</code> is set to &#8220;<span class="quote">run</span>&#8221;, then
                   8482:       there is only a runtime dependency on the JDK.  The default is
                   8483:       &#8220;<span class="quote">yes</span>&#8221;, which also adds a build dependency on the
                   8484:       JDK.</p></li>
                   8485: <li><p>Set <code class="varname">USE_JAVA2</code> to declare that
                   8486:       a package needs a Java2 implementation.  The supported values
                   8487:       are &#8220;<span class="quote">yes</span>&#8221;, &#8220;<span class="quote">1.4</span>&#8221;, and
                   8488:       &#8220;<span class="quote">1.5</span>&#8221;.  &#8220;<span class="quote">yes</span>&#8221; accepts any Java2
                   8489:       implementation, &#8220;<span class="quote">1.4</span>&#8221; insists on versions 1.4 or
                   8490:       above, and &#8220;<span class="quote">1.5</span>&#8221; only accepts versions 1.5 or
                   8491:       above. This variable is not set by default.</p></li>
                   8492: </ul></div>
                   8493: </div>
                   8494: <div class="sect2" lang="en">
                   8495: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8496: <a name="perl-scripts"></a>18.4.3. Packages containing perl scripts</h3></div></div></div>
1.87      wiz      8497: <p>If your package contains interpreted perl scripts, add
                   8498:     &#8220;<span class="quote">perl</span>&#8221; to the <code class="varname">USE_TOOLS</code> variable
                   8499:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   8500:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   8501:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
                   8502:     that you want adjusted.  Every occurrence of
                   8503:     <code class="filename">*/bin/perl</code> will be replaced with the full
                   8504:     path to the perl executable.</p>
                   8505: <p>If a particular version of perl is needed, set the
                   8506:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
                   8507:     default is &#8220;<span class="quote">5.0</span>&#8221;.</p>
1.90      rillig   8508: <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      8509:     about handling perl modules.</p>
                   8510: </div>
                   8511: <div class="sect2" lang="en">
                   8512: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8513: <a name="other-programming-languages"></a>18.4.4. Other programming languages</h3></div></div></div>
1.87      wiz      8514: <p>Currently, there is no special handling for other languages
                   8515:     in pkgsrc.  If a compiler package provides a
                   8516:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   8517:     just add a (build) dependency on the appropriate compiler
                   8518:     package.</p>
                   8519: </div>
                   8520: </div>
                   8521: <div class="sect1" lang="en">
                   8522: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   8523: <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   8524: <p>The most common failures when building a package are that
                   8525:        some platforms do not provide certain header files, functions or
                   8526:        libraries, or they provide the functions in a library that the
                   8527:        original package author didn't know. To work around this, you
                   8528:        can rewrite the source code in most cases so that it does not
                   8529:        use the missing functions or provides a replacement function.</p>
                   8530: <div class="sect2" lang="en">
                   8531: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8532: <a name="fixes.build.cpp"></a>18.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77      rillig   8533: <p>If a package already comes with a GNU configure script, the
                   8534:        preferred way to fix the build failure is to change the
                   8535:        configure script, not the code. In the other cases, you can
                   8536:        utilize the C preprocessor, which defines certain macros
                   8537:        depending on the operating system and hardware architecture it
                   8538:        compiles for. These macros can be queried using for example
                   8539:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   8540:        system, hardware architecture and compiler has its own macro.
                   8541:        For example, if the macros <code class="varname">__GNUC__</code>,
                   8542:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   8543:        are all defined, you know that you are using NetBSD on an i386
                   8544:        compatible CPU, and your compiler is GCC.</p>
                   8545: <p>The list of the following macros for hardware and
                   8546:        operating system depends on the compiler that is used. For
                   8547:        example, if you want to conditionally compile code on Solaris,
                   8548:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   8549:        does not define it. Use <code class="varname">__sun</code> instead.</p>
1.75      rillig   8550: <div class="sect3" lang="en">
                   8551: <div class="titlepage"><div><div><h4 class="title">
1.90      rillig   8552: <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   8553: <p>To distinguish between 4.4 BSD-derived systems and the
                   8554:         rest of the world, you should use the following code.</p>
                   8555: <pre class="programlisting">
1.100   ! rillig   8556: #include &lt;sys/param.h&gt;
        !          8557: #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
        !          8558: /* BSD-specific code goes here */
        !          8559: #else
        !          8560: /* non-BSD-specific code goes here */
        !          8561: #endif
1.75      rillig   8562: </pre>
1.77      rillig   8563: <p>If this distinction is not fine enough, you can also test
                   8564:        for the following macros.</p>
1.75      rillig   8565: <pre class="programlisting">
1.100   ! rillig   8566: FreeBSD     __FreeBSD__
        !          8567: DragonFly   __DragonFly__
        !          8568: Interix     __INTERIX
        !          8569: IRIX        __sgi (TODO: get a definite source for this)
        !          8570: Linux       linux, __linux, __linux__
        !          8571: NetBSD      __NetBSD__
        !          8572: OpenBSD     __OpenBSD__
        !          8573: Solaris     sun, __sun
1.75      rillig   8574: </pre>
                   8575: </div>
                   8576: <div class="sect3" lang="en">
                   8577: <div class="titlepage"><div><div><h4 class="title">
1.90      rillig   8578: <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   8579: <pre class="programlisting">
1.100   ! rillig   8580: i386        i386, __i386, __i386__
        !          8581: MIPS        __mips
        !          8582: SPARC       sparc, __sparc
1.75      rillig   8583: </pre>
                   8584: </div>
                   8585: <div class="sect3" lang="en">
                   8586: <div class="titlepage"><div><div><h4 class="title">
1.90      rillig   8587: <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   8588: <pre class="programlisting">
1.100   ! rillig   8589: GCC         __GNUC__ (major version), __GNUC_MINOR__
        !          8590: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
        !          8591: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
        !          8592: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75      rillig   8593: </pre>
                   8594: </div>
                   8595: </div>
1.78      rillig   8596: <div class="sect2" lang="en">
                   8597: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8598: <a name="compiler-bugs"></a>18.5.2. How to handle compiler bugs</h3></div></div></div>
1.78      rillig   8599: <p>Some source files trigger bugs in the compiler, based on
1.87      wiz      8600:         combinations of compiler version and architecture and almost
                   8601:         always relation to optimisation being enabled.  Common symptoms
                   8602:         are gcc internal errors or never finishing compiling a
1.78      rillig   8603:        file.</p>
                   8604: <p>Typically, a workaround involves testing the
                   8605:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   8606:         optimisation for that combination of file,
                   8607:        <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
1.87      wiz      8608:        in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
1.78      rillig   8609:        number of examples.</p>
                   8610: </div>
                   8611: <div class="sect2" lang="en">
                   8612: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8613: <a name="undefined-reference"></a>18.5.3. Undefined reference to &#8220;<span class="quote">...</span>&#8221;</h3></div></div></div>
1.92      rillig   8614: <p>This error message often means that a package did not
1.78      rillig   8615:        link to a shared library it needs. The following functions are
                   8616:        known to cause this error message over and over.</p>
                   8617: <div class="informaltable">
                   8618: <a name="undefined-reference-functions"></a><table border="1">
                   8619: <colgroup>
                   8620: <col>
                   8621: <col>
                   8622: <col>
                   8623: </colgroup>
                   8624: <thead><tr>
                   8625: <th>Function</th>
                   8626: <th>Library</th>
                   8627: <th>Affected platforms</th>
                   8628: </tr></thead>
                   8629: <tbody>
                   8630: <tr>
                   8631: <td>accept, bind, connect</td>
                   8632: <td>-lsocket</td>
                   8633: <td>Solaris</td>
                   8634: </tr>
                   8635: <tr>
                   8636: <td>crypt</td>
                   8637: <td>-lcrypt</td>
                   8638: <td>DragonFly, NetBSD</td>
                   8639: </tr>
                   8640: <tr>
                   8641: <td>dlopen, dlsym</td>
                   8642: <td>-ldl</td>
                   8643: <td>Linux</td>
                   8644: </tr>
                   8645: <tr>
                   8646: <td>gethost*</td>
                   8647: <td>-lnsl</td>
                   8648: <td>Solaris</td>
                   8649: </tr>
                   8650: <tr>
                   8651: <td>inet_aton</td>
                   8652: <td>-lresolv</td>
                   8653: <td>Solaris</td>
                   8654: </tr>
                   8655: <tr>
                   8656: <td>nanosleep, sem_*, timer_*</td>
                   8657: <td>-lrt</td>
                   8658: <td>Solaris</td>
                   8659: </tr>
                   8660: <tr>
                   8661: <td>openpty</td>
                   8662: <td>-lutil</td>
                   8663: <td>Linux</td>
                   8664: </tr>
                   8665: </tbody>
                   8666: </table>
                   8667: </div>
                   8668: <p>To fix these linker errors, it is often sufficient to say
1.87      wiz      8669:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   8670:     -l<em class="replaceable"><code>foo</code></em></code> to the package
                   8671:     <code class="filename">Makefile</code> and then say <span><strong class="command">bmake clean;
                   8672:     bmake</strong></span>.</p>
1.92      rillig   8673: <div class="sect3" lang="en">
                   8674: <div class="titlepage"><div><div><h4 class="title">
                   8675: <a name="undefined-reference-sunpro"></a>18.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
                   8676: <p>When you are using the SunPro compiler, there is another
                   8677: possibility. That compiler cannot handle the following code:</p>
                   8678: <pre class="programlisting">
1.100   ! rillig   8679: extern int extern_func(int);
1.93      rillig   8680: 
1.100   ! rillig   8681: static inline int
        !          8682: inline_func(int x)
        !          8683: {
1.92      rillig   8684:         return extern_func(x);
1.100   ! rillig   8685: }
1.93      rillig   8686: 
1.100   ! rillig   8687: int main(void)
        !          8688: {
1.92      rillig   8689:         return 0;
1.100   ! rillig   8690: }
1.92      rillig   8691: </pre>
                   8692: <p>It generates the code for <code class="function">inline_func</code> even if
                   8693: that function is never used. This code then refers to
                   8694: <code class="function">extern_func</code>, which can usually not be resolved. To
                   8695: solve this problem you can try to tell the package to disable inlining
                   8696: of functions.</p>
                   8697: </div>
1.87      wiz      8698: </div>
                   8699: <div class="sect2" lang="en">
                   8700: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8701: <a name="out-of-memory"></a>18.5.4. Running out of memory</h3></div></div></div>
1.87      wiz      8702: <p>Sometimes packages fail to build because the compiler runs
                   8703:     into an operating system specific soft limit.  With the
                   8704:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
                   8705:     to unlimit the resources.  Currently, the allowed values are
                   8706:     &#8220;<span class="quote">datasize</span>&#8221; and &#8220;<span class="quote">stacksize</span>&#8221; (or both).
                   8707:     Setting this variable is similar to running the shell builtin
                   8708:     <span><strong class="command">ulimit</strong></span> command to raise the maximum data
                   8709:     segment size or maximum stack size of a process, respectively, to
                   8710:     their hard limits.</p>
1.78      rillig   8711: </div>
1.75      rillig   8712: </div>
                   8713: <div class="sect1" lang="en">
                   8714: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   8715: <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   8716: <div class="sect2" lang="en">
                   8717: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8718: <a name="install-scripts"></a>18.6.1. Creating needed directories</h3></div></div></div>
1.78      rillig   8719: <p>The BSD-compatible <span><strong class="command">install</strong></span> supplied
1.87      wiz      8720:     with some operating systems cannot create more than one
                   8721:     directory at a time. As such, you should call
                   8722:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   8723: <pre class="programlisting">
1.100   ! rillig   8724: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
        !          8725: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.87      wiz      8726:     </pre>
1.78      rillig   8727: <p>You can also just append &#8220;<span class="quote"><code class="literal">dir1
1.87      wiz      8728:     dir2</code></span>&#8221; to the
                   8729:     <code class="varname">INSTALLATION_DIRS</code> variable, which will
                   8730:     automatically do the right thing.</p>
1.75      rillig   8731: </div>
                   8732: <div class="sect2" lang="en">
                   8733: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8734: <a name="where-to-install-documentation"></a>18.6.2. Where to install documentation</h3></div></div></div>
1.83      wiz      8735: <p>In general, documentation should be installed into
1.87      wiz      8736:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8737:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
                   8738:     includes the version number of the package).</p>
1.84      wiz      8739: <p>Many modern packages using GNU autoconf allow to set the
1.87      wiz      8740:     directory where HTML documentation is installed with the
                   8741:     &#8220;<span class="quote">--with-html-dir</span>&#8221; option. Sometimes using this flag
                   8742:     is needed because otherwise the documentation ends up in
                   8743:     <code class="filename">${PREFIX}/share/doc/html</code> or other
                   8744:     places.</p>
                   8745: <p>An exception to the above is that library API documentation
1.91      rillig   8746:     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      8747:     browsers (devhelp) should be left at their default location, which
                   8748:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   8749:     documentation can be recognized from files ending in
                   8750:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   8751:     (It is also acceptable to install such files in
                   8752:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8753:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   8754:     <code class="filename">.devhelp*</code> file must be directly in that
                   8755:     directory then, no additional subdirectory level is allowed in
                   8756:     this case. This is usually achieved by using
                   8757:     &#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;.
                   8758:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   8759:     though.)</p>
1.75      rillig   8760: </div>
                   8761: <div class="sect2" lang="en">
                   8762: <div class="titlepage"><div><div><h3 class="title">
1.100   ! rillig   8763: <a name="installing-score-files"></a>18.6.3. Installing highscore files</h3></div></div></div>
1.75      rillig   8764: <p>Certain packages, most of them in the games category, install
1.87      wiz      8765:     a score file that allows all users on the system to record their
                   8766:     highscores.  In order for this to work, the binaries need to be
                   8767:     installed setgid and the score files owned by the appropriate
                   8768:     group and/or owner (traditionally the "games" user/group).  The
                   8769:     following variables, documented in more detail in
                   8770:     <code class="filename">mk/defaults/mk.conf</code>, control this
                   8771:     behaviour: <code class="varname">SETGIDGAME</code>,
                   8772:     <code class="varname">GAMEDATAMODE</code>, <code class="varname">GAMEGRP</code>,
                   8773:     <code class="varname">GAMEMODE</code>, <code class="varname">GAMEOWN</code>.</p>
1.75      rillig   8774: <p>Note that per default, setgid installation of games is
1.87      wiz      8775:     disabled;  setting <code class="varname">SETGIDGAME=YES</code> will set all
                   8776:     the other variables accordingly.</p>
1.75      rillig   8777: <p>A package should therefor never hard code file ownership or
1.87      wiz      8778:     access permissions but rely on <code class="varname">INSTALL_GAME</code> and
                   8779:     <code class="varname">INSTALL_GAME_DATA</code> to set these
                   8780:     correctly.</p>
1.75      rillig   8781: </div>
                   8782: <div class="sect2" lang="en">
                   8783: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8784: <a name="hardcoded-paths"></a>18.6.4. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87      wiz      8785: <p>Your package may also contain scripts with hardcoded paths to
                   8786:       other interpreters besides (or as well as) perl.  To correct the
                   8787:       full pathname to the script interpreter, you need to set the
                   8788:       following definitions in your <code class="filename">Makefile</code> (we
                   8789:     shall use <span><strong class="command">tclsh</strong></span> in this example):</p>
                   8790: <pre class="programlisting">
1.100   ! rillig   8791: REPLACE_INTERPRETER+=   tcl
        !          8792: REPLACE.tcl.old=        .*/bin/tclsh
        !          8793: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
        !          8794: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
        !          8795: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.87      wiz      8796:     </pre>
1.75      rillig   8797: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   8798: <h3 class="title">Note</h3>
                   8799: <p>Before March 2006, these variables were called
1.87      wiz      8800:     <code class="varname">_REPLACE.*</code> and
                   8801:     <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75      rillig   8802: </div>
                   8803: </div>
                   8804: <div class="sect2" lang="en">
                   8805: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8806: <a name="perl-modules"></a>18.6.5. Packages installing perl modules</h3></div></div></div>
1.75      rillig   8807: <p>Makefiles of packages providing perl5 modules should include
1.87      wiz      8808:     the Makefile fragment
                   8809:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
                   8810:     <span><strong class="command">do-configure</strong></span> target for the standard perl
                   8811:     configuration for such modules as well as various hooks to tune
                   8812:     this configuration.  See comments in this file for
                   8813:     details.</p>
1.75      rillig   8814: <p>Perl5 modules will install into different places depending
1.87      wiz      8815:     on the version of perl used during the build process.  To
                   8816:     address this, pkgsrc will append lines to the
                   8817:     <code class="filename">PLIST</code> corresponding to the files listed in
                   8818:     the installed <code class="filename">.packlist</code> file generated by
                   8819:     most perl5 modules.  This is invoked by defining
                   8820:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
                   8821:     paths to packlist files, e.g.:</p>
1.75      rillig   8822: <pre class="programlisting">
1.100   ! rillig   8823: PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
1.87      wiz      8824:     </pre>
1.75      rillig   8825: <p>The variables <code class="varname">PERL5_SITELIB</code>,
1.87      wiz      8826:     <code class="varname">PERL5_SITEARCH</code>, and
                   8827:     <code class="varname">PERL5_ARCHLIB</code> represent the three locations
                   8828:     in which perl5 modules may be installed, and may be used by
                   8829:     perl5 packages that don't have a packlist.  These three
                   8830:     variables are also substituted for in the
                   8831:     <code class="filename">PLIST</code>.</p>
1.75      rillig   8832: </div>
                   8833: <div class="sect2" lang="en">
                   8834: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8835: <a name="faq.info-files"></a>18.6.6. Packages installing info files</h3></div></div></div>
1.75      rillig   8836: <p>Some packages install info files or use the
1.87      wiz      8837:     &#8220;<span class="quote">makeinfo</span>&#8221;  or &#8220;<span class="quote">install-info</span>&#8221;
                   8838:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   8839:     the package Makefile so that <code class="filename">INSTALL</code> and
                   8840:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   8841:     handle registration of the info files in the Info directory
                   8842:     file. The &#8220;<span class="quote">install-info</span>&#8221; command used for the info
                   8843:     files registration is either provided by the system, or by a
                   8844:     special purpose package automatically added as dependency if
                   8845:     needed.</p>
1.75      rillig   8846: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87      wiz      8847:     <code class="filename">${PREFIX}</code> where info files are primarily
                   8848:     located. <code class="varname">PKGINFODIR</code> defaults to
                   8849:     &#8220;<span class="quote">info</span>&#8221; and can be overridden by the user.</p>
1.75      rillig   8850: <p>The info files for the package should be listed in the
1.87      wiz      8851:     package <code class="filename">PLIST</code>; however any split info files
                   8852:     need not be listed.</p>
1.75      rillig   8853: <p>A package which needs the &#8220;<span class="quote">makeinfo</span>&#8221; command
1.87      wiz      8854:     at build time must add &#8220;<span class="quote">makeinfo</span>&#8221; to
                   8855:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
                   8856:     version of the &#8220;<span class="quote">makeinfo</span>&#8221; command is needed it
                   8857:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   8858:     variable in the package <code class="filename">Makefile</code>. By
                   8859:     default, a minimum version of 3.12 is required. If the system
                   8860:     does not provide a <span><strong class="command">makeinfo</strong></span> command or if it
                   8861:     does not match the required minimum, a build dependency on the
1.91      rillig   8862:     <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      8863:     be added automatically.</p>
1.75      rillig   8864: <p>The build and installation process of the software provided
1.87      wiz      8865:     by the package should not use the
                   8866:     <span><strong class="command">install-info</strong></span> command as the registration of
                   8867:     info files is the task of the package
                   8868:     <code class="filename">INSTALL</code> script, and it must use the
                   8869:     appropriate <span><strong class="command">makeinfo</strong></span> command.</p>
1.75      rillig   8870: <p>To achieve this goal, the pkgsrc infrastructure creates
1.87      wiz      8871:     overriding scripts for the <span><strong class="command">install-info</strong></span> and
                   8872:     <span><strong class="command">makeinfo</strong></span> commands in a directory listed early
                   8873:     in <code class="varname">PATH</code>.</p>
1.75      rillig   8874: <p>The script overriding <span><strong class="command">install-info</strong></span> has
1.87      wiz      8875:     no effect except the logging of a message. The script overriding
                   8876:     <span><strong class="command">makeinfo</strong></span> logs a message and according to the
                   8877:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
                   8878:     <span><strong class="command">makeinfo</strong></span> command or exit on error.</p>
1.75      rillig   8879: </div>
                   8880: <div class="sect2" lang="en">
                   8881: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8882: <a name="manpages"></a>18.6.7. Packages installing man pages</h3></div></div></div>
1.81      rillig   8883: <p>All packages that install manual pages should install them
1.87      wiz      8884:     into the same directory, so that there is one common place to look
                   8885:     for them. In pkgsrc, this place is
                   8886:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   8887:     should be used in packages. The default for
                   8888:     <code class="varname">PKGMANDIR</code> is
                   8889:     &#8220;<span class="quote"><code class="filename">man</code></span>&#8221;. Another often-used value
                   8890:     is &#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;.</p>
1.75      rillig   8891: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   8892: <h3 class="title">Note</h3>
1.87      wiz      8893: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   8894:     is far from complete.</p>
1.75      rillig   8895: </div>
1.81      rillig   8896: <p>The <code class="filename">PLIST</code> files can just use
1.87      wiz      8897:     <code class="filename">man/</code> as the top level directory for the man
                   8898:     page file entries, and the pkgsrc framework will convert as
                   8899:     needed. In all other places, the correct
                   8900:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   8901: <p>Packages that are
                   8902:     configured with <code class="varname">GNU_CONFIGURE</code> set as
                   8903:     &#8220;<span class="quote">yes</span>&#8221;, by default will use the
                   8904:     <code class="filename">./configure</code>
                   8905:     --mandir switch to set where the man pages should be installed.
                   8906:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   8907:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   8908: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   8909:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
                   8910:     to &#8220;<span class="quote">no</span>&#8221;.
                   8911:     Or if the <code class="filename">./configure</code> script uses
                   8912:     a non-standard use of --mandir, you can set
                   8913:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.90      rillig   8914: <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      8915:     information on installation of compressed manual pages.</p>
1.75      rillig   8916: </div>
                   8917: <div class="sect2" lang="en">
                   8918: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8919: <a name="gconf2-data-files"></a>18.6.8. Packages installing GConf2 data files</h3></div></div></div>
1.87      wiz      8920: <p>If a package installs <code class="filename">.schemas</code> or
                   8921:     <code class="filename">.entries</code> files, used by GConf2,
                   8922:     you need to take some extra steps to make sure they get registered
                   8923:     in the database:</p>
1.75      rillig   8924: <div class="orderedlist"><ol type="1">
1.76      rillig   8925: <li><p>Include <code class="filename">../../devel/GConf2/schemas.mk</code>
1.87      wiz      8926:        instead of its <code class="filename">buildlink3.mk</code> file.  This
                   8927:        takes care of rebuilding the GConf2 database at installation and
                   8928:        deinstallation time, and tells the package where to install
                   8929:        GConf2 data files using some standard configure arguments.  It
                   8930:        also disallows any access to the database directly from the
                   8931:        package.</p></li>
1.75      rillig   8932: <li><p>Ensure that the package installs its
1.87      wiz      8933:        <code class="filename">.schemas</code> files under
                   8934:        <code class="filename">${PREFIX}/share/gconf/schemas</code>.  If they get
                   8935:        installed under <code class="filename">${PREFIX}/etc</code>, you will
                   8936:        need to manually patch the package.</p></li>
1.75      rillig   8937: <li><p>Check the PLIST and remove any entries under the etc/gconf
1.87      wiz      8938:        directory, as they will be handled automatically.  See
1.90      rillig   8939:        <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   8940: <li><p>Define the <code class="varname">GCONF2_SCHEMAS</code> variable in
1.87      wiz      8941:        your <code class="filename">Makefile</code> with a list of all
                   8942:        <code class="filename">.schemas</code> files installed by the package, if
                   8943:        any.  Names must not contain any directories in them.</p></li>
1.75      rillig   8944: <li><p>Define the <code class="varname">GCONF2_ENTRIES</code> variable in
1.87      wiz      8945:        your <code class="filename">Makefile</code> with a
                   8946:        list of all <code class="filename">.entries</code> files installed by the
                   8947:        package, if any. Names must not contain any directories in
                   8948:        them.</p></li>
1.75      rillig   8949: </ol></div>
                   8950: </div>
                   8951: <div class="sect2" lang="en">
                   8952: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8953: <a name="scrollkeeper-data-files"></a>18.6.9. Packages installing scrollkeeper data files</h3></div></div></div>
1.87      wiz      8954: <p>If a package installs <code class="filename">.omf</code> files, used by
                   8955:     scrollkeeper, you need to take some extra steps to make sure they
                   8956:     get registered in the database:</p>
1.75      rillig   8957: <div class="orderedlist"><ol type="1">
                   8958: <li><p>Include
1.87      wiz      8959:        <code class="filename">../../textproc/scrollkeeper/omf.mk</code>
                   8960:        instead of its <code class="filename">buildlink3.mk</code> file.  This
                   8961:        takes care of rebuilding the scrollkeeper database at
                   8962:        installation and deinstallation time, and disallows any access
                   8963:        to it directly from the package.</p></li>
1.75      rillig   8964: <li><p>Check the PLIST and remove any entries under the
1.87      wiz      8965:        <code class="filename">libdata/scrollkeeper</code> directory, as they
                   8966:        will be handled automatically.</p></li>
1.76      rillig   8967: <li><p>Remove the <code class="filename">share/omf</code> directory from
1.87      wiz      8968:        the PLIST.  It will be handled by scrollkeeper.</p></li>
1.75      rillig   8969: </ol></div>
                   8970: </div>
                   8971: <div class="sect2" lang="en">
                   8972: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8973: <a name="x11-fonts"></a>18.6.10. Packages installing X11 fonts</h3></div></div></div>
1.75      rillig   8974: <p>If a package installs font files, you will need to rebuild
1.87      wiz      8975:     the fonts database in the directory where they get installed at
                   8976:     installation and deinstallation time.  This can be automatically
                   8977:     done by using the pkginstall framework.</p>
1.75      rillig   8978: <p>You can list the directories where fonts are installed in the
1.87      wiz      8979:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   8980:     variables, where <em class="replaceable"><code>type</code></em> can be one of
                   8981:     &#8220;<span class="quote">ttf</span>&#8221;, &#8220;<span class="quote">type1</span>&#8221; or &#8220;<span class="quote">x11</span>&#8221;.
                   8982:     Also make sure that the database file
                   8983:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75      rillig   8984: <p>Note that you should not create new directories for fonts;
1.87      wiz      8985:     instead use the standard ones to avoid that the user needs to
                   8986:     manually configure his X server to find them.</p>
1.75      rillig   8987: </div>
                   8988: <div class="sect2" lang="en">
                   8989: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8990: <a name="gtk2-modules"></a>18.6.11. Packages installing GTK2 modules</h3></div></div></div>
1.75      rillig   8991: <p>If a package installs GTK2 immodules or loaders, you need to
1.87      wiz      8992:     take some extra steps to get them registered in the GTK2 database
                   8993:     properly:</p>
1.75      rillig   8994: <div class="orderedlist"><ol type="1">
                   8995: <li><p>Include
1.87      wiz      8996:       <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
                   8997:       <code class="filename">buildlink3.mk</code> file.  This takes care of
                   8998:       rebuilding the database at installation and deinstallation time.</p></li>
                   8999: <li><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
                   9000:       your package installs GTK2 immodules.</p></li>
                   9001: <li><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
                   9002:       GTK2 loaders.</p></li>
1.75      rillig   9003: <li>
1.87      wiz      9004: <p>Patch the package to not touch any of the GTK2
                   9005:       databases directly.  These are:</p>
1.75      rillig   9006: <div class="itemizedlist"><ul type="disc">
1.76      rillig   9007: <li><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
                   9008: <li><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75      rillig   9009: </ul></div>
                   9010: </li>
1.87      wiz      9011: <li><p>Check the <code class="filename">PLIST</code> and remove
                   9012:       any entries under the <code class="filename">libdata/gtk-2.0</code>
                   9013:       directory, as they will be handled automatically.</p></li>
1.75      rillig   9014: </ol></div>
                   9015: </div>
                   9016: <div class="sect2" lang="en">
                   9017: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   9018: <a name="sgml-xml-data"></a>18.6.12. Packages installing SGML or XML data</h3></div></div></div>
1.75      rillig   9019: <p>If a package installs SGML or XML data files that need to be
1.87      wiz      9020:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   9021:     etc.), you need to take some extra steps:</p>
1.75      rillig   9022: <div class="orderedlist"><ol type="1">
                   9023: <li><p>Include
1.87      wiz      9024:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   9025:        your <code class="filename">Makefile</code>, which takes care of
                   9026:        registering those files in system-wide catalogs at
                   9027:        installation and deinstallation time.</p></li>
1.75      rillig   9028: <li><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87      wiz      9029:        any SGML catalogs installed by the package.</p></li>
1.75      rillig   9030: <li><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87      wiz      9031:        any XML catalogs installed by the package.</p></li>
1.75      rillig   9032: <li><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87      wiz      9033:        to be added to the SGML catalog.  These come in groups of
                   9034:        three strings; see xmlcatmgr(1) for more information
                   9035:        (specifically, arguments recognized by the 'add' action).
                   9036:        Note that you will normally not use this variable.</p></li>
1.75      rillig   9037: <li><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87      wiz      9038:        to be added to the XML catalog.  These come in groups of three
                   9039:        strings; see xmlcatmgr(1) for more information (specifically,
                   9040:        arguments recognized by the 'add' action).  Note that you will
                   9041:        normally not use this variable.</p></li>
1.75      rillig   9042: </ol></div>
                   9043: </div>
                   9044: <div class="sect2" lang="en">
                   9045: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   9046: <a name="mime-database"></a>18.6.13. Packages installing extensions to the MIME database</h3></div></div></div>
1.75      rillig   9047: <p>If a package provides extensions to the MIME database by
1.87      wiz      9048:     installing <code class="filename">.xml</code> files inside
                   9049:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   9050:     need to take some extra steps to ensure that the database is kept
                   9051:     consistent with respect to these new files:</p>
1.75      rillig   9052: <div class="orderedlist"><ol type="1">
                   9053: <li><p>Include
1.87      wiz      9054:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   9055:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   9056:        this same directory, which is reserved for inclusion from
                   9057:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   9058:        care of rebuilding the MIME database at installation and
                   9059:        deinstallation time, and disallows any access to it directly
                   9060:        from the package.</p></li>
1.75      rillig   9061: <li><p>Check the PLIST and remove any entries under the
1.87      wiz      9062:        <code class="filename">share/mime</code> directory,
                   9063:        <span class="emphasis"><em>except</em></span> for files saved under
                   9064:        <code class="filename">share/mime/packages</code>.  The former are
                   9065:        handled automatically by
                   9066:        the update-mime-database program, but the latter are
                   9067:        package-dependent and must be removed by the package that
                   9068:        installed them in the first place.</p></li>
1.76      rillig   9069: <li><p>Remove any <code class="filename">share/mime/*</code> directories
1.87      wiz      9070:        from the PLIST.  They will be handled by the shared-mime-info
                   9071:        package.</p></li>
1.75      rillig   9072: </ol></div>
                   9073: </div>
                   9074: <div class="sect2" lang="en">
                   9075: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   9076: <a name="intltool"></a>18.6.14. Packages using intltool</h3></div></div></div>
1.93      rillig   9077: <p>If a package uses intltool during its build, add
                   9078:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87      wiz      9079:     which forces it to use the intltool package provided by pkgsrc,
                   9080:     instead of the one bundled with the distribution file.</p>
1.75      rillig   9081: <p>This tracks intltool's build-time dependencies and uses the
1.87      wiz      9082:     latest available version; this way, the package benefits of any
                   9083:     bug fixes that may have appeared since it was released.</p>
1.75      rillig   9084: </div>
                   9085: <div class="sect2" lang="en">
                   9086: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   9087: <a name="startup-scripts"></a>18.6.15. Packages installing startup scripts</h3></div></div></div>
1.75      rillig   9088: <p>If a package contains a rc.d script, it won't be copied into
1.87      wiz      9089:     the startup directory by default, but you can enable it, by adding
                   9090:     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
                   9091:     <code class="filename">/etc/mk.conf</code>. This option will copy the scripts
                   9092:     into <code class="filename">/etc/rc.d</code> when a package is installed, and
                   9093:     it will automatically remove the scripts when the package is
                   9094:     deinstalled.</p>
1.75      rillig   9095: </div>
                   9096: <div class="sect2" lang="en">
                   9097: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   9098: <a name="tex-packages"></a>18.6.16. Packages installing TeX modules</h3></div></div></div>
1.75      rillig   9099: <p>If a package installs TeX packages into the texmf tree,
1.87      wiz      9100:     the <code class="filename">ls-R</code> database of the tree needs to be
                   9101:     updated.</p>
1.75      rillig   9102: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   9103: <h3 class="title">Note</h3>
                   9104: <p>Except the main TeX packages such as teTeX-texmf,
1.87      wiz      9105:     packages should install files
                   9106:     into <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
                   9107:     not <code class="varname">PKG_TEXMFPREFIX</code>.</p>
1.75      rillig   9108: </div>
                   9109: <div class="orderedlist"><ol type="1">
                   9110: <li><p>Include
1.87      wiz      9111:       <code class="filename">../../print/teTeX/module.mk</code> instead
                   9112:       of <code class="filename">../../mk/tex.buildlink3.mk</code>.  This
                   9113:       takes care of rebuilding the <code class="filename">ls-R</code>
                   9114:       database at installation and deinstallation time.</p></li>
1.75      rillig   9115: <li>
                   9116: <p>If your package installs files into a texmf
1.87      wiz      9117:       tree other than the one
                   9118:       at <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
                   9119:       set <code class="varname">TEXMFDIRS</code> to the list of all texmf
                   9120:       trees that need database update.</p>
1.75      rillig   9121: <p>If your package also installs font map files that need
1.87      wiz      9122:       to be registered using <span><strong class="command">updmap</strong></span>,
                   9123:       set <code class="varname">TEX_FONTMAPS</code> to the list of all
                   9124:       such font map files.  Then <span><strong class="command">updmap</strong></span> will
                   9125:       be run automatically at installation/deinstallation to
                   9126:       enable/disable font map files for TeX output
                   9127:       drivers.</p>
1.75      rillig   9128: </li>
1.76      rillig   9129: <li><p>Make sure that none of <code class="filename">ls-R</code>
1.87      wiz      9130:       databases are included in <code class="filename">PLIST</code>, as
                   9131:       they will be removed only by the teTeX-bin package.</p></li>
1.75      rillig   9132: </ol></div>
                   9133: </div>
1.85      jmmv     9134: <div class="sect2" lang="en">
                   9135: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   9136: <a name="emulation-packages"></a>18.6.17. Packages supporting running binaries in
1.87      wiz      9137:     emulation</h3></div></div></div>
                   9138: <p>There are some packages that provide libraries and
                   9139:     executables for running binaries from a one operating system
                   9140:     on a different one (if the latter supports it).  One example
                   9141:     is running Linux binaries on NetBSD.</p>
1.91      rillig   9142: <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      9143:     helps in extracting and packaging Linux rpm packages.</p>
                   9144: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
                   9145:     avoid the <span><strong class="command">check-shlibs</strong></span> target, which tests
                   9146:     if all libraries for each installed executable can be found by
                   9147:     the dynamic linker.  Since the standard dynamic linker is run,
                   9148:     this fails for emulation packages, because the libraries used
                   9149:     by the emulation are not in the standard directories.</p>
                   9150: </div>
                   9151: <div class="sect2" lang="en">
                   9152: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   9153: <a name="hicolor-theme"></a>18.6.18. Packages installing hicolor theme icons</h3></div></div></div>
1.85      jmmv     9154: <p>If a package installs images under the
1.87      wiz      9155:     <code class="filename">share/icons/hicolor</code> and/or updates the
                   9156:     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
                   9157:     database, you need to take some extra steps to make sure that the
                   9158:     shared theme directory is handled appropriately and that the cache
                   9159:     database is rebuilt:</p>
1.85      jmmv     9160: <div class="orderedlist"><ol type="1">
                   9161: <li><p>Include
1.87      wiz      9162:        <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
                   9163: <li><p>Check the <code class="filename">PLIST</code> and remove the
                   9164:        entry that refers to the theme cache.</p></li>
1.85      jmmv     9165: <li><p>Ensure that the PLIST does not remove the shared icon
                   9166:          directories from the <code class="filename">share/icons/hicolor</code>
                   9167:          hierarchy because they will be handled automatically.</p></li>
                   9168: </ol></div>
                   9169: <p>The best way to verify that the PLIST is correct with
                   9170:       respect to the last two points is to regenerate it using
                   9171:       <span><strong class="command">make print-PLIST</strong></span>.</p>
                   9172: </div>
                   9173: <div class="sect2" lang="en">
                   9174: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   9175: <a name="desktop-files"></a>18.6.19. Packages installing desktop files</h3></div></div></div>
1.85      jmmv     9176: <p>If a package installs <code class="filename">.desktop</code> files
                   9177:       under <code class="filename">share/applications</code> and these include
                   9178:       MIME information, you need to take extra steps to ensure that they
                   9179:       are registered into the MIME database:</p>
                   9180: <div class="orderedlist"><ol type="1">
                   9181: <li><p>Include
                   9182:          <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
                   9183: <li><p>Check the PLIST and remove the entry that refers to the
                   9184:          <code class="filename">share/applications/mimeinfo.cache</code> file.
                   9185:          It will be handled automatically.</p></li>
                   9186: </ol></div>
                   9187: <p>The best way to verify that the PLIST is correct with
                   9188:       respect to the last point is to regenerate it using <span><strong class="command">make
                   9189:       print-PLIST</strong></span>.</p>
1.75      rillig   9190: </div>
                   9191: </div>
1.87      wiz      9192: <div class="sect1" lang="en">
                   9193: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9194: <a name="punting"></a>18.7. Marking packages as having problems</h2></div></div></div>
1.87      wiz      9195: <p>In some cases one does not have the time to solve a problem
                   9196:   immediately.  There are currently two ways to declare that one knows
                   9197:   that a package has problems.</p>
                   9198: <div class="itemizedlist"><ul type="disc">
                   9199: <li><p>The first way is to plainly mark it as broken.  For
                   9200:     this, one just sets the variable <code class="varname">BROKEN</code> to the
                   9201:     reason why the package is broken (similar to the
                   9202:     <code class="varname">RESTRICTED</code> variable).  A user trying to build
                   9203:     the package will immediately be shown this message, and the build
                   9204:     will not be even tried.</p></li>
                   9205: <li><p>After each pkgsrc freeze period (a time when the
                   9206:     tree is stabilized and a new pkgsrc branch is cut), the packages
                   9207:     that were not building in the official branch build on the latest
                   9208:     NetBSD release will be marked as broken on that branch.  This is
                   9209:     done by setting the <code class="varname">BROKEN_IN</code> variable to the
                   9210:     branch name (or appending the branch name to it).  If a user tries
                   9211:     to build such a package and the build fails, the user gets a
                   9212:     message that says that the package was broken on the respective
                   9213:     branch(es).</p></li>
                   9214: </ul></div>
                   9215: <p>Both types of packages are removed from pkgsrc in irregular
                   9216:   intervals.</p>
                   9217: </div>
1.75      rillig   9218: </div>
                   9219: <div class="chapter" lang="en">
                   9220: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   9221: <a name="debug"></a>Chapter 19. Debugging</h2></div></div></div>
1.88      wiz      9222: <p>To check out all the gotchas when building a package, here are
                   9223:   the steps that I do in order to get a package working.  Please note
                   9224:   this is basically the same as what was explained in the previous
                   9225:   sections, only with some debugging aids.</p>
1.75      rillig   9226: <div class="itemizedlist"><ul type="disc">
1.88      wiz      9227: <li><p>Be sure to set <code class="varname">PKG_DEVELOPER=1</code> in
                   9228:       <code class="filename">/etc/mk.conf</code></p></li>
1.75      rillig   9229: <li>
1.91      rillig   9230: <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      9231:       create a directory for a new package, change into it, then run
                   9232:       <span><strong class="command">url2pkg</strong></span>:</p>
1.75      rillig   9233: <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>
                   9234: <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>
                   9235: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
                   9236: </li>
1.76      rillig   9237: <li><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
                   9238: <li><p>Fill in the <code class="filename">DESCR</code> file</p></li>
1.87      wiz      9239: <li><p>Run <span><strong class="command">make configure</strong></span></p></li>
1.75      rillig   9240: <li><p>Add any dependencies glimpsed from documentation and the
1.88      wiz      9241:       configure step to the package's
                   9242:       <code class="filename">Makefile</code>.</p></li>
1.75      rillig   9243: <li>
                   9244: <p>Make the package compile, doing multiple rounds of</p>
                   9245: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   9246: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   9247: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
                   9248: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
                   9249: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
                   9250: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
                   9251: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88      wiz      9252: <p>Doing this step as non-root user will ensure that no files
                   9253:       are modified that shouldn't be, especially during the build
                   9254:       phase.  <span><strong class="command">mkpatches</strong></span>,
                   9255:       <span><strong class="command">patchdiff</strong></span> and <span><strong class="command">pkgvi</strong></span> are
1.91      rillig   9256:       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      9257:       package.</p>
1.75      rillig   9258: </li>
1.88      wiz      9259: <li><p>Look at the <code class="filename">Makefile</code>, fix if
1.90      rillig   9260:       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   9261: <li>
1.76      rillig   9262: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75      rillig   9263: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9264: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST &gt;PLIST</code></strong>
                   9265: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
                   9266: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9267: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88      wiz      9268: <p>You usually need to be <code class="username">root</code> to do
                   9269:       this.  Look if there are any files left:</p>
1.75      rillig   9270: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9271: <p>If this reveals any files that are missing in
1.88      wiz      9272:       <code class="filename">PLIST</code>, add them.</p>
1.75      rillig   9273: </li>
                   9274: <li>
1.88      wiz      9275: <p>Now that the <code class="filename">PLIST</code> is OK, install the
                   9276:       package again and make a binary package:</p>
1.75      rillig   9277: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
                   9278: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
                   9279: </li>
                   9280: <li>
                   9281: <p>Delete the installed package:</p>
1.88      wiz      9282: <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   9283: </li>
                   9284: <li>
1.88      wiz      9285: <p>Repeat the above <span><strong class="command">make print-PLIST</strong></span>
                   9286:       command, which shouldn't find anything now:</p>
1.75      rillig   9287: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9288: </li>
                   9289: <li>
                   9290: <p>Reinstall the binary package:</p>
1.93      rillig   9291: <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   9292: </li>
1.88      wiz      9293: <li><p>Play with it.  Make sure everything works.</p></li>
1.75      rillig   9294: <li>
1.91      rillig   9295: <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      9296:       reports:</p>
1.75      rillig   9297: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
                   9298: </li>
1.90      rillig   9299: <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   9300: </ul></div>
                   9301: </div>
                   9302: <div class="chapter" lang="en">
                   9303: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   9304: <a name="submit"></a>Chapter 20. Submitting and Committing</h2></div></div></div>
1.75      rillig   9305: <div class="toc">
                   9306: <p><b>Table of Contents</b></p>
                   9307: <dl>
1.90      rillig   9308: <dt><span class="sect1"><a href="#submitting-binary-packages">20.1. Submitting binary packages</a></span></dt>
                   9309: <dt><span class="sect1"><a href="#submitting-your-package">20.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   9310: <dt><span class="sect1"><a href="#general-notes-for-changes">20.3. General notes when adding, updating, or removing packages</a></span></dt>
                   9311: <dt><span class="sect1"><a href="#committing-importing">20.4. Committing: Importing a package into CVS</a></span></dt>
                   9312: <dt><span class="sect1"><a href="#updating-package">20.5. Updating a package to a newer version</a></span></dt>
                   9313: <dt><span class="sect1"><a href="#moving-package">20.6. Moving a package in pkgsrc</a></span></dt>
1.75      rillig   9314: </dl>
                   9315: </div>
                   9316: <div class="sect1" lang="en">
                   9317: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9318: <a name="submitting-binary-packages"></a>20.1. Submitting binary packages</h2></div></div></div>
1.75      rillig   9319: <p>Our policy is that we accept binaries only from pkgsrc
                   9320:        developers to guarantee that the packages don't contain any
                   9321:        trojan horses etc. This is not to annoy anyone but rather to
                   9322:        protect our users! You're still free to put up your home-made
                   9323:        binary packages and tell the world where to get them. NetBSD
                   9324:        developers doing bulk builds and wanting to upload them please
                   9325:        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>
                   9326: </div>
                   9327: <div class="sect1" lang="en">
                   9328: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9329: <a name="submitting-your-package"></a>20.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75      rillig   9330: <p>First, check that your package is complete, compiles and
1.90      rillig   9331:        runs well; see <a href="#debug" title="Chapter 19. Debugging">Chapter 19, <i>Debugging</i></a> and the rest of this
1.75      rillig   9332:        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   9333:        archive that contains all files that make up the package.
1.87      wiz      9334:        Finally, send this package to the pkgsrc bug tracking system,
                   9335:        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
                   9336:        that, go to the web page
                   9337:        <a href="http://www.NetBSD.org/Misc/send-pr.html" target="_top">http://www.NetBSD.org/Misc/send-pr.html</a>,
                   9338:        which contains some instructions and a link to a form, where you
                   9339:        can submit packages.</p>
                   9340: <p>In the form of the problem report, the category should be
                   9341:        &#8220;<span class="quote">pkg</span>&#8221;, the synopsis should include the package name
                   9342:        and version number, and the description field should contain a
                   9343:        short description of your package (contents of the COMMENT
                   9344:        variable or DESCR file are OK). The uuencoded package data should
                   9345:        go into the &#8220;<span class="quote">fix</span>&#8221; field.</p>
1.75      rillig   9346: <p>If you want to submit several packages, please send a
                   9347:        separate PR for each one, it's easier for us to track things
                   9348:        that way.</p>
                   9349: <p>Alternatively, you can also import new packages into
                   9350:        pkgsrc-wip (&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;); see the
                   9351:        homepage at <a href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
                   9352:        for details.</p>
                   9353: </div>
                   9354: <div class="sect1" lang="en">
                   9355: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9356: <a name="general-notes-for-changes"></a>20.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75      rillig   9357: <p>Please note all package additions, updates, moves, and
1.93      rillig   9358:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75      rillig   9359:        important to keep this file up to date and conforming to the
                   9360:        existing format, because it will be used by scripts to
                   9361:        automatically update pages on <a href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
                   9362:        sites. Additionally, check the
1.76      rillig   9363:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75      rillig   9364:        for the package you updated or removed, in case it was mentioned
                   9365:        there.</p>
                   9366: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   9367:        bumped, the change should appear in
1.93      rillig   9368:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75      rillig   9369:        related or otherwise relevant. Mass bumps that result from a
                   9370:        dependency being updated should not be mentioned. In all other
                   9371:        cases it's the developer's decision.</p>
                   9372: <p>There is a make target that helps in creating proper
1.93      rillig   9373:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span><strong class="command">make
1.75      rillig   9374:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   9375:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93      rillig   9376:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75      rillig   9377:   file is up-to-date (to avoid having to resolve conflicts later-on)
                   9378:   and then to <span><strong class="command">cd</strong></span> to the package directory.  For
                   9379:   package updates, <span><strong class="command">make changes-entry</strong></span> is enough.
                   9380:   For new packages, or package moves or removals, set the
                   9381:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   9382:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.76      rillig   9383:   in <code class="filename">/etc/mk.conf</code> if your local login name is
1.75      rillig   9384:   not the same as your NetBSD login name. Don't forget to commit
1.93      rillig   9385:   the changes to <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>!</p>
1.75      rillig   9386: </div>
                   9387: <div class="sect1" lang="en">
                   9388: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9389: <a name="committing-importing"></a>20.4. Committing: Importing a package into CVS</h2></div></div></div>
1.87      wiz      9390: <p>This section is only of interest for pkgsrc developers with write
1.75      rillig   9391:   access to the pkgsrc repository. Please remember that cvs
                   9392:   imports files relative to the current working directory, and that
                   9393:   the pathname that you
                   9394:   give the <span><strong class="command">cvs import</strong></span> command is so that it knows where
                   9395:   to place the files in the repository.  Newly created packages should be
                   9396:   imported with a vendor tag of &#8220;<span class="quote">TNF</span>&#8221; and a release tag of
1.87      wiz      9397:   &#8220;<span class="quote">pkgsrc-base</span>&#8221;, e.g:</p>
1.75      rillig   9398: <pre class="programlisting">
1.100   ! rillig   9399: <code class="prompt">$</code> cd .../pkgsrc/category/pkgname
        !          9400: <code class="prompt">$</code> cvs import pkgsrc/category/pkgname TNF pkgsrc-base
1.75      rillig   9401: </pre>
1.87      wiz      9402: <p>Remember to move the directory from which you imported out of
1.75      rillig   9403:   the way, or cvs will complain the next time you &#8220;<span class="quote">cvs
                   9404:   update</span>&#8221; your source tree.  Also don't forget to add the new
1.87      wiz      9405:   package to the category's <code class="filename">Makefile</code>.</p>
                   9406: <p>The commit message of the initial import should include part of the
1.76      rillig   9407:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87      wiz      9408:   what the package is/does.</p>
                   9409: <p>For new packages, &#8220;<span class="quote">cvs import</span>&#8221; is preferred to &#8220;<span class="quote">cvs
1.75      rillig   9410:   add</span>&#8221; because the former gets everything with a single command,
1.87      wiz      9411:   and provides a consistent tag.</p>
1.75      rillig   9412: </div>
                   9413: <div class="sect1" lang="en">
                   9414: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9415: <a name="updating-package"></a>20.5. Updating a package to a newer version</h2></div></div></div>
1.87      wiz      9416: <p>Please always put a concise, appropriate and relevant summary of the
1.75      rillig   9417:   changes between old and new versions into the commit log when updating
1.87      wiz      9418:   a package. There are various reasons for this:</p>
1.75      rillig   9419: <div class="itemizedlist"><ul type="disc">
1.87      wiz      9420: <li><p>A URL is volatile, and can change over time. It may go away completely
                   9421:   or its information may be overwritten by newer information.</p></li>
                   9422: <li><p>Having the change information between old and new versions in our CVS
                   9423:   repository is very useful for people who use either cvs or anoncvs.</p></li>
                   9424: <li><p>Having the change information between old and new versions in our CVS
1.75      rillig   9425:   repository is very useful for people who read the pkgsrc-changes mailing
                   9426:   list, so that they can make tactical decisions about when to upgrade
1.87      wiz      9427:   the package.</p></li>
1.75      rillig   9428: </ul></div>
1.87      wiz      9429: <p>Please also recognize that, just because a new version of a package
1.75      rillig   9430:   has been released, it should not automatically be upgraded in the CVS
                   9431:   repository.  We prefer to be conservative in the packages that are
                   9432:   included in pkgsrc - development or beta packages are not really the
                   9433:   best thing for most places in which pkgsrc is used. Please use your
                   9434:   judgement about what should go into pkgsrc, and bear in mind that
1.87      wiz      9435:   stability is to be preferred above new and possibly untested features.</p>
1.75      rillig   9436: </div>
                   9437: <div class="sect1" lang="en">
                   9438: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9439: <a name="moving-package"></a>20.6. Moving a package in pkgsrc</h2></div></div></div>
1.75      rillig   9440: <div class="orderedlist"><ol type="1">
                   9441: <li><p>Make a copy of the directory somewhere else.</p></li>
                   9442: <li>
                   9443: <p>Remove all CVS dirs.</p>
1.87      wiz      9444: <p>Alternatively to the first two steps you can also do:</p>
1.75      rillig   9445: <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      9446: <p>and use that for further work.</p>
1.75      rillig   9447: </li>
                   9448: <li><p>Fix <code class="varname">CATEGORIES</code> and any
                   9449: <code class="varname">DEPENDS</code> paths that just did &#8220;<span class="quote">../package</span>&#8221;
                   9450: instead of &#8220;<span class="quote">../../category/package</span>&#8221;.</p></li>
                   9451: <li><p><span><strong class="command">cvs import</strong></span> the modified package in the new
                   9452: place.</p></li>
                   9453: <li>
                   9454: <p>Check if any package depends on it:
                   9455: </p>
                   9456: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   9457: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   9458: </li>
                   9459: <li><p>Fix paths in packages from step 5 to point to new location.</p></li>
                   9460: <li><p><span><strong class="command">cvs rm (-f)</strong></span> the package at the old location.</p></li>
1.76      rillig   9461: <li><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   9462: <li><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
1.75      rillig   9463: <li>
                   9464: <p>Commit the changed and removed files:</p>
                   9465: <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      9466: <p>(and any packages from step 5, of course).</p>
1.75      rillig   9467: </li>
                   9468: </ol></div>
                   9469: </div>
                   9470: </div>
                   9471: <div class="chapter" lang="en">
                   9472: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   9473: <a name="devfaq"></a>Chapter 21. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   9474: <p>This section contains the answers to questions that may
                   9475:        arise when you are writing a package. If you don't find your
                   9476:        question answered here, first have a look in the other chapters,
                   9477:        and if you still don't have the answer, ask on the
                   9478:        <code class="literal">pkgsrc-users</code> mailing list.</p>
                   9479: <div class="qandaset">
                   9480: <dl>
1.93      rillig   9481: <dt>21.1. <a href="#devfaq.makeflags">What is the difference between
1.75      rillig   9482:        MAKEFLAGS, .MAKEFLAGS and
                   9483:        MAKE_FLAGS?</a>
                   9484: </dt>
1.93      rillig   9485: <dt>21.2. <a href="#devfaq.make">What is the difference between
1.75      rillig   9486:        MAKE, GMAKE and
                   9487:        MAKE_PROGRAM?</a>
                   9488: </dt>
1.93      rillig   9489: <dt>21.3. <a href="#devfaq.cc">What is the difference between
1.75      rillig   9490:        CC, PKG_CC and
                   9491:        PKGSRC_COMPILER?</a>
                   9492: </dt>
1.93      rillig   9493: <dt>21.4. <a href="#devfaq.bl3flags">What is the difference between
1.75      rillig   9494:        BUILDLINK_LDFLAGS,
                   9495:        BUILDLINK_LDADD and
                   9496:        BUILDLINK_LIBS?</a>
                   9497: </dt>
1.93      rillig   9498: <dt>21.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75      rillig   9499:        VARNAME=BUILDLINK_PREFIX.foo
                   9500:        say it's empty?</a>
                   9501: </dt>
1.93      rillig   9502: <dt>21.6. <a href="#devfaq.master_sites">What does
1.78      rillig   9503:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   9504:        don't understand the := inside
                   9505:        it.</a>
                   9506: </dt>
1.93      rillig   9507: <dt>21.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78      rillig   9508:        developers?</a>
                   9509: </dt>
1.93      rillig   9510: <dt>21.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80      rillig   9511:        documentation?</a>
                   9512: </dt>
1.92      rillig   9513: <dt>21.9. <a href="#devfaq.too-much-time">I have a little time to kill.  What shall I
                   9514: do?</a>
                   9515: </dt>
1.75      rillig   9516: </dl>
                   9517: <table border="0" summary="Q and A Set">
                   9518: <col align="left" width="1%">
                   9519: <tbody>
                   9520: <tr class="question">
                   9521: <td align="left" valign="top">
1.100   ! rillig   9522: <a name="devfaq.makeflags"></a><a name="id2713470"></a><b>21.1.</b>
1.75      rillig   9523: </td>
                   9524: <td align="left" valign="top"><p>What is the difference between
                   9525:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   9526:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   9527: </tr>
                   9528: <tr class="answer">
1.91      rillig   9529: <td align="left" valign="top"></td>
1.75      rillig   9530: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
                   9531:        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
                   9532:        <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
                   9533:        the <code class="varname">MAKE_PROGRAM</code> when building the
                   9534:        package. [FIXME: What is .MAKEFLAGS for?]</p></td>
                   9535: </tr>
                   9536: <tr class="question">
                   9537: <td align="left" valign="top">
1.100   ! rillig   9538: <a name="devfaq.make"></a><a name="id2713509"></a><b>21.2.</b>
1.75      rillig   9539: </td>
                   9540: <td align="left" valign="top"><p>What is the difference between
                   9541:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   9542:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   9543: </tr>
                   9544: <tr class="answer">
1.91      rillig   9545: <td align="left" valign="top"></td>
1.75      rillig   9546: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
                   9547:        <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
                   9548:        infrastructure. <code class="varname">GMAKE</code> is the path to GNU
                   9549:        Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
                   9550:        use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
                   9551:        Make program that is used for building the
                   9552:        package.</p></td>
                   9553: </tr>
                   9554: <tr class="question">
                   9555: <td align="left" valign="top">
1.100   ! rillig   9556: <a name="devfaq.cc"></a><a name="id2713549"></a><b>21.3.</b>
1.75      rillig   9557: </td>
                   9558: <td align="left" valign="top"><p>What is the difference between
                   9559:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   9560:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   9561: </tr>
                   9562: <tr class="answer">
1.91      rillig   9563: <td align="left" valign="top"></td>
1.75      rillig   9564: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
                   9565:        compiler, which can be configured by the pkgsrc user.
                   9566:        <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
                   9567:        <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
                   9568:        path to a compiler, but the type of compiler that should be
1.76      rillig   9569:        used. See <code class="filename">mk/compiler.mk</code> for more
1.75      rillig   9570:        information about the latter variable.</p></td>
                   9571: </tr>
                   9572: <tr class="question">
                   9573: <td align="left" valign="top">
1.100   ! rillig   9574: <a name="devfaq.bl3flags"></a><a name="id2713589"></a><b>21.4.</b>
1.75      rillig   9575: </td>
                   9576: <td align="left" valign="top"><p>What is the difference between
                   9577:        <code class="varname">BUILDLINK_LDFLAGS</code>,
                   9578:        <code class="varname">BUILDLINK_LDADD</code> and
                   9579:        <code class="varname">BUILDLINK_LIBS</code>?</p></td>
                   9580: </tr>
                   9581: <tr class="answer">
1.91      rillig   9582: <td align="left" valign="top"></td>
1.75      rillig   9583: <td align="left" valign="top"><p>[FIXME]</p></td>
                   9584: </tr>
                   9585: <tr class="question">
                   9586: <td align="left" valign="top">
1.100   ! rillig   9587: <a name="devfaq.bl3prefix"></a><a name="id2713677"></a><b>21.5.</b>
1.75      rillig   9588: </td>
                   9589: <td align="left" valign="top"><p>Why does <span><strong class="command">make show-var
                   9590:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   9591:        say it's empty?</p></td>
                   9592: </tr>
                   9593: <tr class="answer">
1.91      rillig   9594: <td align="left" valign="top"></td>
1.75      rillig   9595: <td align="left" valign="top"><p>For optimization reasons, some variables are only
                   9596:        available in the &#8220;<span class="quote">wrapper</span>&#8221; phase and later. To
                   9597:        &#8220;<span class="quote">simulate</span>&#8221; the wrapper phase, append
                   9598:        <span><strong class="command">PKG_PHASE=wrapper</strong></span> to the above
                   9599:        command.</p></td>
                   9600: </tr>
1.78      rillig   9601: <tr class="question">
                   9602: <td align="left" valign="top">
1.100   ! rillig   9603: <a name="devfaq.master_sites"></a><a name="id2713707"></a><b>21.6.</b>
1.78      rillig   9604: </td>
                   9605: <td align="left" valign="top"><p>What does
                   9606:        <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   9607:        don't understand the <code class="literal">:=</code> inside
                   9608:        it.</p></td>
                   9609: </tr>
                   9610: <tr class="answer">
1.91      rillig   9611: <td align="left" valign="top"></td>
1.78      rillig   9612: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
                   9613:        assignment operator, like you might expect at first sight.
                   9614:        Instead, it is a degenerate form of
                   9615:        <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
                   9616:        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
                   9617:        may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
                   9618:        case of <code class="varname">MASTER_SITE_*</code>,
                   9619:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   9620:        <em class="replaceable"><code>new_string</code></em> is
                   9621:        <code class="literal">package/</code>. That's where the
                   9622:        <code class="literal">:</code> and the <code class="literal">=</code> fall
                   9623:        together.</p></td>
                   9624: </tr>
                   9625: <tr class="question">
                   9626: <td align="left" valign="top">
1.100   ! rillig   9627: <a name="devfaq.mailinglists"></a><a name="id2713784"></a><b>21.7.</b>
1.78      rillig   9628: </td>
                   9629: <td align="left" valign="top"><p>Which mailing lists are there for package
                   9630:        developers?</p></td>
                   9631: </tr>
                   9632: <tr class="answer">
1.91      rillig   9633: <td align="left" valign="top"></td>
1.78      rillig   9634: <td align="left" valign="top"><div class="variablelist"><dl>
                   9635: <dt><span class="term"><a href="http://www.NetBSD.org/MailingLists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
                   9636: <dd><p>This is a list for technical discussions related
                   9637:        to pkgsrc development, e.g. soliciting feedback for changes to
                   9638:        pkgsrc infrastructure, proposed new features, questions related
                   9639:        to porting pkgsrc to a new platform, advice for maintaining a
                   9640:        package, patches that affect many packages, help requests moved
                   9641:        from pkgsrc-users when an infrastructure bug is found,
                   9642:        etc.</p></dd>
                   9643: <dt><span class="term"><a href="http://www.NetBSD.org/MailingLists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
                   9644: <dd><p>All bug reports in category "pkg" sent with
                   9645:        <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
                   9646:        directly; use one of the other mailing
                   9647:        lists.</p></dd>
                   9648: </dl></div></td>
                   9649: </tr>
1.80      rillig   9650: <tr class="question">
                   9651: <td align="left" valign="top">
1.100   ! rillig   9652: <a name="devfaq.documentation"></a><a name="id2713822"></a><b>21.8.</b>
1.80      rillig   9653: </td>
                   9654: <td align="left" valign="top"><p>Where is the pkgsrc
                   9655:        documentation?</p></td>
                   9656: </tr>
                   9657: <tr class="answer">
1.91      rillig   9658: <td align="left" valign="top"></td>
1.80      rillig   9659: <td align="left" valign="top">
                   9660: <p>There are many places where you can find
                   9661:        documentation about pkgsrc:</p>
                   9662: <div class="itemizedlist"><ul type="disc">
                   9663: <li><p>The pkgsrc guide (this document) is a collection
                   9664:        of chapters that explain large parts of pkgsrc, but some
                   9665:        chapters tend to be outdated. Which ones they are is hard to
                   9666:        say.</p></li>
                   9667: <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
                   9668:        about certain features, announcements of new parts of the pkgsrc
                   9669:        infrastructure and sometimes even announcements that a certain
                   9670:        feature has been marked as obsolete. The benefit here is that
                   9671:        each message has a date appended to it.</p></li>
                   9672: <li><p>Many of the files in the
                   9673:        <code class="filename">mk/</code> directory start with a comment that
                   9674:        describes the purpose of the file and how it can be used by the
1.92      rillig   9675:        pkgsrc user and package authors. An easy way to find this
                   9676:        documentation is to run <span><strong class="command">bmake
                   9677:        help</strong></span>.</p></li>
1.80      rillig   9678: <li><p>The CVS log messages are a rich source of
                   9679:        information, but they tend to be highly abbreviated, especially
                   9680:        for actions that occur often. Some contain a detailed
                   9681:        description of what has changed, but they are geared towards the
                   9682:        other pkgsrc developers, not towards an average pkgsrc user.
                   9683:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   9684:        don't know what has been before, these messages may not be worth
                   9685:        too much to you.</p></li>
                   9686: <li><p>Some parts of pkgsrc are only &#8220;<span class="quote">implicitly
                   9687:        documented</span>&#8221;, that is the documentation exists only in the
                   9688:        mind of the developer who wrote the code. To get this
1.93      rillig   9689:        information, use the <span><strong class="command">cvs annotate</strong></span> command
1.80      rillig   9690:        to see who has written it and ask on the
                   9691:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   9692:        find your questions later (see above). To be sure that the
                   9693:        developer in charge reads the mail, you may CC him or
                   9694:        her.</p></li>
                   9695: </ul></div>
                   9696: </td>
                   9697: </tr>
1.92      rillig   9698: <tr class="question">
                   9699: <td align="left" valign="top">
1.100   ! rillig   9700: <a name="devfaq.too-much-time"></a><a name="id2713953"></a><b>21.9.</b>
1.92      rillig   9701: </td>
                   9702: <td align="left" valign="top"><p>I have a little time to kill.  What shall I
                   9703: do?</p></td>
                   9704: </tr>
                   9705: <tr class="answer">
                   9706: <td align="left" valign="top"></td>
                   9707: <td align="left" valign="top">
1.93      rillig   9708: <p>This is not really an FAQ yet, but here's the answer
1.92      rillig   9709: anyway.</p>
                   9710: <div class="itemizedlist"><ul type="disc">
                   9711: <li><p>Run <span><strong class="command">pkg_chk -N</strong></span> (from the
                   9712:     <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
                   9713:     will tell you about newer versions of installed packages that are
                   9714:     available, but not yet updated in pkgsrc.</p></li>
                   9715: <li><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
                   9716:     &mdash; it contains a list of suggested new packages and a list of
                   9717:     cleanups and enhancements for pkgsrc that would be nice to
                   9718:     have.</p></li>
                   9719: <li><p>Review packages for which review was requested on
                   9720:     the <a href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
                   9721:     mailing list.</p></li>
                   9722: </ul></div>
                   9723: </td>
                   9724: </tr>
1.75      rillig   9725: </tbody>
                   9726: </table>
                   9727: </div>
                   9728: </div>
1.85      jmmv     9729: <div class="chapter" lang="en">
                   9730: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   9731: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
1.85      jmmv     9732: <div class="toc">
                   9733: <p><b>Table of Contents</b></p>
                   9734: <dl>
1.90      rillig   9735: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                   9736: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                   9737: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                   9738: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
1.85      jmmv     9739: </dl>
                   9740: </div>
                   9741: <p>Quoting <a href="http://www.gnome.org/" target="_top">GNOME's web
                   9742: site</a>:</p>
                   9743: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   9744:   environment, an intuitive and attractive desktop for users, and the
                   9745:   GNOME development platform, an extensive framework for building
                   9746:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   9747: <p>pkgsrc provides a seamless way to automatically build and install
                   9748: a complete GNOME environment <span class="emphasis"><em>under many different
                   9749: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   9750: the most advanced build and packaging systems for GNOME due to its
                   9751: included technologies buildlink3, the wrappers and tools framework and
                   9752: automatic configuration file management.  Lots of efforts are put into
                   9753: achieving a completely clean deinstallation of installed software
                   9754: components.</p>
                   9755: <p>Given that pkgsrc is <a href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
                   9756: the above also means that great efforts are put into making GNOME work
                   9757: under this operating system.  Recently, <a href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
                   9758: pkgsrc as its preferred packaging system, contributing lots of
                   9759: portability fixes to make GNOME build and install under it.</p>
                   9760: <p>This chapter is aimed at pkgsrc developers and other people
                   9761: interested in helping our GNOME porting and packaging efforts.  It
                   9762: provides instructions on how to manage the existing packages and some
                   9763: important information regarding their internals.</p>
                   9764: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   9765: <h3 class="title">We need your help!</h3>
                   9766: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
                   9767:   and GNOME and are willing to learn new exciting stuff, please jump
                   9768:   straight to the <a href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
                   9769:   work</a> list!  There is still a long way to go to get a
                   9770:   fully-functional GNOME desktop under NetBSD and we need your help to
                   9771:   achieve it!</p>
                   9772: </div>
                   9773: <div class="sect1" lang="en">
                   9774: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9775: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
1.85      jmmv     9776: <p>pkgsrc includes three GNOME-related meta packages:</p>
                   9777: <div class="itemizedlist"><ul type="disc">
1.91      rillig   9778: <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     9779:     the core GNOME desktop environment.  It only includes the necessary
                   9780:     bits to get it to boot correctly, although it may lack important
                   9781:     functionality for daily operation.  The idea behind this package is
                   9782:     to let end users build their own configurations on top of this one,
                   9783:     first installing this meta package to achieve a functional setup and
                   9784:     then adding individual applications.</p></li>
1.91      rillig   9785: <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     9786:     complete installation of the GNOME platform and desktop as defined
                   9787:     by the GNOME project; this is based on the components distributed in
                   9788:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   9789:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   9790:     official FTP server.  Developer-only tools found in those
                   9791:     directories are not installed unless required by some other
                   9792:     component to work properly.  Similarly, packages from the bindings
                   9793:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   9794:     in unless required as a dependency for an end-user component.  This
1.91      rillig   9795:     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>
                   9796: <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     9797:     Installs all the tools required to build a GNOME component when
                   9798:     fetched from the CVS repository.  These are required to let the
                   9799:     <span><strong class="command">autogen.sh</strong></span> scripts work appropriately.</p></li>
                   9800: </ul></div>
                   9801: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   9802: sorted in a way that eases updates: a package may depend on other
                   9803: packages listed before it but not on any listed after it.  It is very
                   9804: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   9805: change it to alphabetical sorting!</em></span></p>
                   9806: </div>
                   9807: <div class="sect1" lang="en">
                   9808: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9809: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
1.85      jmmv     9810: <p>Almost all GNOME applications are written in C and use a common
                   9811: set of tools as their build system.  Things get different with the new
                   9812: bindings to other languages (such as Python), but the following will
                   9813: give you a general idea on the minimum required tools:</p>
                   9814: <div class="itemizedlist"><ul type="disc">
                   9815: <li>
                   9816: <p>Almost all GNOME applications use the GNU Autotools as their
                   9817:     build system.  As a general rule you will need to tell this to your
                   9818:     package:</p>
1.100   ! rillig   9819: <pre class="programlisting">
        !          9820: GNU_CONFIGURE=yes
1.85      jmmv     9821: USE_LIBTOOL=yes
1.100   ! rillig   9822: USE_TOOLS+=gmake
        !          9823: </pre>
1.85      jmmv     9824: </li>
                   9825: <li>
                   9826: <p>If the package uses pkg-config to detect dependencies, add this
                   9827:     tool to the list of required utilities:</p>
                   9828: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.91      rillig   9829: <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     9830:     the end of the build process to ensure that you did not miss to
                   9831:     specify any dependency in your package and that the version
                   9832:     requirements are all correct.</p>
                   9833: </li>
1.93      rillig   9834: <li><p>If the package uses intltool, be sure to add
                   9835:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85      jmmv     9836:     to handle dependencies and to force the package to use the latest
                   9837:     available version.</p></li>
                   9838: <li>
                   9839: <p>If the package uses gtk-doc (a documentation generation
                   9840:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   9841:     tool is rather big and the distfile should come with pregenerated
                   9842:     documentation anyway; if it does not, it is a bug that you ought to
                   9843:     report.  For such packages you should disable gtk-doc (unless it is
1.89      rillig   9844:     the default):</p>
                   9845: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
                   9846: <p>The default location of installed HTML files
                   9847:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   9848:     and should not be changed unless the package insists on installing
                   9849:     them somewhere else.  Otherwise programs as
                   9850:     <span><strong class="command">devhelp</strong></span> will not be able to open them.  You can
                   9851:     do that with an entry similar to:</p>
                   9852: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
1.85      jmmv     9853: </li>
                   9854: </ul></div>
                   9855: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   9856: files under the installation prefix to maintain databases.  In this
                   9857: context, shared means that those exact same directories and files are
                   9858: used among several different packages, leading to conflicts in the
                   9859: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   9860: handle the most common cases, so you have to forget about using
                   9861: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   9862: omitting shared files from them.  If you find yourself doing those,
                   9863: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   9864: <p>The following table lists the common situations that result in
                   9865: using shared directories or files.  For each of them, the appropriate
                   9866: solution is given.  After applying the solution be sure to
                   9867: <span class="emphasis"><em>regenerate the package's file list</em></span> with
                   9868: <span><strong class="command">make print-PLIST</strong></span> and ensure it is correct.</p>
                   9869: <div class="table">
1.90      rillig   9870: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
1.91      rillig   9871: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
1.85      jmmv     9872: <colgroup>
                   9873: <col>
                   9874: <col>
                   9875: </colgroup>
                   9876: <thead><tr>
                   9877: <th>If the package...</th>
                   9878: <th>Then...</th>
                   9879: </tr></thead>
                   9880: <tbody>
                   9881: <tr>
                   9882: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.90      rillig   9883: <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     9884: </tr>
                   9885: <tr>
                   9886: <td>Installs icons under the
                   9887:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   9888:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.90      rillig   9889: <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     9890: </tr>
                   9891: <tr>
                   9892: <td>Installs files under
                   9893:         <code class="filename">share/mime/packages</code>.</td>
1.90      rillig   9894: <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     9895: </tr>
                   9896: <tr>
                   9897: <td>Installs <code class="filename">.desktop</code> files under
                   9898:         <code class="filename">share/applications</code> and these include MIME
                   9899:         information.</td>
1.90      rillig   9900: <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     9901: </tr>
                   9902: </tbody>
1.91      rillig   9903: </table></div>
1.85      jmmv     9904: </div>
1.91      rillig   9905: <br class="table-break">
1.85      jmmv     9906: </div>
                   9907: <div class="sect1" lang="en">
                   9908: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9909: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
1.85      jmmv     9910: <p>When seeing GNOME as a whole, there are two kinds of
                   9911: updates:</p>
                   9912: <div class="variablelist"><dl>
                   9913: <dt><span class="term">Major update</span></dt>
                   9914: <dd>
                   9915: <p>Given that there is still a very long way for GNOME 3 (if it
                   9916:       ever appears), we consider a major update one that goes from a
                   9917:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   9918:       where <code class="literal">Y</code> is even and greater than
                   9919:       <code class="literal">X</code>.  These are hard to achieve because they
                   9920:       introduce lots of changes in the components' code and almost all
                   9921:       GNOME distfiles are updated to newer versions.  Some of them can
                   9922:       even break API and ABI compatibility with the previous major
                   9923:       version series.  As a result, the update needs to be done all at
                   9924:       once to minimize breakage.</p>
                   9925: <p>A major update typically consists of around 80 package
                   9926:       updates and the addition of some new ones.</p>
                   9927: </dd>
                   9928: <dt><span class="term">Minor update</span></dt>
                   9929: <dd>
                   9930: <p>We consider a minor update one that goes from a
                   9931:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   9932:       one where <code class="literal">Y</code> is greater than
                   9933:       <code class="literal">X</code>.  These are easy to achieve because they do
                   9934:       not update all GNOME components, can be done in an incremental way
                   9935:       and do not break API nor ABI compatibility.</p>
                   9936: <p>A minor update typically consists of around 50 package
                   9937:       updates, although the numbers here may vary a lot.</p>
                   9938: </dd>
                   9939: </dl></div>
                   9940: <p>In order to update the GNOME components in pkgsrc to a new stable
                   9941: release (either major or minor), the following steps should be
                   9942: followed:</p>
                   9943: <div class="orderedlist"><ol type="1">
                   9944: <li>
                   9945: <p>Get a list of all the tarballs that form the new release by
                   9946:     using the following commands.  These will leave the full list of the
                   9947:     components's distfiles into the <code class="filename">list.txt</code>
                   9948:     file:</p>
1.88      wiz      9949: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85      jmmv     9950:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   9951:     awk '{ print $9 }' &gt;list.txt</code></strong>
1.88      wiz      9952: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85      jmmv     9953:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   9954:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
                   9955: </li>
                   9956: <li><p>Open each meta package's <code class="filename">Makefile</code> and
                   9957:     bump their version to the release you are updating them to.  The
                   9958:     three meta packages should be always consistent with versioning.
                   9959:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   9960:     in them.</p></li>
                   9961: <li>
                   9962: <p>For each meta package, update all its
                   9963:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   9964:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   9965:     newer version (even if found in the FTP) because the meta packages
                   9966:     are supposed to list the exact versions that form a specific GNOME
                   9967:     release.  Exceptions are permitted here if a newer version solves a
                   9968:     serious issue in the overall desktop experience; these typically
                   9969:     come in the form of a revision bump in pkgsrc, not in newer versions
                   9970:     from the developers.</p>
                   9971: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   9972:     should be updated to the latest version available (if found in
                   9973:     pkgsrc).  This is the case, for example, of the dependencies on the
1.91      rillig   9974:     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     9975: </li>
                   9976: <li>
                   9977: <p>Generate a patch from the modified meta packages and extract the
                   9978:     list of "new" lines.  This will provide you an outline on what
                   9979:     packages need to be updated in pkgsrc and in what order:</p>
1.93      rillig   9980: <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     9981: </li>
                   9982: <li><p>For major desktop updates it is recommended to zap all your
                   9983:     installed packages and start over from scratch at this point.</p></li>
                   9984: <li><p>Now comes the longest step by far: iterate over the contents
                   9985:     of <code class="filename">todo.txt</code> and update the packages listed in
                   9986:     it in order.  For major desktop updates none of these should be
1.93      rillig   9987:     committed until the entire set is completed because there are chances
1.85      jmmv     9988:     of breaking not-yet-updated packages.</p></li>
                   9989: <li><p>Once the packages are up to date and working, commit them to
                   9990:     the tree one by one with appropriate log messages.  At the end,
                   9991:     commit the three meta package updates and all the corresponding
                   9992:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
                   9993:     <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>
                   9994: </ol></div>
                   9995: </div>
                   9996: <div class="sect1" lang="en">
                   9997: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9998: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
1.85      jmmv     9999: <p>GNOME is a very big component in pkgsrc which approaches 100
                   10000: packages.  Please, it is very important that you always, always,
                   10001: <span class="strong"><strong>always</strong></span> feed back any portability
1.93      rillig   10002: 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     10003: their attention on portability issues and to ensure that future versions
                   10004: can be built out-of-the box on NetBSD.  The less custom patches in
                   10005: pkgsrc, the easier further updates are.  Those developers in charge of
                   10006: issuing major GNOME updates will be grateful if you do that.</p>
                   10007: <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
                   10008: Bugzilla</a>.  Not all components use these to track bugs, but most
                   10009: of them do.  Do not be short on your reports: always provide detailed
                   10010: explanations of the current failure, how it can be improved to achieve
                   10011: maximum portability and, if at all possible, provide a patch against CVS
                   10012: head.  The more verbose you are, the higher chances of your patch being
                   10013: accepted.</p>
                   10014: <p>Also, please avoid using preprocessor magic to fix portability
                   10015: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   10016: GNOME to their operating system, the official GNOME sources are now
                   10017: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   10018: and similar macros.  This hurts portability.  Please see our patching
1.93      rillig   10019: 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     10020: details.</p>
                   10021: </div>
                   10022: </div>
1.75      rillig   10023: </div>
                   10024: <div class="part" lang="en">
                   10025: <div class="titlepage"><div><div><h1 class="title">
                   10026: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
                   10027: <div class="partintro" lang="en">
                   10028: <div></div>
                   10029: <p>This part of the guide deals with everything
                   10030:        from the infrastructure that is behind the interfaces described
                   10031:        in the developer's guide. A casual package maintainer should not
                   10032:        need anything from this part.</p>
                   10033: <div class="toc">
                   10034: <p><b>Table of Contents</b></p>
                   10035: <dl>
1.90      rillig   10036: <dt><span class="chapter"><a href="#infr.design">23. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig   10037: <dd><dl>
1.90      rillig   10038: <dt><span class="sect1"><a href="#infr.vardef">23.1. The meaning of variable definitions</a></span></dt>
                   10039: <dt><span class="sect1"><a href="#infr.vardef.problems">23.2. Avoiding problems before they arise</a></span></dt>
                   10040: <dt><span class="sect1"><a href="#infr.var">23.3. Variable evaluation</a></span></dt>
1.75      rillig   10041: <dd><dl>
1.90      rillig   10042: <dt><span class="sect2"><a href="#infr.var.load">23.3.1. At load time</a></span></dt>
                   10043: <dt><span class="sect2"><a href="#infr.var.run">23.3.2. At runtime</a></span></dt>
1.75      rillig   10044: </dl></dd>
1.90      rillig   10045: <dt><span class="sect1"><a href="#infr.varspec">23.4. How can variables be specified?</a></span></dt>
                   10046: <dt><span class="sect1"><a href="#infr.design.intf">23.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10047: <dd><dl>
1.90      rillig   10048: <dt><span class="sect2"><a href="#infr.design.intf.proc">23.5.1. Procedures with parameters</a></span></dt>
                   10049: <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   10050: </dl></dd>
1.90      rillig   10051: <dt><span class="sect1"><a href="#infr.order">23.6. The order in which files are loaded</a></span></dt>
1.81      rillig   10052: <dd><dl>
1.90      rillig   10053: <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>
                   10054: <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   10055: </dl></dd>
                   10056: </dl></dd>
1.90      rillig   10057: <dt><span class="chapter"><a href="#regression">24. Regression tests</a></span></dt>
1.75      rillig   10058: <dd><dl>
1.90      rillig   10059: <dt><span class="sect1"><a href="#regression.descr">24.1. The regression tests framework</a></span></dt>
                   10060: <dt><span class="sect1"><a href="#regression.run">24.2. Running the regression tests</a></span></dt>
                   10061: <dt><span class="sect1"><a href="#regression.new">24.3. Adding a new regression test</a></span></dt>
1.75      rillig   10062: <dd><dl>
1.90      rillig   10063: <dt><span class="sect2"><a href="#regression.fun.override">24.3.1. Overridable functions</a></span></dt>
                   10064: <dt><span class="sect2"><a href="#regression.fun.helper">24.3.2. Helper functions</a></span></dt>
1.75      rillig   10065: </dl></dd>
                   10066: </dl></dd>
1.90      rillig   10067: <dt><span class="chapter"><a href="#porting">25. Porting pkgsrc</a></span></dt>
1.75      rillig   10068: <dd><dl>
1.90      rillig   10069: <dt><span class="sect1"><a href="#porting.opsys">25.1. Porting pkgsrc to a new operating system</a></span></dt>
                   10070: <dt><span class="sect1"><a href="#porting.compiler">25.2. Adding support for a new compiler</a></span></dt>
1.75      rillig   10071: </dl></dd>
                   10072: </dl>
                   10073: </div>
                   10074: </div>
                   10075: <div class="chapter" lang="en">
                   10076: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   10077: <a name="infr.design"></a>Chapter 23. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75      rillig   10078: <div class="toc">
                   10079: <p><b>Table of Contents</b></p>
                   10080: <dl>
1.90      rillig   10081: <dt><span class="sect1"><a href="#infr.vardef">23.1. The meaning of variable definitions</a></span></dt>
                   10082: <dt><span class="sect1"><a href="#infr.vardef.problems">23.2. Avoiding problems before they arise</a></span></dt>
                   10083: <dt><span class="sect1"><a href="#infr.var">23.3. Variable evaluation</a></span></dt>
1.81      rillig   10084: <dd><dl>
1.90      rillig   10085: <dt><span class="sect2"><a href="#infr.var.load">23.3.1. At load time</a></span></dt>
                   10086: <dt><span class="sect2"><a href="#infr.var.run">23.3.2. At runtime</a></span></dt>
1.81      rillig   10087: </dl></dd>
1.90      rillig   10088: <dt><span class="sect1"><a href="#infr.varspec">23.4. How can variables be specified?</a></span></dt>
                   10089: <dt><span class="sect1"><a href="#infr.design.intf">23.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10090: <dd><dl>
1.90      rillig   10091: <dt><span class="sect2"><a href="#infr.design.intf.proc">23.5.1. Procedures with parameters</a></span></dt>
                   10092: <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   10093: </dl></dd>
1.90      rillig   10094: <dt><span class="sect1"><a href="#infr.order">23.6. The order in which files are loaded</a></span></dt>
1.75      rillig   10095: <dd><dl>
1.90      rillig   10096: <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>
                   10097: <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   10098: </dl></dd>
                   10099: </dl>
                   10100: </div>
                   10101: <p>The pkgsrc infrastructure consists of many small Makefile
                   10102:        fragments. Each such fragment needs a properly specified
                   10103:        interface. This chapter explains how such an interface looks
                   10104:        like.</p>
                   10105: <div class="sect1" lang="en">
                   10106: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10107: <a name="infr.vardef"></a>23.1. The meaning of variable definitions</h2></div></div></div>
1.81      rillig   10108: <p>Whenever a variable is defined in the pkgsrc
                   10109:        infrastructure, the location and the way of definition provide
                   10110:        much information about the intended use of that variable.
                   10111:        Additionally, more documentation may be found in a header
                   10112:        comment or in this pkgsrc guide.</p>
                   10113: <p>A special file is
                   10114:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   10115:        variables that are intended to be user-defined. They are either
                   10116:        defined using the <code class="literal">?=</code> operator or they are
                   10117:        left undefined because defining them to anything would
                   10118:        effectively mean &#8220;<span class="quote">yes</span>&#8221;. All these variables may be
                   10119:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   10120:        file.</p>
                   10121: <p>Outside this file, the following conventions apply:
                   10122:        Variables that are defined using the <code class="literal">?=</code>
                   10123:        operator may be overridden by a package.</p>
                   10124: <p>Variables that are defined using the <code class="literal">=</code>
                   10125:        operator may be used read-only at run-time.</p>
                   10126: <p>Variables whose name starts with an underscore must not be
                   10127:        accessed outside the pkgsrc infrastructure at all. They may
                   10128:        change without further notice.</p>
                   10129: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   10130: <h3 class="title">Note</h3>
                   10131: <p>These conventions are currently not applied
                   10132:        consistently to the complete pkgsrc
                   10133:        infrastructure.</p>
                   10134: </div>
                   10135: </div>
                   10136: <div class="sect1" lang="en">
                   10137: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10138: <a name="infr.vardef.problems"></a>23.2. Avoiding problems before they arise</h2></div></div></div>
1.81      rillig   10139: <p>All variables that contain lists of things should default
                   10140:        to being empty. Two examples that do not follow this rule are
                   10141:        <code class="varname">USE_LANGUAGES</code> and
                   10142:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   10143:        modified using the <code class="literal">+=</code> operator in package
                   10144:        <code class="filename">Makefile</code>s (or other files included by
                   10145:        them), since there is no guarantee whether the variable is
                   10146:        already set or not, and what its value is. In the case of
                   10147:        <code class="varname">DISTFILES</code>, the packages &#8220;<span class="quote">know</span>&#8221;
                   10148:        the default value and just define it as in the following
                   10149:        example.</p>
                   10150: <pre class="programlisting">
1.100   ! rillig   10151: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81      rillig   10152: </pre>
                   10153: <p>Because of the selection of this default value, the same
                   10154:        value appears in many package Makefiles. Similarly for
                   10155:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
                   10156:        value (&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;) is so short that it
                   10157:        doesn't stand out. Nevertheless it is mentioned in many
                   10158:        files.</p>
                   10159: </div>
                   10160: <div class="sect1" lang="en">
                   10161: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10162: <a name="infr.var"></a>23.3. Variable evaluation</h2></div></div></div>
1.75      rillig   10163: <div class="sect2" lang="en">
                   10164: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   10165: <a name="infr.var.load"></a>23.3.1. At load time</h3></div></div></div>
1.75      rillig   10166: <p>Variable evaluation takes place either at load time or at
                   10167:        runtime, depending on the context in which they occur. The
                   10168:        contexts where variables are evaluated at load time are:</p>
                   10169: <div class="itemizedlist"><ul type="disc">
                   10170: <li><p>The right hand side of the <code class="literal">:=</code>
                   10171:        and <code class="literal">!=</code> operators,</p></li>
                   10172: <li><p>Make directives like <code class="literal">.if</code> or
                   10173:        <code class="literal">.for</code>,</p></li>
                   10174: <li><p>Dependency lines.</p></li>
                   10175: </ul></div>
                   10176: <p>A special exception are references to the iteration
                   10177:        variables of <code class="literal">.for</code> loops, which are expanded
                   10178:        inline, no matter in which context they appear.</p>
                   10179: <p>As the values of variables may change during load time,
                   10180:        care must be taken not to evaluate them by accident. Typical
                   10181:        examples for variables that should not be evaluated at load time
                   10182:        are <code class="varname">DEPENDS</code> and
                   10183:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   10184:        clear, here is an example:</p>
                   10185: <pre class="programlisting">
1.100   ! rillig   10186: CONFIGURE_ARGS=         # none
        !          10187: CFLAGS=                 -O
        !          10188: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
1.1       grant    10189: 
1.100   ! rillig   10190: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
1.1       grant    10191: 
1.100   ! rillig   10192: CFLAGS+=                -Wall
1.75      rillig   10193:        </pre>
                   10194: <p>This code shows how the use of the <code class="literal">:=</code>
                   10195:        operator can quickly lead to unexpected results. The first
                   10196:        paragraph is fairly common code. The second paragraph evaluates
                   10197:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   10198:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   10199:        <code class="literal">-Wall</code> is appended to the
                   10200:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   10201:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   10202:        paragraphs from above typically occur in completely unrelated
                   10203:        files.</p>
                   10204: </div>
                   10205: <div class="sect2" lang="en">
                   10206: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   10207: <a name="infr.var.run"></a>23.3.2. At runtime</h3></div></div></div>
1.75      rillig   10208: <p>After all the files have been loaded, the values of the
                   10209:        variables cannot be changed anymore. Variables that are used in
                   10210:        the shell commands are expanded at this point.</p>
                   10211: </div>
                   10212: </div>
                   10213: <div class="sect1" lang="en">
                   10214: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10215: <a name="infr.varspec"></a>23.4. How can variables be specified?</h2></div></div></div>
1.78      rillig   10216: <p>There are many ways in which the definition and use of a
                   10217:        variable can be restricted in order to detect bugs and
                   10218:        violations of the (mostly unwritten) policies. See the
                   10219:        <code class="literal">pkglint</code> developer's documentation for further
                   10220:        details.</p>
                   10221: </div>
                   10222: <div class="sect1" lang="en">
                   10223: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10224: <a name="infr.design.intf"></a>23.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76      rillig   10225: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75      rillig   10226:        of the following classes. Cases where a file falls into more
                   10227:        than one class should be avoided as it often leads to subtle
                   10228:        bugs.</p>
                   10229: <div class="sect2" lang="en">
                   10230: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   10231: <a name="infr.design.intf.proc"></a>23.5.1. Procedures with parameters</h3></div></div></div>
1.75      rillig   10232: <p>In a traditional imperative programming language some of
1.76      rillig   10233:        the <code class="filename">.mk</code> files could be described as
1.89      rillig   10234:        procedures. They take some input parameters and&mdash;after
                   10235:        inclusion&mdash;provide a result in output parameters. Since all
1.76      rillig   10236:        variables in <code class="filename">Makefile</code>s have global scope
1.75      rillig   10237:        care must be taken not to use parameter names that have already
                   10238:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   10239:        bad choice for a parameter name.</p>
                   10240: <p>Procedures are completely evaluated at preprocessing time.
                   10241:        That is, when calling a procedure all input parameters must be
                   10242:        completely resolvable. For example,
                   10243:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   10244:        parameter since it is very likely that further text will be
                   10245:        added after calling the procedure, which would effectively apply
                   10246:        the procedure to only a part of the variable. Also, references
                   10247:        to other variables wit will be modified after calling the
                   10248:        procedure.</p>
                   10249: <p>A procedure can declare its output parameters either as
                   10250:        suitable for use in preprocessing directives or as only
                   10251:        available at runtime. The latter alternative is for variables
                   10252:        that contain references to other runtime variables.</p>
                   10253: <p>Procedures shall be written such that it is possible to
                   10254:        call the procedure more than once. That is, the file must not
                   10255:        contain multiple-inclusion guards.</p>
                   10256: <p>Examples for procedures are
1.76      rillig   10257:        <code class="filename">mk/bsd.options.mk</code> and
                   10258:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75      rillig   10259:        that the parameters are evaluated at load time, they should be
                   10260:        assigned using the <code class="literal">:=</code> operator, which should
                   10261:        be used only for this purpose.</p>
                   10262: </div>
                   10263: <div class="sect2" lang="en">
                   10264: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   10265: <a name="infr.design.intf.action"></a>23.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75      rillig   10266: <p>Action files take some input parameters and may define
                   10267:        runtime variables. They shall not define loadtime variables.
                   10268:        There are action files that are included implicitly by the
                   10269:        pkgsrc infrastructure, while other must be included
                   10270:        explicitly.</p>
                   10271: <p>An example for action files is
1.76      rillig   10272:        <code class="filename">mk/subst.mk</code>.</p>
1.75      rillig   10273: </div>
                   10274: </div>
1.81      rillig   10275: <div class="sect1" lang="en">
                   10276: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10277: <a name="infr.order"></a>23.6. The order in which files are loaded</h2></div></div></div>
1.81      rillig   10278: <p>Package <code class="filename">Makefile</code>s usually consist of
                   10279:        a set of variable definitions, and include the file
                   10280:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   10281:        Before that, they may also include various other
                   10282:        <code class="filename">*.mk</code> files if they need to query the
                   10283:        availability of certain features like the type of compiler or
                   10284:        the X11 implementation. Due to the heavy use of preprocessor
                   10285:        directives like <code class="literal">.if</code> and
                   10286:        <code class="literal">.for</code>, the order in which the files are loaded
                   10287:        matters.</p>
                   10288: <p>This section describes at which point the various files
                   10289:        are loaded and gives reasons for that order.</p>
                   10290: <div class="sect2" lang="en">
                   10291: <div class="titlepage"><div><div><h3 class="title">
1.93      rillig   10292: <a name="infr.order.prefs"></a>23.6.1. The order in <code class="filename">bsd.prefs.mk</code>
                   10293: </h3></div></div></div>
                   10294: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81      rillig   10295:        is to define some essential variables like
                   10296:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   10297:        <code class="varname">MACHINE_ARCH</code>.</p>
                   10298: <p>Then, the user settings are loaded from the file specified
                   10299:        in <code class="varname">MAKECONF</code>. If the bmake command from pkgsrc
                   10300:        is used, <code class="varname">MAKECONF</code> defaults to
                   10301:        <code class="filename"><em class="replaceable"><code>${prefix}</code></em>/etc/mk.conf</code>.
                   10302:        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
                   10303:        <code class="filename">/etc/mk.conf</code>. After that, those variables
                   10304:        that have not been overridden by the user are loaded from
                   10305:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   10306: <p>After the user settings, the system settings and platform
                   10307:        settings are loaded, which may override the user
                   10308:        settings.</p>
                   10309: <p>Then, the tool definitions are loaded. The tool wrappers
                   10310:        are not yet in effect. This only happens when building a
                   10311:        package, so the proper variables must be used instead of the
                   10312:        direct tool names.</p>
                   10313: <p>As the last steps, some essential variables from the
                   10314:        wrapper and the package system flavor are loaded, as well as the
                   10315:        variables that have been cached in earlier phases of a package
                   10316:        build.</p>
                   10317: </div>
                   10318: <div class="sect2" lang="en">
                   10319: <div class="titlepage"><div><div><h3 class="title">
1.93      rillig   10320: <a name="infr.order.pkg"></a>23.6.2. The order in <code class="filename">bsd.pkg.mk</code>
                   10321: </h3></div></div></div>
1.81      rillig   10322: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   10323: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   10324:        loaded, which fill default values for those variables that have
1.93      rillig   10325:        not been defined by the package. These variables may later
1.81      rillig   10326:        be used even in unrelated files.</p>
                   10327: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   10328:        provides the target <code class="literal">error-check</code> that is added
                   10329:        as a special dependency to all other targets that use
                   10330:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   10331:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   10332: <p>Then, the package-specific hacks from
                   10333:        <code class="filename">hacks.mk</code> are included.</p>
                   10334: <p>Then, various other files follow. Most of them don't have
                   10335:        any dependencies on what they need to have included before or
                   10336:        after them, though some do.</p>
                   10337: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   10338:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   10339:        restricts the use of these variables to all the files that have
                   10340:        been included before. Appearances in later files will be
                   10341:        silently ignored.</p>
                   10342: <p>Then, the files for the main targets are included, in the
                   10343:        order of later execution, though the actual order should not
                   10344:        matter.</p>
                   10345: <p>At last, some more files are included that don't set any
                   10346:        interesting variables but rather just define make targets to be
                   10347:        executed.</p>
                   10348: </div>
                   10349: </div>
1.75      rillig   10350: </div>
                   10351: <div class="chapter" lang="en">
                   10352: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   10353: <a name="regression"></a>Chapter 24. Regression tests</h2></div></div></div>
1.75      rillig   10354: <div class="toc">
                   10355: <p><b>Table of Contents</b></p>
                   10356: <dl>
1.90      rillig   10357: <dt><span class="sect1"><a href="#regression.descr">24.1. The regression tests framework</a></span></dt>
                   10358: <dt><span class="sect1"><a href="#regression.run">24.2. Running the regression tests</a></span></dt>
                   10359: <dt><span class="sect1"><a href="#regression.new">24.3. Adding a new regression test</a></span></dt>
1.75      rillig   10360: <dd><dl>
1.90      rillig   10361: <dt><span class="sect2"><a href="#regression.fun.override">24.3.1. Overridable functions</a></span></dt>
                   10362: <dt><span class="sect2"><a href="#regression.fun.helper">24.3.2. Helper functions</a></span></dt>
1.75      rillig   10363: </dl></dd>
                   10364: </dl>
                   10365: </div>
                   10366: <p>The pkgsrc infrastructure consists of a large codebase,
                   10367:        and there are many corners where every little bit of a file is
                   10368:        well thought out, making pkgsrc likely to fail as soon as
                   10369:        anything is changed near those parts. To prevent most changes
                   10370:        from breaking anything, a suite of regression tests should go
                   10371:        along with every important part of the pkgsrc infrastructure.
                   10372:        This chapter describes how regression tests work in pkgsrc and
                   10373:        how you can add new tests.</p>
                   10374: <div class="sect1" lang="en">
                   10375: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10376: <a name="regression.descr"></a>24.1. The regression tests framework</h2></div></div></div>
1.75      rillig   10377: <p></p>
                   10378: </div>
                   10379: <div class="sect1" lang="en">
                   10380: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10381: <a name="regression.run"></a>24.2. Running the regression tests</h2></div></div></div>
1.91      rillig   10382: <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   10383:        provides the <span><strong class="command">pkg_regress</strong></span> command. Then you
                   10384:        can simply run that command, which will run all tests in the
1.76      rillig   10385:        <code class="filename">regress</code> category.</p>
1.75      rillig   10386: </div>
                   10387: <div class="sect1" lang="en">
                   10388: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10389: <a name="regression.new"></a>24.3. Adding a new regression test</h2></div></div></div>
1.76      rillig   10390: <p>Every directory in the <code class="filename">regress</code>
                   10391:        category that contains a file called <code class="filename">spec</code>
1.75      rillig   10392:        is considered a regression test. This file is a shell program
                   10393:        that is included by the <span><strong class="command">pkg_regress</strong></span> command.
                   10394:        The following functions can be overridden to suit your
                   10395:        needs.</p>
                   10396: <div class="sect2" lang="en">
                   10397: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   10398: <a name="regression.fun.override"></a>24.3.1. Overridable functions</h3></div></div></div>
1.75      rillig   10399: <p>These functions do not take any parameters. They are all
                   10400:        called in &#8220;<span class="quote">set -e</span>&#8221; mode, so you should be careful
                   10401:        to check the exitcodes of any commands you run in the
                   10402:        test.</p>
                   10403: <div class="variablelist"><dl>
                   10404: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
                   10405: <dd><p>This function prepares the environment for the
                   10406:        test. By default it does nothing.</p></dd>
                   10407: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
                   10408: <dd><p>This function runs the actual test. By default,
                   10409:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   10410:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   10411:        error messages into the file
                   10412:        <code class="varname">TEST_OUTFILE</code>.</p></dd>
                   10413: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
                   10414: <dd><p>This function is run after the test and is
                   10415:        typically used to compare the actual output from the one that is
                   10416:        expected. It can make use of the various helper functions from
                   10417:        the next section.</p></dd>
                   10418: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
                   10419: <dd><p>This function cleans everything up after the
                   10420:        test has been run. By default it does nothing.</p></dd>
                   10421: </dl></div>
                   10422: </div>
                   10423: <div class="sect2" lang="en">
                   10424: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   10425: <a name="regression.fun.helper"></a>24.3.2. Helper functions</h3></div></div></div>
1.75      rillig   10426: <div class="variablelist"><dl>
                   10427: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
                   10428: <dd><p>This function compares the exitcode of the
                   10429:        <span><strong class="command">do_test()</strong></span> function with its first parameter.
                   10430:        If they differ, the test will fail.</p></dd>
                   10431: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
                   10432: <dd><p>This function checks for each of its parameters
                   10433:        if the output from <span><strong class="command">do_test()</strong></span> matches the
                   10434:        extended regular expression. If it does not, the test will
                   10435:        fail.</p></dd>
                   10436: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
                   10437: <dd><p>This function checks for each of its parameters
                   10438:        if the output from <span><strong class="command">do_test()</strong></span> does
                   10439:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   10440:        If any of the regular expressions matches, the test will
                   10441:        fail.</p></dd>
                   10442: </dl></div>
                   10443: </div>
                   10444: </div>
                   10445: </div>
                   10446: <div class="chapter" lang="en">
                   10447: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   10448: <a name="porting"></a>Chapter 25. Porting pkgsrc</h2></div></div></div>
1.75      rillig   10449: <div class="toc">
                   10450: <p><b>Table of Contents</b></p>
                   10451: <dl>
1.90      rillig   10452: <dt><span class="sect1"><a href="#porting.opsys">25.1. Porting pkgsrc to a new operating system</a></span></dt>
                   10453: <dt><span class="sect1"><a href="#porting.compiler">25.2. Adding support for a new compiler</a></span></dt>
1.75      rillig   10454: </dl>
                   10455: </div>
                   10456: <p>The pkgsrc system has already been ported to many
                   10457:        operating systems, hardware architectures and compilers. This
                   10458:        chapter explains the necessary steps to make pkgsrc even more
                   10459:        portable.</p>
                   10460: <div class="sect1" lang="en">
                   10461: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10462: <a name="porting.opsys"></a>25.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75      rillig   10463: <p>To port pkgsrc to a new operating system (called
                   10464:        <code class="literal">MyOS</code> in this example), you need to touch the
                   10465:        following files:</p>
                   10466: <div class="variablelist"><dl>
1.93      rillig   10467: <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   10468: <dd><p>This file contains some basic definitions, for
                   10469:        example the name of the C
                   10470:        compiler.</p></dd>
1.76      rillig   10471: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75      rillig   10472: <dd><p>Insert code that defines the variables
                   10473:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
                   10474:        <code class="varname">LOWER_OS_VERSION</code>,
                   10475:        <code class="varname">LOWER_VENDOR</code>,
                   10476:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   10477:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   10478:        appear in this file.</p></dd>
1.93      rillig   10479: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10480: <dd><p>This file contains the platform-specific
                   10481:        definitions that are used by pkgsrc. Start by copying one of the
                   10482:        other files and edit it to your
                   10483:        needs.</p></dd>
1.93      rillig   10484: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
1.75      rillig   10485: <dd><p>This file contains a list of directories,
                   10486:        together with their permission bits and ownership. These
                   10487:        directories will be created automatically with every package
1.98      wiz      10488:        that explicitly sets <code class="varname">USE_MTREE</code>. This feature will
                   10489:        be removed.</p></dd>
1.93      rillig   10490: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
1.75      rillig   10491: <dd><p>Just copy one of the pre-existing x11.dist files
                   10492:        to your
1.76      rillig   10493:        <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
                   10494: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
1.75      rillig   10495: <dd><p>On some operating systems, the tools that are
                   10496:        provided with the base system are not good enough for pkgsrc.
                   10497:        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
                   10498:        narrow limit on the line length they can process. Therefore
                   10499:        pkgsrc brings its own tools, which can be enabled
                   10500:        here.</p></dd>
1.93      rillig   10501: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10502: <dd><p>This file defines the paths to all the tools
                   10503:        that are needed by one or the other package in pkgsrc, as well
                   10504:        as by pkgsrc itself. Find out where these tools are on your
                   10505:        platform and add them.</p></dd>
                   10506: </dl></div>
                   10507: <p>Now, you should be able to build some basic packages, like
1.91      rillig   10508:        <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   10509: </div>
                   10510: <div class="sect1" lang="en">
                   10511: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10512: <a name="porting.compiler"></a>25.2. Adding support for a new compiler</h2></div></div></div>
1.75      rillig   10513: <p>TODO</p>
                   10514: </div>
                   10515: </div>
                   10516: </div>
                   10517: <div class="appendix" lang="en">
                   10518: <div class="titlepage"><div><div><h2 class="title">
                   10519: <a name="examples"></a>Appendix A. A simple example package: bison</h2></div></div></div>
                   10520: <div class="toc">
                   10521: <p><b>Table of Contents</b></p>
                   10522: <dl>
                   10523: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   10524: <dd><dl>
                   10525: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   10526: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   10527: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
                   10528: <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>
                   10529: </dl></dd>
                   10530: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   10531: </dl>
                   10532: </div>
                   10533: <p>We checked to find a piece of software that wasn't in the packages
                   10534:     collection, and picked GNU bison. Quite why someone would want to have
                   10535:     <span><strong class="command">bison</strong></span> when Berkeley <span><strong class="command">yacc</strong></span> is already
                   10536:     present in the tree is beyond us, but it's useful for the purposes of
                   10537:     this exercise.</p>
                   10538: <div class="sect1" lang="en">
                   10539: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10540: <a name="example-files"></a>A.1. files</h2></div></div></div>
                   10541: <div class="sect2" lang="en">
                   10542: <div class="titlepage"><div><div><h3 class="title">
                   10543: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
                   10544: <pre class="programlisting">
1.100   ! rillig   10545: # $NetBSD$
        !          10546: #
1.1       grant    10547: 
1.100   ! rillig   10548: DISTNAME=       bison-1.25
        !          10549: CATEGORIES=     devel
        !          10550: MASTER_SITES=   ${MASTER_SITE_GNU}
1.1       grant    10551: 
1.100   ! rillig   10552: MAINTAINER=     thorpej@NetBSD.org
        !          10553: HOMEPAGE=       http://www.gnu.org/software/bison/bison.html
        !          10554: COMMENT=        GNU yacc clone
1.1       grant    10555: 
1.100   ! rillig   10556: GNU_CONFIGURE=  yes
        !          10557: INFO_FILES=     bison.info
1.1       grant    10558: 
1.100   ! rillig   10559: .include "../../mk/bsd.pkg.mk"
1.1       grant    10560: </pre>
1.75      rillig   10561: </div>
                   10562: <div class="sect2" lang="en">
                   10563: <div class="titlepage"><div><div><h3 class="title">
                   10564: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
                   10565: <pre class="programlisting">
1.100   ! rillig   10566: GNU version of yacc.  Can make re-entrant parsers, and numerous other
        !          10567: 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
        !          10568: of the NetBSD source tree is beyond me.
1.1       grant    10569: </pre>
1.75      rillig   10570: </div>
                   10571: <div class="sect2" lang="en">
                   10572: <div class="titlepage"><div><div><h3 class="title">
                   10573: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
                   10574: <pre class="programlisting">
1.100   ! rillig   10575: @comment $NetBSD$
        !          10576: bin/bison
        !          10577: man/man1/bison.1.gz
        !          10578: share/bison.simple
        !          10579: share/bison.hairy
1.1       grant    10580: </pre>
1.75      rillig   10581: </div>
                   10582: <div class="sect2" lang="en">
                   10583: <div class="titlepage"><div><div><h3 class="title">
1.93      rillig   10584: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span><strong class="command">pkglint</strong></span>
                   10585: </h3></div></div></div>
1.75      rillig   10586: <p>The NetBSD package system comes with
1.91      rillig   10587:         <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   10588:        which helps to check the contents of these
                   10589:        files. After installation it is quite easy to use, just change to the
                   10590:        directory of the package you wish to examine and execute
                   10591:        <span><strong class="command">pkglint</strong></span>:</p>
                   10592: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
                   10593: looks fine.</pre>
                   10594: <p>Depending on the supplied command line arguments (see pkglint(1)),
                   10595:        more checks will be performed. Use e.g. <span><strong class="command">pkglint -Call
                   10596:        -Wall</strong></span> for a very thorough check.</p>
                   10597: </div>
                   10598: </div>
                   10599: <div class="sect1" lang="en">
                   10600: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10601: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
                   10602: <p>Create the directory where the package lives,
                   10603:       plus any auxiliary directories:</p>
                   10604: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   10605: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   10606: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   10607: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76      rillig   10608: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.90      rillig   10609:       <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   10610:       then continue with fetching the distfile:</p>
                   10611: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1       grant    10612: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   10613: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   10614: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10615: ftp: Error retrieving file: 500 Internal error
                   10616: 
                   10617: &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   10618: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10619: ftp: Error retrieving file: 500 Internal error
                   10620: 
                   10621: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   10622: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75      rillig   10623: Successfully retrieved file.</pre>
                   10624: <p>Generate the checksum of the distfile into
1.76      rillig   10625:       <code class="filename">distinfo</code>:</p>
1.88      wiz      10626: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75      rillig   10627: <p>Now compile:</p>
                   10628: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10629: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10630: ===&gt;  Extracting for bison-1.25
                   10631: ===&gt;  Patching for bison-1.25
                   10632: ===&gt;   Ignoring empty patch directory
                   10633: ===&gt;  Configuring for bison-1.25
                   10634: creating cache ./config.cache
                   10635: checking for gcc... cc
                   10636: checking whether we are using GNU C... yes
                   10637: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   10638: checking how to run the C preprocessor... cc -E
                   10639: checking for minix/config.h... no
                   10640: checking for POSIXized ISC... no
                   10641: checking whether cross-compiling... no
                   10642: checking for ANSI C header files... yes
                   10643: checking for string.h... yes
                   10644: checking for stdlib.h... yes
                   10645: checking for memory.h... yes
                   10646: checking for working const... yes
                   10647: checking for working alloca.h... no
                   10648: checking for alloca... yes
                   10649: checking for strerror... yes
                   10650: updating cache ./config.cache
                   10651: creating ./config.status
                   10652: creating Makefile
                   10653: ===&gt;  Building for bison-1.25
                   10654: 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
                   10655: 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
                   10656: 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
                   10657: 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
                   10658: 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   10659: 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    10660: 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
                   10661: 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
                   10662: 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
                   10663: 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
                   10664: 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
                   10665: 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
                   10666: 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
                   10667: 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
                   10668: 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
                   10669: 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
                   10670: 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
                   10671: 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
                   10672: 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
                   10673: 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
                   10674: 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
                   10675: 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
                   10676: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   10677: rm -f bison.s1
1.75      rillig   10678: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   10679: <p>Everything seems OK, so install the files:</p>
                   10680: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10681: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10682: ===&gt;  Installing for bison-1.25
                   10683: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   10684: rm -f /usr/pkg/bin/bison
                   10685: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   10686: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   10687: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   10688: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   10689: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   10690: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   10691: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75      rillig   10692: ===&gt;  Registering installation for bison-1.25</pre>
                   10693: <p>You can now use bison, and also - if you decide so - remove it with
                   10694:       <span><strong class="command">pkg_delete bison</strong></span>. Should you decide that you want a
                   10695:       binary package, do this now:</p>
                   10696: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10697: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10698: ===&gt;  Building package for bison-1.25
                   10699: Creating package bison-1.25.tgz
                   10700: Registering depends:.
1.75      rillig   10701: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   10702: <p>Now that you don't need the source and object files
                   10703:       any more, clean up:</p>
                   10704: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   10705: ===&gt;  Cleaning for bison-1.25</pre>
                   10706: </div>
                   10707: </div>
                   10708: <div class="appendix" lang="en">
                   10709: <div class="titlepage"><div><div><h2 class="title">
                   10710: <a name="logs"></a>Appendix B. Build logs</h2></div></div></div>
                   10711: <div class="toc">
                   10712: <p><b>Table of Contents</b></p>
                   10713: <dl>
                   10714: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                   10715: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                   10716: </dl>
                   10717: </div>
                   10718: <div class="sect1" lang="en">
                   10719: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10720: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
                   10721: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10722: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10723: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   10724: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   10725: =&gt; [172219 bytes]
                   10726: Connected to ftp.plig.net.
                   10727: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   10728: 331 Guest login ok, send your complete e-mail address as password.
                   10729: 230-You are user #5 of 500 simultaneous users allowed.
                   10730: 230-
1.68      rillig   10731: 230-  ___ _             _ _
                   10732: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
1.1       grant    10733: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   10734: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   10735: 230-         |_|   |_|     |___|         |___|
                   10736: 230-
                   10737: 230-** Welcome to ftp.plig.org **
                   10738: 230-
                   10739: 230-Please note that all transfers from this FTP site are logged. If you
                   10740: 230-do not like this, please disconnect now.
                   10741: 230-
                   10742: 230-This arhive is available via
                   10743: 230-
                   10744: 230-HTTP:  http://ftp.plig.org/
                   10745: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   10746: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   10747: 230-
                   10748: 230-Please email comments, bug reports and requests for packages to be
1.68      rillig   10749: 230-mirrored to ftp-admin@plig.org.
1.1       grant    10750: 230-
                   10751: 230-
                   10752: 230 Logged in anonymously.
                   10753: Remote system type is UNIX.
                   10754: Using binary mode to transfer files.
                   10755: 200 Type okay.
                   10756: 250 "/pub" is new cwd.
                   10757: 250-"/pub/figlet" is new cwd.
                   10758: 250-
                   10759: 250-Welcome to the figlet archive at ftp.figlet.org
1.68      rillig   10760: 250-
1.75      rillig   10761: 250-   ftp://ftp.figlet.org/pub/figlet/
1.1       grant    10762: 250-
                   10763: 250-The official FIGlet web page is:
1.75      rillig   10764: 250-   http://www.figlet.org/
1.1       grant    10765: 250-
                   10766: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   10767: 250-contribute a font or something else, you can email us.
1.68      rillig   10768: 250
1.1       grant    10769: 250 "/pub/figlet/program" is new cwd.
                   10770: 250 "/pub/figlet/program/unix" is new cwd.
                   10771: local: figlet221.tar.gz remote: figlet221.tar.gz
                   10772: 502 Unimplemented command.
                   10773: 227 Entering Passive Mode (195,40,6,41,246,104)
                   10774: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   10775: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   10776: 226 Transfer completed.
                   10777: 172219 bytes received in 00:02 (75.99 KB/s)
                   10778: 221 Goodbye.
                   10779: =&gt; Checksum OK for figlet221.tar.gz.
                   10780: ===&gt; Extracting for figlet-2.2.1nb2
                   10781: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   10782: ===&gt; Patching for figlet-2.2.1nb2
                   10783: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   10784: ===&gt; Overriding tools for figlet-2.2.1nb2
                   10785: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   10786: ===&gt; Configuring for figlet-2.2.1nb2
                   10787: ===&gt; Building for figlet-2.2.1nb2
                   10788: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   10789: chmod a+x figlet
                   10790: gcc -O2 -o chkfont chkfont.c
                   10791: =&gt; Unwrapping files-to-be-installed.
1.14      xtraeme  10792: <code class="prompt">#</code>
1.75      rillig   10793: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10794: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10795: ===&gt; Installing for figlet-2.2.1nb2
                   10796: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   10797: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   10798: mkdir -p /usr/pkg/share/figlet
                   10799: cp figlet /usr/pkg/bin
                   10800: cp chkfont /usr/pkg/bin
                   10801: chmod 555 figlist showfigfonts
                   10802: cp figlist /usr/pkg/bin
                   10803: cp showfigfonts /usr/pkg/bin
                   10804: cp fonts/*.flf /usr/pkg/share/figlet
                   10805: cp fonts/*.flc /usr/pkg/share/figlet
                   10806: cp figlet.6 /usr/pkg/man/man6
                   10807: ===&gt; Registering installation for figlet-2.2.1nb2
1.75      rillig   10808: <code class="prompt">#</code></pre>
                   10809: </div>
                   10810: <div class="sect1" lang="en">
                   10811: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10812: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
                   10813: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10814: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10815: ===&gt; Packaging figlet-2.2.1nb2
                   10816: ===&gt; Building binary package for figlet-2.2.1nb2
                   10817: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   10818: Using SrcDir value of /usr/pkg
1.68      rillig   10819: Registering depends:.
1.75      rillig   10820: <code class="prompt">#</code></pre>
                   10821: </div>
                   10822: </div>
                   10823: <div class="appendix" lang="en">
                   10824: <div class="titlepage"><div><div><h2 class="title">
1.76      rillig   10825: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h2></div></div></div>
                   10826: <div class="toc">
                   10827: <p><b>Table of Contents</b></p>
                   10828: <dl>
                   10829: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</a></span></dt>
                   10830: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                   10831: <dt><span class="sect1"><a href="#ftp-iso">C.3. <code class="filename">iso</code>: Currently empty</a></span></dt>
                   10832: <dt><span class="sect1"><a href="#ftp-misc">C.4. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                   10833: <dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages*</code>: Binary packages</a></span></dt>
                   10834: <dt><span class="sect1"><a href="#ftp-source">C.6. <code class="filename">current</code>,
1.93      rillig   10835: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   10836: source packages</a></span></dt>
                   10837: </dl>
                   10838: </div>
                   10839: <p>As in other big projects, the directory layout of pkgsrc
                   10840:        is quite complex for newbies. This chapter explains where you
                   10841:        find things on the FTP server. The base directory on
1.89      rillig   10842:        <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>.
                   10843:        On other servers it may be different, but inside this directory,
                   10844:        everything should look the same, no matter on which server you
                   10845:        are. This directory contains some subdirectories, which are
                   10846:        explained below.</p>
1.76      rillig   10847: <div class="sect1" lang="en">
                   10848: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10849: <a name="ftp-bootstrap"></a>C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</h2></div></div></div>
                   10850: <p>For those who only want to manage binary packages on
                   10851:        systems other than NetBSD, we provide the package management
                   10852:        tools in a separate, small tar file.</p>
                   10853: </div>
                   10854: <div class="sect1" lang="en">
                   10855: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10856: <a name="ftp-distfiles"></a>C.2. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
                   10857: <p>The directory <code class="filename">distfiles</code> contains lots
                   10858:        of archive files from all pkgsrc packages, which are mirrored
                   10859:        here. The subdirectories are called after their package names
                   10860:        and are used when the distributed files have names that don't
                   10861:        explicitly contain a version number or are otherwise too generic
                   10862:        (for example <code class="filename">release.tar.gz</code>).</p>
                   10863: </div>
                   10864: <div class="sect1" lang="en">
                   10865: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10866: <a name="ftp-iso"></a>C.3. <code class="filename">iso</code>: Currently empty</h2></div></div></div>
                   10867: <p>This directory is currently not in use.</p>
                   10868: </div>
                   10869: <div class="sect1" lang="en">
                   10870: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10871: <a name="ftp-misc"></a>C.4. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
                   10872: <p>This directory contains things that individual pkgsrc
                   10873:        developers find worth publishing.</p>
                   10874: </div>
                   10875: <div class="sect1" lang="en">
                   10876: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10877: <a name="ftp-packages"></a>C.5. <code class="filename">packages*</code>: Binary packages</h2></div></div></div>
                   10878: <p>These directories contain binary packages. Those
                   10879:        directories that have a branch name
                   10880:        (200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em>)
                   10881:        contain packages from that particular branch. The directory
                   10882:        <code class="filename">packages</code> contains binary packages from
                   10883:        pkgsrc-current. (However, this does not necessarily mean that
                   10884:        the packages are still current anymore.)</p>
                   10885: <p>Below the <code class="filename">packages*</code> directories are
                   10886:        directories that distinguish the packages by operating system
                   10887:        and version, the next directory level specifies the hardware
                   10888:        architecture.</p>
                   10889: <p>In each of the platform-specific directories, there is a
                   10890:        whole binary packages collection. It has a directory called
                   10891:        <code class="filename">All</code> which contains all binary packages.
                   10892:        Besides that, there are various category directories that
                   10893:        contain symbolic links to the real binary packages.</p>
                   10894: </div>
                   10895: <div class="sect1" lang="en">
                   10896: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10897: <a name="ftp-source"></a>C.6. <code class="filename">current</code>,
1.93      rillig   10898: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   10899: source packages</h2></div></div></div>
                   10900: <p>These directories contain the &#8220;<span class="quote">real</span>&#8221; pkgsrc,
                   10901:        that is the files that define how to create binary packages from
                   10902:        source archives.</p>
                   10903: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89      rillig   10904:        snapshot of the CVS repository, which is updated regularly. The
                   10905:        file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
                   10906:        directory, ready to be downloaded as a whole.</p>
1.76      rillig   10907: <p>In the directories for the quarterly branches, there is an
                   10908:        additional file called
                   10909:        <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
                   10910:        which contains the state of pkgsrc when it was branched.</p>
                   10911: </div>
1.75      rillig   10912: </div>
                   10913: <div class="appendix" lang="en">
                   10914: <div class="titlepage"><div><div><h2 class="title">
                   10915: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h2></div></div></div>
                   10916: <div class="toc">
                   10917: <p><b>Table of Contents</b></p>
                   10918: <dl>
1.79      rillig   10919: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75      rillig   10920: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                   10921: </dl>
                   10922: </div>
1.79      rillig   10923: <p>This section contains information on editing the pkgsrc
                   10924:        guide itself.</p>
1.75      rillig   10925: <div class="sect1" lang="en">
                   10926: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79      rillig   10927: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
                   10928: <p>The pkgsrc guide's source code is stored in
                   10929:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   10930:        are created from it:</p>
                   10931: <div class="itemizedlist"><ul type="disc">
                   10932: <li><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   10933: <li><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
                   10934: <li><p><a href="http://www.NetBSD.org/Documentation/pkgsrc/" target="_top">http://www.NetBSD.org/Documentation/pkgsrc/</a></p></li>
                   10935: <li><p><a href="http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.pdf" target="_top">http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.pdf</a>:
                   10936:        The PDF version of the pkgsrc guide.</p></li>
                   10937: <li><p><a href="http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.ps" target="_top">http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.ps</a>:
                   10938:        PostScript version of the pkgsrc guide.</p></li>
1.75      rillig   10939: </ul></div>
                   10940: </div>
                   10941: <div class="sect1" lang="en">
                   10942: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10943: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79      rillig   10944: <p>The procedure to edit the pkgsrc guide is:</p>
                   10945: <div class="procedure"><ol type="1">
                   10946: <li><p>Make sure you have the packages needed to
1.83      wiz      10947:        regenerate the pkgsrc guide (and other XML-based NetBSD
1.91      rillig   10948:        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
                   10949:        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   10950:        PostScript and PDF versions. You will need both packages
                   10951:        installed, to make sure documentation is consistent across all
                   10952:        formats.</p></li>
                   10953: <li><p>Run <span><strong class="command">cd doc/guide</strong></span> to get to the
                   10954:        right directory. All further steps will take place
                   10955:        here.</p></li>
                   10956: <li><p>Edit the XML file(s) in
                   10957:        <code class="filename">files/</code>.</p></li>
                   10958: <li><p>Run <span><strong class="command">bmake</strong></span> to check the pkgsrc
                   10959:        guide for valid XML and to build the final output files. If you
                   10960:        get any errors at this stage, you can just edit the files, as
                   10961:        there are only symbolic links in the working directory, pointing
                   10962:        to the files in <code class="filename">files/</code>.</p></li>
                   10963: <li><p><span><strong class="command">(cd files &amp;&amp; cvs
                   10964:        commit)</strong></span></p></li>
                   10965: <li><p>Run <span><strong class="command">bmake clean &amp;&amp; bmake</strong></span> to
                   10966:        regenerate the output files with the proper RCS
                   10967:        Ids.</p></li>
1.91      rillig   10968: <li>
                   10969: <p>Run <span><strong class="command">bmake regen</strong></span> to install and
                   10970:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                   10971:        <code class="filename">htdocs</code>.</p>
                   10972: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   10973: <h3 class="title">Note</h3>
                   10974: <p>If you have added, removed or renamed some chapters,
1.83      wiz      10975:        you need to synchronize them using <span><strong class="command">cvs add</strong></span> or
                   10976:        <span><strong class="command">cvs delete</strong></span> in the htdocs
1.91      rillig   10977:        directory.</p>
                   10978: </div>
                   10979: </li>
1.79      rillig   10980: </ol></div>
1.75      rillig   10981: </div>
                   10982: </div>
                   10983: </div></body>
1.1       grant    10984: </html>

CVSweb <webmaster@jp.NetBSD.org>