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

1.75      rillig      1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
                      2: <html>
1.1       grant       3: <head>
1.75      rillig      4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
                      5: <title>The pkgsrc guide</title>
1.132     spz         6: <link rel="stylesheet" type="text/css" href="/global.css">
1.75      rillig      7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
1.91      rillig      8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
1.75      rillig      9: </head>
1.148     asau       10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book">
1.75      rillig     11: <div class="titlepage">
                     12: <div>
                     13: <div><h1 class="title">
                     14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
                     15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
                     16: <div><div class="authorgroup">
                     17: <div class="author">
                     18: <h3 class="author">
                     19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
                     20: </h3>
1.110     hubertf    21: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a class="email" href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>&gt;</code></p></div></div>
1.75      rillig     22: </div>
                     23: <div class="author">
                     24: <h3 class="author">
                     25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
                     26: </h3>
1.110     hubertf    27: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a class="email" href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>&gt;</code></p></div></div>
1.75      rillig     28: </div>
                     29: <h3 class="corpauthor">
                     30:         The pkgsrc Developers
                     31:       </h3>
                     32: </div></div>
1.259     jnemeth    33: <div><p class="copyright">Copyright © 1994-2019 The NetBSD Foundation, Inc</p></div>
1.268     sevan      34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.35 2019/04/28 15:22:24 rillig Exp $</p></div>
1.148     asau       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>
1.210     leot       48: <dl class="toc">
1.75      rillig     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>
1.267     rillig     63: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
                     64: <dt><span class="chapter"><a href="#getting">3. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
1.75      rillig     65: <dd><dl>
1.267     rillig     66: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75      rillig     67: <dd><dl>
1.267     rillig     68: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
                     69: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig     70: </dl></dd>
1.267     rillig     71: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75      rillig     72: <dd><dl>
1.267     rillig     73: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
                     74: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75      rillig     75: </dl></dd>
                     76: </dl></dd>
1.267     rillig     77: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.75      rillig     78: <dd><dl>
1.267     rillig     79: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
                     80: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75      rillig     81: </dl></dd>
1.267     rillig     82: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.75      rillig     83: <dd><dl>
1.267     rillig     84: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75      rillig     85: <dd><dl>
1.267     rillig     86: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
                     87: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
                     88: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.3. Deinstalling packages</a></span></dt>
                     89: <dt><span class="sect2"><a href="#using.pkg_info">5.1.4. Getting information about installed packages</a></span></dt>
                     90: <dt><span class="sect2"><a href="#vulnerabilities">5.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                     91: <dt><span class="sect2"><a href="#pkg_versions">5.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                     92: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.7. Other administrative functions</a></span></dt>
1.75      rillig     93: </dl></dd>
1.267     rillig     94: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.75      rillig     95: <dd><dl>
1.267     rillig     96: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
                     97: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
                     98: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.75      rillig     99: </dl></dd>
                    100: </dl></dd>
1.267     rillig    101: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.75      rillig    102: <dd><dl>
1.267     rillig    103: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
                    104: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
                    105: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
                    106: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       107: <dd><dl>
1.267     rillig    108: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
                    109: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    110: <dt><span class="sect2"><a href="#conf.ldflags">6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz       111: </dl></dd>
1.267     rillig    112: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
                    113: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.75      rillig    114: </dl></dd>
1.267     rillig    115: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.75      rillig    116: <dd><dl>
1.267     rillig    117: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
                    118: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.106     rillig    119: </dl></dd>
1.267     rillig    120: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.106     rillig    121: builds)</a></span></dt>
1.75      rillig    122: <dd><dl>
1.267     rillig    123: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
                    124: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a pbulk-style bulk build</a></span></dt>
                    125: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
                    126: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
                    127: <dt><span class="sect1"><a href="#creating-cdroms">8.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                    128: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.4.1. Example of cdpack</a></span></dt></dl></dd>
                    129: </dl></dd>
                    130: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
                    131: <dd><dl>
                    132: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    133: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
                    134: </dl></dd>
                    135: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
                    136: <dd><dl>
                    137: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    138: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
                    139: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
                    140: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
                    141: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">10.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
                    142: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
                    143: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
                    144: <dt><span class="sect1"><a href="#passive-ftp">10.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
                    145: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
                    146: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.128     wiz       147: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.267     rillig    148: <dt><span class="sect1"><a href="#bsd.own.mk-missing">10.11. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</a></span></dt>
                    149: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
                    150: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
                    151: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
                    152: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    153: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build.  What shall I do?</a></span></dt>
                    154: <dt><span class="sect1"><a href="#faq.rcs-conflicts">10.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</a></span></dt>
1.75      rillig    155: </dl></dd>
                    156: </dl></dd>
                    157: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
                    158: <dd><dl>
1.267     rillig    159: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
                    160: <dt><span class="chapter"><a href="#creating">12. Creating a new pkgsrc package from scratch</a></span></dt>
1.91      rillig    161: <dd><dl>
1.267     rillig    162: <dt><span class="sect1"><a href="#creating.common">12.1. Common types of packages</a></span></dt>
1.91      rillig    163: <dd><dl>
1.267     rillig    164: <dt><span class="sect2"><a href="#creating.perl-module">12.1.1. Perl modules</a></span></dt>
                    165: <dt><span class="sect2"><a href="#creating.python-module">12.1.2. Python modules and programs</a></span></dt>
1.273   ! brook     166: <dt><span class="sect2"><a href="#creating.R-package">12.1.3. R packages</a></span></dt>
        !           167: <dt><span class="sect2"><a href="#creating.TeX-package">12.1.4. TeXlive packages</a></span></dt>
1.91      rillig    168: </dl></dd>
1.267     rillig    169: <dt><span class="sect1"><a href="#creating.examples">12.2. Examples</a></span></dt>
                    170: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">12.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.106     rillig    171: </dl></dd>
1.267     rillig    172: <dt><span class="chapter"><a href="#components">13. Package components - files, directories and contents</a></span></dt>
1.106     rillig    173: <dd><dl>
1.267     rillig    174: <dt><span class="sect1"><a href="#components.Makefile">13.1. <code class="filename">Makefile</code></a></span></dt>
                    175: <dt><span class="sect1"><a href="#components.distinfo">13.2. <code class="filename">distinfo</code></a></span></dt>
                    176: <dt><span class="sect1"><a href="#components.patches">13.3. <code class="filename">patches/*</code></a></span></dt>
1.106     rillig    177: <dd><dl>
1.267     rillig    178: <dt><span class="sect2"><a href="#components.patch.structure">13.3.1. Structure of a single patch file</a></span></dt>
                    179: <dt><span class="sect2"><a href="#components.patches.caveats">13.3.2. Creating patch files</a></span></dt>
                    180: <dt><span class="sect2"><a href="#components.patches.sources">13.3.3. Sources where the patch files come from</a></span></dt>
                    181: <dt><span class="sect2"><a href="#components.patches.guidelines">13.3.4. Patching guidelines</a></span></dt>
                    182: <dt><span class="sect2"><a href="#components.patches.feedback">13.3.5. Feedback to the author</a></span></dt>
1.106     rillig    183: </dl></dd>
1.267     rillig    184: <dt><span class="sect1"><a href="#other-mandatory-files">13.4. Other mandatory files</a></span></dt>
                    185: <dt><span class="sect1"><a href="#components.optional">13.5. Optional files</a></span></dt>
1.106     rillig    186: <dd><dl>
1.267     rillig    187: <dt><span class="sect2"><a href="#components.optional.bin">13.5.1. Files affecting the binary package</a></span></dt>
                    188: <dt><span class="sect2"><a href="#components.optional.build">13.5.2. Files affecting the build process</a></span></dt>
                    189: <dt><span class="sect2"><a href="#components.optional.none">13.5.3. Files affecting nothing at all</a></span></dt>
1.106     rillig    190: </dl></dd>
1.267     rillig    191: <dt><span class="sect1"><a href="#work-dir">13.6. <code class="filename">work*</code></a></span></dt>
                    192: <dt><span class="sect1"><a href="#files-dir">13.7. <code class="filename">files/*</code></a></span></dt>
1.106     rillig    193: </dl></dd>
1.267     rillig    194: <dt><span class="chapter"><a href="#makefile">14. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106     rillig    195: <dd><dl>
1.267     rillig    196: <dt><span class="sect1"><a href="#makefile.style">14.1. Caveats</a></span></dt>
                    197: <dt><span class="sect1"><a href="#makefile.variables">14.2. <code class="filename">Makefile</code> variables</a></span></dt>
                    198: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">14.2.1. Naming conventions</a></span></dt></dl></dd>
                    199: <dt><span class="sect1"><a href="#makefile.code">14.3. Code snippets</a></span></dt>
1.106     rillig    200: <dd><dl>
1.267     rillig    201: <dt><span class="sect2"><a href="#adding-to-list">14.3.1. Adding things to a list</a></span></dt>
                    202: <dt><span class="sect2"><a href="#echo-literal">14.3.2. Echoing a string exactly as-is</a></span></dt>
                    203: <dt><span class="sect2"><a href="#cflags-gnu-configure">14.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
                    204: <dt><span class="sect2"><a href="#empty-variables">14.3.4. Handling possibly empty variables</a></span></dt>
1.106     rillig    205: </dl></dd>
                    206: </dl></dd>
1.267     rillig    207: <dt><span class="chapter"><a href="#plist">15. PLIST issues</a></span></dt>
1.106     rillig    208: <dd><dl>
1.267     rillig    209: <dt><span class="sect1"><a href="#rcs-id">15.1. RCS ID</a></span></dt>
                    210: <dt><span class="sect1"><a href="#automatic-plist-generation">15.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                    211: <dt><span class="sect1"><a href="#print-PLIST">15.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
                    212: <dt><span class="sect1"><a href="#plist.misc">15.4. Variable substitution in PLIST</a></span></dt>
                    213: <dt><span class="sect1"><a href="#manpage-compression">15.5. Man page compression</a></span></dt>
                    214: <dt><span class="sect1"><a href="#using-PLIST_SRC">15.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                    215: <dt><span class="sect1"><a href="#platform-specific-plist">15.7. Platform-specific and differing PLISTs</a></span></dt>
                    216: <dt><span class="sect1"><a href="#build-plist">15.8. Build-specific PLISTs</a></span></dt>
                    217: <dt><span class="sect1"><a href="#faq.common-dirs">15.9. Sharing directories between packages</a></span></dt>
1.106     rillig    218: </dl></dd>
1.267     rillig    219: <dt><span class="chapter"><a href="#buildlink">16. Buildlink methodology</a></span></dt>
1.106     rillig    220: <dd><dl>
1.267     rillig    221: <dt><span class="sect1"><a href="#converting-to-buildlink3">16.1. Converting packages to use buildlink3</a></span></dt>
                    222: <dt><span class="sect1"><a href="#creating-buildlink3.mk">16.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig    223: <dd><dl>
1.267     rillig    224: <dt><span class="sect2"><a href="#anatomy-of-bl3">16.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                    225: <dt><span class="sect2"><a href="#updating-buildlink-depends">16.2.2. Updating
1.133     wiz       226:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    227:       and
                    228:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    229:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig    230: </dl></dd>
1.267     rillig    231: <dt><span class="sect1"><a href="#writing-builtin.mk">16.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.106     rillig    232: <dd><dl>
1.267     rillig    233: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">16.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
                    234: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">16.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.106     rillig    235: </dl></dd>
                    236: </dl></dd>
1.267     rillig    237: <dt><span class="chapter"><a href="#pkginstall">17. The pkginstall framework</a></span></dt>
1.106     rillig    238: <dd><dl>
1.267     rillig    239: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">17.1. Files and directories outside the installation prefix</a></span></dt>
                    240: <dd><dl>
                    241: <dt><span class="sect2"><a href="#dirs-outside-prefix">17.1.1. Directory manipulation</a></span></dt>
                    242: <dt><span class="sect2"><a href="#files-outside-prefix">17.1.2. File manipulation</a></span></dt>
                    243: </dl></dd>
                    244: <dt><span class="sect1"><a href="#conf-files">17.2. Configuration files</a></span></dt>
                    245: <dd><dl>
                    246: <dt><span class="sect2"><a href="#conf-files-sysconfdir">17.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                    247: <dt><span class="sect2"><a href="#conf-files-configure">17.2.2. Telling the software where configuration files are</a></span></dt>
                    248: <dt><span class="sect2"><a href="#conf-files-patching">17.2.3. Patching installations</a></span></dt>
                    249: <dt><span class="sect2"><a href="#conf-files-disable">17.2.4. Disabling handling of configuration files</a></span></dt>
                    250: </dl></dd>
                    251: <dt><span class="sect1"><a href="#rcd-scripts">17.3. System startup scripts</a></span></dt>
                    252: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">17.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
                    253: <dt><span class="sect1"><a href="#users-and-groups">17.4. System users and groups</a></span></dt>
                    254: <dt><span class="sect1"><a href="#shells">17.5. System shells</a></span></dt>
                    255: <dd><dl><dt><span class="sect2"><a href="#shells-disable">17.5.1. Disabling shell registration</a></span></dt></dl></dd>
                    256: <dt><span class="sect1"><a href="#fonts">17.6. Fonts</a></span></dt>
                    257: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">17.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
                    258: </dl></dd>
                    259: <dt><span class="chapter"><a href="#options">18. Options handling</a></span></dt>
                    260: <dd><dl>
                    261: <dt><span class="sect1"><a href="#global-default-options">18.1. Global default options</a></span></dt>
                    262: <dt><span class="sect1"><a href="#converting-to-options">18.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
                    263: <dt><span class="sect1"><a href="#option-names">18.3. Option Names</a></span></dt>
                    264: <dt><span class="sect1"><a href="#option-build">18.4. Determining the options of dependencies</a></span></dt>
                    265: </dl></dd>
                    266: <dt><span class="chapter"><a href="#build">19. The build process</a></span></dt>
                    267: <dd><dl>
                    268: <dt><span class="sect1"><a href="#build.intro">19.1. Introduction</a></span></dt>
                    269: <dt><span class="sect1"><a href="#build.prefix">19.2. Program location</a></span></dt>
                    270: <dt><span class="sect1"><a href="#build.builddirs">19.3. Directories used during the build process</a></span></dt>
                    271: <dt><span class="sect1"><a href="#build.running">19.4. Running a phase</a></span></dt>
                    272: <dt><span class="sect1"><a href="#build.fetch">19.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                    273: <dd><dl>
                    274: <dt><span class="sect2"><a href="#build.fetch.what">19.5.1. What to fetch and where to get it from</a></span></dt>
                    275: <dt><span class="sect2"><a href="#build.fetch.how">19.5.2. How are the files fetched?</a></span></dt>
                    276: </dl></dd>
                    277: <dt><span class="sect1"><a href="#build.checksum">19.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                    278: <dt><span class="sect1"><a href="#build.extract">19.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                    279: <dt><span class="sect1"><a href="#build.patch">19.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                    280: <dt><span class="sect1"><a href="#build.tools">19.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                    281: <dt><span class="sect1"><a href="#build.wrapper">19.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                    282: <dt><span class="sect1"><a href="#build.configure">19.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    283: <dt><span class="sect1"><a href="#build.build">19.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    284: <dt><span class="sect1"><a href="#build.test">19.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                    285: <dt><span class="sect1"><a href="#build.install">19.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    286: <dt><span class="sect1"><a href="#build.package">19.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                    287: <dt><span class="sect1"><a href="#build.clean">19.16. Cleaning up</a></span></dt>
                    288: <dt><span class="sect1"><a href="#build.helpful-targets">19.17. Other helpful targets</a></span></dt>
                    289: </dl></dd>
                    290: <dt><span class="chapter"><a href="#tools">20. Tools needed for building or running</a></span></dt>
                    291: <dd><dl>
                    292: <dt><span class="sect1"><a href="#pkgsrc-tools">20.1. Tools for pkgsrc builds</a></span></dt>
                    293: <dt><span class="sect1"><a href="#package-tools">20.2. Tools needed by packages</a></span></dt>
                    294: <dt><span class="sect1"><a href="#platform-tools">20.3. Tools provided by platforms</a></span></dt>
                    295: </dl></dd>
                    296: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
                    297: <dd><dl>
                    298: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
                    299: <dd><dl>
                    300: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">21.1.1. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
                    301: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                    302: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                    303: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                    304: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                    305: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                    306: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                    307: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                    308: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                    309: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                    310: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                    311: </dl></dd>
                    312: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                    313: <dd><dl>
                    314: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                    315: <dt><span class="sect2"><a href="#modified-distfiles-same-name">21.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
                    316: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                    317: </dl></dd>
                    318: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    319: <dd><dl>
                    320: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                    321: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                    322: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
                    323: </dl></dd>
                    324: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                    325: <dd><dl>
                    326: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                    327: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
                    328: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing perl scripts</a></span></dt>
                    329: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
                    330: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
                    331: </dl></dd>
                    332: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    333: <dd><dl>
                    334: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                    335: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
                    336: <dt><span class="sect2"><a href="#undefined-reference">21.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span></a></span></dt>
                    337: <dt><span class="sect2"><a href="#out-of-memory">21.5.4. Running out of memory</a></span></dt>
                    338: </dl></dd>
                    339: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    340: <dd><dl>
                    341: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                    342: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                    343: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                    344: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                    345: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                    346: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing perl modules</a></span></dt>
                    347: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
                    348: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
                    349: <dt><span class="sect2"><a href="#gconf-data-files">21.6.9. Packages installing GConf data files</a></span></dt>
                    350: <dt><span class="sect2"><a href="#scrollkeeper-data-files">21.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
                    351: <dt><span class="sect2"><a href="#x11-fonts">21.6.11. Packages installing X11 fonts</a></span></dt>
                    352: <dt><span class="sect2"><a href="#gtk2-modules">21.6.12. Packages installing GTK2 modules</a></span></dt>
                    353: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.13. Packages installing SGML or XML data</a></span></dt>
                    354: <dt><span class="sect2"><a href="#mime-database">21.6.14. Packages installing extensions to the MIME database</a></span></dt>
                    355: <dt><span class="sect2"><a href="#intltool">21.6.15. Packages using intltool</a></span></dt>
                    356: <dt><span class="sect2"><a href="#startup-scripts">21.6.16. Packages installing startup scripts</a></span></dt>
                    357: <dt><span class="sect2"><a href="#tex-packages">21.6.17. Packages installing TeX modules</a></span></dt>
                    358: <dt><span class="sect2"><a href="#emulation-packages">21.6.18. Packages supporting running binaries in
1.87      wiz       359:     emulation</a></span></dt>
1.267     rillig    360: <dt><span class="sect2"><a href="#hicolor-theme">21.6.19. Packages installing hicolor theme icons</a></span></dt>
                    361: <dt><span class="sect2"><a href="#desktop-files">21.6.20. Packages installing desktop files</a></span></dt>
1.77      rillig    362: </dl></dd>
1.267     rillig    363: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.77      rillig    364: </dl></dd>
1.267     rillig    365: <dt><span class="chapter"><a href="#debug">22. Debugging</a></span></dt>
                    366: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.77      rillig    367: <dd><dl>
1.267     rillig    368: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                    369: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                    370: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                    371: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                    372: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                    373: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                    374: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                    375: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
                    376: </dl></dd>
                    377: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
                    378: <dt><span class="chapter"><a href="#gnome">25. GNOME packaging and porting</a></span></dt>
                    379: <dd><dl>
                    380: <dt><span class="sect1"><a href="#meta-packages">25.1. Meta packages</a></span></dt>
                    381: <dt><span class="sect1"><a href="#new-package">25.2. Packaging a GNOME application</a></span></dt>
                    382: <dt><span class="sect1"><a href="#full-update">25.3. Updating GNOME to a newer version</a></span></dt>
                    383: <dt><span class="sect1"><a href="#patching">25.4. Patching guidelines</a></span></dt>
1.85      jmmv      384: </dl></dd>
1.75      rillig    385: </dl></dd>
                    386: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
                    387: <dd><dl>
1.267     rillig    388: <dt><span class="chapter"><a href="#infr.design">26. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig    389: <dd><dl>
1.267     rillig    390: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
                    391: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
                    392: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.81      rillig    393: <dd><dl>
1.267     rillig    394: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
                    395: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.81      rillig    396: </dl></dd>
1.267     rillig    397: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
                    398: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig    399: <dd><dl>
1.267     rillig    400: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
                    401: <dt><span class="sect2"><a href="#infr.design.intf.action">26.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75      rillig    402: </dl></dd>
1.267     rillig    403: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.75      rillig    404: <dd><dl>
1.267     rillig    405: <dt><span class="sect2"><a href="#infr.order.prefs">26.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
                    406: <dt><span class="sect2"><a href="#infr.order.pkg">26.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75      rillig    407: </dl></dd>
                    408: </dl></dd>
1.267     rillig    409: <dt><span class="chapter"><a href="#regression">27. Regression tests</a></span></dt>
1.75      rillig    410: <dd><dl>
1.267     rillig    411: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
                    412: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.75      rillig    413: <dd><dl>
1.267     rillig    414: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
                    415: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.75      rillig    416: </dl></dd>
                    417: </dl></dd>
1.267     rillig    418: <dt><span class="chapter"><a href="#porting">28. Porting pkgsrc</a></span></dt>
                    419: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">28.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.75      rillig    420: </dl></dd>
                    421: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
                    422: <dd><dl>
                    423: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                    424: <dd><dl>
                    425: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                    426: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                    427: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.128     wiz       428: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span></a></span></dt>
1.75      rillig    429: </dl></dd>
                    430: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                    431: </dl></dd>
                    432: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
                    433: <dd><dl>
                    434: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                    435: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                    436: </dl></dd>
1.76      rillig    437: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
                    438: <dd><dl>
1.128     wiz       439: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                    440: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                    441: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                    442: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                    443: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
1.261     leot      444: <code class="filename">stable</code>,
1.128     wiz       445: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig    446: source packages</a></span></dt>
                    447: </dl></dd>
1.267     rillig    448: <dt><span class="appendix"><a href="#help-topics">D. Help topics</a></span></dt>
                    449: <dt><span class="appendix"><a href="#editing">E. Editing guidelines for the pkgsrc guide</a></span></dt>
1.75      rillig    450: <dd><dl>
1.267     rillig    451: <dt><span class="sect1"><a href="#targets">E.1. Make targets</a></span></dt>
                    452: <dt><span class="sect1"><a href="#procedure">E.2. Procedure</a></span></dt>
1.75      rillig    453: </dl></dd>
                    454: </dl>
                    455: </div>
1.82      rillig    456: <div class="list-of-tables">
                    457: <p><b>List of Tables</b></p>
                    458: <dl>
                    459: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
                    460: </dt>
1.267     rillig    461: <dt>13.1. <a href="#patch-examples">Patching examples</a>
1.85      jmmv      462: </dt>
1.267     rillig    463: <dt>25.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85      jmmv      464: </dt>
1.82      rillig    465: </dl>
                    466: </div>
1.148     asau      467: <div class="chapter">
                    468: <div class="titlepage"><div><div><h1 class="title">
                    469: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.75      rillig    470: <div class="toc">
                    471: <p><b>Table of Contents</b></p>
1.210     leot      472: <dl class="toc">
1.75      rillig    473: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig    474: <dd><dl>
                    475: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                    476: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                    477: </dl></dd>
1.75      rillig    478: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                    479: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88      wiz       480: <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    481: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                    482: </dl>
                    483: </div>
1.148     asau      484: <div class="sect1">
1.75      rillig    485: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    486: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82      rillig    487: <p>There is a lot of software freely available for Unix-based
                    488: systems, which is usually available in form of the source code. Before
                    489: such software can be used, it needs to be configured to the local
                    490: system, compiled and installed, and this is exactly what The NetBSD
                    491: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
                    492: to handle binary packages, so that not every user has to build the
                    493: packages for himself, which is a time-costly task.</p>
1.75      rillig    494: <p>pkgsrc currently contains several thousand packages,
                    495:       including:</p>
1.148     asau      496: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250     leot      497: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/README.html" target="_top"><code class="filename">www/apache24</code></a> - The Apache
1.75      rillig    498:          web server</p></li>
1.250     leot      499: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.75      rillig    500:          web browser</p></li>
1.250     leot      501: <li class="listitem"><p><a href="https://cdn.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    502:          Desktop Environment</p></li>
1.250     leot      503: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/README.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a> - The K
1.75      rillig    504:          Desktop Environment</p></li>
                    505: </ul></div>
1.219     rillig    506: <p>&#8230; just to name a few.</p>
1.75      rillig    507: <p>pkgsrc has built-in support for handling varying dependencies,
                    508:       such as pthreads and X11, and extended features such as IPv6 support on
                    509:       a range of platforms.</p>
1.148     asau      510: <div class="sect2">
1.82      rillig    511: <div class="titlepage"><div><div><h3 class="title">
                    512: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
                    513: <p>
                    514: pkgsrc provides the following key features:
                    515: </p>
1.148     asau      516: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz       517: <li class="listitem"><p>Easy building of software from source as well as the creation
1.82      rillig    518:   and installation of binary packages. The source and latest
                    519:   patches are retrieved from a master or mirror download site, checksum
                    520:   verified, then built on your system. Support for binary-only
                    521:   distributions is available for both native platforms and NetBSD
                    522:   emulated platforms.</p></li>
1.128     wiz       523: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.82      rillig    524:   including binaries, libraries, man pages and other
                    525:   documentation.</p></li>
1.214     sevan     526: <li class="listitem"><p>Tracking of package dependencies automatically, including when
                    527:   performing updates, to ensure required packages are installed. The
                    528:   configuration files of various packages are handled automatically during
                    529:   updates, so local changes are preserved.</p></li>
1.128     wiz       530: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.82      rillig    531:   consists of highly portable code. This allows the greatest speed of
1.132     spz       532:   development when porting to a new platform. This portability also
1.82      rillig    533:   ensures that pkgsrc is <span class="emphasis"><em>consistent across all
                    534:   platforms</em></span>.</p></li>
1.128     wiz       535: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.82      rillig    536:   international encryption requirements and build-time options for a
                    537:   large number of packages are all set in a simple, central
                    538:   configuration file.</p></li>
1.128     wiz       539: <li class="listitem"><p>The entire source (not including the distribution files) is
1.82      rillig    540:   freely available under a BSD license, so you may extend and adapt
                    541:   pkgsrc to your needs. Support for local packages and patches is
                    542:   available right out of the box, so you can configure it specifically
                    543:   for your environment.</p></li>
                    544: </ul></div>
1.91      rillig    545: <p>The following principles are basic to pkgsrc:</p>
1.148     asau      546: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz       547: <li class="listitem"><p><span class="quote">&#8220;<span class="quote">It should only work if it's right.</span>&#8221;</span>
1.126     jakllsch  548: &mdash; That means, if a package contains bugs, it's better to find
1.91      rillig    549: them and to complain about them rather than to just install the package
                    550: and hope that it works. There are numerous checks in pkgsrc that try to
1.250     leot      551: find such bugs: Static analysis tools (<a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
1.91      rillig    552: of shell scripts), and post-installation checks (installed files,
                    553: references to shared libraries, script interpreters).</p></li>
1.128     wiz       554: <li class="listitem"><p><span class="quote">&#8220;<span class="quote">If it works, it should work everywhere</span>&#8221;</span>
1.126     jakllsch  555: &mdash; Like NetBSD has been ported to many hardware architectures,
1.91      rillig    556: pkgsrc has been ported to many operating systems. Care is taken that
                    557: packages behave the same on all platforms.</p></li>
                    558: </ul></div>
1.82      rillig    559: </div>
1.148     asau      560: <div class="sect2">
1.82      rillig    561: <div class="titlepage"><div><div><h3 class="title">
                    562: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
                    563: <p>pkgsrc consists of both a source distribution and a binary
                    564: distribution for these operating systems. After retrieving the required
                    565: source or binaries, you can be up and running with pkgsrc in just
                    566: minutes!</p>
1.75      rillig    567: <p>pkgsrc was derived from FreeBSD's ports system, and
                    568:       initially developed for NetBSD only. Since then, pkgsrc has
                    569:       grown a lot, and now supports the following platforms:</p>
1.82      rillig    570: <div class="table">
                    571: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.216     tnn       572: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.82      rillig    573: <colgroup>
                    574: <col>
                    575: <col>
1.202     sevan     576: <col>
1.82      rillig    577: </colgroup>
                    578: <thead><tr>
                    579: <th>Platform</th>
                    580: <th>Date Support Added</th>
1.202     sevan     581: <th>Notes</th>
1.82      rillig    582: </tr></thead>
                    583: <tbody>
                    584: <tr>
1.110     hubertf   585: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82      rillig    586: <td align="center">Aug 1997</td>
1.202     sevan     587: <td class="auto-generated"> </td>
1.82      rillig    588: </tr>
                    589: <tr>
1.110     hubertf   590: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82      rillig    591: <td align="center">Mar 1999</td>
1.264     sevan     592: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Solaris" target="_top">README.Solaris</a></td>
1.82      rillig    593: </tr>
                    594: <tr>
1.110     hubertf   595: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.82      rillig    596: <td align="center">Jun 1999</td>
1.264     sevan     597: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Linux" target="_top">README.Linux</a></td>
1.82      rillig    598: </tr>
                    599: <tr>
                    600: <td>
1.230     sevan     601:           <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.82      rillig    602:         </td>
                    603: <td align="center">Oct 2001</td>
1.264     sevan     604: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.MacOSX" target="_top">README.MacOSX</a></td>
1.82      rillig    605: </tr>
                    606: <tr>
1.110     hubertf   607: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82      rillig    608: <td align="center">Nov 2002</td>
1.264     sevan     609: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.FreeBSD" target="_top">README.FreeBSD</a></td>
1.82      rillig    610: </tr>
                    611: <tr>
1.110     hubertf   612: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82      rillig    613: <td align="center">Nov 2002</td>
1.264     sevan     614: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OpenBSD" target="_top">README.OpenBSD</a></td>
1.82      rillig    615: </tr>
                    616: <tr>
1.110     hubertf   617: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82      rillig    618: <td align="center">Dec 2002</td>
1.202     sevan     619: <td>
1.264     sevan     620:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
                    621:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX5.3" target="_top">README.IRIX5.3</a>
1.202     sevan     622:        </td>
1.82      rillig    623: </tr>
                    624: <tr>
                    625: <td>BSD/OS</td>
                    626: <td align="center">Dec 2003</td>
1.202     sevan     627: <td class="auto-generated"> </td>
1.82      rillig    628: </tr>
                    629: <tr>
1.110     hubertf   630: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82      rillig    631: <td align="center">Dec 2003</td>
1.264     sevan     632: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.AIX" target="_top">README.AIX</a></td>
1.82      rillig    633: </tr>
                    634: <tr>
                    635: <td>
1.110     hubertf   636:           <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82      rillig    637:           (Microsoft Windows Services for Unix)
                    638:         </td>
                    639: <td align="center">Mar 2004</td>
1.264     sevan     640: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Interix" target="_top">README.Interix</a></td>
1.82      rillig    641: </tr>
                    642: <tr>
1.110     hubertf   643: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82      rillig    644: <td align="center">Oct 2004</td>
1.202     sevan     645: <td class="auto-generated"> </td>
1.82      rillig    646: </tr>
                    647: <tr>
1.110     hubertf   648: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82      rillig    649: <td align="center">Nov 2004</td>
1.264     sevan     650: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OSF1" target="_top">README.OSF1</a></td>
1.82      rillig    651: </tr>
1.98      wiz       652: <tr>
1.110     hubertf   653: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98      wiz       654: <td align="center">Apr 2007</td>
1.264     sevan     655: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.HPUX" target="_top">README.HPUX</a></td>
1.98      wiz       656: </tr>
1.128     wiz       657: <tr>
                    658: <td><a class="ulink" href="http://www.haiku-os.org/" target="_top">Haiku</a></td>
                    659: <td align="center">Sep 2010</td>
1.264     sevan     660: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Haiku" target="_top">README.Haiku</a></td>
1.128     wiz       661: </tr>
1.151     obache    662: <tr>
                    663: <td><a class="ulink" href="http://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.163     bsiegert  664: <td align="center">Jan 2011</td>
1.202     sevan     665: <td class="auto-generated"> </td>
1.151     obache    666: </tr>
                    667: <tr>
                    668: <td><a class="ulink" href="http://www.minix3.org/" target="_top">Minix3</a></td>
                    669: <td align="center">Nov 2011</td>
1.264     sevan     670: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Minix3" target="_top">README.Minix3</a></td>
1.151     obache    671: </tr>
                    672: <tr>
                    673: <td><a class="ulink" href="http://cygwin.com/" target="_top">Cygwin</a></td>
                    674: <td align="center">Mar 2013</td>
1.264     sevan     675: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Cygwin" target="_top">README.Cygwin</a></td>
1.151     obache    676: </tr>
1.166     jnemeth   677: <tr>
                    678: <td><a class="ulink" href="http://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
                    679: <td align="center">Jul 2013</td>
1.264     sevan     680: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.GNUkFreeBSD" target="_top">README.GNUkFreeBSD</a></td>
1.166     jnemeth   681: </tr>
1.214     sevan     682: <tr>
                    683: <td><a class="ulink" href="http://www.bitrig.org/" target="_top">Bitrig</a></td>
                    684: <td align="center">Jun 2014</td>
1.264     sevan     685: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Bitrig" target="_top">README.Bitrig</a></td>
1.214     sevan     686: </tr>
1.82      rillig    687: </tbody>
1.91      rillig    688: </table></div>
1.82      rillig    689: </div>
1.91      rillig    690: <br class="table-break">
1.82      rillig    691: </div>
1.75      rillig    692: </div>
1.148     asau      693: <div class="sect1">
1.75      rillig    694: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    695: <a name="overview"></a>1.2. Overview</h2></div></div></div>
                    696: <p>This document is divided into three parts. The first,
1.110     hubertf   697:        <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75      rillig    698:        describes how one can use one of the packages in the Package
                    699:        Collection, either by installing a precompiled binary package,
1.93      rillig    700:        or by building one's own copy using the NetBSD package system.
1.110     hubertf   701:        The second part, <a class="link" href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
1.75      rillig    702:        package so it can be easily built by other NetBSD users without
                    703:        knowing about the package's building details. The third part,
1.110     hubertf   704:        <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75      rillig    705:        is intended for those who want to understand how pkgsrc is
                    706:        implemented.</p>
                    707: <p>This document is available in various formats:
1.110     hubertf   708:        <span class="simplelist"><a class="ulink" href="index.html" target="_top">HTML</a>, <a class="ulink" href="pkgsrc.pdf" target="_top">PDF</a>, <a class="ulink" href="pkgsrc.ps" target="_top">PS</a>, <a class="ulink" href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
1.75      rillig    709: </div>
1.148     asau      710: <div class="sect1">
1.75      rillig    711: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    712: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.128     wiz       713: <p>There has been a lot of talk about <span class="quote">&#8220;<span class="quote">ports</span>&#8221;</span>,
                    714:       <span class="quote">&#8220;<span class="quote">packages</span>&#8221;</span>, etc. so far. Here is a description of all the
1.75      rillig    715:       terminology used within this document.</p>
1.148     asau      716: <div class="variablelist"><dl class="variablelist">
1.75      rillig    717: <dt><span class="term">Package</span></dt>
                    718: <dd><p>A set of files and building instructions
                    719:            that describe what's necessary
                    720:            to build a certain piece of software using
                    721:             pkgsrc. Packages are traditionally stored under
1.236     wiz       722:            <code class="filename">/usr/pkgsrc</code>,
                    723:            but may be stored in any location,
                    724:            referred to as <code class="varname">PKGSRCDIR</code>.</p></dd>
1.75      rillig    725: <dt><span class="term">The NetBSD package system</span></dt>
1.128     wiz       726: <dd><p>This is the former name of <span class="quote">&#8220;<span class="quote">pkgsrc</span>&#8221;</span>.  It
1.87      wiz       727:          is part of the NetBSD operating system and can be bootstrapped
                    728:          to run on non-NetBSD operating systems as well.  It handles
                    729:          building (compiling), installing, and removing of
                    730:          packages.</p></dd>
1.75      rillig    731: <dt><span class="term">Distfile</span></dt>
                    732: <dd><p>This term describes the file or files that are
                    733:            provided by the author of the piece of software to
                    734:            distribute his work. All the changes necessary to build on
                    735:            NetBSD are reflected in the corresponding package. Usually
                    736:            the distfile is in the form of a compressed tar-archive,
                    737:            but other types are possible, too. Distfiles are usually
                    738:            stored below
1.76      rillig    739:            <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75      rillig    740: <dt><span class="term">Port</span></dt>
                    741: <dd><p>This is the term used by FreeBSD and OpenBSD people
                    742:            for what we call a package.
1.128     wiz       743:            In NetBSD terminology, <span class="quote">&#8220;<span class="quote">port</span>&#8221;</span> refers to a different
1.75      rillig    744:            architecture.</p></dd>
                    745: <dt><span class="term">Precompiled/binary package</span></dt>
                    746: <dd>
                    747: <p>A set of binaries built with pkgsrc from a distfile
1.76      rillig    748:            and stuffed together in a single <code class="filename">.tgz</code>
1.75      rillig    749:            file so it can be installed on machines of the same
                    750:            machine architecture without the need to
                    751:            recompile. Packages are usually generated in
1.76      rillig    752:            <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.132     spz       753:            an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.128     wiz       754: <p>Sometimes, this is referred to by the term <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> too,
1.75      rillig    755:            especially in the context of precompiled packages.</p>
                    756: </dd>
                    757: <dt><span class="term">Program</span></dt>
1.88      wiz       758: <dd><p>The piece of software to be installed which will be
                    759:          constructed from all the files in the distfile by the
                    760:          actions defined in the corresponding package.</p></dd>
1.75      rillig    761: </dl></div>
1.148     asau      762: <div class="sect2">
1.75      rillig    763: <div class="titlepage"><div><div><h3 class="title">
1.88      wiz       764: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.148     asau      765: <div class="variablelist"><dl class="variablelist">
1.75      rillig    766: <dt><span class="term">pkgsrc users</span></dt>
                    767: <dd>
                    768: <p>The
                    769:        pkgsrc users are people who use the packages provided by pkgsrc.
                    770:        Typically they are system administrators. The people using the
1.128     wiz       771:        software that is inside the packages (maybe called <span class="quote">&#8220;<span class="quote">end
                    772:        users</span>&#8221;</span>) are not covered by the pkgsrc guide.</p>
1.75      rillig    773: <p>There are two kinds of pkgsrc users: Some only want to
                    774:        install pre-built binary packages. Others build the pkgsrc
                    775:        packages from source, either for installing them directly or for
1.110     hubertf   776:        building binary packages themselves. For pkgsrc users <a class="xref" href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, &#8220;The pkgsrc user's guide&#8221;</a> should provide all necessary
1.75      rillig    777:        documentation.</p>
                    778: </dd>
                    779: <dt><span class="term">package maintainers</span></dt>
                    780: <dd><p>A
1.110     hubertf   781:        package maintainer creates packages as described in <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, &#8220;The pkgsrc developer's guide&#8221;</a>.</p></dd>
1.75      rillig    782: <dt><span class="term">infrastructure developers</span></dt>
                    783: <dd><p>These people are involved in all those files
1.76      rillig    784:        that live in the <code class="filename">mk/</code> directory and below.
1.110     hubertf   785:        Only these people should need to read through <a class="xref" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, &#8220;The pkgsrc infrastructure internals&#8221;</a>, though others might be curious,
1.75      rillig    786:        too.</p></dd>
                    787: </dl></div>
                    788: </div>
                    789: </div>
1.148     asau      790: <div class="sect1">
1.75      rillig    791: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    792: <a name="typography"></a>1.4. Typography</h2></div></div></div>
                    793: <p>When giving examples for commands, shell prompts are used to
                    794:       show if the command should/can be issued as root, or if
1.128     wiz       795:       <span class="quote">&#8220;<span class="quote">normal</span>&#8221;</span> user privileges are sufficient. We use a
1.226     sevan     796:       <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
                    797:       shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
                    798:       bourne shell and derivatives.</p>
1.75      rillig    799: </div>
                    800: </div>
1.148     asau      801: <div class="part">
1.75      rillig    802: <div class="titlepage"><div><div><h1 class="title">
                    803: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
                    804: <div class="toc">
                    805: <p><b>Table of Contents</b></p>
1.210     leot      806: <dl class="toc">
1.267     rillig    807: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
                    808: <dt><span class="chapter"><a href="#getting">3. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
1.75      rillig    809: <dd><dl>
1.267     rillig    810: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75      rillig    811: <dd><dl>
1.267     rillig    812: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
                    813: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig    814: </dl></dd>
1.267     rillig    815: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75      rillig    816: <dd><dl>
1.267     rillig    817: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
                    818: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75      rillig    819: </dl></dd>
                    820: </dl></dd>
1.267     rillig    821: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.75      rillig    822: <dd><dl>
1.267     rillig    823: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
                    824: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75      rillig    825: </dl></dd>
1.267     rillig    826: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.75      rillig    827: <dd><dl>
1.267     rillig    828: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75      rillig    829: <dd><dl>
1.267     rillig    830: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
                    831: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
                    832: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.3. Deinstalling packages</a></span></dt>
                    833: <dt><span class="sect2"><a href="#using.pkg_info">5.1.4. Getting information about installed packages</a></span></dt>
                    834: <dt><span class="sect2"><a href="#vulnerabilities">5.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    835: <dt><span class="sect2"><a href="#pkg_versions">5.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                    836: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.7. Other administrative functions</a></span></dt>
1.75      rillig    837: </dl></dd>
1.267     rillig    838: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.75      rillig    839: <dd><dl>
1.267     rillig    840: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
                    841: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
                    842: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.75      rillig    843: </dl></dd>
                    844: </dl></dd>
1.267     rillig    845: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.75      rillig    846: <dd><dl>
1.267     rillig    847: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
                    848: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
                    849: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
                    850: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       851: <dd><dl>
1.267     rillig    852: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
                    853: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    854: <dt><span class="sect2"><a href="#conf.ldflags">6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz       855: </dl></dd>
1.267     rillig    856: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
                    857: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.75      rillig    858: </dl></dd>
1.267     rillig    859: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.75      rillig    860: <dd><dl>
1.267     rillig    861: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
                    862: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.106     rillig    863: </dl></dd>
1.267     rillig    864: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.106     rillig    865: builds)</a></span></dt>
1.75      rillig    866: <dd><dl>
1.267     rillig    867: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
                    868: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a pbulk-style bulk build</a></span></dt>
                    869: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
                    870: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
                    871: <dt><span class="sect1"><a href="#creating-cdroms">8.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                    872: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.4.1. Example of cdpack</a></span></dt></dl></dd>
                    873: </dl></dd>
                    874: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
                    875: <dd><dl>
                    876: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    877: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
                    878: </dl></dd>
                    879: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
                    880: <dd><dl>
                    881: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    882: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
                    883: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
                    884: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
                    885: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">10.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
                    886: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
                    887: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
                    888: <dt><span class="sect1"><a href="#passive-ftp">10.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
                    889: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
                    890: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.128     wiz       891: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.267     rillig    892: <dt><span class="sect1"><a href="#bsd.own.mk-missing">10.11. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</a></span></dt>
                    893: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
                    894: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
                    895: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
                    896: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    897: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build.  What shall I do?</a></span></dt>
                    898: <dt><span class="sect1"><a href="#faq.rcs-conflicts">10.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</a></span></dt>
1.75      rillig    899: </dl></dd>
                    900: </dl>
                    901: </div>
1.148     asau      902: <div class="chapter">
1.75      rillig    903: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig    904: <a name="help-user"></a>Chapter 2. Getting help</h2></div></div></div>
                    905: <p>
                    906:        To get help when using pkgsrc, the definitive source is this
                    907:        document, the pkgsrc guide. If you don't find anything here,
                    908:        there are alternatives:
                    909: </p>
                    910: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                    911: <li class="listitem">
                    912: <p>
                    913:        The built-in pkgsrc help, which is available after bootstrapping
                    914:        pkgsrc. Run <span class="command"><strong>bmake help topic=&#8230;</strong></span> to get
                    915:        help for any topic, such as a variable name like
                    916:        <code class="varname">BUILD_DEFS</code>, a make target like
                    917:        <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
                    918:        <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
                    919: <p>The available help topics are listed in <a class="xref" href="#help-topics" title="Appendix D. Help topics">Appendix D, <i>Help topics</i></a>.</p>
                    920: </li>
                    921: <li class="listitem"><p>
                    922:        The pkgsrc-users mailing list, to which
                    923:        <a class="ulink" href="https://www.NetBSD.org/mailinglists/#pkgsrc-users" target="_top">you
                    924:        can subscribe</a> and then <a class="ulink" href="mailto:pkgsrc-users@NetBSD.org" target="_top">ask your
                    925:        questions</a>.</p></li>
                    926: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
                    927:        <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
                    928:        or by using a specialized chat program such as
                    929:        <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
                    930:        Pick any user name and join the channel #pkgsrc.</p></li>
                    931: </ul></div>
                    932: </div>
                    933: <div class="chapter">
                    934: <div class="titlepage"><div><div><h2 class="title">
                    935: <a name="getting"></a>Chapter 3. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
1.75      rillig    936: <div class="toc">
                    937: <p><b>Table of Contents</b></p>
1.210     leot      938: <dl class="toc">
1.267     rillig    939: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75      rillig    940: <dd><dl>
1.267     rillig    941: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
                    942: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig    943: </dl></dd>
1.267     rillig    944: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75      rillig    945: <dd><dl>
1.267     rillig    946: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
                    947: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75      rillig    948: </dl></dd>
                    949: </dl>
                    950: </div>
1.91      rillig    951: <p>Before you download and extract the files, you need to decide
                    952: where you want to extract them. When using pkgsrc as root user, pkgsrc
                    953: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
                    954: free to install the sources and binary packages wherever you want in
                    955: your filesystem, provided that the pathname does not contain white-space
                    956: or other characters that are interpreted specially by the shell and some
                    957: other programs. A safe bet is to use only letters, digits, underscores
                    958: and dashes.</p>
1.148     asau      959: <div class="sect1">
1.75      rillig    960: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig    961: <a name="getting-first"></a>3.1. Getting pkgsrc for the first time</h2></div></div></div>
1.75      rillig    962: <p>Before you download any pkgsrc files, you should decide
                    963:        whether you want the <span class="emphasis"><em>current</em></span> branch or the
                    964:        <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
                    965:        quarterly basis from the current branch and only gets modified
                    966:        for security updates. The names of the stable branches are built
                    967:        from the year and the quarter, for example
1.270     leot      968:        <code class="literal">2019Q2</code>.</p>
1.75      rillig    969: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.128     wiz       970:        want to download pkgsrc. You can get it as a tar file or via CVS.
                    971:        Both ways are described here.</p>
1.157     asau      972: <p>Note that tar archive contains CVS working copy.
                    973:        Thus you can switch to using CVS at any later time.</p>
1.148     asau      974: <div class="sect2">
1.75      rillig    975: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig    976: <a name="getting-via-tar"></a>3.1.1. As tar archive</h3></div></div></div>
1.75      rillig    977: <p>The primary download location for all pkgsrc files is
1.264     sevan     978:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/" target="_top">https://cdn.NetBSD.org/pub/pkgsrc/</a> or
1.157     asau      979:        <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
                    980:        (it points to the same location).
                    981:        There are a number of subdirectories for different purposes,
                    982:        which are described in detail in <a class="xref" href="#ftp-layout" title="Appendix C. Directory layout of the pkgsrc FTP server">Appendix C, <i>Directory layout of the pkgsrc FTP server</i></a>.</p>
                    983: <p>The tar archive for the current branch is in the directory
1.264     sevan     984:        <code class="filename">current</code> and is called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.230     sevan     985:        It is autogenerated weekly.</p>
1.157     asau      986: <p>To save download time we provide bzip2- and
                    987:        xz-compressed archives which are published at
1.264     sevan     988:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
1.157     asau      989:        and
1.264     sevan     990:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
1.157     asau      991:        respectively.
                    992:        </p>
                    993: <p>You can fetch the same files using FTP.</p>
1.270     leot      994: <p>The tar file for the stable branch 2019Q2 is in the
                    995:        directory <code class="filename">pkgsrc-2019Q2</code> and is also called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/pkgsrc-2019Q2/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.249     leot      996: <p>To download the latest pkgsrc stable tarball, run:</p>
1.112     weinem    997: <pre class="screen">
1.270     leot      998: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2019Q2/pkgsrc.tar.gz</code></strong></pre>
1.188     snj       999: <p>If you prefer, you can also fetch it using "wget", "curl",
1.157     asau     1000:        or your web browser.</p>
1.112     weinem   1001: <p>Then, extract it with:</p>
1.188     snj      1002: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.112     weinem   1003: <p>This will create the directory <code class="filename">pkgsrc/</code>
                   1004:        in <code class="filename">/usr/</code> and all the package source will be 
                   1005:        stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                   1006: <p>To download pkgsrc-current, run:</p>
                   1007: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz</code></strong></pre>
1.75      rillig   1008: </div>
1.148     asau     1009: <div class="sect2">
1.75      rillig   1010: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1011: <a name="getting-via-cvs"></a>3.1.2. Via anonymous CVS</h3></div></div></div>
1.128     wiz      1012: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.270     leot     1013: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r pkgsrc-2019Q2 -P pkgsrc</code></strong>
1.128     wiz      1014: </pre>
                   1015: <p>This will create the directory <code class="filename">pkgsrc/</code> 
                   1016:        in your <code class="filename">/usr/</code> directory and all the package source 
                   1017:        will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                   1018: <p>To fetch the pkgsrc current branch, run:</p>
1.146     wiz      1019: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1       grant    1020: </pre>
1.188     snj      1021: <p>Refer to the <a class="ulink" href="http://www.NetBSD.org/mirrors/#anoncvs" target="_top">list of available mirrors</a> to choose a faster CVS mirror, if needed.</p>
1.128     wiz      1022: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable. E.g.:</p>
1.146     wiz      1023: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; env CVS_RSH=ssh cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.128     wiz      1024: </pre>
                   1025: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
                   1026:        For Bourne shells, you can set it in your <code class="filename">.profile</code>
                   1027:        or better globally in <code class="filename">/etc/profile</code>:</p>
                   1028: <pre class="programlisting">
                   1029: # set CVS remote shell command
                   1030: CVS_RSH=ssh
                   1031: export CVS_RSH
                   1032: </pre>
                   1033: <p>By default, CVS doesn't do things like most people would expect it to do.
                   1034:        But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
                   1035:        in your home directory and saving the following lines to it.
                   1036:        This file will save you lots of headache and some bug reports, so we strongly recommend it.
                   1037:        You can find an explanation of this file in the CVS documentation.</p>
1.101     rillig   1038: <pre class="programlisting">
                   1039: # recommended CVS configuration file from the pkgsrc guide
1.268     sevan    1040: cvs -q
1.101     rillig   1041: checkout -P
1.103     wiz      1042: update -dP
                   1043: diff -upN
1.101     rillig   1044: rdiff -u
1.128     wiz      1045: release -d
1.101     rillig   1046: </pre>
1.75      rillig   1047: </div>
                   1048: </div>
1.148     asau     1049: <div class="sect1">
1.75      rillig   1050: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1051: <a name="uptodate"></a>3.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1.75      rillig   1052: <p>The preferred way to keep pkgsrc up-to-date is via CVS
                   1053:        (which also works if you have first installed it via a tar
                   1054:        file). It saves bandwidth and hard disk activity, compared to
                   1055:        downloading the tar file again.</p>
1.148     asau     1056: <div class="sect2">
1.75      rillig   1057: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1058: <a name="uptodate-tar"></a>3.2.1. Via tar files</h3></div></div></div>
1.148     asau     1059: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1060: <h3 class="title">Warning</h3>
1.77      rillig   1061: <p>When updating from a tar file, you first need to
                   1062:        completely remove the old pkgsrc directory. Otherwise those
                   1063:        files that have been removed from pkgsrc in the mean time will
                   1064:        not be removed on your local disk, resulting in inconsistencies.
                   1065:        When removing the old files, any changes that you have done to
                   1066:        the pkgsrc files will be lost after updating. Therefore updating
                   1067:        via CVS is strongly recommended.</p>
1.75      rillig   1068: </div>
1.82      rillig   1069: <p>Note that by default the distfiles and the binary packages
                   1070:        are saved in the pkgsrc tree, so don't forget to rescue them
1.188     snj      1071:        before updating. You can also configure pkgsrc to store distfiles
                   1072:         and packages in directories outside the pkgsrc tree by setting the
1.82      rillig   1073:        <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.267     rillig   1074:        variables. See <a class="xref" href="#configuring" title="Chapter 6. Configuring pkgsrc">Chapter 6, <i>Configuring pkgsrc</i></a> for the details.</p>
1.75      rillig   1075: <p>To update pkgsrc from a tar file, download the tar file as
                   1076:        explained above. Then, make sure that you have not made any
                   1077:        changes to the files in the pkgsrc directory. Remove the pkgsrc
                   1078:        directory and extract the new tar file. Done.</p>
                   1079: </div>
1.148     asau     1080: <div class="sect2">
1.75      rillig   1081: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1082: <a name="uptodate-cvs"></a>3.2.2. Via CVS</h3></div></div></div>
1.132     spz      1083: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
                   1084: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc &amp;&amp; cvs update -dP</code></strong>
                   1085: </pre>
                   1086: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable as described above. E.g.:</p>
                   1087: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc &amp;&amp; env CVS_RSH=ssh cvs up -dP</code></strong>
                   1088: </pre>
1.148     asau     1089: <div class="sect3">
1.75      rillig   1090: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   1091: <a name="uptodate-cvs-switch"></a>3.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1.75      rillig   1092: <p>When updating pkgsrc, the CVS program keeps track of the
                   1093:        branch you selected. But if you, for whatever reason, want to
                   1094:        switch from the stable branch to the current one, you can do it
1.128     wiz      1095:        by adding the option <span class="quote">&#8220;<span class="quote">-A</span>&#8221;</span> after the
                   1096:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> keyword. To switch from the current branch
1.75      rillig   1097:        back to the stable branch, add the
1.270     leot     1098:        <span class="quote">&#8220;<span class="quote">-rpkgsrc-2019Q2</span>&#8221;</span> option.</p>
1.75      rillig   1099: </div>
1.148     asau     1100: <div class="sect3">
1.75      rillig   1101: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   1102: <a name="uptodate-cvs-changes"></a>3.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1.75      rillig   1103: <p>When you update pkgsrc, the CVS program will only touch
                   1104:        those files that are registered in the CVS repository. That
                   1105:        means that any packages that you created on your own will stay
                   1106:        unmodified. If you change files that are managed by CVS, later
                   1107:        updates will try to merge your changes with those that have been
                   1108:        done by others. See the CVS manual, chapter
1.128     wiz      1109:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for details.</p>
1.75      rillig   1110: </div>
                   1111: </div>
                   1112: </div>
                   1113: </div>
1.148     asau     1114: <div class="chapter">
1.75      rillig   1115: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   1116: <a name="platforms"></a>Chapter 4. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1.75      rillig   1117: <div class="toc">
                   1118: <p><b>Table of Contents</b></p>
1.210     leot     1119: <dl class="toc">
1.267     rillig   1120: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
                   1121: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75      rillig   1122: </dl>
                   1123: </div>
1.148     asau     1124: <div class="sect1">
1.75      rillig   1125: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1126: <a name="binarydist"></a>4.1. Binary distribution</h2></div></div></div>
                   1127: <p>See <a class="xref" href="#using-pkg" title="5.1. Using binary packages">Section 5.1, &#8220;Using binary packages&#8221;</a>.</p>
1.82      rillig   1128: </div>
1.148     asau     1129: <div class="sect1">
1.82      rillig   1130: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1131: <a name="bootstrapping-pkgsrc"></a>4.2. Bootstrapping pkgsrc</h2></div></div></div>
1.149     asau     1132: <p>pkgsrc can be bootstrapped for use in two different modes:
                   1133:     privileged and unprivileged one. In unprivileged mode in contrast
1.150     asau     1134:     to privileged one all programs are installed under one particular user
1.149     asau     1135:     and cannot utilise privileged operations (packages don't create
                   1136:     special users and all special file permissions like setuid are ignored).
                   1137:     </p>
1.82      rillig   1138: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75      rillig   1139: <pre class="screen">
1.167     asau     1140: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.75      rillig   1141: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87      wiz      1142: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
                   1143:     </pre>
1.149     asau     1144: <p>To bootstrap in unprivileged mode pass <span class="quote">&#8220;<span class="quote">--unprivileged</span>&#8221;</span> flag to <span class="command"><strong>bootstrap</strong></span></p>
                   1145: <p>By default, in privileged mode pkgsrc uses
                   1146:     <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
                   1147:     where programs will be installed in,
1.230     sevan    1148:     and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.149     asau     1149:     directory where pkgsrc will do its internal bookkeeping,
                   1150:     <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
                   1151:     where packages install their persistent data.
                   1152:     In unprivileged mode pkgsrc uses
                   1153:     <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.230     sevan    1154:     <code class="filename">~/pkg/pkgdb</code> for the package database,
1.149     asau     1155:     and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
                   1156:     </p>
                   1157: <p>You can change default layout using command-line arguments.
                   1158:     Run <span class="quote">&#8220;<span class="quote">./bootstrap --help</span>&#8221;</span> to get details.
                   1159:     </p>
1.148     asau     1160: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1161: <h3 class="title">Note</h3>
1.110     hubertf  1162: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
                   1163:       Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
                   1164:       For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.128     wiz      1165:       instead of <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span>.</p>
1.75      rillig   1166: </div>
1.149     asau     1167: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1168: <h3 class="title">Note</h3>
                   1169: <p>It is possible to bootstrap multiple instances of pkgsrc
                   1170:       using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
                   1171:       corresponding to the installation you're working with to build
                   1172:       and install packages.
                   1173:       </p>
                   1174: </div>
1.75      rillig   1175: </div>
                   1176: </div>
1.148     asau     1177: <div class="chapter">
1.75      rillig   1178: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   1179: <a name="using"></a>Chapter 5. Using pkgsrc</h2></div></div></div>
1.75      rillig   1180: <div class="toc">
                   1181: <p><b>Table of Contents</b></p>
1.210     leot     1182: <dl class="toc">
1.267     rillig   1183: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75      rillig   1184: <dd><dl>
1.267     rillig   1185: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
                   1186: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
                   1187: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.3. Deinstalling packages</a></span></dt>
                   1188: <dt><span class="sect2"><a href="#using.pkg_info">5.1.4. Getting information about installed packages</a></span></dt>
                   1189: <dt><span class="sect2"><a href="#vulnerabilities">5.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                   1190: <dt><span class="sect2"><a href="#pkg_versions">5.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                   1191: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.7. Other administrative functions</a></span></dt>
                   1192: </dl></dd>
                   1193: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
                   1194: <dd><dl>
                   1195: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
                   1196: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
                   1197: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.75      rillig   1198: </dl></dd>
                   1199: </dl>
                   1200: </div>
                   1201: <p>Basically, there are two ways of using pkgsrc. The first
1.88      wiz      1202: is to only install the package tools and to use binary packages
1.128     wiz      1203: that someone else has prepared. This is the <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>
                   1204: in pkgsrc. The second way is to install the <span class="quote">&#8220;<span class="quote">src</span>&#8221;</span>
1.88      wiz      1205: of pkgsrc, too. Then you are able to build your own packages,
                   1206: and you can still use binary packages from someone else.</p>
1.148     asau     1207: <div class="sect1">
1.75      rillig   1208: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1209: <a name="using-pkg"></a>5.1. Using binary packages</h2></div></div></div>
1.264     sevan    1210: <p>On the <a class="ulink" href="https://cdn.NetBSD.org/" target="_top">cdn.NetBSD.org</a>
                   1211:   site and mirrors, there are collections of binary packages,
1.109     rillig   1212:   ready to be installed. These binary packages have been built using the
                   1213:   default settings for the directories, that is:</p>
1.148     asau     1214: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1215: <li class="listitem"><p><code class="filename">/usr/pkg</code> for <code class="varname">LOCALBASE</code>, where most of the files are installed,</p></li>
                   1216: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
                   1217: <li class="listitem"><p><code class="filename">/var</code> for <code class="varname">VARBASE</code>, where those files are installed that may change after installation.</p></li>
1.109     rillig   1218: </ul></div>
                   1219: <p>If you cannot use these directories for whatever reasons (maybe
                   1220:   because you're not root), you cannot use these binary packages, but
1.267     rillig   1221:   have to build the packages yourself, which is explained in <a class="xref" href="#bootstrapping-pkgsrc" title="4.2. Bootstrapping pkgsrc">Section 4.2, &#8220;Bootstrapping pkgsrc&#8221;</a>.</p>
1.148     asau     1222: <div class="sect2">
1.75      rillig   1223: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1224: <a name="finding-binary-packages"></a>5.1.1. Finding binary packages</h3></div></div></div>
1.105     weinem   1225: <p>To install binary packages, you first need to know from where
                   1226:     to get them. The first place where you should look is on the main
1.264     sevan    1227:     pkgsrc FTP server in the directory <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/packages/" target="_top"><code class="filename">/pub/pkgsrc/packages</code></a>.</p>
1.105     weinem   1228: <p>This directory contains binary packages for multiple
                   1229:     platforms. First, select your operating system. (Ignore the
                   1230:     directories with version numbers attached to it, they just exist for
                   1231:     legacy reasons.) Then, select your hardware architecture, and in the
1.128     wiz      1232:     third step, the OS version and the <span class="quote">&#8220;<span class="quote">version</span>&#8221;</span> of pkgsrc.</p>
1.109     rillig   1233: <p>In this directory, you often find a file called
                   1234:     <code class="filename">bootstrap.tar.gz</code> which contains the package
                   1235:     management tools. If the file is missing, it is likely that your
                   1236:     operating system already provides those tools. Download the file and
                   1237:     extract it in the <code class="filename">/</code> directory. It will create
                   1238:     the directories <code class="filename">/usr/pkg</code> (containing the tools
1.230     sevan    1239:     for managing binary packages and the database of installed packages).</p>
1.75      rillig   1240: </div>
1.148     asau     1241: <div class="sect2">
1.75      rillig   1242: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1243: <a name="installing-binary-packages"></a>5.1.2. Installing binary packages</h3></div></div></div>
1.109     rillig   1244: <p>In the directory from the last section, there is a
1.196     wiz      1245:     subdirectory called <code class="filename">All/</code>, which contains all the
1.109     rillig   1246:     binary packages that are available for the platform, excluding those
                   1247:     that may not be distributed via FTP or CDROM (depending on which
1.128     wiz      1248:     medium you are using).</p>
1.109     rillig   1249: <p>To install packages directly from an FTP or HTTP server, run
                   1250:     the following commands in a Bourne-compatible shell (be sure to
1.110     hubertf  1251:     <span class="command"><strong>su</strong></span> to root first):</p>
1.109     rillig   1252: <pre class="screen">
                   1253: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1.264     sevan    1254: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="http://cdn.NetBSD.org/pub/pkgsrc/packages/<em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>VERSIONS</code></em>/All/"</code></strong>
1.109     rillig   1255: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
                   1256: </pre>
                   1257: <p>Instead of URLs, you can also use local paths, for example if
                   1258:     you are installing from a set of CDROMs, DVDs or an NFS-mounted
                   1259:     repository. If you want to install packages from multiple sources,
                   1260:     you can separate them by a semicolon in
                   1261:     <code class="varname">PKG_PATH</code>.</p>
                   1262: <p>After these preparations, installing a package is very
                   1263:     easy:</p>
                   1264: <pre class="screen">
1.230     sevan    1265: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add libreoffice</code></strong>
                   1266: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap24-php71-*</code></strong>
1.109     rillig   1267: </pre>
1.75      rillig   1268: <p>Note that any prerequisite packages needed to run the
1.88      wiz      1269:     package in question will be installed, too, assuming they are
                   1270:     present where you install from.</p>
1.128     wiz      1271: <p>Adding packages might install vulnerable packages.
                   1272:     Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
                   1273:     regularly, especially after installing new packages, and verify
                   1274:     that the vulnerabilities are acceptable for your configuration.</p>
1.75      rillig   1275: <p>After you've installed packages, be sure to have
1.88      wiz      1276:     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
                   1277:     <code class="varname">PATH</code> so you can actually start the just
                   1278:     installed program.</p>
1.75      rillig   1279: </div>
1.148     asau     1280: <div class="sect2">
1.75      rillig   1281: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1282: <a name="using.pkg_delete"></a>5.1.3. Deinstalling packages</h3></div></div></div>
1.82      rillig   1283: <p>To deinstall a package, it does not matter whether it was
1.88      wiz      1284:     installed from source code or from a binary package. The
1.110     hubertf  1285:     <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
                   1286:     To delete a package, you can just run <span class="command"><strong>pkg_delete
1.88      wiz      1287:     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
                   1288:     name can be given with or without version number. Wildcards can
                   1289:     also be used to deinstall a set of packages, for example
                   1290:     <code class="literal">*emacs*</code>. Be sure to include them in quotes,
                   1291:     so that the shell does not expand them before
                   1292:     <code class="literal">pkg_delete</code> sees them.</p>
1.82      rillig   1293: <p>The <code class="option">-r</code> option is very powerful: it
1.88      wiz      1294:     removes all the packages that require the package in question
                   1295:     and then removes the package itself. For example:
1.82      rillig   1296: 
1.88      wiz      1297:     </p>
1.82      rillig   1298: <pre class="screen">
1.88      wiz      1299: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
                   1300:     </pre>
1.82      rillig   1301: <p>
                   1302: 
1.88      wiz      1303:     will remove jpeg and all the packages that used it; this allows
                   1304:     upgrading the jpeg package.</p>
1.82      rillig   1305: </div>
1.148     asau     1306: <div class="sect2">
1.82      rillig   1307: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1308: <a name="using.pkg_info"></a>5.1.4. Getting information about installed packages</h3></div></div></div>
1.110     hubertf  1309: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.88      wiz      1310:     installed packages or binary package files.</p>
1.82      rillig   1311: </div>
1.148     asau     1312: <div class="sect2">
1.82      rillig   1313: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1314: <a name="vulnerabilities"></a>5.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1.82      rillig   1315: <p>
1.88      wiz      1316:       The NetBSD Security-Officer and Packages Groups maintain a list of
                   1317:       known security vulnerabilities to packages which are (or have been)
                   1318:       included in pkgsrc.  The list is available from the NetBSD
1.264     sevan    1319:       FTP site at <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">http://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
1.88      wiz      1320:     </p>
1.82      rillig   1321: <p>
1.125     wiz      1322:       Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88      wiz      1323:       this list can be downloaded
                   1324:       automatically, and a security audit of all packages installed on a system
                   1325:       can take place.
                   1326:     </p>
1.82      rillig   1327: <p>
1.125     wiz      1328:       There are two components to auditing.  The first
                   1329:       step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
                   1330:       is for downloading
1.88      wiz      1331:       the list of vulnerabilities from the NetBSD FTP site.  The second
1.125     wiz      1332:       step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88      wiz      1333:       installed packages are vulnerable.  If a package is vulnerable, you
                   1334:       will see output similar to the following:
                   1335:     </p>
1.82      rillig   1336: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88      wiz      1337:     http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82      rillig   1338: <p>
1.125     wiz      1339:       You may wish to have the
1.264     sevan    1340:       <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125     wiz      1341:       file downloaded daily so that
                   1342:       it remains current.  This may be done by adding an appropriate entry
1.270     leot     1343:       to the root users <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?crontab+5.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry.  For example the entry
1.125     wiz      1344:       </p>
                   1345: <pre class="screen">
1.233     sevan    1346: # Download vulnerabilities file
1.230     sevan    1347: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities &gt;/dev/null 2&gt;&amp;1
1.233     sevan    1348: # Audit the installed packages and email results to root
                   1349: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
                   1350:            root &gt;/dev/null 2&gt;&amp;1
1.125     wiz      1351:       </pre>
                   1352: <p>
1.230     sevan    1353:       will update the vulnerability list every day at 3AM, followed by an audit
                   1354:       at 3:09AM. The result of the audit are then emailed to root.
1.125     wiz      1355: 
1.230     sevan    1356:       On NetBSD this may be accomplished instead by adding the following
                   1357:       line to <code class="filename">/etc/daily.conf</code>:
                   1358:       </p>
                   1359: <pre class="screen">
                   1360: fetch_pkg_vulnerabilities=YES
                   1361:       </pre>
                   1362: <p>
                   1363:       to fetch the vulnerability list from the daily security script. The system
                   1364:       is set to audit the packages by default but can be set explicitly, if
1.235     yyamano  1365:       desired (not required), by adding the following line to
1.230     sevan    1366: <code class="filename">/etc/security.conf</code>:
1.125     wiz      1367:       </p>
                   1368: <pre class="screen">
1.230     sevan    1369: check_pkg_vulnerabilities=YES
1.125     wiz      1370:       </pre>
                   1371: <p>
1.270     leot     1372:       see <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?daily.conf+5.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">daily.conf</span>(5)</span></a> and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?security.conf+5.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">security.conf</span>(5)</span></a> for more details.
1.88      wiz      1373:     </p>
1.82      rillig   1374: </div>
1.148     asau     1375: <div class="sect2">
1.82      rillig   1376: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1377: <a name="pkg_versions"></a>5.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1.82      rillig   1378: <p>
1.250     leot     1379:       Install <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a> and run
1.128     wiz      1380:       <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">&#8220;<span class="quote">-i</span>&#8221;</span>
1.88      wiz      1381:       argument to check if your packages are up-to-date, e.g.
                   1382:     </p>
                   1383: <pre class="screen">
                   1384: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82      rillig   1385: ...
1.88      wiz      1386: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   1387:     </pre>
1.110     hubertf  1388: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.88      wiz      1389:     package on your system and rebuild any dependencies.
                   1390:     </p>
1.82      rillig   1391: </div>
1.148     asau     1392: <div class="sect2">
1.82      rillig   1393: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1394: <a name="using.pkg_admin"></a>5.1.7. Other administrative functions</h3></div></div></div>
1.110     hubertf  1395: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88      wiz      1396:     administrative functions on the package system.</p>
1.82      rillig   1397: </div>
1.75      rillig   1398: </div>
1.148     asau     1399: <div class="sect1">
1.75      rillig   1400: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1401: <a name="building-packages-from-source"></a>5.2. Building packages from source</h2></div></div></div>
1.88      wiz      1402: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
                   1403:   directory now contains a set of packages, organized into
                   1404:   categories. You can browse the online index of packages, or run
1.110     hubertf  1405:   <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88      wiz      1406:   directory to build local <code class="filename">README.html</code> files for
1.250     leot     1407:   all packages, viewable with any web browser such as <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/README.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
1.88      wiz      1408: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
                   1409:   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
                   1410:   should do so by setting <code class="varname">LOCALBASE</code> in
1.110     hubertf  1411:   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88      wiz      1412:   different <code class="varname">LOCALBASE</code> definitions on the same
                   1413:   system (inside a chroot is an exception). </p>
                   1414: <p>The rest of this chapter assumes that the package is already
1.110     hubertf  1415:   in pkgsrc. If it is not, see <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, &#8220;The pkgsrc developer's guide&#8221;</a> for
1.88      wiz      1416:   instructions how to create your own packages.</p>
1.148     asau     1417: <div class="sect2">
1.75      rillig   1418: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1419: <a name="requirements"></a>5.2.1. Requirements</h3></div></div></div>
1.82      rillig   1420: <p>To build packages from source, you need a working C
1.88      wiz      1421:     compiler. On NetBSD, you need to install the
1.128     wiz      1422:     <span class="quote">&#8220;<span class="quote">comp</span>&#8221;</span> and the <span class="quote">&#8220;<span class="quote">text</span>&#8221;</span> distribution
1.88      wiz      1423:     sets. If you want to build X11-related packages, the
1.128     wiz      1424:     <span class="quote">&#8220;<span class="quote">xbase</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">xcomp</span>&#8221;</span> distribution
1.88      wiz      1425:     sets are required, too.</p>
1.75      rillig   1426: </div>
1.148     asau     1427: <div class="sect2">
1.75      rillig   1428: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1429: <a name="fetching-distfiles"></a>5.2.2. Fetching distfiles</h3></div></div></div>
1.75      rillig   1430: <p>The first step for building a package is downloading the
1.88      wiz      1431:     distfiles (i.e. the unmodified source). If they have not yet been
                   1432:     downloaded, pkgsrc will fetch them automatically.</p>
                   1433: <p>If you have all files that you need in the
                   1434:     <code class="filename">distfiles</code> directory,
                   1435:     you don't need to connect. If the distfiles are on CD-ROM, you can
                   1436:     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
                   1437:     </p>
1.82      rillig   1438: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
                   1439: <p>
1.110     hubertf  1440:     to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91      rillig   1441: <p>By default a list of distribution sites will be randomly
                   1442:     intermixed to prevent huge load on servers which holding popular
                   1443:     packages (for example, SourceForge.net mirrors). Thus, every
                   1444:     time when you need to fetch yet another distfile all the mirrors
                   1445:     will be tried in new (random) order. You can turn this feature
                   1446:     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
                   1447:     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88      wiz      1448: <p>You can overwrite some of the major distribution sites to
                   1449:     fit to sites that are close to your own.  By setting one or two
                   1450:     variables you can modify the order in which the master sites are
                   1451:     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
                   1452:     delimited list of domain suffixes.
                   1453:     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
                   1454:     contains a whitespace delimited list of regular expressions.  It
                   1455:     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
                   1456:     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
                   1457:     some examples.  This may save some of your bandwidth and
                   1458:     time.</p>
1.75      rillig   1459: <p>You can change these settings either in your shell's environment, or,
1.88      wiz      1460:     if you want to keep the settings, by editing the
1.110     hubertf  1461:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88      wiz      1462:     and adding the definitions there.</p>
1.82      rillig   1463: <p>
1.88      wiz      1464:       If a package depends on many other packages (such as
1.250     leot     1465:       <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/README.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a>), the build process may
1.88      wiz      1466:       alternate between periods of
                   1467:       downloading source, and compiling. To ensure you have all the source
                   1468:       downloaded initially you can run the command:
                   1469:       </p>
1.82      rillig   1470: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
                   1471: <p>
1.88      wiz      1472:       which will output and run a set of shell commands to fetch the
                   1473:       necessary files into the <code class="filename">distfiles</code> directory.  You can
                   1474:       also choose to download the files manually.
                   1475:     </p>
1.75      rillig   1476: </div>
1.148     asau     1477: <div class="sect2">
1.75      rillig   1478: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1479: <a name="how-to-build-and-install"></a>5.2.3. How to build and install</h3></div></div></div>
1.82      rillig   1480: <p>
1.88      wiz      1481:       Once the software has downloaded, any patches will be applied, then it
                   1482:       will be compiled for you. This may take some time depending on your
                   1483:       computer, and how many other packages the software depends on and their
                   1484:       compile time.
                   1485:     </p>
1.148     asau     1486: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1487: <h3 class="title">Note</h3>
                   1488: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110     hubertf  1489:     use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.128     wiz      1490:     <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> in the examples in this guide.</p>
1.75      rillig   1491: </div>
1.87      wiz      1492: <p>For example, type</p>
1.88      wiz      1493: <pre class="screen">
                   1494: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   1495: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   1496:     </pre>
1.75      rillig   1497: <p>at the shell prompt to build the various components of the
1.88      wiz      1498:     package.</p>
1.82      rillig   1499: <p>The next stage is to actually install the newly compiled
1.88      wiz      1500:     program onto your system. Do this by entering:
1.82      rillig   1501: 
1.88      wiz      1502:     </p>
1.82      rillig   1503: <pre class="screen">
1.88      wiz      1504: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
                   1505:     </pre>
1.82      rillig   1506: <p>
                   1507: 
1.88      wiz      1508:     while you are still in the directory for whatever package you
                   1509:     are installing.</p>
1.82      rillig   1510: <p>Installing the package on your system may require you to
1.88      wiz      1511:     be root.  However, pkgsrc has a
                   1512:     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
                   1513:     to only become root for the actual installation step.</p>
1.82      rillig   1514: <p>That's it, the software should now be installed and setup for use.
1.88      wiz      1515:     You can now enter:
1.82      rillig   1516: 
1.88      wiz      1517:     </p>
1.82      rillig   1518: <pre class="screen">
1.88      wiz      1519: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
                   1520:     </pre>
1.82      rillig   1521: <p>
                   1522: 
1.88      wiz      1523:     to remove the compiled files in the work directory, as you shouldn't need
                   1524:     them any more. If other packages were also added to your system
                   1525:     (dependencies) to allow your program to compile, you can tidy these up
                   1526:     also with the command:</p>
1.82      rillig   1527: <pre class="screen">
1.88      wiz      1528: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
                   1529:     </pre>
1.75      rillig   1530: <p>Taking the figlet utility as an example, we can install it on our
1.110     hubertf  1531:     system by building as shown in <a class="xref" href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
1.88      wiz      1532: <p>The program is installed under the default root of the
                   1533:     packages tree - <code class="filename">/usr/pkg</code>. Should this not
                   1534:     conform to your tastes, set the <code class="varname">LOCALBASE</code>
                   1535:     variable in your environment, and it will use that value as the
                   1536:     root of your packages tree. So, to use
                   1537:     <code class="filename">/usr/local</code>, set
                   1538:     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
                   1539:     Please note that you should use a directory which is dedicated to
                   1540:     packages and not shared with other programs (i.e., do not try and
                   1541:     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
                   1542:     to add any of your own files or directories (such as
                   1543:     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
                   1544:     <code class="filename">pkgsrc/</code>) below the
                   1545:     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
                   1546:     conflicts between programs and other files installed by the
                   1547:     package system and whatever else may have been installed
                   1548:     there.</p>
1.110     hubertf  1549: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88      wiz      1550:     alter some configuration options at build time.  Have a look at
                   1551:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
                   1552:     of what will be set there by default.  Environment variables such
                   1553:     as <code class="varname">LOCALBASE</code> can be set in
1.110     hubertf  1554:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88      wiz      1555:     set them each time you want to use pkgsrc.</p>
1.128     wiz      1556: <p>Occasionally, people want to <span class="quote">&#8220;<span class="quote">look under the
                   1557:     covers</span>&#8221;</span> to see what is going on when a package is building
1.88      wiz      1558:     or being installed. This may be for debugging purposes, or out of
                   1559:     simple curiosity. A number of utility values have been added to
                   1560:     help with this.</p>
1.128     wiz      1561: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1562: <li class="listitem">
1.270     leot     1563: <p>If you invoke the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.88      wiz      1564:        <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
                   1565:        information will be displayed. For example,</p>
1.75      rillig   1566: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88      wiz      1567: <p>will show all the commands that are invoked, up to and
1.128     wiz      1568:        including the <span class="quote">&#8220;<span class="quote">patch</span>&#8221;</span> stage.</p>
1.75      rillig   1569: </li>
1.128     wiz      1570: <li class="listitem">
1.270     leot     1571: <p>If you want to know the value of a certain <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      1572:        definition, then the <code class="varname">VARNAME</code> definition
                   1573:        should be used, in conjunction with the show-var
1.270     leot     1574:        target. e.g. to show the expansion of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      1575:        variable <code class="varname">LOCALBASE</code>:</p>
                   1576: <pre class="screen">
                   1577: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75      rillig   1578: /usr/pkg
                   1579: <code class="prompt">%</code>
1.88      wiz      1580:        </pre>
1.75      rillig   1581: </li>
                   1582: </ol></div>
                   1583: <p>If you want to install a binary package that you've either
1.88      wiz      1584:     created yourself (see next section), that you put into
                   1585:     pkgsrc/packages manually or that is located on a remote FTP
                   1586:     server, you can use the "bin-install" target. This target will
1.270     leot     1587:     install a binary package - if available - via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.110     hubertf  1588:     else do a <span class="command"><strong>make package</strong></span>.  The list of remote FTP
1.88      wiz      1589:     sites searched is kept in the variable
                   1590:     <code class="varname">BINPKG_SITES</code>, which defaults to
1.270     leot     1591:     ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.88      wiz      1592:     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
                   1593:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
                   1594:     details.</p>
                   1595: <p>A final word of warning: If you set up a system that has a
                   1596:     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
                   1597:     set that before any packages are installed, as you cannot use
                   1598:     several directories for the same purpose. Doing so will result in
                   1599:     pkgsrc not being able to properly detect your installed packages,
                   1600:     and fail miserably. Note also that precompiled binary packages are
                   1601:     usually built with the default <code class="varname">LOCALBASE</code> of
                   1602:     <code class="filename">/usr/pkg</code>, and that you should
                   1603:     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
                   1604:     <code class="varname">LOCALBASE</code>.</p>
1.75      rillig   1605: </div>
                   1606: </div>
                   1607: </div>
1.148     asau     1608: <div class="chapter">
1.75      rillig   1609: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   1610: <a name="configuring"></a>Chapter 6. Configuring pkgsrc</h2></div></div></div>
1.75      rillig   1611: <div class="toc">
                   1612: <p><b>Table of Contents</b></p>
1.210     leot     1613: <dl class="toc">
1.267     rillig   1614: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
                   1615: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
                   1616: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
                   1617: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
                   1618: <dd><dl>
                   1619: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
                   1620: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                   1621: <dt><span class="sect2"><a href="#conf.ldflags">6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz      1622: </dl></dd>
1.267     rillig   1623: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
                   1624: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.75      rillig   1625: </dl>
                   1626: </div>
1.104     rillig   1627: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89      rillig   1628: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
                   1629: that file depends on the installation. On NetBSD, when you use
1.270     leot     1630: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.89      rillig   1631: <code class="filename">/etc/</code>. In all other cases the default location is
                   1632: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
                   1633: bootstrap program to install the binary packages.</p>
                   1634: <p>The format of the configuration file is that of the usual
                   1635: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
                   1636: is done by setting variables in this file. Note that you can define all
                   1637: kinds of variables, and no special error checking (for example for
1.223     rillig   1638: spelling mistakes) takes place.</p>
1.148     asau     1639: <div class="sect1">
1.75      rillig   1640: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1641: <a name="general-configuration"></a>6.1. General configuration</h2></div></div></div>
1.223     rillig   1642: <p>The following variables apply to all
1.89      rillig   1643:     pkgsrc packages. A complete list of the variables that can be
                   1644:     configured by the user is available in
                   1645:     <code class="filename">mk/defaults/mk.conf</code>, together with some
                   1646:     comments that describe each variable's intent.</p>
1.148     asau     1647: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1648: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75      rillig   1649:            packages will be installed. The default is
1.76      rillig   1650:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75      rillig   1651:            with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128     wiz      1652: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
                   1653:            <span class="quote">&#8220;<span class="quote">cross</span>&#8221;</span> category packages will be
1.75      rillig   1654:            installed. The default is
1.76      rillig   1655:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128     wiz      1656: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75      rillig   1657:            X11 is installed on the system. The default is
1.194     bsiegert 1658:            <code class="filename">/usr/X11R7</code>.</p></li>
1.128     wiz      1659: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75      rillig   1660:            downloaded copies of the original source distributions used
                   1661:            for building pkgsrc packages. The default is
1.76      rillig   1662:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128     wiz      1663: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97      rillig   1664:            database about installed packages is stored.  The default is
1.230     sevan    1665:            <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.128     wiz      1666: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75      rillig   1667:            If set, override the packages'
                   1668:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128     wiz      1669: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75      rillig   1670:            Backup location(s) for distribution files and patch files
                   1671:            if not found locally or in
1.76      rillig   1672:            <code class="filename">${MASTER_SITES}</code> or
                   1673:            <code class="filename">${PATCH_SITES}</code> respectively.
1.230     sevan    1674:            The defaults is
                   1675:            <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128     wiz      1676: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93      rillig   1677:            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
                   1678:            <em class="replaceable"><code>arch</code></em> are replaced with OS
1.128     wiz      1679:            release (<span class="quote">&#8220;<span class="quote">2.0</span>&#8221;</span>, etc.) and architecture
                   1680:            (<span class="quote">&#8220;<span class="quote">mipsel</span>&#8221;</span>, etc.).</p></li>
                   1681: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125     wiz      1682:            List of acceptable licenses. License names are case-sensitive.
                   1683:            Whenever you try to build a package whose license is not in this
                   1684:            list, you will get an error message. If the license condition is
                   1685:            simple enough, the error message will include specific
                   1686:            instructions on how to change this variable.</p></li>
1.75      rillig   1687: </ul></div>
                   1688: </div>
1.148     asau     1689: <div class="sect1">
1.75      rillig   1690: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1691: <a name="variables-affecting-build"></a>6.2. Variables affecting the build process</h2></div></div></div>
1.219     rillig   1692: <p>
1.75      rillig   1693:       </p>
1.148     asau     1694: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1695: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75      rillig   1696:            directory for the binary packages. The default is
1.76      rillig   1697:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128     wiz      1698: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75      rillig   1699:            The top level directory where, if defined, the separate
                   1700:            working directories will get created, and symbolically
1.76      rillig   1701:            linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75      rillig   1702:            This is useful for building packages on several
1.76      rillig   1703:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                   1704:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75      rillig   1705:            is local to every architecture. (It should be noted that
                   1706:            <code class="varname">PKGSRCDIR</code> should not be set by the user
1.126     jakllsch 1707:            &mdash; it is an internal definition which refers to the
1.75      rillig   1708:            root of the pkgsrc tree. It is possible to have many
                   1709:            pkgsrc tree instances.)</p></li>
1.128     wiz      1710: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75      rillig   1711:            Directory for local patches that aren't part of pkgsrc.
1.267     rillig   1712:            See <a class="xref" href="#components.patches" title="13.3. patches/*">Section 13.3, &#8220;<code class="filename">patches/*</code>&#8221;</a> for more
1.93      rillig   1713:            information.</p></li>
1.128     wiz      1714: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110     hubertf  1715:            the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75      rillig   1716:            BSD-style Makefile. If this is not set,
                   1717:            <code class="varname">MAKECONF</code> is set to
1.76      rillig   1718:            <code class="filename">/dev/null</code> to avoid picking up
                   1719:            settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.75      rillig   1720: </ul></div>
                   1721: </div>
1.148     asau     1722: <div class="sect1">
1.75      rillig   1723: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1724: <a name="variables-affecting-installation"></a>6.3. Variables affecting the installation process</h2></div></div></div>
1.256     maya     1725: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="varname">PKGSRC_KEEP_BIN_PKGSRC</code>:
                   1726:                 By default, binary packages of built packages are
1.263     leot     1727:                 preserved in <code class="filename">${PACKAGES}/All</code>. Setting
1.256     maya     1728:                this variable to "no" prevents this.</p></li></ul></div>
1.217     jnemeth  1729: <p>Packages have to support installation into a
1.103     wiz      1730:     subdirectory of <code class="varname">WRKDIR</code>. This allows a package
                   1731:     to be built, before the actual filesystem is touched. DESTDIR
                   1732:     support exists in two variations:</p>
1.148     asau     1733: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1734: <li class="listitem"><p>Basic DESTDIR support means that the package
1.131     wiz      1735:       installation and packaging is still run as root.</p></li>
                   1736: <li class="listitem"><p>Full DESTDIR support can run the complete
                   1737:       build, installation and packaging as normal user. Root
                   1738:       privileges are only needed to add packages.</p></li>
                   1739: </ul></div>
1.103     wiz      1740: <p>With basic DESTDIR support, <strong class="userinput"><code>make
                   1741:     clean</code></strong> needs to be run as root.</p>
1.118     imil     1742: <p>Considering the <code class="filename">foo/bar</code> package,
                   1743:     DESTDIR full support can be tested using the following commands
                   1744: 
                   1745: </p>
                   1746: <pre class="programlisting">
                   1747: <code class="prompt">$</code> id
                   1748: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
                   1749: <code class="prompt">$</code> mkdir $HOME/packages
                   1750: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
                   1751: </pre>
                   1752: <p>
                   1753: 
                   1754:     Verify <code class="varname">DESTDIR</code> full support, no root privileges
                   1755:     should be needed
                   1756: 
                   1757: </p>
                   1758: <pre class="programlisting">
1.174     asau     1759: <code class="prompt">$</code> make stage-install
1.118     imil     1760: </pre>
                   1761: <p>
                   1762: 
                   1763:     Create a package without root privileges
                   1764: 
                   1765: </p>
                   1766: <pre class="programlisting">
1.174     asau     1767: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.118     imil     1768: </pre>
                   1769: <p>
                   1770: 
                   1771:     For the following command, you must be able to gain root
1.270     leot     1772:     privileges using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.118     imil     1773: 
                   1774: </p>
                   1775: <pre class="programlisting">
1.174     asau     1776: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.118     imil     1777: </pre>
                   1778: <p>
                   1779: 
                   1780:     Then, as a simple user
                   1781: 
                   1782: </p>
                   1783: <pre class="programlisting">
                   1784: <code class="prompt">$</code> make clean
                   1785: </pre>
                   1786: <p>
                   1787: 
                   1788:     </p>
1.103     wiz      1789: </div>
1.148     asau     1790: <div class="sect1">
1.103     wiz      1791: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1792: <a name="conf.compiler"></a>6.4. Selecting and configuring the compiler</h2></div></div></div>
1.148     asau     1793: <div class="sect2">
1.78      rillig   1794: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1795: <a name="selecting-the-compiler"></a>6.4.1. Selecting the compiler</h3></div></div></div>
1.89      rillig   1796: <p>By default, pkgsrc will use GCC to build packages.  This may be
                   1797:     overridden by setting the following variables in /etc/mk.conf:</p>
1.148     asau     1798: <div class="variablelist"><dl class="variablelist">
1.89      rillig   1799: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
                   1800: <dd>
                   1801: <p>This is a list of values specifying the chain of
                   1802:          compilers to invoke when building packages.  Valid values
                   1803:          are:</p>
1.148     asau     1804: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.174     asau     1805: <li class="listitem"><p><code class="varname">ccc</code>:
                   1806:            Compaq C Compilers (Tru64)</p></li>
                   1807: <li class="listitem"><p><code class="varname">ccache</code>:
                   1808:            compiler cache (chainable)</p></li>
                   1809: <li class="listitem"><p><code class="varname">clang</code>:
                   1810:            Clang C and Objective-C compiler</p></li>
1.128     wiz      1811: <li class="listitem"><p><code class="varname">distcc</code>:
1.89      rillig   1812:            distributed C/C++ (chainable)</p></li>
1.174     asau     1813: <li class="listitem"><p><code class="varname">f2c</code>:
                   1814:            Fortran 77 to C compiler (chainable)</p></li>
                   1815: <li class="listitem"><p><code class="varname">icc</code>:
                   1816:            Intel C++ Compiler (Linux)</p></li>
                   1817: <li class="listitem"><p><code class="varname">ido</code>:
                   1818:            SGI IRIS Development Option cc (IRIX 5)</p></li>
1.128     wiz      1819: <li class="listitem"><p><code class="varname">gcc</code>:
1.89      rillig   1820:            GNU C/C++ Compiler</p></li>
1.174     asau     1821: <li class="listitem"><p><code class="varname">hp</code>:
                   1822:            HP-UX C/aC++ compilers</p></li>
1.128     wiz      1823: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89      rillig   1824:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.174     asau     1825: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.89      rillig   1826:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128     wiz      1827: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89      rillig   1828:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.174     asau     1829: <li class="listitem"><p><code class="varname">xlc</code>:
1.230     sevan    1830:            IBM's XL C/C++ compiler suite</p></li>
1.89      rillig   1831: </ul></div>
                   1832: <p>The default is
1.128     wiz      1833:          <span class="quote">&#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;</span>.  You can use
1.89      rillig   1834:          <code class="varname">ccache</code> and/or
                   1835:          <code class="varname">distcc</code> with an appropriate
                   1836:          <code class="varname">PKGSRC_COMPILER</code> setting,
1.128     wiz      1837:          e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;</span>.  This
1.94      dmcmahil 1838:          variable should always be terminated with a value for
                   1839:          a real compiler.  Note that only one real compiler
1.128     wiz      1840:          should be listed (e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;</span>
1.94      dmcmahil 1841:          is not allowed).</p>
1.89      rillig   1842: </dd>
                   1843: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
                   1844: <dd><p>This specifies the minimum version of GCC to use
                   1845:          when building packages.  If the system GCC doesn't
                   1846:          satisfy this requirement, then pkgsrc will build and
                   1847:          install one of the GCC packages to use instead.</p></dd>
1.266     leot     1848: <dt><span class="term"><code class="varname">PYTHON_VERSION_DEFAULT</code>:</span></dt>
1.225     maya     1849: <dd><p>Specifies which version of python to use when several
                   1850:          options are available.</p></dd>
                   1851: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
                   1852: <dd><p>Specifies the fortran compiler to use.
                   1853:          The default is <code class="varname">g95</code>, and
                   1854:          <code class="varname">gfortran</code> is an alternative.</p></dd>
                   1855: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
                   1856: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
                   1857:          <code class="varname">gfortran</code> is used, this option specifies which
                   1858:          version to use.</p></dd>
1.89      rillig   1859: </dl></div>
                   1860: </div>
1.148     asau     1861: <div class="sect2">
1.89      rillig   1862: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1863: <a name="conf.cflags"></a>6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.78      rillig   1864: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
                   1865:        please make sure to use the <code class="literal">+=</code> operator
                   1866:        instead of the <code class="literal">=</code> operator:</p>
                   1867: <pre class="programlisting">
1.100     rillig   1868: CFLAGS+=        -your -flags
1.78      rillig   1869: </pre>
                   1870: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.128     wiz      1871:        <span class="quote">&#8220;<span class="quote">+</span>&#8221;</span>) may lead to problems with packages that
1.117     jnemeth  1872:        need to add their own flags.  You may want to take a look
1.250     leot     1873:        at the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>
1.128     wiz      1874:        package if you're interested in optimization specifically
                   1875:        for the current CPU. </p>
1.78      rillig   1876: </div>
1.148     asau     1877: <div class="sect2">
1.88      wiz      1878: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1879: <a name="conf.ldflags"></a>6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.88      wiz      1880: <p>If you want to pass flags to the linker, both in the configure
                   1881: step and the build step, you can do this in two ways.  Either set
                   1882: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
                   1883: between the two is that <code class="varname">LIBS</code> will be appended to
                   1884: the command line, while <code class="varname">LDFLAGS</code> come earlier.
                   1885: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
                   1886: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
                   1887: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
                   1888: <code class="varname">CFLAGS</code>, if you do not wish to override these
                   1889: settings, use the <code class="literal">+=</code> operator:</p>
                   1890: <pre class="programlisting">
1.100     rillig   1891: LDFLAGS+=        -your -linkerflags
1.88      wiz      1892: </pre>
                   1893: </div>
1.78      rillig   1894: </div>
1.148     asau     1895: <div class="sect1">
1.78      rillig   1896: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1897: <a name="developer-advanced-settings"></a>6.5. Developer/advanced settings</h2></div></div></div>
1.194     bsiegert 1898: <p>
1.75      rillig   1899:       </p>
1.148     asau     1900: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1901: <li class="listitem">
1.75      rillig   1902: <p><code class="varname">PKG_DEVELOPER</code>:
                   1903:            Run some sanity checks that package developers want:
                   1904:            </p>
1.148     asau     1905: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128     wiz      1906: <li class="listitem"><p>make sure patches apply with zero
1.88      wiz      1907:              fuzz</p></li>
1.128     wiz      1908: <li class="listitem"><p>run check-shlibs to see that all
1.88      wiz      1909:              binaries will find their shared libs.</p></li>
1.75      rillig   1910: </ul></div>
                   1911: <p>
1.87      wiz      1912:        </p>
1.75      rillig   1913: </li>
1.128     wiz      1914: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.88      wiz      1915:        of debugging output which is displayed whilst making and
                   1916:        installing the package.  The default value for this is 0,
                   1917:        which will not display the commands as they are executed
                   1918:        (normal, default, quiet operation); the value 1 will display
                   1919:        all shell commands before their invocation, and the value 2
                   1920:        will display both the shell commands before their invocation,
1.223     rillig   1921:        as well as their actual execution progress with <span class="command"><strong>set
                   1922:        -x</strong></span>.</p></li>
1.75      rillig   1923: </ul></div>
                   1924: <p>
                   1925:     </p>
                   1926: </div>
1.148     asau     1927: <div class="sect1">
1.75      rillig   1928: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1929: <a name="selecting-build-options"></a>6.6. Selecting Build Options</h2></div></div></div>
1.88      wiz      1930: <p>Some packages have build time options, usually to select
                   1931:     between different dependencies, enable optional support for big
                   1932:     dependencies or enable experimental features.</p>
1.75      rillig   1933: <p>To see which options, if any, a package supports, and which
1.110     hubertf  1934:     options are mutually exclusive, run <span class="command"><strong>make
1.88      wiz      1935:     show-options</strong></span>, for example:</p>
1.75      rillig   1936: <pre class="programlisting">
                   1937:     The following options are supported by this package:
                   1938:         ssl      Enable SSL support.
                   1939:     Exactly one of the following gecko options is required:
                   1940:         firefox  Use firefox as gecko rendering engine.
                   1941:         mozilla  Use mozilla as gecko rendering engine.
                   1942:     At most one of the following database options may be selected:
                   1943:         mysql    Enable support for MySQL database.
                   1944:         pgsql    Enable support for PostgreSQL database.
1.1       grant    1945: 
1.75      rillig   1946:     These options are enabled by default: firefox
                   1947:     These options are currently enabled: mozilla ssl
1.1       grant    1948: </pre>
1.75      rillig   1949: <p>The following variables can be defined in
1.110     hubertf  1950:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88      wiz      1951:     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
                   1952:     which can be used to select or disable options for all packages
                   1953:     that support them, and
                   1954:     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
                   1955:     which can be used to select or disable options specifically for
                   1956:     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
1.128     wiz      1957:     these variables are selected, options preceded by <span class="quote">&#8220;<span class="quote">-</span>&#8221;</span>
1.88      wiz      1958:     are disabled. A few examples:</p>
1.75      rillig   1959: <pre class="screen">
1.110     hubertf  1960: <code class="prompt">$</code> <span class="command"><strong>grep "PKG.*OPTION" <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a></strong></span>
1.75      rillig   1961: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   1962: PKG_OPTIONS.kdebase=    debug -sasl
                   1963: PKG_OPTIONS.apache=     suexec </pre>
1.111     rillig   1964: <p>It is important to note that options that were specifically
1.120     snj      1965:     suggested by the package maintainer must be explicitly removed if
1.111     rillig   1966:     you do not wish to include the option.  If you are unsure you can view
                   1967:     the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88      wiz      1968: <p>The following settings are consulted in the order given, and
                   1969:     the last setting that selects or disables an option is
                   1970:     used:</p>
1.128     wiz      1971: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1972: <li class="listitem"><p>the default options as suggested by the package
1.88      wiz      1973:       maintainer</p></li>
1.128     wiz      1974: <li class="listitem"><p>the options implied by the settings of legacy
1.88      wiz      1975:       variables (see below)</p></li>
1.128     wiz      1976: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
                   1977: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.75      rillig   1978: </ol></div>
                   1979: <p>For groups of mutually exclusive options, the last option
1.88      wiz      1980:     selected is used, all others are automatically disabled.  If an
                   1981:     option of the group is explicitly disabled, the previously
                   1982:     selected option, if any, is used.  It is an error if no option
                   1983:     from a required group of options is selected, and building the
                   1984:     package will fail.</p>
                   1985: <p>Before the options framework was introduced, build options
                   1986:     were selected by setting a variable (often named
                   1987:     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110     hubertf  1988:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option.  To ease
1.88      wiz      1989:     transition to the options framework for the user, these legacy
                   1990:     variables are converted to the appropriate options setting
                   1991:     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
                   1992:     automatically.  A warning is issued to prompt the user to update
1.110     hubertf  1993:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88      wiz      1994:     directly.  Support for the legacy variables will be removed
                   1995:     eventually.</p>
1.75      rillig   1996: </div>
                   1997: </div>
1.148     asau     1998: <div class="chapter">
1.75      rillig   1999: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   2000: <a name="binary"></a>Chapter 7. Creating binary packages</h2></div></div></div>
1.75      rillig   2001: <div class="toc">
                   2002: <p><b>Table of Contents</b></p>
1.210     leot     2003: <dl class="toc">
1.267     rillig   2004: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
                   2005: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.75      rillig   2006: </dl>
                   2007: </div>
1.148     asau     2008: <div class="sect1">
1.75      rillig   2009: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2010: <a name="building-a-single-binary-package"></a>7.1. Building a single binary package</h2></div></div></div>
1.87      wiz      2011: <p>Once you have built and installed a package, you can create
                   2012:     a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.270     leot     2013:     another system with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.87      wiz      2014:     the same package on a group of hosts and wasting CPU time. It also
                   2015:     provides a simple means for others to install your package, should
                   2016:     you distribute it.</p>
                   2017: <p>To create a binary package, change into the appropriate
1.110     hubertf  2018:     directory in pkgsrc, and run <span class="command"><strong>make
1.87      wiz      2019:     package</strong></span>:</p>
                   2020: <pre class="screen">
1.223     rillig   2021: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2022: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
                   2023: </pre>
1.87      wiz      2024: <p>This will build and install your package (if not already done),
                   2025:     and then build a binary package from what was installed. You can
1.110     hubertf  2026:     then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87      wiz      2027:     it. Binary packages are created by default in
                   2028:     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.110     hubertf  2029:     gzipped tar file. See <a class="xref" href="#logs.package" title="B.2. Packaging figlet">Section B.2, &#8220;Packaging figlet&#8221;</a> for a
1.250     leot     2030:     continuation of the above <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/misc/figlet/README.html" target="_top"><code class="filename">misc/figlet</code></a> example.</p>
1.267     rillig   2031: <p>See <a class="xref" href="#submit" title="Chapter 23. Submitting and Committing">Chapter 23, <i>Submitting and Committing</i></a> for information on how to submit
1.87      wiz      2032:     such a binary package.</p>
1.75      rillig   2033: </div>
1.148     asau     2034: <div class="sect1">
1.75      rillig   2035: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2036: <a name="settings-for-creationg-of-binary-packages"></a>7.2. Settings for creation of binary packages</h2></div></div></div>
                   2037: <p>See <a class="xref" href="#build.helpful-targets" title="19.17. Other helpful targets">Section 19.17, &#8220;Other helpful targets&#8221;</a>.</p>
1.106     rillig   2038: </div>
                   2039: </div>
1.148     asau     2040: <div class="chapter">
1.106     rillig   2041: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   2042: <a name="bulk"></a>Chapter 8. Creating binary packages for everything in pkgsrc (bulk
1.106     rillig   2043: builds)</h2></div></div></div>
                   2044: <div class="toc">
                   2045: <p><b>Table of Contents</b></p>
1.210     leot     2046: <dl class="toc">
1.267     rillig   2047: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
                   2048: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a pbulk-style bulk build</a></span></dt>
                   2049: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
                   2050: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
                   2051: <dt><span class="sect1"><a href="#creating-cdroms">8.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                   2052: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.4.1. Example of cdpack</a></span></dt></dl></dd>
1.106     rillig   2053: </dl>
                   2054: </div>
1.180     wiz      2055: <p>For a number of reasons you may want to build binary packages
                   2056: for a large selected set of packages in pkgsrc or even for all pkgsrc packages.
                   2057: For instance, when you have multiple machines that should run the same software,
                   2058: it is wasted time if they all build their packages themselves from source.
                   2059: Or you may want to build a list of packages you want and check them before
                   2060: deploying onto production system.
                   2061: There is a way of getting a set of binary packages:
1.223     rillig   2062: The bulk build system, or pbulk ("p" stands for "parallel").
                   2063: This chapter describes how to set it up.</p>
1.148     asau     2064: <div class="sect1">
1.106     rillig   2065: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2066: <a name="bulk.pre"></a>8.1. Preparations</h2></div></div></div>
1.180     wiz      2067: <p>First of all, you have to decide whether you build all packages
                   2068: or a limited set of them. Full bulk builds usually consume a lot more resources,
                   2069: both space and time, than builds for some practical sets of packages.
                   2070: There exists a number of particularly heavy packages that are not actually
                   2071: interesting to a wide audience.
                   2072: 
                   2073: For a limited bulk builds you need to make a list of packages you want to build.
1.223     rillig   2074: Note that all their dependencies will be built, so you don't need to track them manually.
1.180     wiz      2075: </p>
                   2076: <p>During bulk builds various packages are installed and deinstalled
                   2077: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
                   2078: so make sure that you don't need any package during the builds.
1.223     rillig   2079: Essentially, you should provide a fresh system, either a chroot environment
1.180     wiz      2080: or something even more restrictive, depending on what the operating system provides,
                   2081: or dedicate the whole physical machine.
                   2082: As a useful side effect this makes sure that bulk builds cannot
                   2083: break anything in your system. There have been numerous cases where
1.106     rillig   2084: certain packages tried to install files outside the
                   2085: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.180     wiz      2086: <code class="filename">/etc</code>.
                   2087: </p>
1.106     rillig   2088: </div>
1.148     asau     2089: <div class="sect1">
1.106     rillig   2090: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2091: <a name="bulk.pbulk"></a>8.2. Running a pbulk-style bulk build</h2></div></div></div>
1.116     rillig   2092: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.148     asau     2093: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2094: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
                   2095: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.116     rillig   2096: </ul></div>
1.148     asau     2097: <div class="sect2">
1.116     rillig   2098: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   2099: <a name="bulk.pbulk.conf"></a>8.2.1. Configuration</h3></div></div></div>
1.223     rillig   2100: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.178     asau     2101: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
                   2102: Configure network access to fetch distribution files.
1.223     rillig   2103: Create a user with name "pbulk".</p>
1.178     asau     2104: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
                   2105: <pre class="screen">
1.264     sevan    2106: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr &amp;&amp; ftp -o - https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)</code></strong>
                   2107: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr &amp;&amp; fetch -o - https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)</code></strong>
1.181     wiz      2108: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr &amp;&amp; cvs -Q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot get -P pkgsrc)</code></strong>
1.178     asau     2109: </pre>
                   2110: <p>Or any other way that fits (e.g., curl, wget).</p>
                   2111: <p>Deploy and configure pbulk tools, e.g.:</p>
                   2112: <pre class="screen">
1.230     sevan    2113: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n # use native make, no bootstrap kit needed (for use on NetBSD)</code></strong>
1.178     asau     2114: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n -c mk.conf.frag # native, apply settings from given mk.conf fragment</code></strong>
                   2115: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
                   2116: </pre>
                   2117: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2118: <h3 class="title">Note</h3>
                   2119: <p><code class="filename">mk.conf.frag</code> is a fragment of
                   2120: <code class="filename">mk.conf</code> that contains settings you want to
                   2121: apply to packages you build. For instance,</p>
                   2122: <pre class="programlisting">
1.223     rillig   2123: PKG_DEVELOPER=          yes     # perform more checks
                   2124: X11_TYPE=               modular # use pkgsrc X11
                   2125: SKIP_LICENSE_CHECK=     yes     # accept all licences (useful
                   2126:                                 # when building all packages)
1.178     asau     2127: </pre>
                   2128: </div>
                   2129: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.223     rillig   2130: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.178     asau     2131: <pre class="programlisting">
                   2132: www/firefox
                   2133: mail/thunderbird
                   2134: misc/libreoffice4
                   2135: </pre>
1.179     asau     2136: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
                   2137: and make final amendments, if wanted.</p>
1.178     asau     2138: <p>Start it:</p>
                   2139: <pre class="screen">
                   2140: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
                   2141: </pre>
                   2142: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
                   2143: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
                   2144: </p>
                   2145: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2146: <h3 class="title">Note</h3>
                   2147: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
                   2148: While being ready to run, it serves as a good starting point to understand and build more complex setups.
                   2149: The script is kept small enough for better understanding.</p>
                   2150: </div>
                   2151: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2152: <h3 class="title">Note</h3>
                   2153: <p>The <code class="filename">pbulk.sh</code> script supports running
                   2154: unprivileged bulk build and helps configuring distributed bulk builds.</p>
                   2155: </div>
1.106     rillig   2156: </div>
                   2157: </div>
1.148     asau     2158: <div class="sect1">
1.106     rillig   2159: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2160: <a name="bulk.req"></a>8.3. Requirements of a full bulk build</h2></div></div></div>
1.180     wiz      2161: <p>A complete bulk build requires lots of disk space. Some of the
                   2162: disk space can be read-only, some other must be writable. Some can be on
                   2163: remote filesystems (such as NFS) and some should be local. Some can be
                   2164: temporary filesystems, others must survive a sudden reboot.</p>
                   2165: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   2166: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
                   2167: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
                   2168: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
                   2169: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
                   2170: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
                   2171: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
                   2172: </ul></div>
                   2173: </div>
                   2174: <div class="sect1">
                   2175: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2176: <a name="creating-cdroms"></a>8.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87      wiz      2177: <p>After your pkgsrc bulk-build has completed, you may wish to
                   2178:     create a CD-ROM set of the resulting binary packages to assist
                   2179:     in installing packages on other machines.  The
1.250     leot     2180:     <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/cdpack/README.html" target="_top"><code class="filename">pkgtools/cdpack</code></a> package provides
1.87      wiz      2181:     a simple tool for creating the ISO 9660 images.
1.110     hubertf  2182:     <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87      wiz      2183:     way that keeps all the dependencies for a given package on the same
                   2184:     CD as that package.</p>
1.148     asau     2185: <div class="sect2">
1.75      rillig   2186: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   2187: <a name="cdpack-example"></a>8.4.1. Example of cdpack</h3></div></div></div>
1.87      wiz      2188: <p>Complete documentation for cdpack is found in the cdpack(1)
                   2189:       man page. The following short example assumes that the binary
                   2190:       packages are left in
                   2191:       <code class="filename">/usr/pkgsrc/packages/All</code> and that
                   2192:       sufficient disk space exists in <code class="filename">/u2</code> to
                   2193:       hold the ISO 9660 images.</p>
                   2194: <pre class="screen">
                   2195: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75      rillig   2196: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87      wiz      2197: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
                   2198:       </pre>
                   2199: <p>If you wish to include a common set of files
                   2200:       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
                   2201:       etc.) on each CD in the collection, then you need to create a
                   2202:       directory which contains these files. e.g.</p>
                   2203: <pre class="screen">
                   2204: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75      rillig   2205: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
                   2206: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
                   2207: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
                   2208: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
                   2209: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
1.87      wiz      2210: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
                   2211:       </pre>
1.75      rillig   2212: <p>Now create the images:</p>
                   2213: <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   2214: <p>Each image will contain <code class="filename">README</code>,
1.87      wiz      2215:       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
                   2216:       in their root directories.</p>
1.75      rillig   2217: </div>
                   2218: </div>
                   2219: </div>
1.148     asau     2220: <div class="chapter">
1.75      rillig   2221: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   2222: <a name="files"></a>Chapter 9. Directory layout of the installed files</h2></div></div></div>
1.90      rillig   2223: <div class="toc">
                   2224: <p><b>Table of Contents</b></p>
1.210     leot     2225: <dl class="toc">
1.267     rillig   2226: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                   2227: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.90      rillig   2228: </dl>
                   2229: </div>
                   2230: <p>The files that are installed by pkgsrc are organized in a way that
                   2231: is similar to what you find in the <code class="filename">/usr</code> directory
                   2232: of the base system. But some details are different. This is because
                   2233: pkgsrc initially came from FreeBSD and had adopted its file system
                   2234: hierarchy. Later it was largely influenced by NetBSD. But no matter
                   2235: which operating system you are using pkgsrc with, you can expect the
                   2236: same layout for pkgsrc.</p>
1.91      rillig   2237: <p>There are mainly four root directories for pkgsrc, which are all
                   2238: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
                   2239: When pkgsrc has been installed as root, the default locations
                   2240: are:</p>
                   2241: <pre class="programlisting">
1.100     rillig   2242: LOCALBASE=              /usr/pkg
                   2243: PKG_SYSCONFBASE=        /usr/pkg/etc
                   2244: VARBASE=                /var
1.231     sevan    2245: PKG_DBDIR=              /usr/pkg/pkgdb
1.91      rillig   2246: </pre>
                   2247: <p>In unprivileged mode (when pkgsrc has been installed as any other
                   2248: user), the default locations are:</p>
                   2249: <pre class="programlisting">
1.100     rillig   2250: LOCALBASE=              ${HOME}/pkg
                   2251: PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   2252: VARBASE=                ${HOME}/pkg/var
1.231     sevan    2253: PKG_DBDIR=              ${HOME}/pkg/pkgdb
1.91      rillig   2254: </pre>
                   2255: <p>What these four directories are for, and what they look like is
                   2256: explained below.</p>
1.148     asau     2257: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2258: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.90      rillig   2259: <code class="filename">/usr</code> directory in the base system. It is the
1.128     wiz      2260: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> directory where the files are installed and contains
1.90      rillig   2261: the well-known subdirectories like <code class="filename">bin</code>,
                   2262: <code class="filename">include</code>, <code class="filename">lib</code>,
                   2263: <code class="filename">share</code> and
                   2264: <code class="filename">sbin</code>.</p></li>
1.128     wiz      2265: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.90      rillig   2266: <code class="filename">/var</code> in the base system. Some programs (especially
                   2267: games, network daemons) need write access to it during normal
                   2268: operation.</p></li>
1.128     wiz      2269: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.90      rillig   2270: <code class="filename">/etc</code> in the base system. It contains configuration
1.110     hubertf  2271: files of the packages, as well as pkgsrc's <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.90      rillig   2272: itself.</p></li>
                   2273: </ul></div>
1.148     asau     2274: <div class="sect1">
1.90      rillig   2275: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2276: <a name="files.localbase"></a>9.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93      rillig   2277: </h2></div></div></div>
1.90      rillig   2278: <p>The following directories exist in a typical pkgsrc installation
1.91      rillig   2279: in <code class="filename">${LOCALBASE}</code>.</p>
1.148     asau     2280: <div class="variablelist"><dl class="variablelist">
1.90      rillig   2281: <dt><span class="term"><code class="filename">bin</code></span></dt>
                   2282: <dd><p>Contains executable programs that are intended to be
                   2283: directly used by the end user.</p></dd>
                   2284: <dt><span class="term"><code class="filename">emul</code></span></dt>
                   2285: <dd><p>Contains files for the emulation layers of various other
                   2286: operating systems, especially for
                   2287: NetBSD.</p></dd>
                   2288: <dt><span class="term"><code class="filename">etc</code> (the usual location of
                   2289: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
                   2290: <dd><p>Contains
                   2291: the configuration files.</p></dd>
                   2292: <dt><span class="term"><code class="filename">include</code></span></dt>
                   2293: <dd><p>Contains headers for the C and C++ programming
                   2294: languages.</p></dd>
                   2295: <dt><span class="term"><code class="filename">info</code></span></dt>
                   2296: <dd><p>Contains GNU info files of various
                   2297: packages.</p></dd>
                   2298: <dt><span class="term"><code class="filename">lib</code></span></dt>
                   2299: <dd><p>Contains shared and static
                   2300: libraries.</p></dd>
                   2301: <dt><span class="term"><code class="filename">libdata</code></span></dt>
                   2302: <dd><p>Contains data files that don't change after
                   2303: installation. Other data files belong into
                   2304: <code class="filename">${VARBASE}</code>.</p></dd>
                   2305: <dt><span class="term"><code class="filename">libexec</code></span></dt>
                   2306: <dd><p>Contains programs that are not intended to be used by
                   2307: end users, such as helper programs or network
                   2308: daemons.</p></dd>
                   2309: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
                   2310: <dd><p>Contains programs that are intended to be executed as
                   2311: CGI scripts by a web server.</p></dd>
                   2312: <dt><span class="term"><code class="filename">man</code> (the usual value of
                   2313: <code class="filename">${PKGMANDIR}</code>)</span></dt>
                   2314: <dd><p>Contains brief
                   2315: documentation in form of manual pages.</p></dd>
                   2316: <dt><span class="term"><code class="filename">sbin</code></span></dt>
                   2317: <dd><p>Contains programs that are intended to be used only by
                   2318: the super-user.</p></dd>
                   2319: <dt><span class="term"><code class="filename">share</code></span></dt>
                   2320: <dd><p>Contains platform-independent data files that don't
                   2321: change after installation.</p></dd>
                   2322: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
                   2323: <dd><p>Contains documentation files provided by the
                   2324: packages.</p></dd>
                   2325: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
                   2326: <dd><p>Contains example files provided by the packages. Among
                   2327: others, the original configuration files are saved here and copied to
                   2328: <code class="filename">${PKG_SYSCONFDIR}</code> during
                   2329: installation.</p></dd>
                   2330: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
                   2331: <dd><p>Contains the original files for rc.d
                   2332: scripts.</p></dd>
                   2333: <dt><span class="term"><code class="filename">var</code> (the usual location of
                   2334: <code class="filename">${VARBASE}</code>)</span></dt>
                   2335: <dd><p>Contains files
                   2336: that may be modified after
                   2337: installation.</p></dd>
                   2338: </dl></div>
                   2339: </div>
1.148     asau     2340: <div class="sect1">
1.90      rillig   2341: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2342: <a name="files.varbase"></a>9.2. File system layout in <code class="literal">${VARBASE}</code>
1.93      rillig   2343: </h2></div></div></div>
1.148     asau     2344: <div class="variablelist"><dl class="variablelist">
1.90      rillig   2345: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
                   2346: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
                   2347: <dd><p>Contains
                   2348: information about the currently installed
                   2349: packages.</p></dd>
                   2350: <dt><span class="term"><code class="filename">games</code></span></dt>
                   2351: <dd><p>Contains highscore
                   2352: files.</p></dd>
                   2353: <dt><span class="term"><code class="filename">log</code></span></dt>
                   2354: <dd><p>Contains log files.</p></dd>
                   2355: <dt><span class="term"><code class="filename">run</code></span></dt>
                   2356: <dd><p>Contains informational files about daemons that are
                   2357: currently running.</p></dd>
                   2358: </dl></div>
                   2359: </div>
                   2360: </div>
1.148     asau     2361: <div class="chapter">
1.90      rillig   2362: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   2363: <a name="faq"></a>Chapter 10. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   2364: <div class="toc">
                   2365: <p><b>Table of Contents</b></p>
1.210     leot     2366: <dl class="toc">
1.267     rillig   2367: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                   2368: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
                   2369: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
                   2370: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
                   2371: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">10.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
                   2372: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
                   2373: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
                   2374: <dt><span class="sect1"><a href="#passive-ftp">10.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
                   2375: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
                   2376: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.128     wiz      2377: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.267     rillig   2378: <dt><span class="sect1"><a href="#bsd.own.mk-missing">10.11. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</a></span></dt>
                   2379: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
                   2380: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
                   2381: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
                   2382: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                   2383: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build.  What shall I do?</a></span></dt>
                   2384: <dt><span class="sect1"><a href="#faq.rcs-conflicts">10.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</a></span></dt>
1.75      rillig   2385: </dl>
                   2386: </div>
                   2387: <p>This section contains hints, tips &amp; tricks on special things in
                   2388: pkgsrc that we didn't find a better place for in the previous chapters, and
                   2389: it contains items for both pkgsrc users and developers.</p>
1.148     asau     2390: <div class="sect1">
1.75      rillig   2391: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2392: <a name="mailing-list-pointers"></a>10.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75      rillig   2393: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.148     asau     2394: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2395: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.78      rillig   2396:          This is a general purpose list for most issues regarding
                   2397:          pkgsrc, regardless of platform, e.g. soliciting user help
                   2398:          for pkgsrc configuration, unexpected build failures, using
                   2399:          particular packages, upgrading pkgsrc installations,
                   2400:          questions regarding the pkgsrc release branches, etc.  General announcements or
                   2401:          proposals for changes that impact the pkgsrc user community,
                   2402:          e.g. major infrastructure changes, new features, package
                   2403:          removals, etc., may also be posted.</p></li>
1.128     wiz      2404: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.75      rillig   2405:          A list where the results of pkgsrc bulk builds are sent and
                   2406:          discussed.</p></li>
1.128     wiz      2407: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.75      rillig   2408:          This list is for those who are interested in getting a
                   2409:          commit message for every change committed to pkgsrc. It is
                   2410:          also available in digest form, meaning one daily message
                   2411:          containing all commit messages for changes to the package
                   2412:          source tree in that 24 hour period.</p></li>
                   2413: </ul></div>
                   2414: <p>To subscribe, do:</p>
                   2415: <pre class="programlisting">
1.100     rillig   2416: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75      rillig   2417: </pre>
                   2418: <p>Archives for all these mailing lists are available from
1.110     hubertf  2419: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.75      rillig   2420: </div>
1.148     asau     2421: <div class="sect1">
1.75      rillig   2422: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2423: <a name="faq-pkgtools"></a>10.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.80      rillig   2424: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75      rillig   2425: a number of useful utilities for both users and developers of pkgsrc.  This
1.233     sevan    2426: section attempts only to make the reader aware of some of the utilities and when
1.75      rillig   2427: they might be useful, and not to duplicate the documentation that comes
                   2428: with each package.</p>
                   2429: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.250     leot     2430: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/x11-links/README.html" target="_top"><code class="filename">pkgtools/x11-links</code></a>:
1.75      rillig   2431:       Symlinks for use by buildlink.</p></li></ul></div>
                   2432: <p>OS tool augmentation (automatically installed when needed):</p>
1.148     asau     2433: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250     leot     2434: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/README.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.233     sevan    2435:       Calculates various kinds of checksums (including SHA3).</p></li>
1.250     leot     2436: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/README.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
1.75      rillig   2437:       Compatibility library for pkgsrc tools.</p></li>
1.250     leot     2438: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mtree/README.html" target="_top"><code class="filename">pkgtools/mtree</code></a>: Installed on
1.87      wiz      2439:       non-BSD systems due to lack of native mtree.</p></li>
1.250     leot     2440: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>:
1.75      rillig   2441:       Up-to-date replacement for
1.76      rillig   2442:       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75      rillig   2443:       systems where pkg_install is not present.</p></li>
                   2444: </ul></div>
                   2445: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.148     asau     2446: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250     leot     2447: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
1.75      rillig   2448:       Create a binary package from an
1.110     hubertf  2449:       already-installed package.  Used by <span class="command"><strong>make replace</strong></span> to
1.75      rillig   2450:       save the old package.</p></li>
1.250     leot     2451: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/README.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
1.75      rillig   2452:       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
                   2453:       from multiple locations. It currently supports the following
                   2454:       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.250     leot     2455: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>: Determine
1.117     jnemeth  2456:       the best compiler flags to optimise code for your current
1.128     wiz      2457:       CPU and compiler. </p></li>
1.75      rillig   2458: </ul></div>
                   2459: <p>Utilities for keeping track of installed packages, being up to date,
                   2460: etc:</p>
1.148     asau     2461: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250     leot     2462: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgin/README.html" target="_top"><code class="filename">pkgtools/pkgin</code></a>: A package
1.173     wiz      2463:     update tool similar to apt(1). Download, install, and upgrade
                   2464:     binary packages easily.</p></li>
1.250     leot     2465: <li class="listitem"><p><a href="https://cdn.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   2466:       packages whose installed versions do not match the latest pkgsrc
                   2467:       entries.</p></li>
1.250     leot     2468: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
1.75      rillig   2469:       dependency graphs of packages, to aid in choosing a strategy for
                   2470:       updating.</p></li>
1.250     leot     2471: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdepgraph/README.html" target="_top"><code class="filename">pkgtools/pkgdepgraph</code></a>: Makes
                   2472:       graphs from the output of <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a> (uses graphviz).</p></li>
                   2473: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
1.112     weinem   2474:       pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.250     leot     2475: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a>: The lintpkgsrc(1) program
1.75      rillig   2476:       does various checks on the complete pkgsrc system.</p></li>
1.250     leot     2477: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgsurvey/README.html" target="_top"><code class="filename">pkgtools/pkgsurvey</code></a>: Report what
1.75      rillig   2478:       packages you have installed.</p></li>
                   2479: </ul></div>
                   2480: <p>Utilities for people maintaining or creating individual packages:</p>
1.148     asau     2481: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250     leot     2482: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
1.75      rillig   2483:       making and maintaining patches for a package (includes pkgdiff,
                   2484:       pkgvi, mkpatches, etc.).</p></li>
1.250     leot     2485: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>: Aids in
1.75      rillig   2486:       converting to pkgsrc.</p></li>
                   2487: </ul></div>
                   2488: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
                   2489: utilities)</p>
1.148     asau     2490: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250     leot     2491: <li class="listitem"><p><a href="https://cdn.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   2492:       packages in a chrooted area.</p></li>
1.250     leot     2493: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/README.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
1.75      rillig   2494:       kernel version for chrooted cross builds.</p></li>
                   2495: </ul></div>
                   2496: </div>
1.148     asau     2497: <div class="sect1">
1.75      rillig   2498: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2499: <a name="non-root-pkgsrc"></a>10.3. How to use pkgsrc as non-root</h2></div></div></div>
1.219     rillig   2500: <p>To install packages from source as a non-root user, download
1.267     rillig   2501: pkgsrc as described in <a class="xref" href="#getting" title="Chapter 3. Where to get pkgsrc and how to keep it up-to-date">Chapter 3, <i>Where to get pkgsrc and how to keep it up-to-date</i></a>, cd into that
1.219     rillig   2502: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
                   2503: --unprivileged</strong></span>.</p>
                   2504: <p>This will install the binary part of pkgsrc to
                   2505: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
                   2506: into <code class="filename">~/pkg/etc</code>.</p>
                   2507: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.75      rillig   2508: </div>
1.148     asau     2509: <div class="sect1">
1.75      rillig   2510: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2511: <a name="resume-transfers"></a>10.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75      rillig   2512: <p>By default, resuming transfers in pkgsrc is disabled, but you can
                   2513: enable this feature by adding the option
                   2514: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110     hubertf  2515: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  If, during a fetch step, an incomplete
1.75      rillig   2516: distfile is found, pkgsrc will try to resume it.</p>
                   2517: <p>You can also
1.168     wiz      2518: use a different program than the platform default program by changing the
1.117     jnemeth  2519: <code class="varname">FETCH_USING</code> variable.  You can specify the program by
                   2520: using of ftp, fetch, wget or curl.  Alternatively, fetching can be disabled
                   2521: by using the value manual.  A value of custom disables the system defaults
                   2522: and dependency tracking for the fetch program.  In that case you have to
                   2523: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
                   2524: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
                   2525: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75      rillig   2526: <p>For example, if you want to use
1.117     jnemeth  2527: <code class="filename">wget</code> to download, you'll have to use something
1.75      rillig   2528: like:</p>
                   2529: <pre class="programlisting">
1.223     rillig   2530: FETCH_USING=    wget
1.1       grant    2531: </pre>
1.75      rillig   2532: </div>
1.148     asau     2533: <div class="sect1">
1.75      rillig   2534: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2535: <a name="x.org-from-pkgsrc"></a>10.5. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.103     wiz      2536: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76      rillig   2537: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75      rillig   2538: you will have to add the following line into
1.110     hubertf  2539: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75      rillig   2540: <pre class="programlisting">
1.103     wiz      2541: X11_TYPE=modular
1.1       grant    2542: </pre>
1.75      rillig   2543: </div>
1.148     asau     2544: <div class="sect1">
1.75      rillig   2545: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2546: <a name="fetch-behind-firewall"></a>10.6. How to fetch files from behind a firewall</h2></div></div></div>
1.75      rillig   2547: <p>If you are sitting behind a firewall which does not allow direct
                   2548: connections to Internet hosts (i.e. non-NAT), you may specify the
                   2549: relevant proxy hosts.  This is done using an environment variable in the
                   2550: form of a URL, e.g. in Amdahl, the machine
1.128     wiz      2551: <span class="quote">&#8220;<span class="quote">orpheus.amdahl.com</span>&#8221;</span> is one of the firewalls, and it uses
1.75      rillig   2552: port 80 as the proxy port number.  So the proxy environment variables
                   2553: are:</p>
                   2554: <pre class="programlisting">
1.100     rillig   2555: ftp_proxy=ftp://orpheus.amdahl.com:80/
                   2556: http_proxy=http://orpheus.amdahl.com:80/
1.1       grant    2557: </pre>
1.75      rillig   2558: </div>
1.148     asau     2559: <div class="sect1">
1.75      rillig   2560: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2561: <a name="fetch-https"></a>10.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.173     wiz      2562: <p>Some fetch tools are not prepared to support HTTPS by default
                   2563: (for example, the one in NetBSD 6.0), or the one installed by the
                   2564: pkgsrc bootstrap (to avoid an openssl dependency that low in the
                   2565: dependency graph).</p>
                   2566: <p>Usually you won't notice, because distribution files are
                   2567: mirrored weekly to <span class="quote">&#8220;<span class="quote">ftp.NetBSD.org</span>&#8221;</span>, but that might not
                   2568: be often enough if you are following pkgsrc-current. In that case, set
                   2569: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
                   2570: <span class="quote">&#8220;<span class="quote">curl</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">wget</span>&#8221;</span>, which are both compiled
                   2571: with HTTPS support by default. Of course, these tools need to be
                   2572: installed before you can use them this way.</p>
                   2573: </div>
                   2574: <div class="sect1">
                   2575: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2576: <a name="passive-ftp"></a>10.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.75      rillig   2577: <p>This depends on which utility is used to retrieve distfiles.  From
1.76      rillig   2578: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75      rillig   2579: the first available command from the following list:</p>
1.148     asau     2580: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2581: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
                   2582: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75      rillig   2583: </ul></div>
                   2584: <p>On a default NetBSD installation, this will be
1.76      rillig   2585: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75      rillig   2586: connections first, and falls back to active connections if the server
                   2587: refuses to do passive.  For the other tools, add the following to your
1.110     hubertf  2588: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75      rillig   2589: <code class="varname">PASSIVE_FETCH=1</code>.</p>
                   2590: <p>Having that option present will prevent
1.76      rillig   2591: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75      rillig   2592: transfers.</p>
                   2593: </div>
1.148     asau     2594: <div class="sect1">
1.75      rillig   2595: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2596: <a name="fetching-all-distfiles"></a>10.9. How to fetch all distfiles at once</h2></div></div></div>
1.88      wiz      2597: <p>You would like to download all the distfiles in a single batch
1.110     hubertf  2598: from work or university, where you can't run a <span class="command"><strong>make
1.132     spz      2599: fetch</strong></span>.  There is an archive of distfiles on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/" target="_top">ftp.NetBSD.org</a>,
1.75      rillig   2600: but downloading the entire directory may not be appropriate.</p>
1.110     hubertf  2601: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76      rillig   2602: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75      rillig   2603: resulting list to your machine at work/school and use it there.  If you
1.270     leot     2604: don't have a NetBSD-compatible <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.75      rillig   2605: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
                   2606: URL:</p>
                   2607: <p>At home:</p>
                   2608: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   2609: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
                   2610: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
                   2611: <p>At work:</p>
                   2612: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76      rillig   2613: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75      rillig   2614: home.</p>
                   2615: <p>If you have a machine running NetBSD, and you want to get
1.88      wiz      2616: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
                   2617: machine architecture), you can do so by using the above-mentioned
1.110     hubertf  2618: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88      wiz      2619: directly by running:</p>
1.75      rillig   2620: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
                   2621: <p>If you even decide to ignore
                   2622: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
                   2623: by running:</p>
                   2624: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
                   2625: </div>
1.148     asau     2626: <div class="sect1">
1.75      rillig   2627: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2628: <a name="tmac.andoc-missing"></a>10.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.128     wiz      2629: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</h2></div></div></div>
1.250     leot     2630: <p>When compiling the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>
1.75      rillig   2631: package, you get the error from make that it doesn't know how to make
1.76      rillig   2632: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.128     wiz      2633: you don't have installed the <span class="quote">&#8220;<span class="quote">text</span>&#8221;</span> set (nroff, ...) from
1.75      rillig   2634: the NetBSD base distribution on your machine.  It is recommended to do
                   2635: that to format man pages.</p>
1.250     leot     2636: <p>In the case of the <a href="https://cdn.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   2637: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110     hubertf  2638: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   2639: </div>
1.148     asau     2640: <div class="sect1">
1.75      rillig   2641: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2642: <a name="bsd.own.mk-missing"></a>10.11. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</h2></div></div></div>
1.87      wiz      2643: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75      rillig   2644: when you installed your NetBSD machine.  Please get and install it, by
1.76      rillig   2645: extracting it in <code class="filename">/</code>:</p>
1.75      rillig   2646: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   2647: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76      rillig   2648: <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
1.110     hubertf  2649: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75      rillig   2650: -r</strong></span>).</p>
                   2651: </div>
1.148     asau     2652: <div class="sect1">
1.75      rillig   2653: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2654: <a name="using-sudo-with-pkgsrc"></a>10.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75      rillig   2655: <p>When installing packages as non-root user and using the just-in-time
1.270     leot     2656: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a> feature of pkgsrc, it can become annoying to type in the root
1.75      rillig   2657: password for each required package installed.  To avoid this, the sudo
                   2658: package can be used, which does password caching over a limited time.  To
                   2659: use it, install sudo (either as binary package or from
1.250     leot     2660: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/sudo/README.html" target="_top"><code class="filename">security/sudo</code></a>) and then put the
1.110     hubertf  2661: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98      wiz      2662: <span class="emphasis"><em>after</em></span> the definition of the
                   2663: <code class="varname">LOCALBASE</code> variable:</p>
1.75      rillig   2664: <pre class="programlisting">
1.100     rillig   2665: .if exists(${LOCALBASE}/bin/sudo)
                   2666: SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
                   2667: .endif
1.1       grant    2668: </pre>
1.75      rillig   2669: </div>
1.148     asau     2670: <div class="sect1">
1.75      rillig   2671: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2672: <a name="faq.conf"></a>10.13. How do I change the location of configuration files?</h2></div></div></div>
1.75      rillig   2673: <p>As the system administrator, you can choose where configuration files
                   2674: are installed.  The default settings make all these files go into
1.76      rillig   2675: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75      rillig   2676: be suboptimal depending on your expectations (e.g., a read-only,
                   2677: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
                   2678: configuration of the provided packages).</p>
                   2679: <p>In order to change the defaults, you can modify the
                   2680: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110     hubertf  2681: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76      rillig   2682: directory; some common examples include <code class="filename">/etc</code> or
                   2683: <code class="filename">/etc/pkg</code>.</p>
1.75      rillig   2684: <p>Furthermore, you can change this value on a per-package basis by
                   2685: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
                   2686: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
                   2687: package you would like to modify, that is, the contents of
                   2688: <code class="varname">PKGBASE</code>.</p>
                   2689: <p>Note that after changing these settings, you must rebuild and
                   2690: reinstall any affected packages.</p>
                   2691: </div>
1.148     asau     2692: <div class="sect1">
1.75      rillig   2693: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2694: <a name="audit-packages"></a>10.14. Automated security checks</h2></div></div></div>
1.75      rillig   2695: <p>Please be aware that there can often be bugs in third-party software,
                   2696: and some of these bugs can leave a machine vulnerable to exploitation by
                   2697: attackers.  In an effort to lessen the exposure, the NetBSD packages team
                   2698: maintains a database of known-exploits to packages which have at one time
                   2699: been included in pkgsrc.  The database can be downloaded automatically, and
                   2700: a security audit of all packages installed on a system can take place.  To
1.114     jmcneill 2701: do this, refer to the following two tools (installed as part of the
1.250     leot     2702: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package):</p>
1.128     wiz      2703: <div class="orderedlist"><ol class="orderedlist" type="1">
                   2704: <li class="listitem">
1.122     reed     2705: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75      rillig   2706:     download a list of the security vulnerabilities information.  This list
1.132     spz      2707:     is kept up to date by the pkgsrc security team, and is distributed
                   2708:     from the NetBSD ftp server:</p>
                   2709: <p><a class="ulink" href="ftp://ftp.NetBSD.org/pkgsrc/distfiles/pkg-vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pkgsrc/distfiles/pkg-vulnerabilities</a></p>
1.75      rillig   2710: </li>
1.128     wiz      2711: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
                   2712:     current machine, checking each known vulnerability.  If a
1.75      rillig   2713:     vulnerable package is installed, it will be shown by output to stdout,
                   2714:     including a description of the type of vulnerability, and a URL
                   2715:     containing more information.</p></li>
                   2716: </ol></div>
1.233     sevan    2717: <p>Use of these tools is strongly recommended!
1.267     rillig   2718: See <a class="xref" href="#vulnerabilities" title="5.1.5. Checking for security vulnerabilities in installed packages">Section 5.1.5, &#8220;Checking for security vulnerabilities in installed packages&#8221;</a> for instructions on how to automate checking and
1.233     sevan    2719: reporting.</p>
                   2720: <p>If this database is installed, pkgsrc builds will use it to
                   2721: perform a security check before building any package.</p>
1.75      rillig   2722: </div>
1.148     asau     2723: <div class="sect1">
1.75      rillig   2724: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2725: <a name="ufaq-cflags"></a>10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.75      rillig   2726: <p>When you add your own preferences to the
                   2727:        <code class="varname">CFLAGS</code> variable in your
1.110     hubertf  2728:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76      rillig   2729:        environment variables to the <code class="filename">./configure</code>
1.270     leot     2730:        scripts and to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.75      rillig   2731:        <code class="varname">CFLAGS</code> from the environment variable by
1.76      rillig   2732:        overriding them in the <code class="filename">Makefile</code>s of their
1.75      rillig   2733:        package.</p>
                   2734: <p>Currently there is no solution to this problem. If you
                   2735:        really need the package to use your <code class="varname">CFLAGS</code>
1.110     hubertf  2736:        you should run <span class="command"><strong>make patch</strong></span> in the package
1.76      rillig   2737:        directory and then inspect any <code class="filename">Makefile</code> and
                   2738:        <code class="filename">Makefile.in</code> for whether they define
1.75      rillig   2739:        <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.128     wiz      2740:        these lines. But be aware that some <span class="quote">&#8220;<span class="quote">smart</span>&#8221;</span>
1.75      rillig   2741:        programmers write so bad code that it only works for the
                   2742:        specific combination of <code class="varname">CFLAGS</code> they have
                   2743:        chosen.</p>
                   2744: </div>
1.148     asau     2745: <div class="sect1">
1.80      rillig   2746: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2747: <a name="ufaq-fail"></a>10.16. A package does not build.  What shall I do?</h2></div></div></div>
1.128     wiz      2748: <div class="procedure"><ol class="procedure" type="1">
1.148     asau     2749: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.80      rillig   2750:        case that occurs often is that people only update pkgsrc in
                   2751:        parts, because of performance reasons. Since pkgsrc is one large
                   2752:        system, not a collection of many small systems, there are
                   2753:        sometimes changes that only work when the whole pkgsrc tree is
                   2754:        updated.</p></li>
1.148     asau     2755: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.128     wiz      2756:        Search for <span class="quote">&#8220;<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>&#8221;</span> or
                   2757:        <span class="quote">&#8220;<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>&#8221;</span> in all your pkgsrc
1.80      rillig   2758:        files.</p></li>
1.148     asau     2759: <li class="step"><p>Make sure that you don't have old copies of the packages
1.110     hubertf  2760:        extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80      rillig   2761:        verify this.</p></li>
1.218     rillig   2762: <li class="step"><p>If you are a package developer who wants to invest
1.267     rillig   2763:        some work, have a look at <a class="xref" href="#fixes" title="Chapter 21. Making your package work">Chapter 21, <i>Making your package work</i></a>.</p></li>
1.148     asau     2764: <li class="step"><p>If the problem still exists, write a mail to the
1.80      rillig   2765:        <code class="literal">pkgsrc-users</code> mailing list.</p></li>
                   2766: </ol></div>
                   2767: </div>
1.148     asau     2768: <div class="sect1">
1.88      wiz      2769: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2770: <a name="faq.rcs-conflicts"></a>10.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</h2></div></div></div>
1.89      rillig   2771: <p>You have modified a file from pkgsrc, and someone else has
                   2772: modified that same file afterwards in the CVS repository. Both changes
                   2773: are in the same region of the file, so when you updated pkgsrc, the
                   2774: <code class="literal">cvs</code> command marked the conflicting changes in the
                   2775: file. Because of these markers, the file is no longer a valid
                   2776: <code class="filename">Makefile</code>.</p>
                   2777: <p>Have a look at that file, and if you don't need your local changes
1.110     hubertf  2778: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89      rillig   2779: -dP</strong></span> in that directory to download the current version.</p>
                   2780: </div>
1.75      rillig   2781: </div>
                   2782: </div>
1.148     asau     2783: <div class="part">
1.75      rillig   2784: <div class="titlepage"><div><div><h1 class="title">
                   2785: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.148     asau     2786: <div class="partintro">
1.77      rillig   2787: <div></div>
                   2788: <p>This part of the book deals with creating and
1.128     wiz      2789:        modifying packages. It starts with a <span class="quote">&#8220;<span class="quote">HOWTO</span>&#8221;</span>-like
1.77      rillig   2790:        guide on creating a new package. The remaining chapters are more
                   2791:        like a reference manual for pkgsrc.</p>
1.75      rillig   2792: <div class="toc">
                   2793: <p><b>Table of Contents</b></p>
1.210     leot     2794: <dl class="toc">
1.267     rillig   2795: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
                   2796: <dt><span class="chapter"><a href="#creating">12. Creating a new pkgsrc package from scratch</a></span></dt>
1.91      rillig   2797: <dd><dl>
1.267     rillig   2798: <dt><span class="sect1"><a href="#creating.common">12.1. Common types of packages</a></span></dt>
1.91      rillig   2799: <dd><dl>
1.267     rillig   2800: <dt><span class="sect2"><a href="#creating.perl-module">12.1.1. Perl modules</a></span></dt>
                   2801: <dt><span class="sect2"><a href="#creating.python-module">12.1.2. Python modules and programs</a></span></dt>
1.273   ! brook    2802: <dt><span class="sect2"><a href="#creating.R-package">12.1.3. R packages</a></span></dt>
        !          2803: <dt><span class="sect2"><a href="#creating.TeX-package">12.1.4. TeXlive packages</a></span></dt>
1.91      rillig   2804: </dl></dd>
1.267     rillig   2805: <dt><span class="sect1"><a href="#creating.examples">12.2. Examples</a></span></dt>
                   2806: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">12.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.106     rillig   2807: </dl></dd>
1.267     rillig   2808: <dt><span class="chapter"><a href="#components">13. Package components - files, directories and contents</a></span></dt>
1.106     rillig   2809: <dd><dl>
1.267     rillig   2810: <dt><span class="sect1"><a href="#components.Makefile">13.1. <code class="filename">Makefile</code></a></span></dt>
                   2811: <dt><span class="sect1"><a href="#components.distinfo">13.2. <code class="filename">distinfo</code></a></span></dt>
                   2812: <dt><span class="sect1"><a href="#components.patches">13.3. <code class="filename">patches/*</code></a></span></dt>
1.106     rillig   2813: <dd><dl>
1.267     rillig   2814: <dt><span class="sect2"><a href="#components.patch.structure">13.3.1. Structure of a single patch file</a></span></dt>
                   2815: <dt><span class="sect2"><a href="#components.patches.caveats">13.3.2. Creating patch files</a></span></dt>
                   2816: <dt><span class="sect2"><a href="#components.patches.sources">13.3.3. Sources where the patch files come from</a></span></dt>
                   2817: <dt><span class="sect2"><a href="#components.patches.guidelines">13.3.4. Patching guidelines</a></span></dt>
                   2818: <dt><span class="sect2"><a href="#components.patches.feedback">13.3.5. Feedback to the author</a></span></dt>
1.106     rillig   2819: </dl></dd>
1.267     rillig   2820: <dt><span class="sect1"><a href="#other-mandatory-files">13.4. Other mandatory files</a></span></dt>
                   2821: <dt><span class="sect1"><a href="#components.optional">13.5. Optional files</a></span></dt>
1.106     rillig   2822: <dd><dl>
1.267     rillig   2823: <dt><span class="sect2"><a href="#components.optional.bin">13.5.1. Files affecting the binary package</a></span></dt>
                   2824: <dt><span class="sect2"><a href="#components.optional.build">13.5.2. Files affecting the build process</a></span></dt>
                   2825: <dt><span class="sect2"><a href="#components.optional.none">13.5.3. Files affecting nothing at all</a></span></dt>
1.106     rillig   2826: </dl></dd>
1.267     rillig   2827: <dt><span class="sect1"><a href="#work-dir">13.6. <code class="filename">work*</code></a></span></dt>
                   2828: <dt><span class="sect1"><a href="#files-dir">13.7. <code class="filename">files/*</code></a></span></dt>
1.106     rillig   2829: </dl></dd>
1.267     rillig   2830: <dt><span class="chapter"><a href="#makefile">14. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106     rillig   2831: <dd><dl>
1.267     rillig   2832: <dt><span class="sect1"><a href="#makefile.style">14.1. Caveats</a></span></dt>
                   2833: <dt><span class="sect1"><a href="#makefile.variables">14.2. <code class="filename">Makefile</code> variables</a></span></dt>
                   2834: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">14.2.1. Naming conventions</a></span></dt></dl></dd>
                   2835: <dt><span class="sect1"><a href="#makefile.code">14.3. Code snippets</a></span></dt>
1.106     rillig   2836: <dd><dl>
1.267     rillig   2837: <dt><span class="sect2"><a href="#adding-to-list">14.3.1. Adding things to a list</a></span></dt>
                   2838: <dt><span class="sect2"><a href="#echo-literal">14.3.2. Echoing a string exactly as-is</a></span></dt>
                   2839: <dt><span class="sect2"><a href="#cflags-gnu-configure">14.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
                   2840: <dt><span class="sect2"><a href="#empty-variables">14.3.4. Handling possibly empty variables</a></span></dt>
1.106     rillig   2841: </dl></dd>
                   2842: </dl></dd>
1.267     rillig   2843: <dt><span class="chapter"><a href="#plist">15. PLIST issues</a></span></dt>
1.106     rillig   2844: <dd><dl>
1.267     rillig   2845: <dt><span class="sect1"><a href="#rcs-id">15.1. RCS ID</a></span></dt>
                   2846: <dt><span class="sect1"><a href="#automatic-plist-generation">15.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   2847: <dt><span class="sect1"><a href="#print-PLIST">15.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
                   2848: <dt><span class="sect1"><a href="#plist.misc">15.4. Variable substitution in PLIST</a></span></dt>
                   2849: <dt><span class="sect1"><a href="#manpage-compression">15.5. Man page compression</a></span></dt>
                   2850: <dt><span class="sect1"><a href="#using-PLIST_SRC">15.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   2851: <dt><span class="sect1"><a href="#platform-specific-plist">15.7. Platform-specific and differing PLISTs</a></span></dt>
                   2852: <dt><span class="sect1"><a href="#build-plist">15.8. Build-specific PLISTs</a></span></dt>
                   2853: <dt><span class="sect1"><a href="#faq.common-dirs">15.9. Sharing directories between packages</a></span></dt>
1.106     rillig   2854: </dl></dd>
1.267     rillig   2855: <dt><span class="chapter"><a href="#buildlink">16. Buildlink methodology</a></span></dt>
1.106     rillig   2856: <dd><dl>
1.267     rillig   2857: <dt><span class="sect1"><a href="#converting-to-buildlink3">16.1. Converting packages to use buildlink3</a></span></dt>
                   2858: <dt><span class="sect1"><a href="#creating-buildlink3.mk">16.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig   2859: <dd><dl>
1.267     rillig   2860: <dt><span class="sect2"><a href="#anatomy-of-bl3">16.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   2861: <dt><span class="sect2"><a href="#updating-buildlink-depends">16.2.2. Updating
1.133     wiz      2862:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   2863:       and
                   2864:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   2865:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig   2866: </dl></dd>
1.267     rillig   2867: <dt><span class="sect1"><a href="#writing-builtin.mk">16.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.106     rillig   2868: <dd><dl>
1.267     rillig   2869: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">16.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
                   2870: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">16.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.106     rillig   2871: </dl></dd>
                   2872: </dl></dd>
1.267     rillig   2873: <dt><span class="chapter"><a href="#pkginstall">17. The pkginstall framework</a></span></dt>
1.106     rillig   2874: <dd><dl>
1.267     rillig   2875: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">17.1. Files and directories outside the installation prefix</a></span></dt>
                   2876: <dd><dl>
                   2877: <dt><span class="sect2"><a href="#dirs-outside-prefix">17.1.1. Directory manipulation</a></span></dt>
                   2878: <dt><span class="sect2"><a href="#files-outside-prefix">17.1.2. File manipulation</a></span></dt>
                   2879: </dl></dd>
                   2880: <dt><span class="sect1"><a href="#conf-files">17.2. Configuration files</a></span></dt>
                   2881: <dd><dl>
                   2882: <dt><span class="sect2"><a href="#conf-files-sysconfdir">17.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   2883: <dt><span class="sect2"><a href="#conf-files-configure">17.2.2. Telling the software where configuration files are</a></span></dt>
                   2884: <dt><span class="sect2"><a href="#conf-files-patching">17.2.3. Patching installations</a></span></dt>
                   2885: <dt><span class="sect2"><a href="#conf-files-disable">17.2.4. Disabling handling of configuration files</a></span></dt>
                   2886: </dl></dd>
                   2887: <dt><span class="sect1"><a href="#rcd-scripts">17.3. System startup scripts</a></span></dt>
                   2888: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">17.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
                   2889: <dt><span class="sect1"><a href="#users-and-groups">17.4. System users and groups</a></span></dt>
                   2890: <dt><span class="sect1"><a href="#shells">17.5. System shells</a></span></dt>
                   2891: <dd><dl><dt><span class="sect2"><a href="#shells-disable">17.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   2892: <dt><span class="sect1"><a href="#fonts">17.6. Fonts</a></span></dt>
                   2893: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">17.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
                   2894: </dl></dd>
                   2895: <dt><span class="chapter"><a href="#options">18. Options handling</a></span></dt>
                   2896: <dd><dl>
                   2897: <dt><span class="sect1"><a href="#global-default-options">18.1. Global default options</a></span></dt>
                   2898: <dt><span class="sect1"><a href="#converting-to-options">18.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
                   2899: <dt><span class="sect1"><a href="#option-names">18.3. Option Names</a></span></dt>
                   2900: <dt><span class="sect1"><a href="#option-build">18.4. Determining the options of dependencies</a></span></dt>
                   2901: </dl></dd>
                   2902: <dt><span class="chapter"><a href="#build">19. The build process</a></span></dt>
                   2903: <dd><dl>
                   2904: <dt><span class="sect1"><a href="#build.intro">19.1. Introduction</a></span></dt>
                   2905: <dt><span class="sect1"><a href="#build.prefix">19.2. Program location</a></span></dt>
                   2906: <dt><span class="sect1"><a href="#build.builddirs">19.3. Directories used during the build process</a></span></dt>
                   2907: <dt><span class="sect1"><a href="#build.running">19.4. Running a phase</a></span></dt>
                   2908: <dt><span class="sect1"><a href="#build.fetch">19.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   2909: <dd><dl>
                   2910: <dt><span class="sect2"><a href="#build.fetch.what">19.5.1. What to fetch and where to get it from</a></span></dt>
                   2911: <dt><span class="sect2"><a href="#build.fetch.how">19.5.2. How are the files fetched?</a></span></dt>
                   2912: </dl></dd>
                   2913: <dt><span class="sect1"><a href="#build.checksum">19.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   2914: <dt><span class="sect1"><a href="#build.extract">19.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   2915: <dt><span class="sect1"><a href="#build.patch">19.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   2916: <dt><span class="sect1"><a href="#build.tools">19.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   2917: <dt><span class="sect1"><a href="#build.wrapper">19.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   2918: <dt><span class="sect1"><a href="#build.configure">19.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   2919: <dt><span class="sect1"><a href="#build.build">19.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   2920: <dt><span class="sect1"><a href="#build.test">19.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   2921: <dt><span class="sect1"><a href="#build.install">19.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   2922: <dt><span class="sect1"><a href="#build.package">19.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   2923: <dt><span class="sect1"><a href="#build.clean">19.16. Cleaning up</a></span></dt>
                   2924: <dt><span class="sect1"><a href="#build.helpful-targets">19.17. Other helpful targets</a></span></dt>
                   2925: </dl></dd>
                   2926: <dt><span class="chapter"><a href="#tools">20. Tools needed for building or running</a></span></dt>
                   2927: <dd><dl>
                   2928: <dt><span class="sect1"><a href="#pkgsrc-tools">20.1. Tools for pkgsrc builds</a></span></dt>
                   2929: <dt><span class="sect1"><a href="#package-tools">20.2. Tools needed by packages</a></span></dt>
                   2930: <dt><span class="sect1"><a href="#platform-tools">20.3. Tools provided by platforms</a></span></dt>
                   2931: </dl></dd>
                   2932: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
                   2933: <dd><dl>
                   2934: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
                   2935: <dd><dl>
                   2936: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">21.1.1. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
                   2937: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                   2938: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                   2939: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                   2940: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                   2941: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                   2942: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                   2943: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   2944: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                   2945: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   2946: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   2947: </dl></dd>
                   2948: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   2949: <dd><dl>
                   2950: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   2951: <dt><span class="sect2"><a href="#modified-distfiles-same-name">21.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
                   2952: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                   2953: </dl></dd>
                   2954: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   2955: <dd><dl>
                   2956: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                   2957: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   2958: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
                   2959: </dl></dd>
                   2960: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                   2961: <dd><dl>
                   2962: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                   2963: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
                   2964: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing perl scripts</a></span></dt>
                   2965: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
                   2966: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
                   2967: </dl></dd>
                   2968: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   2969: <dd><dl>
                   2970: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   2971: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
                   2972: <dt><span class="sect2"><a href="#undefined-reference">21.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span></a></span></dt>
                   2973: <dt><span class="sect2"><a href="#out-of-memory">21.5.4. Running out of memory</a></span></dt>
                   2974: </dl></dd>
                   2975: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   2976: <dd><dl>
                   2977: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                   2978: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                   2979: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                   2980: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                   2981: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   2982: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing perl modules</a></span></dt>
                   2983: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
                   2984: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
                   2985: <dt><span class="sect2"><a href="#gconf-data-files">21.6.9. Packages installing GConf data files</a></span></dt>
                   2986: <dt><span class="sect2"><a href="#scrollkeeper-data-files">21.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
                   2987: <dt><span class="sect2"><a href="#x11-fonts">21.6.11. Packages installing X11 fonts</a></span></dt>
                   2988: <dt><span class="sect2"><a href="#gtk2-modules">21.6.12. Packages installing GTK2 modules</a></span></dt>
                   2989: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.13. Packages installing SGML or XML data</a></span></dt>
                   2990: <dt><span class="sect2"><a href="#mime-database">21.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   2991: <dt><span class="sect2"><a href="#intltool">21.6.15. Packages using intltool</a></span></dt>
                   2992: <dt><span class="sect2"><a href="#startup-scripts">21.6.16. Packages installing startup scripts</a></span></dt>
                   2993: <dt><span class="sect2"><a href="#tex-packages">21.6.17. Packages installing TeX modules</a></span></dt>
                   2994: <dt><span class="sect2"><a href="#emulation-packages">21.6.18. Packages supporting running binaries in
1.87      wiz      2995:     emulation</a></span></dt>
1.267     rillig   2996: <dt><span class="sect2"><a href="#hicolor-theme">21.6.19. Packages installing hicolor theme icons</a></span></dt>
                   2997: <dt><span class="sect2"><a href="#desktop-files">21.6.20. Packages installing desktop files</a></span></dt>
1.77      rillig   2998: </dl></dd>
1.267     rillig   2999: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.77      rillig   3000: </dl></dd>
1.267     rillig   3001: <dt><span class="chapter"><a href="#debug">22. Debugging</a></span></dt>
                   3002: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.77      rillig   3003: <dd><dl>
1.267     rillig   3004: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                   3005: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   3006: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                   3007: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                   3008: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                   3009: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                   3010: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                   3011: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
                   3012: </dl></dd>
                   3013: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
                   3014: <dt><span class="chapter"><a href="#gnome">25. GNOME packaging and porting</a></span></dt>
                   3015: <dd><dl>
                   3016: <dt><span class="sect1"><a href="#meta-packages">25.1. Meta packages</a></span></dt>
                   3017: <dt><span class="sect1"><a href="#new-package">25.2. Packaging a GNOME application</a></span></dt>
                   3018: <dt><span class="sect1"><a href="#full-update">25.3. Updating GNOME to a newer version</a></span></dt>
                   3019: <dt><span class="sect1"><a href="#patching">25.4. Patching guidelines</a></span></dt>
1.85      jmmv     3020: </dl></dd>
1.75      rillig   3021: </dl>
                   3022: </div>
1.77      rillig   3023: </div>
1.148     asau     3024: <div class="chapter">
1.77      rillig   3025: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   3026: <a name="help-devel"></a>Chapter 11. Getting help</h2></div></div></div>
                   3027: <p>
                   3028:        To get help when developing pkgsrc, the definitive source is this
                   3029:        document, the pkgsrc guide. If you don't find anything here,
                   3030:        there are alternatives:
                   3031: </p>
                   3032: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3033: <li class="listitem">
                   3034: <p>
                   3035:        The built-in pkgsrc help, which is available after bootstrapping
                   3036:        pkgsrc. Run <span class="command"><strong>bmake help topic=&#8230;</strong></span> to get
                   3037:        help for any topic, such as a variable name like
                   3038:        <code class="varname">BUILD_DEFS</code>, a make target like
                   3039:        <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
                   3040:        <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
                   3041: <p>The available help topics are listed in <a class="xref" href="#help-topics" title="Appendix D. Help topics">Appendix D, <i>Help topics</i></a>.</p>
                   3042: </li>
                   3043: <li class="listitem"><p>
                   3044:        The tech-pkg mailing list, to which
                   3045:        <a class="ulink" href="https://www.NetBSD.org/mailinglists/#tech-pkg" target="_top">you
                   3046:        can subscribe</a> and then <a class="ulink" href="mailto:tech-pkg@NetBSD.org" target="_top">ask your
                   3047:        questions</a>.</p></li>
                   3048: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
                   3049:        <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
                   3050:        or by using a specialized chat program such as
                   3051:        <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
                   3052:        Pick any user name and join the channel #pkgsrc.</p></li>
                   3053: </ul></div>
                   3054: </div>
                   3055: <div class="chapter">
                   3056: <div class="titlepage"><div><div><h2 class="title">
                   3057: <a name="creating"></a>Chapter 12. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91      rillig   3058: <div class="toc">
                   3059: <p><b>Table of Contents</b></p>
1.210     leot     3060: <dl class="toc">
1.267     rillig   3061: <dt><span class="sect1"><a href="#creating.common">12.1. Common types of packages</a></span></dt>
1.91      rillig   3062: <dd><dl>
1.267     rillig   3063: <dt><span class="sect2"><a href="#creating.perl-module">12.1.1. Perl modules</a></span></dt>
                   3064: <dt><span class="sect2"><a href="#creating.python-module">12.1.2. Python modules and programs</a></span></dt>
1.273   ! brook    3065: <dt><span class="sect2"><a href="#creating.R-package">12.1.3. R packages</a></span></dt>
        !          3066: <dt><span class="sect2"><a href="#creating.TeX-package">12.1.4. TeXlive packages</a></span></dt>
1.91      rillig   3067: </dl></dd>
1.267     rillig   3068: <dt><span class="sect1"><a href="#creating.examples">12.2. Examples</a></span></dt>
                   3069: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">12.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.91      rillig   3070: </dl>
                   3071: </div>
1.77      rillig   3072: <p>When you find a package that is not yet in pkgsrc, you
1.91      rillig   3073: most likely have a URL from where you can download the source
                   3074: code. Starting with this URL, creating a package involves only a
                   3075: few steps.</p>
1.128     wiz      3076: <div class="procedure"><ol class="procedure" type="1">
1.250     leot     3077: <li class="step"><p>First, install the packages <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a> and <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>.</p></li>
1.148     asau     3078: <li class="step"><p>Then, choose one of the top-level directories as the
1.91      rillig   3079: category in which you want to place your package. You can also create a
                   3080: directory of your own (maybe called <code class="filename">local</code>). In that
                   3081: category directory, create another directory for your package and change
                   3082: into it.</p></li>
1.148     asau     3083: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.91      rillig   3084: you for a URL. Enter the URL of the distribution file (in most cases a
                   3085: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
                   3086: of your package are created automatically. The distribution file is
                   3087: extracted automatically to fill in some details in the
                   3088: <code class="filename">Makefile</code> that would otherwise have to be done
                   3089: manually.</p></li>
1.148     asau     3090: <li class="step">
1.91      rillig   3091: <p>Examine the extracted files to determine the dependencies of
                   3092: your package. Ideally, this is mentioned in some
                   3093: <code class="filename">README</code> file, but things may differ. For each of
                   3094: these dependencies, look where it exists in pkgsrc, and if there is a
                   3095: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   3096: line to your package <code class="filename">Makefile</code> which includes that
                   3097: file just before the last line. If the
1.132     spz      3098: <code class="filename">buildlink3.mk</code> file does not exist, it must be
                   3099: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
                   3100: <p>If you just need binaries from a package, add a
1.91      rillig   3101: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   3102: version of the dependency and where it can be found in pkgsrc. This line
                   3103: should be placed in the third paragraph. If the dependency is only
                   3104: needed for building the package, but not when using it, use
1.269     leot     3105: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
                   3106: instead of <code class="varname">DEPENDS</code>.
                   3107: The difference between <code class="varname">TOOL_DEPENDS</code> and
                   3108: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
                   3109: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
                   3110: packages, i.e. packages for the architecture where the package
                   3111: is built;
                   3112: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
                   3113: packages, i.e. packages for the architecture for which the package
                   3114: is built.
1.91      rillig   3115: Your package may then look like this:</p>
1.77      rillig   3116: <pre class="programlisting">
1.100     rillig   3117: [...]
1.77      rillig   3118: 
1.269     leot     3119: TOOL_DEPENDS+=  libxslt-[0-9]*:../../textproc/libxslt
1.100     rillig   3120: DEPENDS+=       screen-[0-9]*:../../misc/screen
                   3121: DEPENDS+=       screen&gt;=4.0:../../misc/screen
1.77      rillig   3122: 
1.100     rillig   3123: [...]
1.77      rillig   3124: 
1.100     rillig   3125: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
                   3126: .include "../../devel/glib2/buildlink3.mk"
                   3127: .include "../../mk/bsd.pkg.mk"
1.77      rillig   3128: </pre>
                   3129: </li>
1.148     asau     3130: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.128     wiz      3131: to be done to make your package a <span class="quote">&#8220;<span class="quote">good</span>&#8221;</span> one. If you don't
1.110     hubertf  3132: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
                   3133: --explain</strong></span> or <span class="command"><strong>pkglint
1.91      rillig   3134: -e</strong></span>, which outputs additional
                   3135: explanations.</p></li>
1.148     asau     3136: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.267     rillig   3137: find instructions for the most common cases in the next section, <a class="xref" href="#creating.common" title="12.1. Common types of packages">Section 12.1, &#8220;Common types of packages&#8221;</a>. After you have followed the instructions
1.91      rillig   3138: over there, you can hopefully continue here.</p></li>
1.148     asau     3139: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.91      rillig   3140: directory from the extracted files. Besides these files, a lot of cache
                   3141: files and other system information has been saved in the working
                   3142: directory, which may become wrong after you edited the
                   3143: <code class="filename">Makefile</code>.</p></li>
1.148     asau     3144: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.267     rillig   3145: the various things that can go wrong in this phase, consult <a class="xref" href="#fixes" title="Chapter 21. Making your package work">Chapter 21, <i>Making your package work</i></a>.</p></li>
1.148     asau     3146: <li class="step"><p>When the package builds fine, the next step is to install
1.110     hubertf  3147: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.91      rillig   3148: everything works.</p></li>
1.148     asau     3149: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.91      rillig   3150: contains a list of the files that are installed by the package, is
1.110     hubertf  3151: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.91      rillig   3152: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   3153: the file using your preferred text editor to see if the list of
                   3154: files looks plausible.</p></li>
1.148     asau     3155: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.91      rillig   3156: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.148     asau     3157: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.91      rillig   3158: has been registered in the database of installed files, but with an
1.110     hubertf  3159: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
                   3160: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.91      rillig   3161: registered with the list of files from
                   3162: <code class="filename">PLIST</code>.</p></li>
1.148     asau     3163: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.91      rillig   3164: package from the set of installed files.</p></li>
1.77      rillig   3165: </ol></div>
1.148     asau     3166: <div class="sect1">
1.91      rillig   3167: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3168: <a name="creating.common"></a>12.1. Common types of packages</h2></div></div></div>
1.148     asau     3169: <div class="sect2">
1.91      rillig   3170: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   3171: <a name="creating.perl-module"></a>12.1.1. Perl modules</h3></div></div></div>
1.91      rillig   3172: <p>Simple Perl modules are handled automatically by
1.110     hubertf  3173: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.91      rillig   3174: </div>
1.148     asau     3175: <div class="sect2">
1.91      rillig   3176: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   3177: <a name="creating.python-module"></a>12.1.2. Python modules and programs</h3></div></div></div>
1.118     imil     3178: <p>Python modules and programs packages are easily created using a
                   3179: set of predefined variables.</p>
                   3180: <p>
1.171     wiz      3181: If some Python versions are not supported by the software, set the
                   3182: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
                   3183: that are not supported, e.g.
1.118     imil     3184: </p>
                   3185: <pre class="programlisting">
1.203     sevan    3186: PYTHON_VERSIONS_INCOMPATIBLE=       27
1.118     imil     3187: </pre>
                   3188: <p>
1.213     wiz      3189: If the packaged software is a Python module, include one of
                   3190: <code class="filename">../../lang/python/egg.mk</code>,
                   3191: <code class="filename">../../lang/python/distutils.mk</code>, or
                   3192: <code class="filename">../../lang/python/extension.mk</code>.</p>
                   3193: <p>Most Python packages use either <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> or
                   3194: easy-setup/setuptools (<span class="quote">&#8220;<span class="quote">eggs</span>&#8221;</span>).
                   3195: if the packaged software is using setuptools, you only need
                   3196: to include <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>&#8221;</span>.
                   3197: Otherwise, if the software uses <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span>, include 
                   3198: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>&#8221;</span>.
                   3199: so pkgsrc will use this framework.
                   3200: <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> uses a script called <code class="filename">setup.py</code>,
                   3201: if the <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> driver is not called
                   3202: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
                   3203: to the name of the script.</p>
                   3204: <p>Either way, the package directory should be called
1.128     wiz      3205: <span class="quote">&#8220;<span class="quote">py-software</span>&#8221;</span> and <code class="varname">PKGNAME</code> should be set to
                   3206: <span class="quote">&#8220;<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>&#8221;</span>, e.g.
1.118     imil     3207: </p>
                   3208: <pre class="programlisting">
                   3209: DISTNAME=   foopymodule-1.2.10
                   3210: PKGNAME=    ${PYPKGPREFIX}-${DISTNAME}
                   3211: </pre>
1.171     wiz      3212: <p>If it is an application, include
                   3213: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>&#8221;</span>.
                   3214: In order to correctly set the path to the Python interpreter, use the
1.118     imil     3215: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.142     wiz      3216: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.171     wiz      3217: For example:
1.118     imil     3218: </p>
                   3219: <pre class="programlisting">
1.142     wiz      3220: REPLACE_PYTHON=   *.py
1.118     imil     3221: </pre>
1.171     wiz      3222: <p>Some Python modules have separate distributions for Python-2.x
                   3223: and Python-3.x support. In pkgsrc this is handled by the
                   3224: <code class="filename">versioned_dependencies.mk</code> file. Set
                   3225: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
                   3226: packages that should be depended upon and include
                   3227: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>&#8221;</span>,
                   3228: then the pkgsrc infrastructure will depend on the appropriate package
                   3229: version. For example:
                   3230: </p>
                   3231: <pre class="programlisting">
1.248     wiz      3232: PYTHON_VERSIONED_DEPENDENCIES=dialog
1.171     wiz      3233: </pre>
                   3234: <p>
                   3235: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
                   3236: of supported packages.</p>
1.118     imil     3237: </div>
1.273   ! brook    3238: <div class="sect2">
        !          3239: <div class="titlepage"><div><div><h3 class="title">
        !          3240: <a name="creating.R-package"></a>12.1.3. R packages</h3></div></div></div>
        !          3241: <p>Simple R packages from <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>
        !          3242: are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
        !          3243: available in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/R2pkg/README.html" target="_top"><code class="filename">pkgtools/R2pkg</code></a>.
        !          3244: Individual packages (and optionally their dependencies) may be created
        !          3245: and updated.  R packages generally follow the same form, and most of
        !          3246: the relevant information needed is contained in a
        !          3247: <code class="filename">DESCRIPTION</code> file as part of each R package on
        !          3248: <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
        !          3249: Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
        !          3250: creates or updates a package in the canonical form.  The resulting
        !          3251: package should be reviewed for correctness.</p>
        !          3252: </div>
        !          3253: <div class="sect2">
        !          3254: <div class="titlepage"><div><div><h3 class="title">
        !          3255: <a name="creating.TeX-package"></a>12.1.4. TeXlive packages</h3></div></div></div>
        !          3256: <p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> are handled automatically by
        !          3257: <span class="command"><strong>texlive2pkg</strong></span>, which is available in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/texlive2pkg/README.html" target="_top"><code class="filename">pkgtools/texlive2pkg</code></a>.</p>
        !          3258: <p>If the TeXlive package name is not known, it may be useful to
        !          3259: search <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>.  A
        !          3260: <span class="quote">&#8220;<span class="quote">Contained in</span>&#8221;</span> field on the package page typically
        !          3261: identifies the basename of the package file in the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
        !          3262: archive</a>.</p>
        !          3263: <p>If the TeXlive package name is known, download the files from
        !          3264: the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
        !          3265: archive</a>.  For package <code class="filename">foo</code>, you will need
        !          3266: to download <code class="filename">foo.tar.xz</code>.  Most TeXlive packages
        !          3267: also have associated documentation packages, so download
        !          3268: <code class="filename">foo.doc.tar.xz</code> at the same time.  These files
        !          3269: should be placed in the appropriate category directory, which is often
        !          3270: but not always <code class="filename">print</code>.  Then run the following
        !          3271: command in the category directory.</p>
        !          3272: <pre class="programlisting">
        !          3273: texlive2pkg foo.tar.xz foo.doc.tar.xz
        !          3274: </pre>
        !          3275: <p>This will create two packages, <code class="filename">tex-foo</code> and
        !          3276: <code class="filename">tex-foo-doc</code>.  Be sure to check that both packages
        !          3277: are correct.</p>
        !          3278: </div>
1.91      rillig   3279: </div>
1.148     asau     3280: <div class="sect1">
1.91      rillig   3281: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3282: <a name="creating.examples"></a>12.2. Examples</h2></div></div></div>
1.148     asau     3283: <div class="sect2">
1.91      rillig   3284: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   3285: <a name="creating.nvu"></a>12.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.148     asau     3286: <div class="sect3">
1.91      rillig   3287: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   3288: <a name="creating.nvu.init"></a>12.2.1.1. The initial package</h4></div></div></div>
1.91      rillig   3289: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.128     wiz      3290: that the <span class="quote">&#8220;<span class="quote">nvu</span>&#8221;</span> package has not yet been imported into
1.91      rillig   3291: pkgsrc. As the description says it has to do with the web, the obvious
1.128     wiz      3292: choice for the category is <span class="quote">&#8220;<span class="quote">www</span>&#8221;</span>.</p>
1.91      rillig   3293: <pre class="programlisting">
1.100     rillig   3294: <code class="prompt">$</code> mkdir www/nvu
                   3295: <code class="prompt">$</code> cd www/nvu
1.91      rillig   3296: </pre>
                   3297: <p>The web site says that the sources are available as a tar file, so
1.110     hubertf  3298: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.91      rillig   3299: <pre class="programlisting">
1.100     rillig   3300: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91      rillig   3301: </pre>
                   3302: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   3303: below the <code class="varname">DISTNAME</code> line, as the package name should
1.128     wiz      3304: not have the word <span class="quote">&#8220;<span class="quote">sources</span>&#8221;</span> in it. I also filled in the
1.91      rillig   3305: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   3306: <code class="varname">COMMENT</code> fields. Then the package
                   3307: <code class="filename">Makefile</code> looked like that:</p>
                   3308: <pre class="programlisting">
1.233     sevan    3309: # $NetBSD $
1.100     rillig   3310: #
1.91      rillig   3311: 
1.100     rillig   3312: DISTNAME=       nvu-1.0-sources
                   3313: PKGNAME=        nvu-1.0
                   3314: CATEGORIES=     www
                   3315: MASTER_SITES=   http://cvs.nvu.com/download/
                   3316: EXTRACT_SUFX=   .tar.bz2
                   3317: 
                   3318: MAINTAINER=     rillig@NetBSD.org
                   3319: HOMEPAGE=       http://cvs.nvu.com/
                   3320: COMMENT=        Web Authoring System
1.91      rillig   3321: 
1.100     rillig   3322: # url2pkg-marker (please do not remove this line.)
                   3323: .include "../../mk/bsd.pkg.mk"
1.91      rillig   3324: </pre>
1.237     wiz      3325: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
1.233     sevan    3326: this is a workaround to prevent CVS expanding to the filename of the
                   3327: guide.</p>
1.91      rillig   3328: <p>Then, I quit the editor and watched pkgsrc downloading a large
                   3329: source archive:</p>
                   3330: <pre class="programlisting">
1.100     rillig   3331: url2pkg&gt; Running "make makesum" ...
                   3332: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   3333: =&gt; Fetching nvu-1.0-sources.tar.bz2
                   3334: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   3335: 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
                   3336: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   3337: url2pkg&gt; Running "make extract" ...
                   3338: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   3339: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   3340: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   3341: work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
                   3342: ===&gt; Installing dependencies for nvu-1.0
                   3343: ===&gt; Overriding tools for nvu-1.0
                   3344: ===&gt; Extracting for nvu-1.0
                   3345: url2pkg&gt; Adjusting the Makefile.
1.91      rillig   3346: 
1.100     rillig   3347: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.91      rillig   3348: 
1.100     rillig   3349: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.91      rillig   3350: </pre>
                   3351: </div>
1.148     asau     3352: <div class="sect3">
1.91      rillig   3353: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   3354: <a name="creating.nvu.problems"></a>12.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
1.91      rillig   3355: <p>Now that the package has been extracted, let's see what's inside
                   3356: it. The package has a <code class="filename">README.txt</code>, but that only
                   3357: says something about mozilla, so it's probably useless for seeing what
                   3358: dependencies this package has. But since there is a GNU configure script
                   3359: in the package, let's hope that it will complain about everything it
                   3360: needs.</p>
                   3361: <pre class="programlisting">
1.100     rillig   3362: <code class="prompt">$</code> bmake
                   3363: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   3364: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   3365: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   3366: ===&gt; Patching for nvu-1.0
                   3367: ===&gt; Creating toolchain wrappers for nvu-1.0
                   3368: ===&gt; Configuring for nvu-1.0
                   3369: [...]
                   3370: configure: error: Perl 5.004 or higher is required.
                   3371: [...]
                   3372: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   3373: [...]
1.91      rillig   3374: </pre>
                   3375: <p>That worked quite well. So I opened the package Makefile in my
                   3376: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.128     wiz      3377: just appended <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to it. Since the dependencies of the
1.91      rillig   3378: package have changed now, and since a perl wrapper is automatically
1.128     wiz      3379: installed in the <span class="quote">&#8220;<span class="quote">tools</span>&#8221;</span> phase, I need to build the package
1.91      rillig   3380: from scratch.</p>
                   3381: <pre class="programlisting">
1.100     rillig   3382: <code class="prompt">$</code> bmake clean
                   3383: ===&gt; Cleaning for nvu-1.0
                   3384: <code class="prompt">$</code> bmake
                   3385: [...]
                   3386: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   3387: GNU Make.  You will not be able to build Mozilla without GNU Make.
                   3388: [...]
1.91      rillig   3389: </pre>
1.128     wiz      3390: <p>So I added <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> to the
1.91      rillig   3391: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
                   3392: <pre class="programlisting">
1.100     rillig   3393: [...]
                   3394: checking for GTK - version &gt;= 1.2.0... no
                   3395: *** Could not run GTK test program, checking why...
                   3396: [...]
1.91      rillig   3397: </pre>
                   3398: <p>Now to the other dependencies. The first question is: Where is the
                   3399: GTK package hidden in pkgsrc?</p>
                   3400: <pre class="programlisting">
1.100     rillig   3401: <code class="prompt">$</code> echo ../../*/gtk*
                   3402: [many packages ...]
                   3403: <code class="prompt">$</code> echo ../../*/gtk
                   3404: ../../x11/gtk
                   3405: <code class="prompt">$</code> echo ../../*/gtk2
                   3406: ../../x11/gtk2
                   3407: <code class="prompt">$</code> echo ../../*/gtk2/bui*
                   3408: ../../x11/gtk2/buildlink3.mk
1.91      rillig   3409: </pre>
                   3410: <p>The first try was definitely too broad. The second one had exactly
                   3411: one result, which is very good. But there is one pitfall with GNOME
                   3412: packages. Before GNOME 2 had been released, there were already many
                   3413: GNOME 1 packages in pkgsrc. To be able to continue to use these
                   3414: packages, the GNOME 2 packages were imported as separate packages, and
1.128     wiz      3415: their names usually have a <span class="quote">&#8220;<span class="quote">2</span>&#8221;</span> appended. So I checked
1.91      rillig   3416: whether this was the case here, and indeed it was.</p>
                   3417: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
                   3418: file, adding the dependency is very easy. I just inserted an
                   3419: <code class="literal">.include</code> line before the last line of the package
                   3420: <code class="filename">Makefile</code>, so that it now looks like this:</p>
                   3421: <pre class="programlisting">
1.100     rillig   3422: [...]
                   3423: .include "../../x11/gtk2/buildlink3.mk"
                   3424: .include "../../mk/bsd.pkg.mk
1.91      rillig   3425: </pre>
1.110     hubertf  3426: <p>After another <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span>, the answer
1.91      rillig   3427: was:</p>
                   3428: <pre class="programlisting">
1.100     rillig   3429: [...]
                   3430: checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   3431: checking for GTK - version &gt;= 1.2.0... no
                   3432: *** Could not run GTK test program, checking why...
                   3433: *** The test program failed to compile or link. See the file config.log for the
                   3434: *** exact error that occured. This usually means GTK was incorrectly installed
                   3435: *** or that you have moved GTK since it was installed. In the latter case, you
                   3436: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   3437: configure: error: Test for GTK failed.
                   3438: [...]
1.91      rillig   3439: </pre>
1.128     wiz      3440: <p>In this particular case, the assumption that <span class="quote">&#8220;<span class="quote">every package
                   3441: prefers GNOME 2</span>&#8221;</span> had been wrong. The first of the lines above
1.91      rillig   3442: told me that this package really wanted to have the GNOME 1 version of
                   3443: GTK. If the package had looked for GTK2, it would have looked for
1.110     hubertf  3444: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.91      rillig   3445: So I changed the <code class="literal">x11/gtk2</code> to
                   3446: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
                   3447: and tried again.</p>
                   3448: <pre class="programlisting">
1.100     rillig   3449: [...]
1.166     jnemeth  3450: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\"  [...]
1.100     rillig   3451: In file included from xpidl.c:42:
                   3452: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   3453: In file included from xpidl.c:42:
                   3454: xpidl.h:132: error: parse error before "IDL_ns"
                   3455: [...]
1.91      rillig   3456: </pre>
                   3457: <p>The package still does not find all of its dependencies. Now the
                   3458: question is: Which package provides the
                   3459: <code class="filename">libIDL/IDL.h</code> header file?</p>
                   3460: <pre class="programlisting">
1.100     rillig   3461: <code class="prompt">$</code> echo ../../*/*idl*
                   3462: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   3463: <code class="prompt">$</code> echo ../../*/*IDL*
                   3464: ../../net/libIDL
1.91      rillig   3465: </pre>
                   3466: <p>Let's take the one from the second try. So I included the
                   3467: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
                   3468: again. But the error didn't change. After digging through some of the
                   3469: code, I concluded that the build process of the package was broken and
                   3470: couldn't have ever worked, but since the Mozilla source tree is quite
                   3471: large, I didn't want to fix it. So I added the following to the package
                   3472: <code class="filename">Makefile</code> and tried again:</p>
                   3473: <pre class="programlisting">
1.100     rillig   3474: CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
1.252     leot     3475: BUILDLINK_TRANSFORM+=   l:IDL:IDL-2
1.91      rillig   3476: </pre>
                   3477: <p>The latter line is needed because the package expects the library
                   3478: <code class="filename">libIDL.so</code>, but only
                   3479: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
                   3480: wrapper to rewrite that on the fly.</p>
                   3481: <p>The next problem was related to a recent change of the FreeType
1.250     leot     3482: interface. I looked up in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/seamonkey/README.html" target="_top"><code class="filename">www/seamonkey</code></a>
1.91      rillig   3483: which patch files were relevant for this issue and copied them to the
                   3484: <code class="filename">patches</code> directory. Then I retried, fixed the
                   3485: patches so that they applied cleanly and retried again. This time,
                   3486: everything worked.</p>
                   3487: </div>
1.148     asau     3488: <div class="sect3">
1.91      rillig   3489: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   3490: <a name="creating.nvu.inst"></a>12.2.1.3. Installing the package</h4></div></div></div>
1.91      rillig   3491: <pre class="programlisting">
1.100     rillig   3492: <code class="prompt">$</code> bmake CHECK_FILES=no install
                   3493: [...]
                   3494: <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
                   3495: <code class="prompt">$</code> bmake deinstall
                   3496: <code class="prompt">$</code> bmake install
1.91      rillig   3497: </pre>
                   3498: </div>
                   3499: </div>
                   3500: </div>
1.77      rillig   3501: </div>
1.148     asau     3502: <div class="chapter">
1.75      rillig   3503: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   3504: <a name="components"></a>Chapter 13. Package components - files, directories and contents</h2></div></div></div>
1.75      rillig   3505: <div class="toc">
                   3506: <p><b>Table of Contents</b></p>
1.210     leot     3507: <dl class="toc">
1.267     rillig   3508: <dt><span class="sect1"><a href="#components.Makefile">13.1. <code class="filename">Makefile</code></a></span></dt>
                   3509: <dt><span class="sect1"><a href="#components.distinfo">13.2. <code class="filename">distinfo</code></a></span></dt>
                   3510: <dt><span class="sect1"><a href="#components.patches">13.3. <code class="filename">patches/*</code></a></span></dt>
                   3511: <dd><dl>
                   3512: <dt><span class="sect2"><a href="#components.patch.structure">13.3.1. Structure of a single patch file</a></span></dt>
                   3513: <dt><span class="sect2"><a href="#components.patches.caveats">13.3.2. Creating patch files</a></span></dt>
                   3514: <dt><span class="sect2"><a href="#components.patches.sources">13.3.3. Sources where the patch files come from</a></span></dt>
                   3515: <dt><span class="sect2"><a href="#components.patches.guidelines">13.3.4. Patching guidelines</a></span></dt>
                   3516: <dt><span class="sect2"><a href="#components.patches.feedback">13.3.5. Feedback to the author</a></span></dt>
                   3517: </dl></dd>
                   3518: <dt><span class="sect1"><a href="#other-mandatory-files">13.4. Other mandatory files</a></span></dt>
                   3519: <dt><span class="sect1"><a href="#components.optional">13.5. Optional files</a></span></dt>
                   3520: <dd><dl>
                   3521: <dt><span class="sect2"><a href="#components.optional.bin">13.5.1. Files affecting the binary package</a></span></dt>
                   3522: <dt><span class="sect2"><a href="#components.optional.build">13.5.2. Files affecting the build process</a></span></dt>
                   3523: <dt><span class="sect2"><a href="#components.optional.none">13.5.3. Files affecting nothing at all</a></span></dt>
1.78      rillig   3524: </dl></dd>
1.267     rillig   3525: <dt><span class="sect1"><a href="#work-dir">13.6. <code class="filename">work*</code></a></span></dt>
                   3526: <dt><span class="sect1"><a href="#files-dir">13.7. <code class="filename">files/*</code></a></span></dt>
1.75      rillig   3527: </dl>
                   3528: </div>
1.87      wiz      3529: <p>Whenever you're preparing a package, there are a number of
                   3530: files involved which are described in the following
                   3531: sections.</p>
1.148     asau     3532: <div class="sect1">
1.75      rillig   3533: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3534: <a name="components.Makefile"></a>13.1. <code class="filename">Makefile</code>
1.93      rillig   3535: </h2></div></div></div>
1.75      rillig   3536: <p>Building, installation and creation of a binary package are all
1.87      wiz      3537:   controlled by the package's <code class="filename">Makefile</code>.
                   3538:   The <code class="filename">Makefile</code> describes various things about
                   3539:   a package, for example from where to get it, how to configure,
                   3540:   build, and install it.</p>
1.76      rillig   3541: <p>A package <code class="filename">Makefile</code> contains several
1.87      wiz      3542:   sections that describe the package.</p>
1.75      rillig   3543: <p>In the first section there are the following variables, which
1.87      wiz      3544:   should appear exactly in the order given here.  The order and
                   3545:   grouping of the variables is mostly historical and has no further
                   3546:   meaning.</p>
1.148     asau     3547: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      3548: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.87      wiz      3549:     distribution file to be downloaded from the package's
                   3550:     website.</p></li>
1.128     wiz      3551: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.174     asau     3552:     package, as used by pkgsrc. You need to provide it if
1.87      wiz      3553:     <code class="varname">DISTNAME</code> (which is the default) is not a good
1.174     asau     3554:     name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
                   3555:     provided (no distribution file is required).  Usually it is the pkgsrc
1.87      wiz      3556:     directory name together with the version number. It must match the
                   3557:     regular expression
                   3558:     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
                   3559:     starts with a letter or digit, and contains only letters, digits,
                   3560:     dashes, underscores, dots and plus signs.</p></li>
1.128     wiz      3561: <li class="listitem">
1.75      rillig   3562: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87      wiz      3563:     which the package fits in. You can choose any of the top-level
                   3564:     directories of pkgsrc for it.</p>
1.75      rillig   3565: <p>Currently the following values are available for
1.87      wiz      3566:     <code class="varname">CATEGORIES</code>. If more than
                   3567:     one is used, they need to be separated by spaces:</p>
1.75      rillig   3568: <pre class="programlisting">
1.100     rillig   3569: archivers     cross         geography     meta-pkgs     security
                   3570: audio         databases     graphics      misc          shells
                   3571: benchmarks    devel         ham           multimedia    sysutils
                   3572: biology       editors       inputmethod   net           textproc
                   3573: cad           emulators     lang          news          time
                   3574: chat          finance       mail          parallel      wm
                   3575: comms         fonts         math          pkgtools      www
                   3576: converters    games         mbone         print         x11
                   3577: </pre>
1.75      rillig   3578: </li>
1.128     wiz      3579: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.87      wiz      3580:     <code class="varname">DYNAMIC_MASTER_SITES</code>,
                   3581:     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
                   3582:     and <code class="varname">DISTFILES</code> are discussed in detail in
1.267     rillig   3583:     <a class="xref" href="#build.fetch" title="19.5. The fetch phase">Section 19.5, &#8220;The <span class="emphasis"><em>fetch</em></span> phase&#8221;</a>.</p></li>
1.75      rillig   3584: </ul></div>
                   3585: <p>The second section contains information about separately
1.87      wiz      3586:   downloaded patches, if any.
                   3587:   </p>
1.148     asau     3588: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.190     wiz      3589: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
1.87      wiz      3590:     Name(s) of additional files that contain distribution patches.
                   3591:     There is no default. pkgsrc will look for them at
                   3592:     <code class="varname">PATCH_SITES</code>.
                   3593:     They will automatically be uncompressed before patching if
                   3594:     the names end with <code class="filename">.gz</code> or
                   3595:     <code class="filename">.Z</code>.</p></li>
1.128     wiz      3596: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.87      wiz      3597:     Primary location(s) for distribution patch files (see
1.190     wiz      3598:     <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
                   3599: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.270     leot     3600:     an argument to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> that sets the pathname strip count to
1.190     wiz      3601:     help find the correct files to patch. It defaults to
                   3602:     <span class="command"><strong>-p0</strong></span>.</p></li>
1.75      rillig   3603: </ul></div>
                   3604: <p>The third section contains the following variables.
1.87      wiz      3605:   </p>
1.148     asau     3606: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      3607: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.114     jmcneill 3608:     address of the person who feels responsible for this package,
                   3609:     and who is most likely to look at problems or questions regarding
1.270     leot     3610:     this package which have been reported with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
1.114     jmcneill 3611:     Other developers may contact the <code class="varname">MAINTAINER</code>
                   3612:     before making changes to the package, but are not required to
                   3613:     do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
                   3614:     to yourself. If you really can't maintain the package for future
                   3615:     updates, set it to
1.110     hubertf  3616:     <code class="email">&lt;<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>&gt;</code>.</p></li>
1.128     wiz      3617: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.114     jmcneill 3618:     of <code class="varname">MAINTAINER</code> when you do not want other
                   3619:     developers to update or change the package without contacting
                   3620:     you first. A package Makefile should contain one of
                   3621:     <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
                   3622:     not both.  </p></li>
1.128     wiz      3623: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87      wiz      3624:     find more information about the package.</p></li>
1.128     wiz      3625: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.87      wiz      3626:     description of the package (should not include the package
                   3627:     name).</p></li>
1.234     leot     3628: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
1.267     rillig   3629:     applicable for the package. See <a class="xref" href="#handling-licenses" title="21.1.3. Handling licenses">Section 21.1.3, &#8220;Handling licenses&#8221;</a> for further details.</p></li>
1.75      rillig   3630: </ul></div>
                   3631: <p>Other variables that affect the build:
1.87      wiz      3632:   </p>
1.148     asau     3633: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.75      rillig   3634: <p><code class="varname">WRKSRC</code>: The directory where the
1.87      wiz      3635:       interesting distribution files of the package are found. The
                   3636:       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
                   3637:       works for most packages.</p>
1.75      rillig   3638: <p>If a package doesn't create a subdirectory for itself
1.87      wiz      3639:       (most GNU software does, for instance), but extracts itself in
                   3640:       the current directory, you should set
                   3641:       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
                   3642: <p>If a package doesn't create a subdirectory with the
                   3643:       name of <code class="varname">DISTNAME</code> but some different name,
                   3644:       set <code class="varname">WRKSRC</code> to point to the proper name in
                   3645:       <code class="filename">${WRKDIR}</code>, for example
                   3646:       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.250     leot     3647:       <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/tcl/README.html" target="_top"><code class="filename">lang/tcl</code></a> and <a href="https://cdn.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   3648: <p>The name of the working directory created by pkgsrc is
1.87      wiz      3649:       taken from the <code class="varname">WRKDIR_BASENAME</code>
                   3650:       variable. By default, its value is
                   3651:       <code class="filename">work</code>. If you want to use the same
                   3652:       pkgsrc tree for building different kinds of binary packages,
                   3653:       you can change the variable according to your needs. Two
                   3654:       other variables handle common cases of setting
                   3655:       <code class="varname">WRKDIR_BASENAME</code> individually. If
                   3656:       <code class="varname">OBJHOSTNAME</code> is defined in
1.110     hubertf  3657:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.87      wiz      3658:       the host's name is attached to the directory name. If
                   3659:       <code class="varname">OBJMACHINE</code> is defined, the platform name
                   3660:       is attached, which might look like
                   3661:       <code class="filename">work.i386</code> or
                   3662:       <code class="filename">work.sparc</code>.</p>
1.75      rillig   3663: </li></ul></div>
                   3664: <p>Please pay attention to the following gotchas:</p>
1.148     asau     3665: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      3666: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88      wiz      3667:       installed in compressed form by the package.  For packages using
                   3668:       BSD-style makefiles which honor MANZ, there is
                   3669:       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.128     wiz      3670: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
                   3671:       <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span> in all files (see patches,
1.88      wiz      3672:       below).</p></li>
1.267     rillig   3673: <li class="listitem"><p>If the package installs any info files, see <a class="xref" href="#faq.info-files" title="21.6.7. Packages installing info files">Section 21.6.7, &#8220;Packages installing info files&#8221;</a>.</p></li>
1.75      rillig   3674: </ul></div>
                   3675: </div>
1.148     asau     3676: <div class="sect1">
1.75      rillig   3677: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3678: <a name="components.distinfo"></a>13.2. <code class="filename">distinfo</code>
1.93      rillig   3679: </h2></div></div></div>
1.76      rillig   3680: <p>The <code class="filename">distinfo</code> file contains the message
1.87      wiz      3681:   digest, or checksum, of each distfile needed for the package. This
                   3682:   ensures that the distfiles retrieved from the Internet have not been
                   3683:   corrupted during transfer or altered by a malign force to introduce
1.219     rillig   3684:   a security hole. To provide maximum security, all distfiles are
                   3685:   protected using three different message digest algorithms (SHA1,
                   3686:   RMD160, SHA512), as well as the file size.</p>
1.76      rillig   3687: <p>The <code class="filename">distinfo</code> file also contains the
1.87      wiz      3688:   checksums for all the patches found in the
1.267     rillig   3689:   <code class="filename">patches</code> directory (see <a class="xref" href="#components.patches" title="13.3. patches/*">Section 13.3, &#8220;<code class="filename">patches/*</code>&#8221;</a>). These checksums ensure that patches
1.258     leot     3690:   are only applied intentionally and that they don't accidentally change,
                   3691:   e.g. when merging different changes together. They also make sure that
                   3692:   new patches are actually added to CVS and old ones are removed.
                   3693:   Too see whether the patches and the <code class="filename">distinfo</code> file
                   3694:   match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
1.76      rillig   3695: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.219     rillig   3696:   <span class="command"><strong>make distinfo</strong></span> command.</p>
1.75      rillig   3697: <p>Some packages have different sets of distfiles depending on
1.250     leot     3698:   the platform, for example <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/openjdk7/README.html" target="_top"><code class="filename">lang/openjdk7</code></a>. These are kept in the same
1.87      wiz      3699:   <code class="filename">distinfo</code> file and care should be taken when
                   3700:   upgrading such a package to ensure distfile information is not
                   3701:   lost.</p>
1.75      rillig   3702: </div>
1.148     asau     3703: <div class="sect1">
1.75      rillig   3704: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3705: <a name="components.patches"></a>13.3. <code class="filename">patches/*</code>
1.219     rillig   3706: </h2></div></div></div>
                   3707: <p>Some packages don't work out-of-the box on the various
                   3708:   platforms that are supported by pkgsrc. These packages need
                   3709:   to be patched to make them work. The patch files can be
1.93      rillig   3710:   found in the <code class="filename">patches/</code> directory.</p>
                   3711: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
                   3712:   applied to the files in <code class="varname">WRKSRC</code> directory after
1.219     rillig   3713:   extracting them, in alphabetic order.</p>
1.148     asau     3714: <div class="sect2">
1.93      rillig   3715: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   3716: <a name="components.patch.structure"></a>13.3.1. Structure of a single patch file</h3></div></div></div>
1.76      rillig   3717: <p>The <code class="filename">patch-*</code> files should be in
1.110     hubertf  3718:   <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93      rillig   3719:   problems. (To force patches to apply with fuzz you can set
                   3720:   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94      dmcmahil 3721:   should contain only changes for a single file, and no file should be
1.93      rillig   3722:   patched by more than one patch file. This helps to keep future
                   3723:   modifications simple.</p>
                   3724: <p>Each patch file is structured as follows: In the first line,
                   3725:   there is the RCS Id of the patch itself. The second line should be
                   3726:   empty for aesthetic reasons. After that, there should be a comment for
                   3727:   each change that the patch does. There are a number of standard
                   3728:   cases:</p>
1.148     asau     3729: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      3730: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.93      rillig   3731:   mention the vulnerability ID (CAN, CVE).</p></li>
1.128     wiz      3732: <li class="listitem"><p>Patches that change source code should mention the
1.93      rillig   3733:   platform and other environment (for example, the compiler) that the
                   3734:   patch is needed for.</p></li>
                   3735: </ul></div>
1.219     rillig   3736: <p>The patch should be commented so that any
1.93      rillig   3737:   developer who knows the code of the application can make some use of
                   3738:   the patch. Special care should be taken for the upstream developers,
                   3739:   since we generally want that they accept our patches, so we have less
                   3740:   work in the future.</p>
                   3741: </div>
1.148     asau     3742: <div class="sect2">
1.93      rillig   3743: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   3744: <a name="components.patches.caveats"></a>13.3.2. Creating patch files</h3></div></div></div>
1.93      rillig   3745: <p>One important thing to mention is to pay attention that no RCS
                   3746:   IDs get stored in the patch files, as these will cause problems when
1.87      wiz      3747:   later checked into the NetBSD CVS tree. Use the
1.250     leot     3748:   <span class="command"><strong>pkgdiff</strong></span> command from the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package to avoid these
1.93      rillig   3749:   problems.</p>
1.87      wiz      3750: <p>For even more automation, we recommend using
1.110     hubertf  3751:   <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.87      wiz      3752:   whole set of patches. You just have to backup files before you
                   3753:   edit them to <code class="filename">filename.orig</code>, e.g. with
1.110     hubertf  3754:   <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
                   3755:   using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.87      wiz      3756:   you upgrade a package this way, you can easily compare the new
                   3757:   set of patches with the previously existing one with
1.130     wiz      3758:   <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
                   3759:   are replaced by new files, so carefully check if you want to take all
                   3760:   the changes.</p>
1.87      wiz      3761: <p>When you have finished a package, remember to generate
1.110     hubertf  3762:   the checksums for the patch files by using the <span class="command"><strong>make
1.267     rillig   3763:   makepatchsum</strong></span> command, see <a class="xref" href="#components.distinfo" title="13.2. distinfo">Section 13.2, &#8220;<code class="filename">distinfo</code>&#8221;</a>.</p>
1.87      wiz      3764: <p>When adding a patch that corrects a problem in the
                   3765:   distfile (rather than e.g. enforcing pkgsrc's view of where
                   3766:   man pages should go), send the patch as a bug report to the
                   3767:   maintainer.  This benefits non-pkgsrc users of the package,
                   3768:   and usually makes it possible to remove the patch in future
                   3769:   version.</p>
1.101     rillig   3770: <p>The file names of the patch files are usually of the form
1.130     wiz      3771:   <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
                   3772:   Many packages still use the previous convention
                   3773:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
                   3774:   but new patches should be of the form containing the filename.
1.250     leot     3775:   <span class="command"><strong>mkpatches</strong></span> included in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> takes care of the name
1.130     wiz      3776:   automatically.</p>
1.93      rillig   3777: </div>
1.148     asau     3778: <div class="sect2">
1.93      rillig   3779: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   3780: <a name="components.patches.sources"></a>13.3.3. Sources where the patch files come from</h3></div></div></div>
1.87      wiz      3781: <p>If you want to share patches between multiple packages
                   3782:   in pkgsrc, e.g. because they use the same distfiles, set
                   3783:   <code class="varname">PATCHDIR</code> to the path where the patch files
                   3784:   can be found, e.g.:</p>
                   3785: <pre class="programlisting">
1.100     rillig   3786: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93      rillig   3787: </pre>
1.75      rillig   3788: <p>Patch files that are distributed by the author or other
1.87      wiz      3789:     maintainers can be listed in
                   3790:     <code class="varname">PATCHFILES</code>.</p>
                   3791: <p>If it is desired to store any patches that should not be
                   3792:     committed into pkgsrc, they can be kept outside the pkgsrc
                   3793:     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
                   3794:     directory tree there is expected to have the same
1.128     wiz      3795:     <span class="quote">&#8220;<span class="quote">category/package</span>&#8221;</span> structure as pkgsrc, and
1.87      wiz      3796:     patches are expected to be stored inside these dirs (also
                   3797:     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
                   3798:     example, if you want to keep a private patch for
                   3799:     <code class="filename">pkgsrc/graphics/png</code>, keep it in
                   3800:     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
                   3801:     files in the named directory are expected to be patch files,
                   3802:     and <span class="emphasis"><em>they are applied after pkgsrc patches are
                   3803:     applied</em></span>.</p>
1.93      rillig   3804: </div>
1.148     asau     3805: <div class="sect2">
1.85      jmmv     3806: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   3807: <a name="components.patches.guidelines"></a>13.3.4. Patching guidelines</h3></div></div></div>
1.85      jmmv     3808: <p>When fixing a portability issue in the code do not use
                   3809:       preprocessor magic to check for the current operating system nor
                   3810:       platform.  Doing so hurts portability to other platforms because
                   3811:       the OS-specific details are not abstracted appropriately.</p>
                   3812: <p>The general rule to follow is: instead of checking for the
                   3813:       operating system the application is being built on, check for the
                   3814:       specific <span class="emphasis"><em>features</em></span> you need.  For example,
                   3815:       instead of assuming that kqueue is available under NetBSD and
                   3816:       using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.126     jakllsch 3817:       kqueue support, add a check that detects kqueue itself &mdash;
1.85      jmmv     3818:       yes, this generally involves patching the
1.110     hubertf  3819:       <span class="command"><strong>configure</strong></span> script.  There is absolutely nothing
1.85      jmmv     3820:       that prevents some OSes from adopting interfaces from other OSes
                   3821:       (e.g. Linux implementing kqueue), something that the above checks
                   3822:       cannot take into account.</p>
                   3823: <p>Of course, checking for features generally involves more
                   3824:       work on the developer's side, but the resulting changes are
1.87      wiz      3825:       cleaner and there are chances they will work on many other
1.85      jmmv     3826:       platforms.  Not to mention that there are higher chances of being
                   3827:       later integrated into the mainstream sources.  Remember:
                   3828:       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
                   3829: <p>Some typical examples:</p>
                   3830: <div class="table">
1.267     rillig   3831: <a name="patch-examples"></a><p class="title"><b>Table 13.1. Patching examples</b></p>
1.216     tnn      3832: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
1.85      jmmv     3833: <colgroup>
                   3834: <col>
                   3835: <col>
                   3836: <col>
                   3837: </colgroup>
                   3838: <thead><tr>
                   3839: <th>Where</th>
                   3840: <th>Incorrect</th>
                   3841: <th>Correct</th>
                   3842: </tr></thead>
                   3843: <tbody>
                   3844: <tr>
                   3845: <td>configure script</td>
                   3846: <td>
1.100     rillig   3847: <pre class="programlisting">
                   3848: case ${target_os} in
                   3849: netbsd*) have_kvm=yes ;;
                   3850: *)       have_kvm=no  ;;
                   3851: esac
                   3852: </pre>
1.85      jmmv     3853:              </td>
                   3854: <td>
1.100     rillig   3855: <pre class="programlisting">
                   3856: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
                   3857: </pre>
1.85      jmmv     3858:              </td>
                   3859: </tr>
                   3860: <tr>
                   3861: <td>C source file</td>
                   3862: <td>
1.100     rillig   3863: <pre class="programlisting">
                   3864: #if defined(__NetBSD__)
                   3865: #  include &lt;sys/event.h&gt;
                   3866: #endif
                   3867: </pre>
1.85      jmmv     3868:              </td>
                   3869: <td>
1.100     rillig   3870: <pre class="programlisting">
                   3871: #if defined(HAVE_SYS_EVENT_H)
                   3872: #  include &lt;sys/event.h&gt;
                   3873: #endif
                   3874: </pre>
1.85      jmmv     3875:              </td>
                   3876: </tr>
                   3877: <tr>
                   3878: <td>C source file</td>
                   3879: <td>
1.100     rillig   3880: <pre class="programlisting">
                   3881: int
                   3882: monitor_file(...)
                   3883: {
                   3884: #if defined(__NetBSD__)
                   3885:         int fd = kqueue();
                   3886:         ...
                   3887: #else
                   3888:         ...
                   3889: #endif
                   3890: }
                   3891: </pre>
1.85      jmmv     3892:              </td>
                   3893: <td>
1.100     rillig   3894: <pre class="programlisting">
                   3895: int
                   3896: monitor_file(...)
                   3897: {
                   3898: #if defined(HAVE_KQUEUE)
                   3899:         int fd = kqueue();
                   3900:         ...
                   3901: #else
1.223     rillig   3902:         ...
1.100     rillig   3903: #endif
                   3904: }
                   3905: </pre>
1.85      jmmv     3906:              </td>
                   3907: </tr>
                   3908: </tbody>
1.91      rillig   3909: </table></div>
1.85      jmmv     3910: </div>
1.254     maya     3911: <br class="table-break">
1.85      jmmv     3912: </div>
1.148     asau     3913: <div class="sect2">
1.85      jmmv     3914: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   3915: <a name="components.patches.feedback"></a>13.3.5. Feedback to the author</h3></div></div></div>
1.85      jmmv     3916: <p>Always, always, <span class="strong"><strong>always</strong></span>
                   3917:       feed back any <span class="emphasis"><em>portability fixes</em></span> or
                   3918:       improvements you do to a package to the mainstream developers.
                   3919:       This is the only way to get their attention on portability issues
                   3920:       and to ensure that future versions can be built out-of-the box on
                   3921:       NetBSD.  Furthermore, any user that gets newer distfiles will get
                   3922:       the fixes straight from the packaged code.</p>
1.93      rillig   3923: <p>This generally involves cleaning up the patches
                   3924:       (because sometimes the patches that are
1.147     wiz      3925:       added to pkgsrc are quick hacks), filing bug reports in the
1.85      jmmv     3926:       appropriate trackers for the projects and working with the
                   3927:       mainstream authors to accept your changes.  It is
                   3928:       <span class="emphasis"><em>extremely important</em></span> that you do it so that
                   3929:       the packages in pkgsrc are kept simple and thus further changes
                   3930:       can be done without much hassle.</p>
1.130     wiz      3931: <p>When you have done this, please add a URL to the upstream
                   3932:       bug report to the patch comment.</p>
1.85      jmmv     3933: <p>Support the idea of free software!</p>
                   3934: </div>
1.75      rillig   3935: </div>
1.148     asau     3936: <div class="sect1">
1.75      rillig   3937: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3938: <a name="other-mandatory-files"></a>13.4. Other mandatory files</h2></div></div></div>
1.148     asau     3939: <div class="variablelist"><dl class="variablelist">
1.76      rillig   3940: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75      rillig   3941: <dd><p>A multi-line description of the piece of software.  This should include
1.87      wiz      3942:          any credits where they are due.  Please bear in mind that others do not
                   3943:          share your sense of humour (or spelling idiosyncrasies), and that others
                   3944:          will read everything that you write here.</p></dd>
1.76      rillig   3945: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87      wiz      3946: <dd><p>This file governs the files that are installed on your
                   3947:          system: all the binaries, manual pages, etc. There are other
                   3948:          directives which may be entered in this file, to control the
                   3949:          creation and deletion of directories, and the location of
1.267     rillig   3950:          inserted files.  See <a class="xref" href="#plist" title="Chapter 15. PLIST issues">Chapter 15, <i>PLIST issues</i></a> for more
1.87      wiz      3951:          information.</p></dd>
1.75      rillig   3952: </dl></div>
                   3953: </div>
1.148     asau     3954: <div class="sect1">
1.75      rillig   3955: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3956: <a name="components.optional"></a>13.5. Optional files</h2></div></div></div>
1.148     asau     3957: <div class="sect2">
1.78      rillig   3958: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   3959: <a name="components.optional.bin"></a>13.5.1. Files affecting the binary package</h3></div></div></div>
1.148     asau     3960: <div class="variablelist"><dl class="variablelist">
1.76      rillig   3961: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.135     wiz      3962: <dd>
1.270     leot     3963: <p>This shell script is invoked twice by <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.87      wiz      3964:            First time after package extraction and before files are
                   3965:            moved in place, the second time after the files to install
                   3966:            are moved in place. This can be used to do any custom
                   3967:            procedures not possible with @exec commands in
1.270     leot     3968:            <code class="filename">PLIST</code>. See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
                   3969:            <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.  See also <a class="xref" href="#files-and-dirs-outside-prefix" title="17.1. Files and directories outside the installation prefix">Section 17.1, &#8220;Files and directories outside the installation prefix&#8221;</a>.
1.135     wiz      3970:            Please note that you can modify variables in it easily by using
                   3971:            <code class="varname">FILES_SUBST</code> in the package's
                   3972:            <code class="filename">Makefile</code>:</p>
                   3973: <pre class="programlisting">
                   3974: FILES_SUBST+=  SOMEVAR="somevalue"
                   3975: </pre>
                   3976: <p>replaces "@SOMEVAR@" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in the
                   3977:            <code class="filename">INSTALL</code>.  By default, substitution is
                   3978:            performed for <code class="varname">PREFIX</code>,
                   3979:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
                   3980:            <code class="varname">VARBASE</code>, and a few others, type
                   3981:            <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
                   3982:            complete list.</p>
                   3983: </dd>
1.76      rillig   3984: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75      rillig   3985: <dd><p>This script is executed before and after any files are removed.  It is
1.87      wiz      3986:            this script's responsibility to clean up any additional messy details
                   3987:            around the package's installation, since all pkg_delete knows is how to
                   3988:            delete the files created in the original distribution.
1.270     leot     3989:            See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
                   3990:            and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.135     wiz      3991:            The same methods to replace variables can be used as for
                   3992:            the <code class="filename">INSTALL</code> file.</p></dd>
1.76      rillig   3993: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75      rillig   3994: <dd>
                   3995: <p>This file is displayed after installation of the package.
1.87      wiz      3996:            Useful for things like legal notices on almost-free
                   3997:            software and hints for updating config files after
                   3998:            installing modules for apache, PHP etc.
                   3999:            Please note that you can modify variables in it easily by using
                   4000:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   4001:            <code class="filename">Makefile</code>:</p>
1.75      rillig   4002: <pre class="programlisting">
1.100     rillig   4003: MESSAGE_SUBST+=  SOMEVAR="somevalue"
                   4004: </pre>
1.128     wiz      4005: <p>replaces "${SOMEVAR}" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in
1.87      wiz      4006:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   4007:            performed for <code class="varname">PKGNAME</code>,
                   4008:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
1.209     sevan    4009:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
1.87      wiz      4010:            <code class="varname">PKG_SYSCONFDIR</code>,
                   4011:            <code class="varname">ROOT_GROUP</code>, and
1.117     jnemeth  4012:            <code class="varname">ROOT_USER</code>.</p>
1.87      wiz      4013: <p>You can display a different or additional files by
                   4014:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   4015:            default is <code class="filename">MESSAGE</code>, if the file
                   4016:            exists.</p>
1.75      rillig   4017: </dd>
1.78      rillig   4018: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.174     asau     4019: <dd>
                   4020: <p>This file is used by the alternatives framework.
                   4021:            It creates, configures, and destroys generic wrappers used to
                   4022:            run programs with similar interfaces.
                   4023:            See pkg_alternatives(8) from pkgtools/pkg_alternatives
                   4024:             for more information.</p>
                   4025: <p>Each line of the file contains two filenames, first
                   4026:            the wrapper and then the alternative provided by the package.
                   4027:            Both paths are relative to <code class="varname">PREFIX</code>.</p>
                   4028: </dd>
1.78      rillig   4029: </dl></div>
                   4030: </div>
1.148     asau     4031: <div class="sect2">
1.78      rillig   4032: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   4033: <a name="components.optional.build"></a>13.5.2. Files affecting the build process</h3></div></div></div>
1.148     asau     4034: <div class="variablelist"><dl class="variablelist">
1.78      rillig   4035: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   4036: <dd><p>This file contains arbitrary things that could
                   4037:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   4038:        to be used by more than one package. This file should only be
                   4039:        used when the packages that will use the file are known in
                   4040:        advance. For other purposes it is often better to write a
                   4041:        <code class="filename">*.mk</code> file and give it a good name that
                   4042:        describes what it does.</p></dd>
                   4043: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   4044: <dd><p>This file contains the dependency information
1.267     rillig   4045:        for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 16. Buildlink methodology">Chapter 16, <i>Buildlink methodology</i></a>).</p></dd>
1.78      rillig   4046: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   4047: <dd><p>This file contains workarounds for compiler bugs
                   4048:        and similar things. It is included automatically by the pkgsrc
                   4049:        infrastructure, so you don't need an extra
                   4050:        <code class="literal">.include</code> line for
                   4051:        it.</p></dd>
                   4052: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   4053: <dd><p>This file contains the code for the
1.267     rillig   4054:        package-specific options (see <a class="xref" href="#options" title="Chapter 18. Options handling">Chapter 18, <i>Options handling</i></a>) that can be
1.78      rillig   4055:        selected by the user. If a package has only one or two options,
                   4056:        it is equally acceptable to put the code directly into the
                   4057:        <code class="filename">Makefile</code>.</p></dd>
                   4058: </dl></div>
                   4059: </div>
1.148     asau     4060: <div class="sect2">
1.78      rillig   4061: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   4062: <a name="components.optional.none"></a>13.5.3. Files affecting nothing at all</h3></div></div></div>
1.148     asau     4063: <div class="variablelist"><dl class="variablelist">
1.78      rillig   4064: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   4065: <dd><p>These files do not take place in the creation of
                   4066:        a package and thus are purely informative to the package
                   4067:        developer.</p></dd>
                   4068: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   4069: <dd><p>This file contains things that need to be done
                   4070:        to make the package even
                   4071:        better.</p></dd>
1.75      rillig   4072: </dl></div>
                   4073: </div>
1.78      rillig   4074: </div>
1.148     asau     4075: <div class="sect1">
1.75      rillig   4076: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   4077: <a name="work-dir"></a>13.6. <code class="filename">work*</code>
1.93      rillig   4078: </h2></div></div></div>
1.110     hubertf  4079: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.87      wiz      4080:     unpacked into the directory denoted by
                   4081:     <code class="varname">WRKDIR</code>. It can be removed by running
1.110     hubertf  4082:     <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.87      wiz      4083:     directory is also used to keep various timestamp files.
                   4084:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   4085:     The default is <code class="filename">${.CURDIR}/work</code>
                   4086:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   4087:     if <code class="varname">OBJMACHINE</code> is set.</p>
1.75      rillig   4088: </div>
1.148     asau     4089: <div class="sect1">
1.75      rillig   4090: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   4091: <a name="files-dir"></a>13.7. <code class="filename">files/*</code>
1.93      rillig   4092: </h2></div></div></div>
1.75      rillig   4093: <p>If you have any files that you wish to be placed in the package prior
1.87      wiz      4094:     to configuration or building, you could place these files here and use
1.110     hubertf  4095:     a <span class="command"><strong>${CP}</strong></span> command in the
1.128     wiz      4096:     <span class="quote">&#8220;<span class="quote">pre-configure</span>&#8221;</span> target to achieve
1.87      wiz      4097:     this. Alternatively, you could simply diff the file against
                   4098:     <code class="filename">/dev/null</code> and use the patch mechanism to manage
                   4099:     the creation of this file.</p>
                   4100: <p>If you want to share files in this way with other
                   4101:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   4102:     to the other package's <code class="filename">files</code> directory,
                   4103:     e.g.:</p>
                   4104: <pre class="programlisting">
1.100     rillig   4105: FILESDIR=${.CURDIR}/../xemacs/files
                   4106: </pre>
1.75      rillig   4107: </div>
                   4108: </div>
1.148     asau     4109: <div class="chapter">
1.75      rillig   4110: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   4111: <a name="makefile"></a>Chapter 14. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75      rillig   4112: <div class="toc">
                   4113: <p><b>Table of Contents</b></p>
1.210     leot     4114: <dl class="toc">
1.267     rillig   4115: <dt><span class="sect1"><a href="#makefile.style">14.1. Caveats</a></span></dt>
                   4116: <dt><span class="sect1"><a href="#makefile.variables">14.2. <code class="filename">Makefile</code> variables</a></span></dt>
                   4117: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">14.2.1. Naming conventions</a></span></dt></dl></dd>
                   4118: <dt><span class="sect1"><a href="#makefile.code">14.3. Code snippets</a></span></dt>
                   4119: <dd><dl>
                   4120: <dt><span class="sect2"><a href="#adding-to-list">14.3.1. Adding things to a list</a></span></dt>
                   4121: <dt><span class="sect2"><a href="#echo-literal">14.3.2. Echoing a string exactly as-is</a></span></dt>
                   4122: <dt><span class="sect2"><a href="#cflags-gnu-configure">14.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
                   4123: <dt><span class="sect2"><a href="#empty-variables">14.3.4. Handling possibly empty variables</a></span></dt>
1.75      rillig   4124: </dl></dd>
                   4125: </dl>
                   4126: </div>
1.76      rillig   4127: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75      rillig   4128:   each of which forms a well-defined part of the pkgsrc system. Using
1.270     leot     4129:   the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.75      rillig   4130:   like pkgsrc requires some discipline to keep the code correct and
                   4131:   understandable.</p>
1.76      rillig   4132: <p>The basic ingredients for <code class="filename">Makefile</code>
1.267     rillig   4133:   programming are variables and shell
1.75      rillig   4134:   commands. Among these shell commands may even be more complex ones
1.270     leot     4135:   like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?awk+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.75      rillig   4136:   as intended it is necessary to quote all variables correctly when they
                   4137:   are used.</p>
1.267     rillig   4138: <p>This chapter describes some patterns that appear quite often in
1.76      rillig   4139:   <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75      rillig   4140:   with them.</p>
1.148     asau     4141: <div class="sect1">
1.75      rillig   4142: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   4143: <a name="makefile.style"></a>14.1. Caveats</h2></div></div></div>
1.148     asau     4144: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.97      rillig   4145: <p>When you are creating a file as a
                   4146:     target of a rule, always write the data to a temporary file first
                   4147:     and finally rename that file. Otherwise there might occur an error
                   4148:     in the middle of generating the file, and when the user runs
1.270     leot     4149:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
1.97      rillig   4150:     regenerated properly. Example:</p>
                   4151: <pre class="programlisting">
1.100     rillig   4152: wrong:
                   4153:         @echo "line 1" &gt; ${.TARGET}
                   4154:         @echo "line 2" &gt;&gt; ${.TARGET}
                   4155:         @false
                   4156: 
                   4157: correct:
                   4158:         @echo "line 1" &gt; ${.TARGET}.tmp
                   4159:         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
                   4160:         @false
                   4161:         @mv ${.TARGET}.tmp ${.TARGET}
1.97      rillig   4162: </pre>
1.110     hubertf  4163: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.97      rillig   4164:     <code class="filename">wrong</code> will exist, although there was an error
1.110     hubertf  4165:     message in the first run. On the other hand, running <span class="command"><strong>make
1.97      rillig   4166:     correct</strong></span> gives an error message twice, as expected.</p>
1.270     leot     4167: <p>You might remember that <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.97      rillig   4168:     <code class="literal">${.TARGET}</code> in case of error, but this only
                   4169:     happens when it is interrupted, for example by pressing
1.267     rillig   4170:     <code class="literal">Ctrl+C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.270     leot     4171:     when one of the commands fails (like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?false+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.97      rillig   4172: </li></ul></div>
                   4173: </div>
1.148     asau     4174: <div class="sect1">
1.97      rillig   4175: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   4176: <a name="makefile.variables"></a>14.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76      rillig   4177: <p><code class="filename">Makefile</code> variables contain strings that
1.267     rillig   4178:     can be processed using the five operators <code class="code">=</code>,
                   4179:     <code class="code">+=</code>, <code class="code">?=</code>, <code class="code">:=</code> and
1.270     leot     4180:     <code class="code">!=</code>, which are described in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.75      rillig   4181:     page.</p>
                   4182: <p>When a variable's value is parsed from a
1.267     rillig   4183:     <code class="filename">Makefile</code>, the hash character <code class="code">#</code> and
                   4184:     the backslash character <code class="code">\</code> are handled specially. If a
                   4185:     backslash is the last character in a line, that backslash is removed
                   4186:     from the line and the line continues with the next line of the file.</p>
                   4187: <p>The <code class="code">#</code> character starts a comment that reaches
                   4188:     until the end of the line. To get an actual <code class="code">#</code> character,
                   4189:     such as in a URL, write <code class="code">\#</code> instead.</p>
1.219     rillig   4190: <p>The evaluation of variables either happens immediately or lazy.
1.267     rillig   4191:     It happens immediately when the variable occurs on the right-hand
                   4192:     side of the <code class="code">:=</code> or the <code class="code">!=</code> operator, in a
1.219     rillig   4193:     <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
                   4194:     In the other cases, it is evaluated lazily.</p>
1.75      rillig   4195: <p>Some of the modifiers split the string into words and then
1.267     rillig   4196:     operate on the words, others operate on the string as a whole. When a
                   4197:     string is split into words, double quotes and single quotes are
1.270     leot     4198:     interpreted as delimiters, just like in <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.148     asau     4199: <div class="sect2">
1.75      rillig   4200: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   4201: <a name="makefile.variables.names"></a>14.2.1. Naming conventions</h3></div></div></div>
1.148     asau     4202: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4203: <li class="listitem"><p>All variable names starting with an underscore
1.75      rillig   4204:        are reserved for use by the pkgsrc infrastructure. They shall
1.267     rillig   4205:        not be used by packages.</p></li>
1.128     wiz      4206: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.75      rillig   4207:        lowercase variable names for the iteration
                   4208:        variables.</p></li>
1.267     rillig   4209: <li class="listitem"><p>All list variables should have a plural name,
                   4210:        such as <code class="varname">PKG_OPTIONS</code> or
1.75      rillig   4211:        <code class="varname">DISTFILES</code>.</p></li>
                   4212: </ul></div>
                   4213: </div>
                   4214: </div>
1.148     asau     4215: <div class="sect1">
1.75      rillig   4216: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   4217: <a name="makefile.code"></a>14.3. Code snippets</h2></div></div></div>
1.148     asau     4218: <div class="sect2">
1.75      rillig   4219: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   4220: <a name="adding-to-list"></a>14.3.1. Adding things to a list</h3></div></div></div>
1.220     wiz      4221: <p>When adding a string that possibly contains whitespace or quotes to
                   4222: a list (example 1), it must be quoted using the <code class="code">:Q</code>
                   4223: modifier.</p>
                   4224: <p>When adding another list to a list (example 2), it must not be
                   4225: quoted, since its elements are already quoted.</p>
1.75      rillig   4226: <pre class="programlisting">
1.220     wiz      4227: STRING=         foo * bar `date`
                   4228: LIST=           # empty
                   4229: ANOTHER_LIST=   a=b c=d
                   4230: 
                   4231: LIST+=          ${STRING:Q}       # 1
                   4232: LIST+=          ${ANOTHER_LIST}   # 2
                   4233: </pre>
1.75      rillig   4234: </div>
1.148     asau     4235: <div class="sect2">
1.75      rillig   4236: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   4237: <a name="echo-literal"></a>14.3.2. Echoing a string exactly as-is</h3></div></div></div>
1.220     wiz      4238: <p>Echoing a string containing special characters needs special
                   4239: work.</p>
1.75      rillig   4240: <pre class="programlisting">
1.100     rillig   4241: STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
1.219     rillig   4242: EXAMPLE_ENV=    string=${STRING:Q} x=multiple\ quoted\ words
1.1       grant    4243: 
1.100     rillig   4244: all:
                   4245:         echo ${STRING}                  # 1
1.219     rillig   4246:         echo ${STRING:Q}                # 2
                   4247:         printf '%s\n' ${STRING:Q}''     # 3
1.220     wiz      4248:         env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"'   # 4
1.1       grant    4249: </pre>
1.220     wiz      4250: <p>Example 1 leads to a syntax error in the shell, as the characters
                   4251: are just copied.</p>
                   4252: <p>Example 2 quotes the string so that the shell interprets it
                   4253: correctly. But the echo command may additionally interpret strings with a
                   4254: leading dash or those containing backslashes.</p>
1.270     leot     4255: <p>Example 3 can handle arbitrary strings, since <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?printf+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> only
1.252     leot     4256: interprets the format string, but not the next argument. The trailing
                   4257: single quotes handle the case when the string is empty. In that case, the
                   4258: :Q modifier would result in an empty string too, which would then be
1.270     leot     4259: skipped by the shell. For <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?printf+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> this doesn't make a difference,
1.252     leot     4260: but other programs may care.</p>
1.220     wiz      4261: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
                   4262: need to be quoted because the quoting has already been done
                   4263: when adding elements to the list.</p>
1.75      rillig   4264: </div>
1.148     asau     4265: <div class="sect2">
1.75      rillig   4266: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   4267: <a name="cflags-gnu-configure"></a>14.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
1.220     wiz      4268: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
                   4269: GNU-style configure script (especially those that call other configure
                   4270: scripts), it must not have leading or trailing whitespace, since
                   4271: otherwise the configure script gets confused. To trim leading and
                   4272: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
                   4273: following example:</p>
1.75      rillig   4274: <pre class="programlisting">
1.100     rillig   4275: CPPFLAGS=               # empty
1.220     wiz      4276: CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX}\"
1.100     rillig   4277: CPPFLAGS+=              ${MY_CPPFLAGS}
                   4278: 
                   4279: CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
                   4280: 
                   4281: all:
                   4282:         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
1.220     wiz      4283:         echo x${CONFIGURE_ARGS:Q}x      # properly trimmed
1.1       grant    4284: </pre>
1.220     wiz      4285: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
                   4286: trailing whitespace because the <code class="code">+=</code> operator always adds a
                   4287: space.</p>
                   4288: </div>
                   4289: <div class="sect2">
                   4290: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   4291: <a name="empty-variables"></a>14.3.4. Handling possibly empty variables</h3></div></div></div>
1.220     wiz      4292: <p>When a possibly empty variable is used in a shell program, it may
                   4293: lead to a syntax error.</p>
                   4294: <pre class="programlisting">
                   4295: EGFILES=        # empty
                   4296: 
                   4297: install-examples:   # produces a syntax error in the shell
                   4298:         for egfile in ${EGFILES}; do            \
                   4299:                 echo "Installing $$egfile";     \
                   4300:         done
                   4301: </pre>
                   4302: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.270     leot     4303: <code class="code">${EGFILES}</code> is replaced with an empty string by <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.
1.220     wiz      4304: To fix this syntax error, use one of the snippets below.</p>
                   4305: <pre class="programlisting">
                   4306: EMPTY=          # empty
                   4307: 
                   4308: install-examples:
                   4309:         for egfile in ${EGFILES} ""; do         \
                   4310:                 [ -n "$$egfile" ] || continue;  \
                   4311:                 echo "Installing $$egfile";     \
1.100     rillig   4312:         done
1.220     wiz      4313: </pre>
                   4314: <p>In this case, an empty string is appended to the iteration list (to
                   4315: prevent the syntax error) and filtered out later.</p>
                   4316: <pre class="programlisting">
                   4317: EGFILES=        # empty
1.100     rillig   4318: 
1.220     wiz      4319: install-examples:
                   4320: .for egfile in ${EGFILES}
                   4321:         echo "Installing ${egfile}"
1.100     rillig   4322: .endfor
1.1       grant    4323: </pre>
1.267     rillig   4324: <p>If one of the filenames contains special characters, it should be
                   4325: enclosed in single or double quotes.</p>
1.220     wiz      4326: <p>To have a shell command test whether a make variable is empty, use
                   4327: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
1.75      rillig   4328: </div>
                   4329: </div>
                   4330: </div>
1.148     asau     4331: <div class="chapter">
1.75      rillig   4332: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   4333: <a name="plist"></a>Chapter 15. PLIST issues</h2></div></div></div>
1.75      rillig   4334: <div class="toc">
                   4335: <p><b>Table of Contents</b></p>
1.210     leot     4336: <dl class="toc">
1.267     rillig   4337: <dt><span class="sect1"><a href="#rcs-id">15.1. RCS ID</a></span></dt>
                   4338: <dt><span class="sect1"><a href="#automatic-plist-generation">15.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   4339: <dt><span class="sect1"><a href="#print-PLIST">15.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
                   4340: <dt><span class="sect1"><a href="#plist.misc">15.4. Variable substitution in PLIST</a></span></dt>
                   4341: <dt><span class="sect1"><a href="#manpage-compression">15.5. Man page compression</a></span></dt>
                   4342: <dt><span class="sect1"><a href="#using-PLIST_SRC">15.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   4343: <dt><span class="sect1"><a href="#platform-specific-plist">15.7. Platform-specific and differing PLISTs</a></span></dt>
                   4344: <dt><span class="sect1"><a href="#build-plist">15.8. Build-specific PLISTs</a></span></dt>
                   4345: <dt><span class="sect1"><a href="#faq.common-dirs">15.9. Sharing directories between packages</a></span></dt>
1.75      rillig   4346: </dl>
                   4347: </div>
1.87      wiz      4348: <p>The <code class="filename">PLIST</code> file contains a package's
1.128     wiz      4349:   <span class="quote">&#8220;<span class="quote">packing list</span>&#8221;</span>, i.e. a list of files that belong to
1.87      wiz      4350:   the package (relative to the <code class="filename">${PREFIX}</code>
                   4351:   directory it's been installed in) plus some additional statements
1.270     leot     4352:   - see the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.87      wiz      4353:   This chapter addresses some issues that need attention when
                   4354:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   4355:   below!).</p>
1.148     asau     4356: <div class="sect1">
1.75      rillig   4357: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   4358: <a name="rcs-id"></a>15.1. RCS ID</h2></div></div></div>
1.87      wiz      4359: <p>Be sure to add a RCS ID line as the first thing in any
                   4360:     <code class="filename">PLIST</code> file you write:</p>
1.75      rillig   4361: <pre class="programlisting">
1.233     sevan    4362: @comment $NetBSD $
1.222     sevan    4363: </pre>
1.235     yyamano  4364: <p>An artificial space has been added between NetBSD and $, this is a
1.233     sevan    4365: workaround here to prevent CVS expanding to the filename of the guide. When
1.238     leot     4366: adding the RCS ID the space should be omitted.</p>
1.75      rillig   4367: </div>
1.148     asau     4368: <div class="sect1">
1.75      rillig   4369: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   4370: <a name="automatic-plist-generation"></a>15.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.110     hubertf  4371: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.87      wiz      4372:     to output a PLIST that matches any new files since the package
1.267     rillig   4373:     was extracted.  See <a class="xref" href="#build.helpful-targets" title="19.17. Other helpful targets">Section 19.17, &#8220;Other helpful targets&#8221;</a> for
1.87      wiz      4374:     more information on this target.</p>
1.75      rillig   4375: </div>
1.148     asau     4376: <div class="sect1">
1.75      rillig   4377: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   4378: <a name="print-PLIST"></a>15.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.93      rillig   4379: </h2></div></div></div>
1.87      wiz      4380: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   4381:     of AWK patterns and actions that are used to filter the output of
                   4382:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   4383:     scripting you like to it, but be careful with quoting.</p>
                   4384: <p>For example, to get all files inside the
                   4385:     <code class="filename">libdata/foo</code> directory removed from the
                   4386:     resulting PLIST:</p>
                   4387: <pre class="programlisting">
1.100     rillig   4388: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
1.222     sevan    4389: </pre>
1.75      rillig   4390: </div>
1.148     asau     4391: <div class="sect1">
1.75      rillig   4392: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   4393: <a name="plist.misc"></a>15.4. Variable substitution in PLIST</h2></div></div></div>
1.87      wiz      4394: <p>A number of variables are substituted automatically in
                   4395:     PLISTs when a package is installed on a system. This includes the
                   4396:     following variables:</p>
1.148     asau     4397: <div class="variablelist"><dl class="variablelist">
1.75      rillig   4398: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   4399: <dd>
                   4400: <p>Some packages like emacs and perl embed information
1.87      wiz      4401:          about which architecture they were built on into the
                   4402:          pathnames where they install their files. To handle this
                   4403:          case, PLIST will be preprocessed before actually used, and
                   4404:          the symbol
1.128     wiz      4405:          <span class="quote">&#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221;</span> will be
1.110     hubertf  4406:          replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.87      wiz      4407:          same is done if the string
                   4408:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   4409:          PLIST somewhere - use this on packages that have GNU
                   4410:          autoconf-created configure scripts.</p>
1.148     asau     4411: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   4412: <h3 class="title">Legacy note</h3>
                   4413: <p>There used to be a symbol
1.128     wiz      4414:            <span class="quote">&#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221;</span> that
1.110     hubertf  4415:            was replaced by the output of <span class="command"><strong>uname
1.87      wiz      4416:            -m</strong></span>, but that's no longer supported and has
                   4417:            been removed.</p>
1.75      rillig   4418: </div>
                   4419: </dd>
                   4420: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   4421: <dd>
                   4422: <p>Some packages want to embed the OS name and version
1.87      wiz      4423:          into some paths.  To do this, use these variables in the
                   4424:          <code class="filename">PLIST</code>:
                   4425:          </p>
1.148     asau     4426: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4427: <li class="listitem"><p><code class="varname">${OPSYS}</code> - output of <span class="quote">&#8220;<span class="quote"><span class="command"><strong>uname -s</strong></span></span>&#8221;</span></p></li>
                   4428: <li class="listitem"><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. <span class="quote">&#8220;<span class="quote">solaris</span>&#8221;</span>)</p></li>
                   4429: <li class="listitem"><p><code class="varname">${OS_VERSION}</code> - <span class="quote">&#8220;<span class="quote"><span class="command"><strong>uname -r</strong></span></span>&#8221;</span></p></li>
1.75      rillig   4430: </ul></div>
                   4431: </dd>
                   4432: </dl></div>
1.199     tnn      4433: <p>For a list of values which are replaced by
                   4434:     default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
                   4435: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
                   4436: <code class="varname">PLIST_SUBST</code> should help.</p>
1.87      wiz      4437: <p>If you want to change other variables not listed above, you
                   4438:     can add variables and their expansions to this variable in the
1.267     rillig   4439:     following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a class="xref" href="#components.optional" title="13.5. Optional files">Section 13.5, &#8220;Optional files&#8221;</a>):</p>
1.75      rillig   4440: <pre class="programlisting">
1.100     rillig   4441: PLIST_SUBST+=   SOMEVAR="somevalue"
1.222     sevan    4442: </pre>
1.128     wiz      4443: <p>This replaces all occurrences of <span class="quote">&#8220;<span class="quote">${SOMEVAR}</span>&#8221;</span>
1.87      wiz      4444:     in the <code class="filename">PLIST</code> with
1.128     wiz      4445:     <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span>.</p>
1.120     snj      4446: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
1.119     mishka   4447:     the common case of conditionally including some
                   4448:     <code class="filename">PLIST</code> entries. It can be done by adding
                   4449:     <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
1.120     snj      4450:     setting the corresponding <code class="varname">PLIST.foo</code> variable
                   4451:     to <code class="literal">yes</code> if the entry should be included.
1.128     wiz      4452:     This will substitute <span class="quote">&#8220;<span class="quote"><code class="varname">${PLIST.foo}</code></span>&#8221;</span>
1.119     mishka   4453:     in the <code class="filename">PLIST</code> with either
1.128     wiz      4454:     <span class="quote">&#8220;<span class="quote"><code class="literal">""</code></span>&#8221;</span> or
                   4455:     <span class="quote">&#8220;<span class="quote"><code class="literal">"@comment "</code></span>&#8221;</span>.
1.119     mishka   4456:     For example, in <code class="filename">Makefile</code>:</p>
                   4457: <pre class="programlisting">
1.223     rillig   4458: PLIST_VARS+=    foo
1.119     mishka   4459: .if <em class="replaceable"><code>condition</code></em>
1.223     rillig   4460: PLIST.foo=      yes
1.119     mishka   4461: .else
1.222     sevan    4462: </pre>
1.119     mishka   4463: <p>And then in <code class="filename">PLIST</code>:</p>
                   4464: <pre class="programlisting">
1.233     sevan    4465: @comment $NetBSD $
1.119     mishka   4466: bin/bar
                   4467: man/man1/bar.1
                   4468: ${PLIST.foo}bin/foo
                   4469: ${PLIST.foo}man/man1/foo.1
                   4470: ${PLIST.foo}share/bar/foo.data
1.222     sevan    4471: </pre>
1.235     yyamano  4472: <p>An artificial space has been added between NetBSD and $, this is a
1.233     sevan    4473: workaround here to prevent CVS expanding to the filename of the guide. When
                   4474: adding the RCS ID the space should be ommited.</p>
1.75      rillig   4475: </div>
1.148     asau     4476: <div class="sect1">
1.75      rillig   4477: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   4478: <a name="manpage-compression"></a>15.5. Man page compression</h2></div></div></div>
1.75      rillig   4479: <p>Man pages should be installed in compressed form if
1.87      wiz      4480:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   4481:     and uncompressed otherwise. To handle this in the
1.128     wiz      4482:     <code class="filename">PLIST</code> file, the suffix <span class="quote">&#8220;<span class="quote">.gz</span>&#8221;</span> is
1.87      wiz      4483:     appended/removed automatically for man pages according to
                   4484:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   4485:     or not, see above for details. This modification of the
                   4486:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   4487:     <code class="filename">PLIST</code> itself.</p>
1.75      rillig   4488: </div>
1.148     asau     4489: <div class="sect1">
1.75      rillig   4490: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   4491: <a name="using-PLIST_SRC"></a>15.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.93      rillig   4492: </h2></div></div></div>
1.76      rillig   4493: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87      wiz      4494:     in generating the binary package, set the variable
                   4495:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.270     leot     4496:     The files are later concatenated using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cat+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.87      wiz      4497:     important. The default for <code class="varname">PLIST_SRC</code> is
                   4498:     <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75      rillig   4499: </div>
1.148     asau     4500: <div class="sect1">
1.75      rillig   4501: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   4502: <a name="platform-specific-plist"></a>15.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75      rillig   4503: <p>Some packages decide to install a different set of files based on
1.87      wiz      4504:     the operating system being used. These differences can be
                   4505:     automatically handled by using the following files:</p>
1.148     asau     4506: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4507: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
                   4508: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   4509: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   4510: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   4511: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.75      rillig   4512: </ul></div>
                   4513: </div>
1.148     asau     4514: <div class="sect1">
1.75      rillig   4515: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   4516: <a name="build-plist"></a>15.8. Build-specific PLISTs</h2></div></div></div>
1.197     wiz      4517: <p>Some packages decide to generate hard-to-guess file names
                   4518:     during installation that are hard to wire down.</p>
                   4519: <p>In such cases, you can set the
                   4520:     <code class="varname">GENERATE_PLIST</code> variable to shell code
                   4521:     terminated (with a semicolon) that will output PLIST entries which
                   4522:     will be appended to the PLIST</p>
                   4523: <p>You can find one example in editors/xemacs:</p>
                   4524: <pre class="programlisting">
1.222     sevan    4525: GENERATE_PLIST+=        ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
                   4526: </pre>
1.197     wiz      4527: <p>which will append something like
                   4528:     <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
                   4529:     <code class="filename">PLIST</code>.
                   4530:     </p>
                   4531: </div>
                   4532: <div class="sect1">
                   4533: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   4534: <a name="faq.common-dirs"></a>15.9. Sharing directories between packages</h2></div></div></div>
1.128     wiz      4535: <p>A <span class="quote">&#8220;<span class="quote">shared directory</span>&#8221;</span> is a directory where
1.87      wiz      4536:     multiple (and unrelated) packages install files.  These
1.125     wiz      4537:     directories were problematic because you had to add special
                   4538:     tricks in the PLIST to conditionally remove them, or have some
1.87      wiz      4539:     centralized package handle them.</p>
1.125     wiz      4540: <p>In pkgsrc, it is now easy: Each package should create
                   4541:     directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
                   4542:     will remove any directories left empty after uninstalling a
                   4543:     package.</p>
                   4544: <p>If a package needs an empty directory to work, create
                   4545:     the directory during installation as usual, and also add an
                   4546:     entry to the PLIST:
1.222     sevan    4547: 
                   4548: </p>
1.87      wiz      4549: <pre class="programlisting">
1.125     wiz      4550: @pkgdir path/to/empty/directory
1.222     sevan    4551: </pre>
1.125     wiz      4552: <p>
1.222     sevan    4553: 
1.197     wiz      4554:     or take a look at <code class="varname">MAKE_DIRS</code> and
                   4555:     <code class="varname">OWN_DIRS</code>.
1.125     wiz      4556:     </p>
1.75      rillig   4557: </div>
                   4558: </div>
1.148     asau     4559: <div class="chapter">
1.75      rillig   4560: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   4561: <a name="buildlink"></a>Chapter 16. Buildlink methodology</h2></div></div></div>
1.75      rillig   4562: <div class="toc">
                   4563: <p><b>Table of Contents</b></p>
1.210     leot     4564: <dl class="toc">
1.267     rillig   4565: <dt><span class="sect1"><a href="#converting-to-buildlink3">16.1. Converting packages to use buildlink3</a></span></dt>
                   4566: <dt><span class="sect1"><a href="#creating-buildlink3.mk">16.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75      rillig   4567: <dd><dl>
1.267     rillig   4568: <dt><span class="sect2"><a href="#anatomy-of-bl3">16.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   4569: <dt><span class="sect2"><a href="#updating-buildlink-depends">16.2.2. Updating
1.133     wiz      4570:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4571:       and
                   4572:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4573:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75      rillig   4574: </dl></dd>
1.267     rillig   4575: <dt><span class="sect1"><a href="#writing-builtin.mk">16.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.75      rillig   4576: <dd><dl>
1.267     rillig   4577: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">16.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
                   4578: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">16.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.75      rillig   4579: </dl></dd>
                   4580: </dl>
                   4581: </div>
                   4582: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87      wiz      4583:   are seen by a package's configure and build processes.  This is implemented
                   4584:   in a two step process:</p>
1.128     wiz      4585: <div class="orderedlist"><ol class="orderedlist" type="1">
                   4586: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.87      wiz      4587:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   4588:       of <code class="varname">WRKDIR</code>.</p></li>
1.128     wiz      4589: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.87      wiz      4590:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   4591:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   4592:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   4593:       native compiler on some operating systems look like GCC, so that
                   4594:       packages that expect GCC won't require modifications to build with
                   4595:       those native compilers.</p></li>
1.75      rillig   4596: </ol></div>
                   4597: <p>This normalizes the environment in which a package is built so that the
1.87      wiz      4598:   package may be built consistently despite what other software may be
                   4599:   installed. Please note that the normal system header and library paths,
                   4600:   e.g. <code class="filename">/usr/include</code>,
                   4601:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   4602:   designed to insulate the package build from non-system-supplied
                   4603:   software.</p>
1.148     asau     4604: <div class="sect1">
1.75      rillig   4605: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   4606: <a name="converting-to-buildlink3"></a>16.1. Converting packages to use buildlink3</h2></div></div></div>
1.75      rillig   4607: <p>The process of converting packages to use the buildlink3
1.128     wiz      4608:     framework (<span class="quote">&#8220;<span class="quote">bl3ifying</span>&#8221;</span>) is fairly straightforward.
1.87      wiz      4609:     The things to keep in mind are:</p>
1.128     wiz      4610: <div class="orderedlist"><ol class="orderedlist" type="1">
                   4611: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.87      wiz      4612:        instead of the actual toolchain.  Some packages are tricky,
                   4613:        and the only way to know for sure is the check
                   4614:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   4615:        wrappers are being invoked.</p></li>
1.128     wiz      4616: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.87      wiz      4617:        the package Makefile, e.g. Java VMs, standalone shells,
                   4618:        etc., because the code to symlink files into
                   4619:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.128     wiz      4620:        relative to <span class="quote">&#8220;<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>&#8221;</span>.
1.87      wiz      4621:        </p></li>
1.128     wiz      4622: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.87      wiz      4623:        <code class="filename">buildlink3.mk</code> files that you list in a
                   4624:        package's Makefile are added as dependencies for that package.
                   4625:        </p></li>
1.75      rillig   4626: </ol></div>
1.87      wiz      4627: <p>If a dependency on a particular package is required for its libraries and
                   4628:     headers, then we replace:</p>
1.75      rillig   4629: <pre class="programlisting">
1.100     rillig   4630: DEPENDS+=       foo&gt;=1.1.0:../../category/foo
                   4631: </pre>
1.75      rillig   4632: <p>with</p>
                   4633: <pre class="programlisting">
1.100     rillig   4634: .include "../../category/foo/buildlink3.mk"
                   4635: </pre>
1.75      rillig   4636: <p>The buildlink3.mk files usually define the required dependencies.
                   4637:     If you need a newer version of the dependency when using buildlink3.mk
1.87      wiz      4638:     files, then you can define it in your Makefile; for example:</p>
1.75      rillig   4639: <pre class="programlisting">
1.100     rillig   4640: BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
                   4641: .include "../../category/foo/buildlink3.mk"
                   4642: </pre>
1.76      rillig   4643: <p>There are several <code class="filename">buildlink3.mk</code>
1.87      wiz      4644:     files in <code class="filename">pkgsrc/mk</code>
                   4645:     that handle special package issues:</p>
1.148     asau     4646: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4647: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87      wiz      4648:        the native or a pkgsrc Berkeley DB implementation based on
                   4649:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   4650:        <code class="varname">BDB_DEFAULT</code>.</p></li>
1.128     wiz      4651: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87      wiz      4652:        comes with neither Curses nor NCurses, this will take care
1.250     leot     4653:        to install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/ncurses/README.html" target="_top"><code class="filename">devel/ncurses</code></a> package.</p></li>
1.128     wiz      4654: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87      wiz      4655:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   4656:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   4657:        require a Kerberos 5 implementation.</p></li>
1.128     wiz      4658: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.88      wiz      4659:        system-provided Motif installation or adds a dependency on
1.250     leot     4660:        <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/README.html" target="_top"><code class="filename">x11/lesstif</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/motif/README.html" target="_top"><code class="filename">x11/motif</code></a>. The user can set
1.128     wiz      4661:        <code class="varname">MOTIF_TYPE</code> to <span class="quote">&#8220;<span class="quote">dt</span>&#8221;</span>,
1.239     leot     4662:        <span class="quote">&#8220;<span class="quote">lesstif</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">motif</span>&#8221;</span>
                   4663:        to choose which Motif version will be used.</p></li>
1.161     ryoon    4664: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.162     wiz      4665:        system-provided GNU readline or editline (libedit) installation,
1.250     leot     4666:        or adds a dependency on <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/readline/README.html" target="_top"><code class="filename">devel/readline</code></a>,
                   4667:        <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/editline/README.html" target="_top"><code class="filename">devel/editline</code></a>. The user can set
1.161     ryoon    4668:        <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
                   4669:        If your package really needs GNU readline library, its Makefile
                   4670:        should include <code class="filename">devel/readline/buildlink3.mk</code>
                   4671:        instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.128     wiz      4672: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87      wiz      4673:        variables that may be used by packages that use the
                   4674:        Open Sound System (OSS) API.</p></li>
1.128     wiz      4675: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.142     wiz      4676:        any of the Postgres versions in the variable
                   4677:        <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
                   4678:        the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.87      wiz      4679:        the file for more information.</p></li>
1.128     wiz      4680: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87      wiz      4681:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.250     leot     4682:        a dependency on <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/pth/README.html" target="_top"><code class="filename">devel/pth</code></a> as needed.</p></li>
1.128     wiz      4683: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87      wiz      4684:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   4685:        library.</p></li>
1.75      rillig   4686: </ul></div>
1.76      rillig   4687: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87      wiz      4688:     files provide a more complete
                   4689:     description of how to use them properly.</p>
1.75      rillig   4690: </div>
1.148     asau     4691: <div class="sect1">
1.75      rillig   4692: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   4693: <a name="creating-buildlink3.mk"></a>16.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.107     rillig   4694: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.87      wiz      4695:     included by Makefiles to indicate the need to compile and link
                   4696:     against header files and libraries provided by the package.  A
                   4697:     <code class="filename">buildlink3.mk</code> file should always provide
                   4698:     enough information to add the correct type of dependency
                   4699:     relationship and include any other
                   4700:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   4701:     headers and libraries that it needs in turn.</p>
                   4702: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.250     leot     4703:     file for further editing, Rene Hexel's <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/createbuildlink/README.html" target="_top"><code class="filename">pkgtools/createbuildlink</code></a>
1.87      wiz      4704:     package is highly recommended.  For most packages, the following
                   4705:     command will generate a good starting point for
                   4706:     <code class="filename">buildlink3.mk</code> files:</p>
                   4707: <pre class="screen">
                   4708: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   4709: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   4710:     </pre>
1.148     asau     4711: <div class="sect2">
1.75      rillig   4712: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   4713: <a name="anatomy-of-bl3"></a>16.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75      rillig   4714: <p>The following real-life example
1.87      wiz      4715:       <code class="filename">buildlink3.mk</code> is taken
                   4716:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75      rillig   4717: <pre class="programlisting">
1.120     snj      4718: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1       grant    4719: 
1.223     rillig   4720: BUILDLINK_TREE+=        tiff
1.1       grant    4721: 
1.120     snj      4722: .if !defined(TIFF_BUILDLINK3_MK)
                   4723: TIFF_BUILDLINK3_MK:=
1.87      wiz      4724: 
1.223     rillig   4725: BUILDLINK_API_DEPENDS.tiff+=    tiff&gt;=3.6.1
                   4726: BUILDLINK_ABI_DEPENDS.tiff+=    tiff&gt;=3.7.2nb1
                   4727: BUILDLINK_PKGSRCDIR.tiff?=      ../../graphics/tiff
1.87      wiz      4728: 
1.100     rillig   4729: .include "../../devel/zlib/buildlink3.mk"
                   4730: .include "../../graphics/jpeg/buildlink3.mk"
1.120     snj      4731: .endif # TIFF_BUILDLINK3_MK
1.87      wiz      4732: 
1.223     rillig   4733: BUILDLINK_TREE+=        -tiff
1.100     rillig   4734: </pre>
1.87      wiz      4735: <p>The header and footer manipulate
1.120     snj      4736:       <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.87      wiz      4737:       <code class="filename">buildlink3.mk</code> files and is used to track
1.120     snj      4738:       the dependency tree.</p>
                   4739: <p>The main section is protected from multiple inclusion
1.87      wiz      4740:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   4741:       added.  Several important variables are set in the section:</p>
1.148     asau     4742: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4743: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.87      wiz      4744:          is the actual dependency recorded in the installed
                   4745:          package; this should always be set using
1.110     hubertf  4746:          <span class="command"><strong>+=</strong></span> to ensure that
1.87      wiz      4747:          we're appending to any pre-existing list of values.  This
                   4748:          variable should be set to the first version of the
1.133     wiz      4749:          package that had an backwards-incompatible API change.
1.87      wiz      4750:          </p></li>
1.128     wiz      4751: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.87      wiz      4752:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   4753:          pkgsrc directory.</p></li>
1.128     wiz      4754: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.87      wiz      4755:          (not shown above) controls whether we use
                   4756:          <code class="varname">BUILD_DEPENDS</code> or
                   4757:          <code class="varname">DEPENDS</code> to add the dependency on
                   4758:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   4759:          selected by setting
                   4760:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      4761:          to <span class="quote">&#8220;<span class="quote">build</span>&#8221;</span>.  By default, the full dependency is
1.87      wiz      4762:          used.</p></li>
1.128     wiz      4763: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   4764:            and
                   4765:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   4766:            (not shown above) are lists of subdirectories of
1.76      rillig   4767:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   4768:            to add to the header and library search paths.  These
1.128     wiz      4769:            default to <span class="quote">&#8220;<span class="quote">include</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">lib</span>&#8221;</span>
1.87      wiz      4770:          respectively.</p></li>
1.128     wiz      4771: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   4772:            (not shown above) is the list of preprocessor flags to add
                   4773:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.128     wiz      4774:            configure and build phases.  The <span class="quote">&#8220;<span class="quote">-I</span>&#8221;</span> option
1.75      rillig   4775:            should be avoided and instead be handled using
                   4776:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87      wiz      4777:          above.</p></li>
1.75      rillig   4778: </ul></div>
1.87      wiz      4779: <p>The following variables are all optionally defined within
                   4780:       this second section (protected against multiple inclusion) and
                   4781:       control which package files are symlinked into
                   4782:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   4783:       transformed during the symlinking:</p>
1.148     asau     4784: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4785: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   4786:            (not shown above) is a shell glob pattern relative to
1.76      rillig   4787:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   4788:            to be symlinked into
1.76      rillig   4789:            <code class="filename">${BUILDLINK_DIR}</code>,
1.87      wiz      4790:          e.g. <code class="filename">include/*.h</code>.</p></li>
1.128     wiz      4791: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.87      wiz      4792:            (not shown above) is a shell pipeline that
                   4793:            outputs to stdout a list of files relative to
                   4794:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   4795:            The resulting files are to be symlinked
                   4796:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   4797:            this takes the <code class="filename">+CONTENTS</code> of a
                   4798:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   4799:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.128     wiz      4800: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   4801:            (not shown above) is a filter command that filters
1.76      rillig   4802:            <code class="filename">+CONTENTS</code> input into a list of files
1.75      rillig   4803:            relative to
1.76      rillig   4804:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.194     bsiegert 4805:            on stdout.  By default,
1.75      rillig   4806:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76      rillig   4807:            outputs the contents of the <code class="filename">include</code>
                   4808:            and <code class="filename">lib</code> directories in the package
1.194     bsiegert 4809:            <code class="filename">+CONTENTS</code>.</p></li>
1.128     wiz      4810: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   4811:            (not shown above) is a list of sed arguments used to
                   4812:            transform the name of the source filename into a
1.110     hubertf  4813:            destination filename, e.g. <span class="command"><strong>-e
1.87      wiz      4814:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75      rillig   4815: </ul></div>
1.120     snj      4816: <p>This section can additionally include any
1.87      wiz      4817:       <code class="filename">buildlink3.mk</code> needed for
                   4818:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   4819:       Including these <code class="filename">buildlink3.mk</code> files
                   4820:       means that the headers and libraries for these
                   4821:       dependencies are also symlinked into
                   4822:       <code class="filename">${BUILDLINK_DIR}</code>
                   4823:       whenever the <em class="replaceable"><code>pkg</code></em>
                   4824:       <code class="filename">buildlink3.mk</code>
1.120     snj      4825:       file is included. Dependencies are only added for directly
                   4826:       include <code class="filename">buildlink3.mk</code> files.</p>
1.153     wiz      4827: <p>When providing a <code class="filename">buildlink3.mk</code> and
                   4828:       including other <code class="filename">buildlink3.mk</code> files in it,
1.156     wiz      4829:       please only add necessary ones, i.e., those whose libraries or
1.153     wiz      4830:       header files are automatically exposed when the package is
                   4831:       use.</p>
                   4832: <p>In particular, if only an executable
                   4833:       (<code class="filename">bin/foo</code>) is linked against a library, that
                   4834:       library does not need to be propagated in the
                   4835:       <code class="filename">buildlink3.mk</code> file.</p>
                   4836: <p>The following steps should help you decide if a
                   4837:       <code class="filename">buildlink3.mk</code> file needs to be included:
                   4838:       </p>
                   4839: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   4840: <li class="listitem"><p>Look at the installed header files: What
                   4841:        headers do they include? The packages providing these files
                   4842:        must be buildlinked.</p></li>
1.155     wiz      4843: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
                   4844:        libraries and look against what other libraries they link.
                   4845:        Some of the packages providing these probably need to be
                   4846:        buildlinked; however, it's not automatic, since e.g. GTK on
                   4847:        some systems pulls in the X libraries, so they will show up in
                   4848:        the <code class="filename">ldd</code> output, while on others (like OS
1.156     wiz      4849:        X) it won't. <code class="filename">ldd</code> output can thus only be
1.155     wiz      4850:        used as a hint.</p></li>
1.153     wiz      4851: </ul></div>
                   4852: <p>
                   4853:       </p>
1.75      rillig   4854: </div>
1.148     asau     4855: <div class="sect2">
1.75      rillig   4856: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   4857: <a name="updating-buildlink-depends"></a>16.2.2. Updating
1.87      wiz      4858:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133     wiz      4859:       and
                   4860:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4861:       in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
                   4862: <p>These two variables differ in that one describes source
                   4863:       compatibility (API) and the other binary compatibility (ABI).
                   4864:       The difference is that a change in the API breaks compilation of
                   4865:       programs while changes in the ABI stop compiled programs from
                   4866:       running.</p>
                   4867: <p>Changes to the
1.134     wiz      4868:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133     wiz      4869:       variable in a <code class="filename">buildlink3.mk</code> file happen
                   4870:       very rarely. One possible reason is that all packages depending
                   4871:       on this already need a newer version. In case it is bumped see
                   4872:       the description below.</p>
                   4873: <p>The most common example of an ABI change is that the major
                   4874:       version of a shared library is increased. In this case,
                   4875:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4876:       should be adjusted to require at least the new package version.
                   4877:       Then the packages that depend on this package need their
                   4878:       <code class="varname">PKGREVISION</code>s increased and, if they have
                   4879:       <code class="filename">buildlink3.mk</code> files, their
                   4880:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4881:       adjusted, too. This is needed so pkgsrc will require the correct
                   4882:       package dependency and not settle for an older one when building
                   4883:       the source.</p>
1.267     rillig   4884: <p>See <a class="xref" href="#dependencies" title="21.1.5. Handling dependencies">Section 21.1.5, &#8220;Handling dependencies&#8221;</a> for
1.133     wiz      4885:       more information about dependencies on other packages,
                   4886:       including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87      wiz      4887:       <code class="varname">ABI_DEPENDS</code> definitions.</p>
                   4888: <p>Please take careful consideration before adjusting
                   4889:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4890:       or
                   4891:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4892:       as we don't want to cause unneeded package deletions and
                   4893:       rebuilds.  In many cases, new versions of packages work just
                   4894:       fine with older dependencies.</p>
                   4895: <p>Also it is not needed to set
1.133     wiz      4896:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4897:       when it is identical to
1.87      wiz      4898:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.        </p>
1.75      rillig   4899: </div>
                   4900: </div>
1.148     asau     4901: <div class="sect1">
1.75      rillig   4902: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   4903: <a name="writing-builtin.mk"></a>16.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87      wiz      4904: <p>Some packages in pkgsrc install headers and libraries that
1.75      rillig   4905:       coincide with headers and libraries present in the base system.
1.76      rillig   4906:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   4907:       packages should also include a <code class="filename">builtin.mk</code>
1.75      rillig   4908:       file that includes the necessary checks to decide whether using
                   4909:       the built-in software or the pkgsrc software is
1.87      wiz      4910:     appropriate.</p>
                   4911: <p>The only requirements of a builtin.mk file for
                   4912:     <em class="replaceable"><code>pkg</code></em> are:</p>
1.128     wiz      4913: <div class="orderedlist"><ol class="orderedlist" type="1">
                   4914: <li class="listitem"><p>It should set
1.87      wiz      4915:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      4916:        to either <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>
1.87      wiz      4917:        after it is included.</p></li>
1.128     wiz      4918: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.87      wiz      4919:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   4920:        which is already set before the
                   4921:        <code class="filename">builtin.mk</code> file is included.</p></li>
1.128     wiz      4922: <li class="listitem"><p>It should be written to allow multiple inclusion.  This
1.87      wiz      4923:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   4924:        attention to <code class="filename">Makefile</code> coding.</p></li>
1.75      rillig   4925: </ol></div>
1.148     asau     4926: <div class="sect2">
1.75      rillig   4927: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   4928: <a name="anatomy-of-builtin.mk"></a>16.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
1.75      rillig   4929: <p>The following is the recommended template for builtin.mk
1.87      wiz      4930:       files:</p>
1.75      rillig   4931: <pre class="programlisting">
1.100     rillig   4932: .if !defined(IS_BUILTIN.foo)
                   4933: #
                   4934: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   4935: # genuinely exists in the system or not.
                   4936: #
                   4937: IS_BUILTIN.foo?=        no
                   4938: 
                   4939: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   4940: # version can be determined.
                   4941: #
                   4942: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   4943: BUILTIN_PKG.foo?=       foo-1.0
                   4944: .  endif
                   4945: .endif  # IS_BUILTIN.foo
                   4946: 
                   4947: .if !defined(USE_BUILTIN.foo)
                   4948: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   4949: .  if defined(BUILTIN_PKG.foo)
                   4950: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   4951: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   4952: USE_BUILTIN.foo!=                                                       \
                   4953:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
                   4954:         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
                   4955: .      endif
                   4956: .    endfor
                   4957: .  endif
                   4958: .endif  # USE_BUILTIN.foo
                   4959: 
                   4960: CHECK_BUILTIN.foo?=     no
                   4961: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   4962: #
                   4963: # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   4964: # "yes" or "no".
                   4965: #
                   4966: .endif  # CHECK_BUILTIN.foo
                   4967: </pre>
1.87      wiz      4968: <p>The first section sets
                   4969:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   4970:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   4971:       in the base system.  This should not be a base system software
                   4972:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.128     wiz      4973:       it should only be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> if the actual package is
1.87      wiz      4974:       included as part of the base system.  This variable is only
                   4975:       used internally within the <code class="filename">builtin.mk</code>
                   4976:       file.</p>
                   4977: <p>The second section sets
                   4978:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   4979:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   4980:       system if it exists (if
                   4981:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      4982:       is <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>).  This variable is only used internally
1.87      wiz      4983:       within the <code class="filename">builtin.mk</code> file.</p>
                   4984: <p>The third section sets
                   4985:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   4986:       and is <span class="emphasis"><em>required</em></span> in all
                   4987:       <code class="filename">builtin.mk</code> files.  The code in this
                   4988:       section must make the determination whether the built-in
                   4989:       software is adequate to satisfy the dependencies listed in
                   4990:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   4991:       This is typically done by comparing
                   4992:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   4993:       against each of the dependencies in
                   4994:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   4995:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   4996:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   4997:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   4998:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      4999:       may be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> even if
1.87      wiz      5000:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      5001:       is <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span> because we may make the determination
1.87      wiz      5002:       that the built-in version of the software is similar enough to
                   5003:       be used as a replacement.</p>
                   5004: <p>The last section is guarded by
                   5005:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   5006:       and includes code that uses the value of
                   5007:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5008:       set in the previous section.  This typically includes, e.g.,
                   5009:       adding additional dependency restrictions and listing additional
                   5010:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   5011:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75      rillig   5012: </div>
1.148     asau     5013: <div class="sect2">
1.75      rillig   5014: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   5015: <a name="native-or-pkgsrc-preference"></a>16.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87      wiz      5016: <p>When building packages, it's possible to choose whether to set
                   5017:        a global preference for using either the built-in (native)
                   5018:        version or the pkgsrc version of software to satisfy a
                   5019:        dependency.  This is controlled by setting
                   5020:        <code class="varname">PREFER_PKGSRC</code> and
                   5021:        <code class="varname">PREFER_NATIVE</code>.  These variables take values
1.128     wiz      5022:        of either <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>, or a list of
1.87      wiz      5023:        packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
                   5024:        use the pkgsrc versions of software, while
                   5025:        <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
                   5026:        built-in versions.  Preferences are determined by the most
                   5027:        specific instance of the package in either
                   5028:        <code class="varname">PREFER_PKGSRC</code> or
                   5029:        <code class="varname">PREFER_NATIVE</code>.  If a package is specified
                   5030:        in neither or in both variables, then
                   5031:        <code class="varname">PREFER_PKGSRC</code> has precedence over
                   5032:        <code class="varname">PREFER_NATIVE</code>.  For example, to require
                   5033:        using pkgsrc versions of software for all but the most basic
                   5034:       bits on a NetBSD system, you can set:</p>
                   5035: <pre class="programlisting">
1.100     rillig   5036: PREFER_PKGSRC=  yes
                   5037: PREFER_NATIVE=  getopt skey tcp_wrappers
                   5038: </pre>
1.87      wiz      5039: <p>A package <span class="emphasis"><em>must</em></span> have a
                   5040:       <code class="filename">builtin.mk</code>
                   5041:       file to be listed in <code class="varname">PREFER_NATIVE</code>,
                   5042:       otherwise it is simply ignored in that list.</p>
1.229     sevan    5043: <p>Setting <code class="varname">PREFER_NATIVE</code> should be performed
                   5044:       straight after bootstrap and <code class="varname">PREFER_PKGSRC</code> during
                   5045:       bootstrap.
                   5046:       Switching between settings globally at a later date can introduce
                   5047:       complications with dependency resolution. This is caused by packages
                   5048:       built with the opposite preference being installed alongside each other.</p>
                   5049: <pre class="screen">
                   5050: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes</code></strong>
                   5051: </pre>
1.75      rillig   5052: </div>
                   5053: </div>
                   5054: </div>
1.148     asau     5055: <div class="chapter">
1.75      rillig   5056: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   5057: <a name="pkginstall"></a>Chapter 17. The pkginstall framework</h2></div></div></div>
1.75      rillig   5058: <div class="toc">
                   5059: <p><b>Table of Contents</b></p>
1.210     leot     5060: <dl class="toc">
1.267     rillig   5061: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">17.1. Files and directories outside the installation prefix</a></span></dt>
1.75      rillig   5062: <dd><dl>
1.267     rillig   5063: <dt><span class="sect2"><a href="#dirs-outside-prefix">17.1.1. Directory manipulation</a></span></dt>
                   5064: <dt><span class="sect2"><a href="#files-outside-prefix">17.1.2. File manipulation</a></span></dt>
1.75      rillig   5065: </dl></dd>
1.267     rillig   5066: <dt><span class="sect1"><a href="#conf-files">17.2. Configuration files</a></span></dt>
1.75      rillig   5067: <dd><dl>
1.267     rillig   5068: <dt><span class="sect2"><a href="#conf-files-sysconfdir">17.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   5069: <dt><span class="sect2"><a href="#conf-files-configure">17.2.2. Telling the software where configuration files are</a></span></dt>
                   5070: <dt><span class="sect2"><a href="#conf-files-patching">17.2.3. Patching installations</a></span></dt>
                   5071: <dt><span class="sect2"><a href="#conf-files-disable">17.2.4. Disabling handling of configuration files</a></span></dt>
                   5072: </dl></dd>
                   5073: <dt><span class="sect1"><a href="#rcd-scripts">17.3. System startup scripts</a></span></dt>
                   5074: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">17.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
                   5075: <dt><span class="sect1"><a href="#users-and-groups">17.4. System users and groups</a></span></dt>
                   5076: <dt><span class="sect1"><a href="#shells">17.5. System shells</a></span></dt>
                   5077: <dd><dl><dt><span class="sect2"><a href="#shells-disable">17.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   5078: <dt><span class="sect1"><a href="#fonts">17.6. Fonts</a></span></dt>
                   5079: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">17.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.75      rillig   5080: </dl>
                   5081: </div>
                   5082: <p>This chapter describes the framework known as
                   5083: <code class="literal">pkginstall</code>, whose key features are:</p>
1.148     asau     5084: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5085: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.75      rillig   5086:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.128     wiz      5087: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.75      rillig   5088:     provided that packages are correctly designed.</p></li>
1.128     wiz      5089: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
                   5090: <li class="listitem"><p>Registration of system users and groups.</p></li>
                   5091: <li class="listitem"><p>Registration of system shells.</p></li>
                   5092: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.75      rillig   5093: </ul></div>
                   5094: <p>The following sections inspect each of the above points in detail.</p>
                   5095: <p>You may be thinking that many of the things described here could be
                   5096: easily done with simple code in the package's post-installation target
                   5097: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   5098: as the code in them is only executed when building from source.  Machines
                   5099: using binary packages could not benefit from it at all (as the code itself
                   5100: could be unavailable).  Therefore, the only way to achieve any of the items
                   5101: described above is by means of the installation scripts, which are
                   5102: automatically generated by pkginstall.</p>
1.148     asau     5103: <div class="sect1">
1.75      rillig   5104: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   5105: <a name="files-and-dirs-outside-prefix"></a>17.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76      rillig   5106: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75      rillig   5107: of files and directories that belong to a package.  The names used in it
1.76      rillig   5108: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75      rillig   5109: which means that it cannot register files outside this directory (absolute
                   5110: path names are not allowed).  Despite this restriction, some packages need
                   5111: to install files outside this location; e.g., under
1.76      rillig   5112: <code class="filename">${VARBASE}</code> or
1.87      wiz      5113: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   5114: is to create such files during installation time by using
                   5115: installation scripts.</p>
                   5116: <p>The generic installation scripts are shell scripts that can
                   5117: contain arbitrary code.  The list of scripts to execute is taken from
                   5118: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   5119: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   5120: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   5121: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   5122: commands, so they have the potential to create and manage files
                   5123: anywhere in the file system.</p>
                   5124: <p>Using these general installation files is not recommended, but
                   5125: may be needed in some special cases.  One reason for avoiding them is
                   5126: that the user has to trust the packager that there is no unwanted or
                   5127: simply erroneous code included in the installation script. Also,
                   5128: previously there were many similar scripts for the same functionality,
                   5129: and fixing a common error involved finding and changing all of
                   5130: them.</p>
                   5131: <p>The pkginstall framework offers another, standardized way.  It
                   5132: provides generic scripts to abstract the manipulation of such files
                   5133: and directories based on variables set in the package's
                   5134: <code class="filename">Makefile</code>.  The rest of this section describes
                   5135: these variables.</p>
1.148     asau     5136: <div class="sect2">
1.75      rillig   5137: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   5138: <a name="dirs-outside-prefix"></a>17.1.1. Directory manipulation</h3></div></div></div>
1.75      rillig   5139: <p>The following variables can be set to request the creation of
                   5140: directories anywhere in the file system:</p>
1.148     asau     5141: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.218     rillig   5142: <li class="listitem">
                   5143: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.75      rillig   5144:     contain a list of directories that should be created and should attempt
                   5145:     to be destroyed by the installation scripts.  The difference between
                   5146:     the two is that the latter prompts the administrator to remove any
                   5147:     directories that may be left after deinstallation (because they were
1.218     rillig   5148:     not empty), while the former does not.  Example:</p>
                   5149: <pre class="programlisting">
                   5150: MAKE_DIRS+=             ${VARBASE}/foo/private
                   5151: </pre>
                   5152: </li>
1.128     wiz      5153: <li class="listitem">
1.75      rillig   5154: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   5155:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   5156:     which directories should be created and should attempt to be destroyed
                   5157:     by the installation scripts.  Each tuple holds the following values,
                   5158:     separated by spaces: the directory name, its owner, its group and its
                   5159:     numerical mode.  For example:</p>
                   5160: <pre class="programlisting">
1.218     rillig   5161: MAKE_DIRS_PERMS+=       ${VARBASE}/foo/private \
                   5162:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1       grant    5163: </pre>
1.75      rillig   5164: <p>The difference between the two is exactly the same as their
                   5165:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5166: </li>
                   5167: </ul></div>
                   5168: </div>
1.148     asau     5169: <div class="sect2">
1.75      rillig   5170: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   5171: <a name="files-outside-prefix"></a>17.1.2. File manipulation</h3></div></div></div>
1.75      rillig   5172: <p>Creating non-empty files outside the installation prefix is tricky
1.76      rillig   5173: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75      rillig   5174: To overcome this problem, the only solution is to extract the file in the
                   5175: known place (i.e., inside the installation prefix) and copy it to the
                   5176: appropriate location during installation (done by the installation scripts
                   5177: generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
                   5178: file</em></span> in the following paragraphs, which describe the variables
                   5179: that can be used to automatically and consistently handle files outside the
                   5180: installation prefix:</p>
1.148     asau     5181: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5182: <li class="listitem">
1.75      rillig   5183: <p><code class="varname">CONF_FILES</code> and
1.137     wiz      5184:     <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.75      rillig   5185:     During installation time, the master file is copied to the target one
                   5186:     if and only if the latter does not exist.  Upon deinstallation, the
                   5187:     target file is removed provided that it was not modified by the
                   5188:     installation.</p>
                   5189: <p>The difference between the two is that the latter prompts the
                   5190:     administrator to remove any files that may be left after
                   5191:     deinstallation (because they were not empty), while the former does
                   5192:     not.</p>
                   5193: </li>
1.128     wiz      5194: <li class="listitem">
1.75      rillig   5195: <p><code class="varname">CONF_FILES_PERMS</code> and
1.137     wiz      5196:     <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.75      rillig   5197:     files as well as their target locations.  For each of them, it also
                   5198:     specifies their owner, their group and their numeric permissions, in
                   5199:     this order.  For example:</p>
                   5200: <pre class="programlisting">
1.218     rillig   5201: REQD_FILES_PERMS+=      ${PREFIX}/share/somefile ${VARBASE}/somefile \
                   5202:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1       grant    5203: </pre>
1.75      rillig   5204: <p>The difference between the two is exactly the same as their
                   5205:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5206: </li>
                   5207: </ul></div>
                   5208: </div>
                   5209: </div>
1.148     asau     5210: <div class="sect1">
1.75      rillig   5211: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   5212: <a name="conf-files"></a>17.2. Configuration files</h2></div></div></div>
1.75      rillig   5213: <p>Configuration files are special in the sense that they are installed
                   5214: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
                   5215: need special treatment during installation (most of which is automated by
                   5216: pkginstall).  The main concept you must bear in mind is that files marked
                   5217: as configuration files are automatically copied to the right place (somewhere
                   5218: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
                   5219: and only if</em></span> they didn't exist before.  Similarly, they will not
                   5220: be removed if they have local modifications.  This ensures that
                   5221: administrators never lose any custom changes they may have made.</p>
1.148     asau     5222: <div class="sect2">
1.75      rillig   5223: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   5224: <a name="conf-files-sysconfdir"></a>17.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
1.75      rillig   5225: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   5226: specifies where configuration files shall be installed.  Its contents are
                   5227: set based upon the following variables:</p>
1.148     asau     5228: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5229: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76      rillig   5230:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75      rillig   5231:     be overridden by the user to point to his preferred location (e.g.,
1.76      rillig   5232:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75      rillig   5233:     Packages must not use it directly.</p></li>
1.128     wiz      5234: <li class="listitem">
1.75      rillig   5235: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   5236:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   5237:     for the package being built shall be installed.  The definition of this
                   5238:     variable only makes sense in the package's
1.76      rillig   5239:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75      rillig   5240: <p>As an example, consider the Apache package,
1.250     leot     5241:     <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/README.html" target="_top"><code class="filename">www/apache24</code></a>, which places its
1.75      rillig   5242:     configuration files under the
1.76      rillig   5243:     <code class="filename">httpd/</code> subdirectory of
1.75      rillig   5244:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   5245:     Makefile.</p>
                   5246: </li>
1.128     wiz      5247: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.75      rillig   5248:     variable that holds this package's configuration directory (if
                   5249:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   5250:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   5251:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.128     wiz      5252: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.75      rillig   5253:     directory where the configuration files for the package identified by
                   5254:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   5255: </ul></div>
                   5256: <p>Based on the above variables, pkginstall determines the value of
                   5257: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
                   5258: variable that can be used within a package to refer to its configuration
                   5259: directory.  The algorithm used to set its value is basically the
                   5260: following:</p>
1.128     wiz      5261: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5262: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.75      rillig   5263:     its value is used.</p></li>
1.128     wiz      5264: <li class="listitem"><p>If the previous variable is not defined but
1.75      rillig   5265:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76      rillig   5266:     <code class="filename">Makefile</code>, the resulting value is
                   5267:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.128     wiz      5268: <li class="listitem"><p>Otherwise, it is set to
1.76      rillig   5269:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75      rillig   5270: </ol></div>
1.76      rillig   5271: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.267     rillig   5272: automatically added to <code class="filename">OWN_DIRS</code>.  See <a class="xref" href="#dirs-outside-prefix" title="17.1.1. Directory manipulation">Section 17.1.1, &#8220;Directory manipulation&#8221;</a> what this means.  This does not apply to
1.117     jnemeth  5273: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
                   5274: be created with OWN_DIRS or MAKE_DIRS.</p>
1.75      rillig   5275: </div>
1.148     asau     5276: <div class="sect2">
1.75      rillig   5277: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   5278: <a name="conf-files-configure"></a>17.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75      rillig   5279: <p>Given that pkgsrc (and users!) expect configuration files to be in a
                   5280: known place, you need to teach each package where it shall install its
                   5281: files.  In some cases you will have to patch the package Makefiles to
                   5282: achieve it.  If you are lucky, though, it may be as easy as passing an
                   5283: extra flag to the configuration script; this is the case of GNU Autoconf-
                   5284: generated files:</p>
                   5285: <pre class="programlisting">
1.100     rillig   5286: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1       grant    5287: </pre>
1.75      rillig   5288: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
                   5289: for</em></span> its configuration files, not where they will be originally
                   5290: installed (although the difference is never explicit,
                   5291: unfortunately).</p>
                   5292: </div>
1.148     asau     5293: <div class="sect2">
1.75      rillig   5294: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   5295: <a name="conf-files-patching"></a>17.2.3. Patching installations</h3></div></div></div>
1.75      rillig   5296: <p>As said before, pkginstall automatically handles configuration files.
                   5297: This means that <span class="strong"><strong>the packages themselves must not
1.76      rillig   5298: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75      rillig   5299: directly</strong></span>.  Bad news is that many software installation scripts
                   5300: will, out of the box, mess with the contents of that directory.  So what is
                   5301: the correct procedure to fix this issue?</p>
                   5302: <p>You must teach the package (usually by manually patching it) to
                   5303: install any configuration files under the examples hierarchy,
1.76      rillig   5304: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   5305: <code class="filename">PLIST</code> registers them and the administrator always
1.75      rillig   5306: has the original copies available.</p>
                   5307: <p>Once the required configuration files are in place (i.e., under the
                   5308: examples hierarchy), the pkginstall framework can use them as master copies
                   5309: during the package installation to update what is in
1.76      rillig   5310: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
1.75      rillig   5311: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.267     rillig   5312: used.  Check out <a class="xref" href="#files-outside-prefix" title="17.1.2. File manipulation">Section 17.1.2, &#8220;File manipulation&#8221;</a> for information
1.75      rillig   5313: about their syntax and their purpose.  Here is an example, taken from the
1.250     leot     5314: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/mail/mutt/README.html" target="_top"><code class="filename">mail/mutt</code></a> package:</p>
1.75      rillig   5315: <pre class="programlisting">
1.100     rillig   5316: EGDIR=        ${PREFIX}/share/doc/mutt/samples
                   5317: CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1       grant    5318: </pre>
1.75      rillig   5319: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
                   5320: package and has no meaning outside it.</p>
                   5321: </div>
1.148     asau     5322: <div class="sect2">
1.75      rillig   5323: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   5324: <a name="conf-files-disable"></a>17.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75      rillig   5325: <p>The automatic copying of config files can be toggled by setting the
                   5326: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   5327: installation.</p>
                   5328: </div>
                   5329: </div>
1.148     asau     5330: <div class="sect1">
1.75      rillig   5331: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   5332: <a name="rcd-scripts"></a>17.3. System startup scripts</h2></div></div></div>
1.75      rillig   5333: <p>System startup scripts are special files because they must be
                   5334: installed in a place known by the underlying OS, usually outside the
1.267     rillig   5335: installation prefix.  Therefore, the same rules described in <a class="xref" href="#files-and-dirs-outside-prefix" title="17.1. Files and directories outside the installation prefix">Section 17.1, &#8220;Files and directories outside the installation prefix&#8221;</a> apply, and the same solutions
1.75      rillig   5336: can be used.  However, pkginstall provides a special mechanism to handle
                   5337: these files.</p>
                   5338: <p>In order to provide system startup scripts, the package has
                   5339: to:</p>
1.128     wiz      5340: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5341: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75      rillig   5342:     the <code class="literal">.sh</code> suffix appended.  Considering the
1.250     leot     5343:     <a href="https://cdn.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   5344:     <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.128     wiz      5345: <li class="listitem">
1.75      rillig   5346: <p>Tell pkginstall to handle it, appending the name of the script,
                   5347:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   5348:     Continuing the previous example:</p>
                   5349: <pre class="programlisting">
1.100     rillig   5350: RCD_SCRIPTS+=   cupsd
1.1       grant    5351: </pre>
1.75      rillig   5352: </li>
                   5353: </ol></div>
                   5354: <p>Once this is done, pkginstall will do the following steps for each
                   5355: script in an automated fashion:</p>
1.128     wiz      5356: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5357: <li class="listitem"><p>Process the file found in the files directory applying all the
1.76      rillig   5358:     substitutions described in the <code class="filename">FILES_SUBST</code>
1.75      rillig   5359:     variable.</p></li>
1.128     wiz      5360: <li class="listitem"><p>Copy the script from the files directory to the examples
1.76      rillig   5361:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
1.75      rillig   5362:     that this master file must be explicitly registered in the
1.76      rillig   5363:     <code class="filename">PLIST</code>.</p></li>
1.128     wiz      5364: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.75      rillig   5365:     from the examples hierarchy into the system-wide startup scripts
                   5366:     directory.</p></li>
                   5367: </ol></div>
1.148     asau     5368: <div class="sect2">
1.75      rillig   5369: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   5370: <a name="rcd-scripts-disable"></a>17.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75      rillig   5371: <p>The automatic copying of config files can be toggled by setting the
                   5372: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   5373: installation.  Note that the scripts will be always copied inside the
1.76      rillig   5374: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75      rillig   5375: matter what the value of this variable is.</p>
                   5376: </div>
                   5377: </div>
1.148     asau     5378: <div class="sect1">
1.75      rillig   5379: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   5380: <a name="users-and-groups"></a>17.4. System users and groups</h2></div></div></div>
1.75      rillig   5381: <p>If a package needs to create special users and/or groups during
                   5382: installation, it can do so by using the pkginstall framework.</p>
                   5383: <p>Users can be created by adding entries to the
                   5384: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   5385: syntax:</p>
                   5386: <pre class="programlisting">
1.100     rillig   5387: user:group
1.1       grant    5388: </pre>
1.87      wiz      5389: <p>Further specification of user details may be done by setting
                   5390: per-user variables.
                   5391: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   5392: numeric UID for the user.
                   5393: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   5394: user's description or comment.
                   5395: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   5396: user's home directory, and defaults to
                   5397: <code class="filename">/nonexistent</code> if not specified.
                   5398: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94      dmcmahil 5399: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87      wiz      5400: not specified.</p>
1.75      rillig   5401: <p>Similarly, groups can be created by adding entries to the
                   5402: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   5403: <pre class="programlisting">
1.100     rillig   5404: group
1.1       grant    5405: </pre>
1.93      rillig   5406: <p>The numeric GID of the group may be set by defining
1.75      rillig   5407: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   5408: <p>If a package needs to create the users and groups at an earlier
1.227     wiz      5409: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
                   5410: <code class="literal">configure</code>,<code class="literal">build</code>, or
                   5411: <code class="literal">pre-install</code> to indicate the phase before which the
                   5412: users and groups are created. In this case, the numeric UIDs and GIDs
                   5413: of the created users and groups are automatically hardcoded into the
                   5414: final installation scripts.</p>
1.75      rillig   5415: </div>
1.148     asau     5416: <div class="sect1">
1.75      rillig   5417: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   5418: <a name="shells"></a>17.5. System shells</h2></div></div></div>
1.75      rillig   5419: <p>Packages that install system shells should register them in the shell
1.76      rillig   5420: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75      rillig   5421: administrator.  This must be done from the installation scripts to keep
                   5422: binary packages working on any system.  pkginstall provides an easy way to
                   5423: accomplish this task.</p>
                   5424: <p>When a package provides a shell interpreter, it has to set the
                   5425: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   5426: add some hooks to the installation scripts to handle it.  Consider the
1.250     leot     5427: following example, taken from <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/zsh/README.html" target="_top"><code class="filename">shells/zsh</code></a>:</p>
1.75      rillig   5428: <pre class="programlisting">
1.100     rillig   5429: PKG_SHELL=      ${PREFIX}/bin/zsh
1.1       grant    5430: </pre>
1.148     asau     5431: <div class="sect2">
1.75      rillig   5432: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   5433: <a name="shells-disable"></a>17.5.1. Disabling shell registration</h3></div></div></div>
1.75      rillig   5434: <p>The automatic registration of shell interpreters can be disabled by
1.76      rillig   5435: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75      rillig   5436: environment variable to <code class="literal">NO</code>.</p>
                   5437: </div>
                   5438: </div>
1.148     asau     5439: <div class="sect1">
1.75      rillig   5440: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   5441: <a name="fonts"></a>17.6. Fonts</h2></div></div></div>
1.75      rillig   5442: <p>Packages that install X11 fonts should update the database files
                   5443: that index the fonts within each fonts directory.  This can easily be
                   5444: accomplished within the pkginstall framework.</p>
                   5445: <p>When a package installs X11 fonts, it must list the directories in
                   5446: which fonts are installed in the
                   5447: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.128     wiz      5448: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">&#8220;<span class="quote">ttf</span>&#8221;</span>,
                   5449: <span class="quote">&#8220;<span class="quote">type1</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">x11</span>&#8221;</span>.  This will add hooks to the
1.75      rillig   5450: installation scripts to run the appropriate commands to update the fonts
                   5451: database files within each of those directories.  For convenience, if the
                   5452: directory path is relative, it is taken to be relative to the package's
1.250     leot     5453: installation prefix.  Consider the following example, taken from <a href="https://cdn.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   5454: <pre class="programlisting">
1.175     wiz      5455: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1       grant    5456: </pre>
1.148     asau     5457: <div class="sect2">
1.75      rillig   5458: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   5459: <a name="fonts-disable"></a>17.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75      rillig   5460: <p>The automatic update of fonts databases can be disabled by
1.76      rillig   5461: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75      rillig   5462: environment variable to <code class="literal">NO</code>.</p>
                   5463: </div>
                   5464: </div>
                   5465: </div>
1.148     asau     5466: <div class="chapter">
1.75      rillig   5467: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   5468: <a name="options"></a>Chapter 18. Options handling</h2></div></div></div>
1.75      rillig   5469: <div class="toc">
                   5470: <p><b>Table of Contents</b></p>
1.210     leot     5471: <dl class="toc">
1.267     rillig   5472: <dt><span class="sect1"><a href="#global-default-options">18.1. Global default options</a></span></dt>
                   5473: <dt><span class="sect1"><a href="#converting-to-options">18.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
                   5474: <dt><span class="sect1"><a href="#option-names">18.3. Option Names</a></span></dt>
                   5475: <dt><span class="sect1"><a href="#option-build">18.4. Determining the options of dependencies</a></span></dt>
1.75      rillig   5476: </dl>
                   5477: </div>
                   5478: <p>Many packages have the ability to be built to support different
1.76      rillig   5479: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
1.75      rillig   5480: in pkgsrc that provides generic handling of those options that
                   5481: determine different ways in which the packages can be built.  It's
                   5482: possible for the user to specify exactly which sets of options will be
                   5483: built into a package or to allow a set of global default options
                   5484: apply.</p>
1.107     rillig   5485: <p>There are two broad classes of behaviors that one might want to
                   5486: control via options.  One is whether some particular feature is
                   5487: enabled in a program that will be built anyway, often by including or
                   5488: not including a dependency on some other package.  The other is
                   5489: whether or not an additional program will be built as part of the
                   5490: package.  Generally, it is better to make a split package for such
                   5491: additional programs instead of using options, because it enables
                   5492: binary packages to be built which can then be added separately.  For
                   5493: example, the foo package might have minimal dependencies (those
                   5494: packages without which foo doesn't make sense), and then the foo-gfoo
                   5495: package might include the GTK frontend program gfoo.  This is better
                   5496: than including a gtk option to foo that adds gfoo, because either that
                   5497: option is default, in which case binary users can't get foo without
                   5498: gfoo, or not default, in which case they can't get gfoo.  With split
                   5499: packages, they can install foo without having GTK, and later decide to
                   5500: install gfoo (pulling in GTK at that time).  This is an advantage to
                   5501: source users too, avoiding the need for rebuilds.</p>
                   5502: <p>Plugins with widely varying dependencies should usually be split
                   5503: instead of options.</p>
                   5504: <p>It is often more work to maintain split packages, especially if
                   5505: the upstream package does not support this.  The decision of split
                   5506: vs. option should be made based on the likelihood that users will want
                   5507: or object to the various pieces, the size of the dependencies that are
                   5508: included, and the amount of work.</p>
                   5509: <p>A further consideration is licensing.  Non-free parts, or parts
                   5510: that depend on non-free dependencies (especially plugins) should
                   5511: almost always be split if feasible.</p>
1.148     asau     5512: <div class="sect1">
1.75      rillig   5513: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   5514: <a name="global-default-options"></a>18.1. Global default options</h2></div></div></div>
1.75      rillig   5515: <p>Global default options are listed in
                   5516: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   5517: that should be built into every package if that option is supported.
1.110     hubertf  5518: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   5519: </div>
1.148     asau     5520: <div class="sect1">
1.75      rillig   5521: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   5522: <a name="converting-to-options"></a>18.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.93      rillig   5523: </h2></div></div></div>
1.75      rillig   5524: <p>The following example shows how
1.76      rillig   5525: <code class="filename">bsd.options.mk</code> should be used
1.75      rillig   5526: by the hypothetical ``wibble'' package, either in the package
1.76      rillig   5527: <code class="filename">Makefile</code>, or in a file,
                   5528: e.g. <code class="filename">options.mk</code>, that is included by the
                   5529: main package <code class="filename">Makefile</code>.</p>
1.75      rillig   5530: <pre class="programlisting">
1.100     rillig   5531: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   5532: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   5533: PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   5534: PKG_OPTIONS_GROUP.database=     mysql pgsql
                   5535: PKG_SUGGESTED_OPTIONS=          wibble-foo
                   5536: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   5537: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
                   5538: 
                   5539: .include "../../mk/bsd.prefs.mk"
                   5540: 
                   5541: # this package was previously named wibble2
                   5542: .if defined(PKG_OPTIONS.wibble2)
                   5543: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   5544: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
                   5545:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
                   5546: .endif
                   5547: 
                   5548: .include "../../mk/bsd.options.mk"
                   5549: 
                   5550: # Package-specific option-handling
                   5551: 
                   5552: ###
                   5553: ### FOO support
                   5554: ###
                   5555: .if !empty(PKG_OPTIONS:Mwibble-foo)
                   5556: CONFIGURE_ARGS+=    --enable-foo
                   5557: .endif
                   5558: 
                   5559: ###
                   5560: ### LDAP support
                   5561: ###
                   5562: .if !empty(PKG_OPTIONS:Mldap)
                   5563: .  include "../../databases/openldap-client/buildlink3.mk"
                   5564: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
                   5565: .endif
                   5566: 
                   5567: ###
                   5568: ### database support
                   5569: ###
                   5570: .if !empty(PKG_OPTIONS:Mmysql)
                   5571: .  include "../../mk/mysql.buildlink3.mk"
                   5572: .endif
                   5573: .if !empty(PKG_OPTIONS:Mpgsql)
                   5574: .  include "../../mk/pgsql.buildlink3.mk"
                   5575: .endif
1.75      rillig   5576: </pre>
                   5577: <p>The first section contains the information about which build
                   5578: options are supported by the package, and any default options settings
                   5579: if needed.</p>
1.128     wiz      5580: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5581: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.270     leot     5582: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.75      rillig   5583: options.  It should be set to
1.78      rillig   5584: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   5585: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   5586: at the point where the options are processed.</p></li>
1.128     wiz      5587: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.75      rillig   5588: build options supported by the package.</p></li>
1.128     wiz      5589: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.75      rillig   5590: list of names of groups of mutually exclusive options.  The options in
                   5591: each group are listed in
                   5592: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   5593: The most specific setting of any option from the group takes
                   5594: precedence over all other options in the group.  Options from the
                   5595: groups will be automatically added to
                   5596: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.128     wiz      5597: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.75      rillig   5598: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   5599: packages will fail if no option from the group is
                   5600: selected.</p></li>
1.128     wiz      5601: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.75      rillig   5602: of names of sets of options.  At least one option from each set must
                   5603: be selected.  The options in each set are listed in
                   5604: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   5605: Options from the sets will be automatically added to
                   5606: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   5607: fail if no option from the set is selected.</p></li>
1.128     wiz      5608: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.75      rillig   5609: build options which are enabled by default.</p></li>
1.128     wiz      5610: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.75      rillig   5611: of
1.128     wiz      5612: <span class="quote">&#8220;<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>&#8221;</span>
1.110     hubertf  5613: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.75      rillig   5614: their option counterparts.  Pairs should be added with
1.128     wiz      5615: <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep the listing of global legacy variables.  A
1.75      rillig   5616: warning will be issued if the user uses a legacy
                   5617: variable.</p></li>
1.128     wiz      5618: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.75      rillig   5619: of
1.128     wiz      5620: <span class="quote">&#8220;<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>&#8221;</span>
1.75      rillig   5621: pairs that map options that have been renamed to their new
1.128     wiz      5622: counterparts.  Pairs should be added with <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep
1.75      rillig   5623: the listing of global legacy options.  A warning will be issued if
                   5624: the user uses a legacy option.</p></li>
1.128     wiz      5625: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.75      rillig   5626: options implied by deprecated variables used.  This can be used for
                   5627: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   5628: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   5629: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.128     wiz      5630: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.75      rillig   5631: a list of warnings about deprecated variables or options used, and
                   5632: what to use instead.</p></li>
                   5633: </ol></div>
                   5634: <p>A package should never modify
                   5635: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   5636: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   5637: To suggest a default set of options, use
                   5638: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   5639: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76      rillig   5640: including <code class="filename">bsd.options.mk</code>.  If none of
1.75      rillig   5641: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   5642: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   5643: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   5644: happen with platform-specific options if none of them is supported on
                   5645: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   5646: empty list and the package is otherwise treated as not using the
                   5647: options framework.</p>
1.76      rillig   5648: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75      rillig   5649: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   5650: build options, properly filtered to remove unsupported and duplicate
                   5651: options.</p>
                   5652: <p>The remaining sections contain the logic that is specific to
                   5653: each option.  The correct way to check for an option is to check
                   5654: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   5655: <pre class="programlisting">
1.100     rillig   5656: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75      rillig   5657: </pre>
                   5658: </div>
1.148     asau     5659: <div class="sect1">
1.75      rillig   5660: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   5661: <a name="option-names"></a>18.3. Option Names</h2></div></div></div>
1.75      rillig   5662: <p>Options that enable similar features in different packages (like
                   5663: optional support for a library) should use a common name in all
                   5664: packages that support it (like the name of the library).  If another
                   5665: package already has an option with the same meaning, use the same
                   5666: name.</p>
                   5667: <p>Options that enable features specific to one package, where it's
                   5668: unlikely that another (unrelated) package has the same (or a similar)
                   5669: optional feature, should use a name prefixed with
                   5670: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   5671: <p>If a group of related packages share an optional feature
                   5672: specific to that group, prefix it with the name of the
1.128     wiz      5673: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> package
1.75      rillig   5674: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   5675: <p>For new options, add a line to
1.76      rillig   5676: <code class="filename">mk/defaults/options.description</code>.  Lines have two
1.75      rillig   5677: fields, separated by tab.  The first field is the option name, the
                   5678: second its description.  The description should be a whole sentence
                   5679: (starting with an uppercase letter and ending with a period) that
1.128     wiz      5680: describes what enabling the option does.  E. g. <span class="quote">&#8220;<span class="quote">Enable ispell
                   5681: support.</span>&#8221;</span> The file is sorted by option names.</p>
1.75      rillig   5682: </div>
1.148     asau     5683: <div class="sect1">
1.107     rillig   5684: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   5685: <a name="option-build"></a>18.4. Determining the options of dependencies</h2></div></div></div>
1.110     hubertf  5686: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
1.107     rillig   5687: different dependencies based on the options with which the package was
                   5688: built. For querying these options, the file
                   5689: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
                   5690: typical example looks like this:</p>
                   5691: <pre class="programlisting">
                   5692: pkgbase := libpurple
                   5693: .include "../../mk/pkg-build-options.mk"
                   5694: 
                   5695: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
                   5696: ...
                   5697: .endif
                   5698: </pre>
                   5699: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
                   5700: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
                   5701: options of the libpurple package, which can then be queried like
                   5702: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
                   5703: file. See the file <code class="filename">pkg-build-options.mk</code> for more
                   5704: details.</p>
                   5705: </div>
1.75      rillig   5706: </div>
1.148     asau     5707: <div class="chapter">
1.75      rillig   5708: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   5709: <a name="build"></a>Chapter 19. The build process</h2></div></div></div>
1.75      rillig   5710: <div class="toc">
                   5711: <p><b>Table of Contents</b></p>
1.210     leot     5712: <dl class="toc">
1.267     rillig   5713: <dt><span class="sect1"><a href="#build.intro">19.1. Introduction</a></span></dt>
                   5714: <dt><span class="sect1"><a href="#build.prefix">19.2. Program location</a></span></dt>
                   5715: <dt><span class="sect1"><a href="#build.builddirs">19.3. Directories used during the build process</a></span></dt>
                   5716: <dt><span class="sect1"><a href="#build.running">19.4. Running a phase</a></span></dt>
                   5717: <dt><span class="sect1"><a href="#build.fetch">19.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   5718: <dd><dl>
                   5719: <dt><span class="sect2"><a href="#build.fetch.what">19.5.1. What to fetch and where to get it from</a></span></dt>
                   5720: <dt><span class="sect2"><a href="#build.fetch.how">19.5.2. How are the files fetched?</a></span></dt>
                   5721: </dl></dd>
                   5722: <dt><span class="sect1"><a href="#build.checksum">19.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   5723: <dt><span class="sect1"><a href="#build.extract">19.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   5724: <dt><span class="sect1"><a href="#build.patch">19.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   5725: <dt><span class="sect1"><a href="#build.tools">19.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   5726: <dt><span class="sect1"><a href="#build.wrapper">19.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   5727: <dt><span class="sect1"><a href="#build.configure">19.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   5728: <dt><span class="sect1"><a href="#build.build">19.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   5729: <dt><span class="sect1"><a href="#build.test">19.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   5730: <dt><span class="sect1"><a href="#build.install">19.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   5731: <dt><span class="sect1"><a href="#build.package">19.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   5732: <dt><span class="sect1"><a href="#build.clean">19.16. Cleaning up</a></span></dt>
                   5733: <dt><span class="sect1"><a href="#build.helpful-targets">19.17. Other helpful targets</a></span></dt>
1.75      rillig   5734: </dl>
                   5735: </div>
1.148     asau     5736: <div class="sect1">
1.75      rillig   5737: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   5738: <a name="build.intro"></a>19.1. Introduction</h2></div></div></div>
1.75      rillig   5739: <p>This chapter gives a detailed description on how a package is
1.87      wiz      5740:     built. Building a package is separated into different
                   5741:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   5742:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.120     snj      5743:     described in the following sections. Each phase is split into
1.87      wiz      5744:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   5745:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   5746:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   5747:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   5748:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97      rillig   5749: <p>Never override the regular targets (like
                   5750:     <code class="varname">fetch</code>), if you have to, override the
                   5751:     <code class="varname">do-*</code> ones instead.</p>
1.75      rillig   5752: <p>The basic steps for building a program are always the same.  First
1.87      wiz      5753:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   5754:     the local system and then extracted. After any pkgsrc-specific patches
                   5755:     to compile properly are applied, the software can be configured, then
                   5756:     built (usually by compiling), and finally the generated binaries, etc.
                   5757:     can be put into place on the system.</p>
1.97      rillig   5758: <p>To get more details about what is happening at each step,
                   5759:     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
                   5760:     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
                   5761:     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75      rillig   5762: </div>
1.148     asau     5763: <div class="sect1">
1.75      rillig   5764: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   5765: <a name="build.prefix"></a>19.2. Program location</h2></div></div></div>
1.75      rillig   5766: <p>Before outlining the process performed by the NetBSD package system in
1.87      wiz      5767:     the next section, here's a brief discussion on where programs are
                   5768:     installed, and which variables influence this.</p>
1.75      rillig   5769: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87      wiz      5770:     where all files of the final program shall be installed. It is
                   5771:     usually set to <code class="varname">LOCALBASE</code>
                   5772:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88      wiz      5773:     for pkgs in the <code class="filename">cross</code> category.  The value of
1.87      wiz      5774:     <code class="varname">PREFIX</code> needs to be put
                   5775:     into the various places in the program's source where paths to
1.267     rillig   5776:     these files are encoded.  See <a class="xref" href="#components.patches" title="13.3. patches/*">Section 13.3, &#8220;<code class="filename">patches/*</code>&#8221;</a> and <a class="xref" href="#fixes.libtool" title="21.3.1. Shared libraries - libtool">Section 21.3.1, &#8220;Shared libraries - libtool&#8221;</a> for more details.</p>
1.75      rillig   5777: <p>When choosing which of these variables to use,
1.87      wiz      5778:     follow the following rules:</p>
1.148     asau     5779: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5780: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.88      wiz      5781:        where the current pkg will be installed.  When referring to a
                   5782:        pkg's own installation path, use
1.128     wiz      5783:        <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span>.</p></li>
                   5784: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.88      wiz      5785:        are installed.  If you need to construct a -I or -L argument
                   5786:        to the compiler to find includes and libraries installed by
1.128     wiz      5787:        another non-X11 pkg, use <span class="quote">&#8220;<span class="quote">${LOCALBASE}</span>&#8221;</span>. The name
1.87      wiz      5788:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   5789:        installed all packages in <code class="filename">/usr/local</code>. As
                   5790:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   5791:        administrator, this variable is a misnomer.</p></li>
1.128     wiz      5792: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.88      wiz      5793:        distribution (from xsrc, etc.) is installed. When looking for
                   5794:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.128     wiz      5795:        installed by a package), use <span class="quote">&#8220;<span class="quote">${X11BASE}</span>&#8221;</span>.</p></li>
1.209     sevan    5796: <li class="listitem"><p>X11-based packages using imake must set
                   5797:        <code class="varname">USE_IMAKE</code> to be installed correctly under
                   5798:        <code class="varname">LOCALBASE</code>.</p></li>
1.128     wiz      5799: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.270     leot     5800:        install files according to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?hier+7.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.87      wiz      5801:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   5802:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75      rillig   5803: </ul></div>
                   5804: </div>
1.148     asau     5805: <div class="sect1">
1.75      rillig   5806: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   5807: <a name="build.builddirs"></a>19.3. Directories used during the build process</h2></div></div></div>
1.114     jmcneill 5808: <p>When building a package, various directories are used to store
1.87      wiz      5809:     source files, temporary files, pkgsrc-internal files, and so on. These
                   5810:     directories are explained here.</p>
1.75      rillig   5811: <p>Some of the directory variables contain relative pathnames. There
1.87      wiz      5812:     are two common base directories for these relative directories:
                   5813:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   5814:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   5815:     inside the package itself.</p>
1.148     asau     5816: <div class="variablelist"><dl class="variablelist">
1.75      rillig   5817: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   5818: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87      wiz      5819:       root directory. Generally, you don't need
                   5820:       it.</p></dd>
1.97      rillig   5821: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
                   5822: <dd><p>This is an absolute pathname that points to the
                   5823:       current package.</p></dd>
1.75      rillig   5824: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
                   5825: <dd><p>This is a pathname relative to
1.87      wiz      5826:       <code class="varname">PKGSRCDIR</code> that points to the current
                   5827:       package.</p></dd>
1.75      rillig   5828: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   5829: <dd><p>This is an absolute pathname pointing to the directory
1.93      rillig   5830:       where all work takes place. The distfiles are extracted to this
1.87      wiz      5831:       directory. It also contains temporary directories and log files used by
                   5832:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   5833:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75      rillig   5834: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   5835: <dd><p>This is an absolute pathname pointing to the directory
1.87      wiz      5836:       where the distfiles are extracted. It is usually a direct subdirectory
                   5837:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   5838:       that isn't hidden. This variable may be changed by a package
                   5839:       <code class="filename">Makefile</code>.</p></dd>
1.75      rillig   5840: </dl></div>
1.114     jmcneill 5841: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
                   5842:     the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.116     rillig   5843:     to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.114     jmcneill 5844:     <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
                   5845:     If users would like to have their pkgsrc trees behave in a
                   5846:     read-only manner, then the value of
                   5847:     <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
                   5848:     <span class="emphasis"><em>no</em></span>.</p>
1.75      rillig   5849: </div>
1.148     asau     5850: <div class="sect1">
1.75      rillig   5851: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   5852: <a name="build.running"></a>19.4. Running a phase</h2></div></div></div>
1.110     hubertf  5853: <p>You can run a particular phase by typing <span class="command"><strong>make
1.87      wiz      5854:     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
                   5855:     phase. This will automatically run all phases that are required for this
                   5856:     phase. The default phase is <code class="varname">build</code>, that is, when you
1.110     hubertf  5857:     run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.87      wiz      5858:     the package will be built, but not installed.</p>
1.75      rillig   5859: </div>
1.148     asau     5860: <div class="sect1">
1.75      rillig   5861: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   5862: <a name="build.fetch"></a>19.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81      rillig   5863: <p>The first step in building a package is to fetch the
1.88      wiz      5864:     distribution files (distfiles) from the sites that are providing
                   5865:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   5866:     phase.</p>
1.148     asau     5867: <div class="sect2">
1.81      rillig   5868: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   5869: <a name="build.fetch.what"></a>19.5.1. What to fetch and where to get it from</h3></div></div></div>
1.88      wiz      5870: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   5871:       defines all URLs from where the distfile, whose name is
                   5872:       derived from the <code class="varname">DISTNAME</code> variable, is
                   5873:       fetched. The more complicated cases are described
                   5874:       below.</p>
                   5875: <p>The variable <code class="varname">DISTFILES</code> specifies
                   5876:       the list of distfiles that have to be fetched. Its value
1.174     asau     5877:       defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
                   5878:       its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
1.88      wiz      5879:       so that most packages don't need to define it at all.
                   5880:       <code class="varname">EXTRACT_SUFX</code> is
                   5881:       <code class="literal">.tar.gz</code> by default, but can be changed
                   5882:       freely. Note that if your package requires additional
                   5883:       distfiles to the default one, you cannot just append the
                   5884:       additional filenames using the <code class="literal">+=</code>
                   5885:       operator, but you have write for example:</p>
1.81      rillig   5886: <pre class="programlisting">
1.174     asau     5887: DISTFILES=      ${DEFAULT_DISTFILES} additional-files.tar.gz
1.100     rillig   5888: </pre>
1.88      wiz      5889: <p>Each distfile is fetched from a list of sites, usually
                   5890:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   5891:       <code class="varname">DISTFILES</code> or multiple
                   5892:       <code class="varname">PATCHFILES</code> from different sites, you can
                   5893:       set
                   5894:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   5895:       to the list of URLs where the file
                   5896:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   5897:       (including the suffix) can be found.</p>
                   5898: <pre class="programlisting">
1.100     rillig   5899: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   5900: DISTFILES+=     foo-file.tar.gz
                   5901: SITES.foo-file.tar.gz= \
                   5902: http://www.somewhere.com/somehow/ \
                   5903: http://www.somewhereelse.com/mirror/somehow/
                   5904: </pre>
1.81      rillig   5905: <p>When actually fetching the distfiles, each item from
1.88      wiz      5906:       <code class="varname">MASTER_SITES</code> or
                   5907:       <code class="varname">SITES.*</code> gets the name of each distfile
                   5908:       appended to it, without an intermediate slash. Therefore,
                   5909:       all site values have to end with a slash or other separator
                   5910:       character. This allows for example to set
                   5911:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   5912:       that gets the name of the distfile as a parameter. In this
                   5913:       case, the definition would look like:</p>
1.81      rillig   5914: <pre class="programlisting">
1.100     rillig   5915: MASTER_SITES=   http://www.example.com/download.cgi?file=
                   5916: </pre>
1.125     wiz      5917: <p> The exception to this rule are URLs starting with a dash.
1.174     asau     5918:       In that case the URL is taken as is, fetched and the result
                   5919:       stored under the name of the distfile. You can use this style
                   5920:       for the case when the download URL style does not match the
                   5921:       above common case. For example, if permanent download URL is a
                   5922:       redirector to the real download URL, or the download file name
                   5923:       is offered by an HTTP Content-Disposition header. In the
                   5924:       following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
                   5925:       created instead of the default
                   5926:       <code class="filename">v1.0.0.tar.gz</code>.</p>
                   5927: <pre class="programlisting">
                   5928: DISTNAME=       foo-1.0.0
                   5929: MASTER_SITES=   -http://www.example.com/archive/v1.0.0.tar.gz
                   5930: </pre>
1.81      rillig   5931: <p>There are some predefined values for
1.88      wiz      5932:       <code class="varname">MASTER_SITES</code>, which can be used in
                   5933:       packages.  The names of the variables should speak for
                   5934:       themselves.</p>
1.269     leot     5935: <table border="0" summary="Simple list" class="simplelist">
                   5936: <tr>
                   5937: <td>MASTER_SITE_APACHE</td>
                   5938: <td>MASTER_SITE_BACKUP</td>
                   5939: </tr>
                   5940: <tr>
                   5941: <td>MASTER_SITE_CRATESIO</td>
                   5942: <td>MASTER_SITE_CYGWIN</td>
                   5943: </tr>
                   5944: <tr>
                   5945: <td>MASTER_SITE_DEBIAN</td>
                   5946: <td>MASTER_SITE_FREEBSD</td>
                   5947: </tr>
                   5948: <tr>
                   5949: <td>MASTER_SITE_FREEBSD_LOCAL</td>
                   5950: <td>MASTER_SITE_GENTOO</td>
                   5951: </tr>
                   5952: <tr>
                   5953: <td>MASTER_SITE_GITHUB</td>
                   5954: <td>MASTER_SITE_GNOME</td>
                   5955: </tr>
                   5956: <tr>
                   5957: <td>MASTER_SITE_GNU</td>
                   5958: <td>MASTER_SITE_GNUSTEP</td>
                   5959: </tr>
                   5960: <tr>
                   5961: <td>MASTER_SITE_HASKELL_HACKAGE</td>
                   5962: <td>MASTER_SITE_IFARCHIVE</td>
                   5963: </tr>
                   5964: <tr>
                   5965: <td>MASTER_SITE_KDE</td>
                   5966: <td>MASTER_SITE_MOZILLA</td>
                   5967: </tr>
                   5968: <tr>
                   5969: <td>MASTER_SITE_MOZILLA_ALL</td>
                   5970: <td>MASTER_SITE_MYSQL</td>
                   5971: </tr>
                   5972: <tr>
                   5973: <td>MASTER_SITE_NETLIB</td>
                   5974: <td>MASTER_SITE_OPENBSD</td>
                   5975: </tr>
                   5976: <tr>
                   5977: <td>MASTER_SITE_OPENOFFICE</td>
                   5978: <td>MASTER_SITE_OSDN</td>
                   5979: </tr>
                   5980: <tr>
                   5981: <td>MASTER_SITE_PERL_CPAN</td>
                   5982: <td>MASTER_SITE_PGSQL</td>
                   5983: </tr>
                   5984: <tr>
                   5985: <td>MASTER_SITE_PYPI</td>
                   5986: <td>MASTER_SITE_RUBYGEMS</td>
                   5987: </tr>
                   5988: <tr>
                   5989: <td>MASTER_SITE_R_CRAN</td>
                   5990: <td>MASTER_SITE_SOURCEFORGE</td>
                   5991: </tr>
                   5992: <tr>
                   5993: <td>MASTER_SITE_SUNSITE</td>
                   5994: <td>MASTER_SITE_SUSE</td>
                   5995: </tr>
                   5996: <tr>
                   5997: <td>MASTER_SITE_TEX_CTAN</td>
                   5998: <td>MASTER_SITE_XCONTRIB</td>
                   5999: </tr>
                   6000: <tr>
                   6001: <td>MASTER_SITE_XEMACS</td>
                   6002: <td>MASTER_SITE_XORG</td>
                   6003: </tr>
                   6004: </table>
1.88      wiz      6005: <p>Some explanations for the less self-explaining ones:
                   6006:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.133     wiz      6007:       for packages that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/%24%7BDIST_SUBDIR%7D" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}</a>.  <code class="varname">MASTER_SITE_LOCAL</code> contains local
1.132     spz      6008:       package source distributions that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/LOCAL_PORTS/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/LOCAL_PORTS/</a>.</p>
1.88      wiz      6009: <p>If you choose one of these predefined sites, you may
                   6010:       want to specify a subdirectory of that site. Since these
                   6011:       macros may expand to more than one actual site, you
                   6012:       <span class="emphasis"><em>must</em></span> use the following construct to
                   6013:       specify a subdirectory:</p>
1.81      rillig   6014: <pre class="programlisting">
1.100     rillig   6015: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   6016: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
                   6017: </pre>
1.81      rillig   6018: <p>Note the trailing slash after the subdirectory
1.88      wiz      6019:       name.</p>
1.81      rillig   6020: </div>
1.148     asau     6021: <div class="sect2">
1.81      rillig   6022: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   6023: <a name="build.fetch.how"></a>19.5.2. How are the files fetched?</h3></div></div></div>
1.88      wiz      6024: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   6025:       all the distfiles exist in a local directory
1.93      rillig   6026:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88      wiz      6027:       user). If the files do not exist, they are fetched using
                   6028:       commands of the form</p>
1.75      rillig   6029: <pre class="programlisting">
1.100     rillig   6030: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   6031: </pre>
1.88      wiz      6032: <p>where <code class="literal">${site}</code> varies through
                   6033:       several possibilities in turn: first,
                   6034:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   6035:       sites specified in either <code class="varname">SITES.file</code> if
                   6036:       defined, else <code class="varname">MASTER_SITES</code> or
                   6037:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   6038:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91      rillig   6039:       all except the first and the last can be optionally sorted
                   6040:       by the user, via setting either
                   6041:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   6042:       <code class="varname">MASTER_SORT_AWK</code> or
1.88      wiz      6043:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.117     jnemeth  6044: <p> The specific command and arguments used depend on the
                   6045:       <code class="varname">FETCH_USING</code> parameter. The example above is
                   6046:       for <code class="literal">FETCH_USING=custom</code>.</p>
1.97      rillig   6047: <p>The distfiles mirror run by the NetBSD Foundation uses the
                   6048:       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
                   6049:       distfiles, if they are freely distributable.  Packages setting
                   6050:       <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.128     wiz      6051:       <span class="quote">&#8220;<span class="quote">${RESTRICTED}</span>&#8221;</span>) will not have their distfiles
1.97      rillig   6052:       mirrored.</p>
1.81      rillig   6053: </div>
1.75      rillig   6054: </div>
1.148     asau     6055: <div class="sect1">
1.75      rillig   6056: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   6057: <a name="build.checksum"></a>19.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88      wiz      6058: <p>After the distfile(s) are fetched, their checksum is
                   6059:     generated and compared with the checksums stored in the
                   6060:     distinfo file. If the checksums don't match, the build is
                   6061:     aborted. This is to ensure the same distfile is used for
                   6062:     building, and that the distfile wasn't changed, e.g. by some
                   6063:     malign force, deliberately changed distfiles on the master
                   6064:     distribution site or network lossage.</p>
1.75      rillig   6065: </div>
1.148     asau     6066: <div class="sect1">
1.75      rillig   6067: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   6068: <a name="build.extract"></a>19.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75      rillig   6069: <p>When the distfiles are present on the local system, they
1.88      wiz      6070:     need to be extracted, as they usually come in the form of some
                   6071:     compressed archive format.</p>
1.75      rillig   6072: <p>By default, all <code class="varname">DISTFILES</code> are
1.88      wiz      6073:     extracted. If you only need some of them, you can set the
                   6074:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   6075:     files.</p>
                   6076: <p>Extracting the files is usually done by a little
1.93      rillig   6077:     program, <code class="filename">mk/extract/extract</code>, which
1.88      wiz      6078:     already knows how to extract various archive formats, so most
                   6079:     likely you will not need to change anything here. But if you
                   6080:     need, the following variables may help you:</p>
1.148     asau     6081: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6082: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   6083: <dd><p>Use these variables to override the default
1.88      wiz      6084:       options for an extract command, which are defined in
1.93      rillig   6085:       <code class="filename">mk/extract/extract</code>.</p></dd>
1.75      rillig   6086: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   6087: <dd><p>This variable can be set to
1.114     jmcneill 6088:       <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
                   6089:       (which is the default value), <code class="literal">pax</code>, or an
1.88      wiz      6090:       absolute pathname pointing to the command with which tar
1.114     jmcneill 6091:       archives should be extracted.  It is preferred to choose bsdtar over gtar
                   6092:       if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75      rillig   6093: </dl></div>
1.88      wiz      6094: <p>If the <code class="filename">extract</code> program doesn't
                   6095:     serve your needs, you can also override the
                   6096:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   6097:     command used for extracting the files. This command is
                   6098:     executed in the <code class="filename">${WRKSRC}</code>
                   6099:     directory. During execution of this command, the shell
                   6100:     variable <code class="varname">extract_file</code> holds the absolute
                   6101:     pathname of the file that is going to be extracted.</p>
1.75      rillig   6102: <p>And if that still does not suffice, you can override the
1.88      wiz      6103:     <code class="varname">do-extract</code> target in the package
                   6104:     Makefile.</p>
1.75      rillig   6105: </div>
1.148     asau     6106: <div class="sect1">
1.75      rillig   6107: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   6108: <a name="build.patch"></a>19.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75      rillig   6109: <p>After extraction, all the patches named by the
1.88      wiz      6110:     <code class="varname">PATCHFILES</code>, those present in the patches
                   6111:     subdirectory of the package as well as in
                   6112:     $LOCALPATCHES/$PKGPATH (e.g.
                   6113:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   6114:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   6115:     <code class="filename">.gz</code> are uncompressed before they are
                   6116:     applied, files ending in <code class="filename">.orig</code> or
                   6117:     <code class="filename">.rej</code> are ignored. Any special options to
1.270     leot     6118:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.267     rillig   6119:     <code class="varname">PATCH_DIST_ARGS</code>.  See <a class="xref" href="#components.patches" title="13.3. patches/*">Section 13.3, &#8220;<code class="filename">patches/*</code>&#8221;</a> for more details.</p>
1.270     leot     6120: <p>By default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special args to make
1.88      wiz      6121:     it fail if the patches apply with some lines of fuzz. Please
                   6122:     fix (regen) the patches so that they apply cleanly. The
                   6123:     rationale behind this is that patches that don't apply cleanly
                   6124:     may end up being applied in the wrong place, and cause severe
                   6125:     harm there.</p>
1.75      rillig   6126: </div>
1.148     asau     6127: <div class="sect1">
1.75      rillig   6128: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   6129: <a name="build.tools"></a>19.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
                   6130: <p>This is covered in <a class="xref" href="#tools" title="Chapter 20. Tools needed for building or running">Chapter 20, <i>Tools needed for building or running</i></a>.
1.88      wiz      6131:     </p>
1.75      rillig   6132: </div>
1.148     asau     6133: <div class="sect1">
1.75      rillig   6134: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   6135: <a name="build.wrapper"></a>19.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75      rillig   6136: <p>This phase creates wrapper programs for the compilers and
1.88      wiz      6137:     linkers. The following variables can be used to tweak the
                   6138:     wrappers.</p>
1.148     asau     6139: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6140: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   6141: <dd><p>The command used to print progress
1.88      wiz      6142:       messages. Does nothing by default. Set to
                   6143:       <code class="literal">${ECHO}</code> to see the progress
                   6144:       messages.</p></dd>
1.75      rillig   6145: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   6146: <dd><p>This variable can be set to
1.88      wiz      6147:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   6148:       depending on whether you want additional information in the
                   6149:       wrapper log file.</p></dd>
1.75      rillig   6150: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   6151: <dd><p>This variable can be set to
1.88      wiz      6152:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   6153:       on whether the wrapper should use its cache, which will
                   6154:       improve the speed. The default value is
                   6155:       <code class="literal">yes</code>, but is forced to
                   6156:       <code class="literal">no</code> if the platform does not support
                   6157:       it.</p></dd>
1.75      rillig   6158: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88      wiz      6159: <dd><p>A list of reordering commands. A reordering
                   6160:       command has the form
                   6161:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   6162:       It ensures that that
                   6163:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   6164:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   6165:       </p></dd>
1.75      rillig   6166: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
                   6167: <dd><p>A list of transformation commands. [TODO:
1.88      wiz      6168:       investigate further]</p></dd>
1.75      rillig   6169: </dl></div>
                   6170: </div>
1.148     asau     6171: <div class="sect1">
1.75      rillig   6172: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   6173: <a name="build.configure"></a>19.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88      wiz      6174: <p>Most pieces of software need information on the header
                   6175:     files, system calls, and library routines which are available
                   6176:     on the platform they run on. The process of determining this
                   6177:     information is known as configuration, and is usually
                   6178:     automated. In most cases, a script is supplied with the
                   6179:     distfiles, and its invocation results in generation of header
                   6180:     files, Makefiles, etc.</p>
                   6181: <p>If the package contains a configure script, this can be
                   6182:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.128     wiz      6183:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. If the configure script is a GNU autoconf
1.88      wiz      6184:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.128     wiz      6185:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> instead. What happens in the
1.88      wiz      6186:     <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
                   6187: <pre class="programlisting">
1.100     rillig   6188: .for d in ${CONFIGURE_DIRS}
                   6189:         cd ${WRKSRC} \
                   6190:         &amp;&amp; cd ${d} \
                   6191:         &amp;&amp; env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
                   6192: .endfor
                   6193: </pre>
1.88      wiz      6194: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.128     wiz      6195:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
1.88      wiz      6196:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   6197:     configure script is run with the environment
                   6198:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   6199:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   6200:     <code class="varname">CONFIGURE_ENV</code>,
                   6201:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.128     wiz      6202:     <span class="quote">&#8220;<span class="quote">./configure</span>&#8221;</span>) and
1.88      wiz      6203:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   6204:     package.</p>
1.144     wiz      6205: <p>If the program uses the Perl way of configuration (mainly Perl
                   6206:     modules, but not only), i.e. a file called
                   6207:     <code class="filename">Makefile.PL</code>, it should include
                   6208:     <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
                   6209:     <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
                   6210:     variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.88      wiz      6211: <p>If the program uses an <code class="filename">Imakefile</code>
                   6212:     for configuration, the appropriate steps can be invoked by
                   6213:     setting <code class="varname">USE_IMAKE</code> to
1.209     sevan    6214:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.  If you only need xmkmf, add it to <code class="varname">USE_TOOLS</code>.
                   6215:     You can add variables to xmkmf's environment by adding them to the
1.97      rillig   6216:     <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.111     rillig   6217: <p>If the program uses <code class="filename">cmake</code>
                   6218:     for configuration, the appropriate steps can be invoked by
1.128     wiz      6219:     setting <code class="varname">USE_CMAKE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.
1.111     rillig   6220:     You can add variables to cmake's environment by adding them to the
                   6221:     <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
                   6222:     by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
                   6223:     The top directory argument is given by the
                   6224:     <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.128     wiz      6225:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.97      rillig   6226: <p>If there is no configure step at all, set
1.128     wiz      6227:     <code class="varname">NO_CONFIGURE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.75      rillig   6228: </div>
1.148     asau     6229: <div class="sect1">
1.75      rillig   6230: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   6231: <a name="build.build"></a>19.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88      wiz      6232: <p>For building a package, a rough equivalent of the
                   6233:     following code is executed.</p>
1.75      rillig   6234: <pre class="programlisting">
1.100     rillig   6235: .for d in ${BUILD_DIRS}
                   6236:         cd ${WRKSRC} \
                   6237:         &amp;&amp; cd ${d} \
                   6238:         &amp;&amp; env ${MAKE_ENV} \
                   6239:             ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
                   6240:                 -f ${MAKE_FILE} \
                   6241:                 ${BUILD_TARGET}
                   6242: .endfor
                   6243: </pre>
1.88      wiz      6244: <p><code class="varname">BUILD_DIRS</code> (default:
1.128     wiz      6245:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
1.88      wiz      6246:     <code class="varname">WRKSRC</code>. In each of these directories,
                   6247:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   6248:     <code class="varname">MAKE_ENV</code> and arguments
                   6249:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   6250:     <code class="varname">MAKE_ENV</code>,
                   6251:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   6252:     <code class="varname">MAKE_FILE</code> and
                   6253:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   6254:     package.</p>
1.75      rillig   6255: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.128     wiz      6256:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> if <code class="varname">USE_TOOLS</code> contains
                   6257:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> otherwise. The
1.88      wiz      6258:     default value of <code class="varname">MAKE_FILE</code> is
1.128     wiz      6259:     <span class="quote">&#8220;<span class="quote">Makefile</span>&#8221;</span>, and <code class="varname">BUILD_TARGET</code>
                   6260:     defaults to <span class="quote">&#8220;<span class="quote">all</span>&#8221;</span>.</p>
1.97      rillig   6261: <p>If there is no build step at all, set
1.128     wiz      6262:     <code class="varname">NO_BUILD</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.75      rillig   6263: </div>
1.148     asau     6264: <div class="sect1">
1.75      rillig   6265: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   6266: <a name="build.test"></a>19.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75      rillig   6267: <p>[TODO]</p>
                   6268: </div>
1.148     asau     6269: <div class="sect1">
1.75      rillig   6270: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   6271: <a name="build.install"></a>19.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75      rillig   6272: <p>Once the build stage has completed, the final step is to
1.88      wiz      6273:     install the software in public directories, so users can
                   6274:     access the programs and files.</p>
1.75      rillig   6275: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88      wiz      6276:     equivalent of the following code is executed. Additionally,
                   6277:     before and after this code, much magic is performed to do
                   6278:     consistency checks, registering the package, and so on.</p>
                   6279: <pre class="programlisting">
1.100     rillig   6280: .for d in ${INSTALL_DIRS}
                   6281:         cd ${WRKSRC} \
                   6282:         &amp;&amp; cd ${d} \
                   6283:         &amp;&amp; env ${MAKE_ENV} \
                   6284:             ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
                   6285:                 -f ${MAKE_FILE} \
                   6286:                 ${INSTALL_TARGET}
                   6287: .endfor
                   6288: </pre>
1.75      rillig   6289: <p>The variable's meanings are analogous to the ones in the
1.88      wiz      6290:     <span class="emphasis"><em>build</em></span> phase.
                   6291:     <code class="varname">INSTALL_DIRS</code> defaults to
                   6292:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.128     wiz      6293:     is <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> by default, plus
                   6294:     <span class="quote">&#8220;<span class="quote">install.man</span>&#8221;</span> if <code class="varname">USE_IMAKE</code> is
1.88      wiz      6295:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   6296:     defined.</p>
1.75      rillig   6297: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88      wiz      6298:     variables are useful. They are all variations of the
1.270     leot     6299:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.88      wiz      6300:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   6301:     install command. The specialized variants, together with their
                   6302:     intended use, are:</p>
1.148     asau     6303: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6304: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88      wiz      6305: <dd><p>directories that contain
                   6306:       binaries</p></dd>
1.75      rillig   6307: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88      wiz      6308: <dd><p>directories that contain
                   6309:       scripts</p></dd>
1.75      rillig   6310: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88      wiz      6311: <dd><p>directories that contain shared and static
                   6312:       libraries</p></dd>
1.75      rillig   6313: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88      wiz      6314: <dd><p>directories that contain data
                   6315:       files</p></dd>
1.75      rillig   6316: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88      wiz      6317: <dd><p>directories that contain man
                   6318:       pages</p></dd>
1.210     leot     6319: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
                   6320: <dd><p>directories that contain data files for games
                   6321:       </p></dd>
1.75      rillig   6322: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88      wiz      6323: <dd><p>binaries that can be stripped from debugging
                   6324:       symbols</p></dd>
1.75      rillig   6325: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88      wiz      6326: <dd><p>binaries that cannot be
                   6327:       stripped</p></dd>
1.75      rillig   6328: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88      wiz      6329: <dd><p>game
                   6330:       binaries</p></dd>
1.75      rillig   6331: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88      wiz      6332: <dd><p>shared and static
                   6333:       libraries</p></dd>
1.75      rillig   6334: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   6335: <dd><p>data files</p></dd>
                   6336: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88      wiz      6337: <dd><p>data files for
                   6338:       games</p></dd>
1.75      rillig   6339: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   6340: <dd><p>man pages</p></dd>
                   6341: </dl></div>
                   6342: <p>Some other variables are:</p>
1.148     asau     6343: <div class="variablelist"><dl class="variablelist">
1.216     tnn      6344: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.270     leot     6345: <dd><p>If set to <code class="literal">yes</code>, do not run <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?strip+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">strip</span>(1)</span></a>
1.216     tnn      6346:       when installing binaries. Any debugging sections and symbols present in
                   6347:       binaries will be preserved.
                   6348:       </p></dd>
1.75      rillig   6349: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   6350: <dd><p>A list of directories relative to
1.88      wiz      6351:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98      wiz      6352:       beginning of the <span class="emphasis"><em>install</em></span> phase.
                   6353:       The package is supposed to create all needed directories itself
                   6354:       before installing files to it and list all other directories here.
                   6355:       </p></dd>
1.75      rillig   6356: </dl></div>
1.97      rillig   6357: <p>In the rare cases that a package shouldn't install anything,
1.128     wiz      6358:     set <code class="varname">NO_INSTALL</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. This is
1.97      rillig   6359:     mostly relevant for packages in the <code class="filename">regress</code>
                   6360:     category.</p>
1.75      rillig   6361: </div>
1.148     asau     6362: <div class="sect1">
1.75      rillig   6363: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   6364: <a name="build.package"></a>19.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88      wiz      6365: <p>Once the install stage has completed, a binary package of
                   6366:     the installed files can be built.  These binary packages can be
                   6367:     used for quick installation without previous compilation, e.g. by
1.110     hubertf  6368:     the <span class="command"><strong>make bin-install</strong></span> or by using
                   6369:     <span class="command"><strong>pkg_add</strong></span>.</p>
1.88      wiz      6370: <p>By default, the binary packages are created in
                   6371:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   6372:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   6373:     one for each category in the <code class="varname">CATEGORIES</code>
                   6374:     variable.  <code class="varname">PACKAGES</code> defaults to
                   6375:     <code class="filename">pkgsrc/packages</code>.</p>
                   6376: </div>
1.148     asau     6377: <div class="sect1">
1.88      wiz      6378: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   6379: <a name="build.clean"></a>19.16. Cleaning up</h2></div></div></div>
1.88      wiz      6380: <p>Once you're finished with a package, you can clean the work
1.110     hubertf  6381:     directory by running <span class="command"><strong>make clean</strong></span>.  If you want
1.88      wiz      6382:     to clean the work directories of all dependencies too, use
1.110     hubertf  6383:     <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75      rillig   6384: </div>
1.148     asau     6385: <div class="sect1">
1.75      rillig   6386: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   6387: <a name="build.helpful-targets"></a>19.17. Other helpful targets</h2></div></div></div>
1.148     asau     6388: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6389: <dt><span class="term">pre/post-*</span></dt>
1.88      wiz      6390: <dd><p>For any of the main targets described in the
                   6391:          previous section, two auxiliary targets exist with
1.128     wiz      6392:          <span class="quote">&#8220;<span class="quote">pre-</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">post-</span>&#8221;</span> used as a
1.87      wiz      6393:          prefix for the main target's name.  These targets are
1.88      wiz      6394:          invoked before and after the main target is called,
                   6395:          allowing extra configuration or installation steps be
                   6396:          performed from a package's Makefile, for example, which
                   6397:          a program's configure script or install target
                   6398:          omitted.</p></dd>
1.75      rillig   6399: <dt><span class="term">do-*</span></dt>
1.88      wiz      6400: <dd><p>Should one of the main targets do the wrong thing,
                   6401:          and should there be no variable to fix this, you can
                   6402:          redefine it with the do-* target.  (Note that redefining
                   6403:          the target itself instead of the do-* target is a bad
                   6404:          idea, as the pre-* and post-* targets won't be called
                   6405:          anymore, etc.) You will not usually need to do
                   6406:          this.</p></dd>
1.75      rillig   6407: <dt><span class="term">reinstall</span></dt>
1.88      wiz      6408: <dd>
1.110     hubertf  6409: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.88      wiz      6410:          you noticed some file was not installed properly, you
                   6411:          can repeat the installation with this target, which will
1.128     wiz      6412:          ignore the <span class="quote">&#8220;<span class="quote">already installed</span>&#8221;</span> flag.</p>
1.88      wiz      6413: <p>This is the default value of
                   6414:          <code class="varname">DEPENDS_TARGET</code> except in the case of
1.110     hubertf  6415:          <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.88      wiz      6416:          package</strong></span>, where the defaults are
1.128     wiz      6417:          <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span>,
1.88      wiz      6418:          respectively.</p>
                   6419: </dd>
1.75      rillig   6420: <dt><span class="term">deinstall</span></dt>
                   6421: <dd>
1.270     leot     6422: <p>This target does a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.88      wiz      6423:          current directory, effectively de-installing the
                   6424:          package. The following variables can be used to tune the
                   6425:          behaviour:</p>
1.148     asau     6426: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6427: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.270     leot     6428: <dd><p>Add a "-v" to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.75      rillig   6429: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88      wiz      6430: <dd><p>Remove all packages that require (depend on)
                   6431:                the given package.  This can be used to remove any
                   6432:                packages that may have been pulled in by a given
1.110     hubertf  6433:                package, e.g. if <span class="command"><strong>make deinstall
1.87      wiz      6434:                DEINSTALLDEPENDS=1</strong></span> is done in
1.88      wiz      6435:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   6436:                likely to remove whole KDE. Works by adding
1.270     leot     6437:                <span class="quote">&#8220;<span class="quote">-R</span>&#8221;</span> to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.88      wiz      6438:                command line.</p></dd>
1.75      rillig   6439: </dl></div>
                   6440: </dd>
1.88      wiz      6441: <dt><span class="term">bin-install</span></dt>
                   6442: <dd><p>Install a binary package from local disk and via FTP
                   6443:          from a list of sites (see the
                   6444:          <code class="varname">BINPKG_SITES</code> variable), and do a
1.110     hubertf  6445:          <span class="command"><strong>make package</strong></span> if no binary package is
1.88      wiz      6446:          available anywhere.  The arguments given to
1.110     hubertf  6447:          <span class="command"><strong>pkg_add</strong></span> can be set via
1.88      wiz      6448:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   6449:          operation, etc.</p></dd>
1.205     wiz      6450: <dt><span class="term">install-clean</span></dt>
                   6451: <dd><p>This target removes the state files for the "install" and later
                   6452:          phases so that the "install" target may be re-invoked. This can be
                   6453:          used after editing the PLIST to install the package without
                   6454:          rebuilding it.</p></dd>
                   6455: <dt><span class="term">build-clean</span></dt>
                   6456: <dd><p>This target removes the state files for the "build" and later
                   6457:          phases so that the "build" target may be re-invoked.</p></dd>
1.75      rillig   6458: <dt><span class="term">update</span></dt>
                   6459: <dd>
1.88      wiz      6460: <p>This target causes the current package to be
                   6461:          updated to the latest version.  The package and all
                   6462:          depending packages first get de-installed, then current
                   6463:          versions of the corresponding packages get compiled and
                   6464:          installed.  This is similar to manually noting which
                   6465:          packages are currently installed, then performing a
1.110     hubertf  6466:          series of <span class="command"><strong>make deinstall</strong></span> and
                   6467:          <span class="command"><strong>make install</strong></span> (or whatever
1.88      wiz      6468:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   6469:          packages.</p>
1.128     wiz      6470: <p>You can use the <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> target to
1.110     hubertf  6471:          resume package updating in case a previous <span class="command"><strong>make
1.88      wiz      6472:          update</strong></span> was interrupted for some reason.
                   6473:          However, in this case, make sure you don't call
1.110     hubertf  6474:          <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.88      wiz      6475:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   6476:          Otherwise, you lose the ability to automatically update
                   6477:          the current package along with the dependent packages
                   6478:          you have installed.</p>
1.110     hubertf  6479: <p>Resuming an interrupted <span class="command"><strong>make
1.88      wiz      6480:          update</strong></span> will only work as long as the package
                   6481:          tree remains unchanged.  If the source code for one of
                   6482:          the packages to be updated has been changed, resuming
1.110     hubertf  6483:          <span class="command"><strong>make update</strong></span> will most certainly
1.88      wiz      6484:          fail!</p>
                   6485: <p>The following variables can be used either on the
1.110     hubertf  6486:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
                   6487:          alter the behaviour of <span class="command"><strong>make
1.88      wiz      6488:          update</strong></span>:</p>
1.148     asau     6489: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6490: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88      wiz      6491: <dd><p>Install target to recursively use for the
                   6492:                updated package and the dependent packages.
                   6493:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.128     wiz      6494:                set, <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> otherwise for
1.110     hubertf  6495:                <span class="command"><strong>make update</strong></span>.  Other good
1.128     wiz      6496:                targets are <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> or
                   6497:                <span class="quote">&#8220;<span class="quote">bin-install</span>&#8221;</span>.  Do not set this to
                   6498:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> or you will get stuck in an
1.88      wiz      6499:                endless loop!</p></dd>
1.75      rillig   6500: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88      wiz      6501: <dd><p>Don't clean up after updating.  Useful if
                   6502:                you want to leave the work sources of the updated
                   6503:                packages around for inspection or other purposes.
                   6504:                Be sure you eventually clean up the source tree
1.128     wiz      6505:                (see the <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target below)
1.88      wiz      6506:                or you may run into troubles with old source code
                   6507:                still lying around on your next
1.110     hubertf  6508:                <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.88      wiz      6509:                update</strong></span>.</p></dd>
1.75      rillig   6510: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88      wiz      6511: <dd><p>Deinstall each package before installing
                   6512:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   6513:                may be necessary if the
1.128     wiz      6514:                <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target (see below) was
1.110     hubertf  6515:                called after interrupting a running <span class="command"><strong>make
1.88      wiz      6516:                update</strong></span>.</p></dd>
1.75      rillig   6517: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88      wiz      6518: <dd><p>Allows you to disable recursion and hardcode
                   6519:                the target for packages.  The default is
1.128     wiz      6520:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for the update target,
1.88      wiz      6521:                facilitating a recursive update of prerequisite
                   6522:                packages.  Only set
                   6523:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   6524:                disable recursive updates. Use
                   6525:                <code class="varname">UPDATE_TARGET</code> instead to just
                   6526:                set a specific target for each package to be
1.110     hubertf  6527:                installed during <span class="command"><strong>make update</strong></span>
1.88      wiz      6528:                (see above).</p></dd>
1.75      rillig   6529: </dl></div>
                   6530: </dd>
                   6531: <dt><span class="term">clean-update</span></dt>
                   6532: <dd>
1.88      wiz      6533: <p>Clean the source tree for all packages that would
1.110     hubertf  6534:          get updated if <span class="command"><strong>make update</strong></span> was called
1.88      wiz      6535:          from the current directory.  This target should not be
                   6536:          used if the current package (or any of its depending
                   6537:          packages) have already been de-installed (e.g., after
1.110     hubertf  6538:          calling <span class="command"><strong>make update</strong></span>) or you may lose
1.88      wiz      6539:          some packages you intended to update. As a rule of
                   6540:          thumb: only use this target <span class="emphasis"><em>before</em></span>
1.110     hubertf  6541:          the first time you run <span class="command"><strong>make update</strong></span>
1.88      wiz      6542:          and only if you have a dirty package tree (e.g., if you
                   6543:          used <code class="varname">NOCLEAN</code>).</p>
                   6544: <p>If you are unsure about whether your tree is
1.110     hubertf  6545:          clean, you can either perform a <span class="command"><strong>make
1.88      wiz      6546:          clean</strong></span> at the top of the tree, or use the
                   6547:          following sequence of commands from the directory of the
                   6548:          package you want to update (<span class="emphasis"><em>before</em></span>
1.110     hubertf  6549:          running <span class="command"><strong>make update</strong></span> for the first
1.88      wiz      6550:          time, otherwise you lose all the packages you wanted to
                   6551:          update!):</p>
1.87      wiz      6552: <pre class="screen">
                   6553: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75      rillig   6554: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87      wiz      6555: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   6556:          </pre>
1.88      wiz      6557: <p>The following variables can be used either on the
1.110     hubertf  6558:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
                   6559:          <span class="command"><strong>make clean-update</strong></span>:</p>
1.148     asau     6560: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6561: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.110     hubertf  6562: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.88      wiz      6563:                reconstruct the list of directories to update for
1.110     hubertf  6564:                this package.  Only use this if <span class="command"><strong>make
1.88      wiz      6565:                update</strong></span> successfully installed all
                   6566:                packages you wanted to update.  Normally, this is
1.110     hubertf  6567:                done automatically on <span class="command"><strong>make
1.88      wiz      6568:                update</strong></span>, but may have been suppressed by
                   6569:                the <code class="varname">NOCLEAN</code> variable (see
                   6570:                above).</p></dd>
1.75      rillig   6571: </dl></div>
                   6572: </dd>
1.88      wiz      6573: <dt><span class="term">replace</span></dt>
                   6574: <dd>
                   6575: <p>Update the installation of the current package.  This
                   6576:          differs from update in that it does not replace dependent
1.250     leot     6577:          packages.  You will need to install <a href="https://cdn.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      6578:          target to work.</p>
                   6579: <p><span class="emphasis"><em>Be careful when using this
                   6580:          target!</em></span> There are no guarantees that dependent
                   6581:          packages will still work, in particular they will most
1.110     hubertf  6582:          certainly break if you <span class="command"><strong>make replace</strong></span> a
1.88      wiz      6583:          library package whose shared library major version changed
                   6584:          between your installed version and the new one.  For this
                   6585:          reason, this target is not officially supported and only
                   6586:          recommended for advanced users.</p>
                   6587: </dd>
1.75      rillig   6588: <dt><span class="term">info</span></dt>
1.270     leot     6589: <dd><p>This target invokes <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.88      wiz      6590:          package. You can use this to check which version of a
                   6591:          package is installed.</p></dd>
                   6592: <dt><span class="term">index</span></dt>
                   6593: <dd>
                   6594: <p>This is a top-level command, i.e. it should be used in
                   6595:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   6596:          database of all packages in the local pkgsrc tree, including
                   6597:          dependencies, comment, maintainer, and some other useful
                   6598:          information.  Individual entries are created by running
1.110     hubertf  6599:          <span class="command"><strong>make describe</strong></span> in the packages'
1.88      wiz      6600:          directories.  This index file is saved as
                   6601:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
1.110     hubertf  6602:          verbose format by running <span class="command"><strong>make
1.88      wiz      6603:          print-index</strong></span>.  You can search in it with
1.110     hubertf  6604:          <span class="command"><strong>make search
1.88      wiz      6605:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   6606:          extract a list of all packages that depend on a particular
1.110     hubertf  6607:          one by running <span class="command"><strong>make show-deps
1.88      wiz      6608:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   6609: <p>Running this command takes a very long time, some
                   6610:          hours even on fast machines!</p>
                   6611: </dd>
1.75      rillig   6612: <dt><span class="term">readme</span></dt>
1.88      wiz      6613: <dd>
                   6614: <p>This target generates a
                   6615:          <code class="filename">README.html</code> file, which can be
1.250     leot     6616:          viewed using a browser such as <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> or <a href="https://cdn.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      6617:          contain references to any packages which are in the
                   6618:          <code class="varname">PACKAGES</code> directory on the local
                   6619:          host. The generated files can be made to refer to URLs
                   6620:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   6621:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
                   6622:          wanted to generate <code class="filename">README.html</code>
                   6623:          files which pointed to binary packages on the local
                   6624:          machine, in the directory
                   6625:          <code class="filename">/usr/packages</code>, set
                   6626:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   6627:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   6628:          <code class="varname">${PACKAGES}</code> directory and its
                   6629:          subdirectories will be searched for all the binary
                   6630:          packages.</p>
                   6631: <p>The target can be run at the toplevel or in category
                   6632:          directories, in which case it descends recursively.</p>
                   6633: </dd>
1.75      rillig   6634: <dt><span class="term">readme-all</span></dt>
1.88      wiz      6635: <dd><p>This is a top-level command, run it in
                   6636:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   6637:          file <code class="filename">README-all.html</code> which contains a
                   6638:          list of all packages currently available in the NetBSD
                   6639:          Packages Collection, together with the category they belong
                   6640:          to and a short description. This file is compiled from the
                   6641:          <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.110     hubertf  6642:          to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.88      wiz      6643:          readme</strong></span>.</p></dd>
1.75      rillig   6644: <dt><span class="term">cdrom-readme</span></dt>
1.88      wiz      6645: <dd><p>This is very much the same as the
1.128     wiz      6646:          <span class="quote">&#8220;<span class="quote">readme</span>&#8221;</span> target (see above), but is to be
1.88      wiz      6647:          used when generating a pkgsrc tree to be written to a
                   6648:          CD-ROM.  This target also produces
                   6649:          <code class="filename">README.html</code> files, and can be made
                   6650:          to refer to URLs based on
                   6651:          <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87      wiz      6652:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75      rillig   6653: <dt><span class="term">show-distfiles</span></dt>
1.88      wiz      6654: <dd><p>This target shows which distfiles and patchfiles
                   6655:          are needed to build the package
                   6656:          (<code class="varname">ALLFILES</code>, which contains all
                   6657:          <code class="varname">DISTFILES</code> and
1.87      wiz      6658:          <code class="varname">PATCHFILES</code>, but not
                   6659:          <code class="filename">patches/*</code>).</p></dd>
1.75      rillig   6660: <dt><span class="term">show-downlevel</span></dt>
1.88      wiz      6661: <dd><p>This target shows nothing if the package is not
                   6662:          installed. If a version of this package is installed,
                   6663:          but is not the version provided in this version of
                   6664:          pkgsrc, then a warning message is displayed. This target
                   6665:          can be used to show which of your installed packages are
                   6666:          downlevel, and so the old versions can be deleted, and
                   6667:          the current ones added.</p></dd>
1.75      rillig   6668: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88      wiz      6669: <dd><p>This target shows the directory in the pkgsrc
                   6670:          hierarchy from which the package can be built and
                   6671:          installed. This may not be the same directory as the one
                   6672:          from which the package was installed. This target is
                   6673:          intended to be used by people who may wish to upgrade
                   6674:          many packages on a single host, and can be invoked from
                   6675:          the top-level pkgsrc Makefile by using the
1.128     wiz      6676:          <span class="quote">&#8220;<span class="quote">show-host-specific-pkgs</span>&#8221;</span> target.</p></dd>
1.75      rillig   6677: <dt><span class="term">show-installed-depends</span></dt>
1.88      wiz      6678: <dd><p>This target shows which installed packages match
                   6679:          the current package's <code class="varname">DEPENDS</code>. Useful
                   6680:          if out of date dependencies are causing build
                   6681:          problems.</p></dd>
1.205     wiz      6682: <dt><span class="term">print-build-depends-list</span></dt>
                   6683: <dd><p>This target shows the list of packages that the current package
                   6684:            depends on for building.</p></dd>
                   6685: <dt><span class="term">print-run-depends-list</span></dt>
                   6686: <dd><p>This target shows the list of packages that the current package
                   6687:            depends on for running.</p></dd>
1.75      rillig   6688: <dt><span class="term">check-shlibs</span></dt>
1.88      wiz      6689: <dd><p>After a package is installed, check all its
                   6690:          binaries and (on ELF platforms) shared libraries to see
                   6691:          if they find the shared libs they need.  Run by default
1.110     hubertf  6692:          if <code class="varname">PKG_DEVELOPER</code> is set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></dd>
1.75      rillig   6693: <dt><span class="term">print-PLIST</span></dt>
                   6694: <dd>
1.128     wiz      6695: <p>After a <span class="quote">&#8220;<span class="quote">make install</span>&#8221;</span> from a new or
1.88      wiz      6696:          upgraded pkg, this prints out an attempt to generate a
1.110     hubertf  6697:          new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.88      wiz      6698:          -newer work/.extract_done</strong></span>.  An attempt is made
                   6699:          to care for shared libs etc., but it is
1.87      wiz      6700:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   6701:          result before putting it into
                   6702:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   6703:          diff the output of this command against an already
                   6704:          existing <code class="filename">PLIST</code> file.</p>
1.270     leot     6705: <p>If the package installs files via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.88      wiz      6706:          other methods that don't update file access times, be
                   6707:          sure to add these files manually to your
1.128     wiz      6708:          <code class="filename">PLIST</code>, as the <span class="quote">&#8220;<span class="quote">find
                   6709:          -newer</span>&#8221;</span> command used by this target won't catch
1.87      wiz      6710:          them!</p>
1.267     rillig   6711: <p>See <a class="xref" href="#print-PLIST" title="15.3. Tweaking output of make print-PLIST">Section 15.3, &#8220;Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>&#8221;</a> for more
1.87      wiz      6712:          information on this target.</p>
1.75      rillig   6713: </dd>
                   6714: <dt><span class="term">bulk-package</span></dt>
                   6715: <dd>
1.88      wiz      6716: <p>Used to do bulk builds. If an appropriate binary
                   6717:          package already exists, no action is taken. If not, this
                   6718:          target will compile, install and package it (and its
                   6719:          depends, if <code class="varname">PKG_DEPENDS</code> is set
1.267     rillig   6720:          properly. See <a class="xref" href="#bulk" title="Chapter 8. Creating binary packages for everything in pkgsrc (bulk builds)">Chapter 8, <i>Creating binary packages for everything in pkgsrc (bulk
1.174     asau     6721: builds)</i></a>).
1.88      wiz      6722:          After creating the binary package, the sources, the
                   6723:          just-installed package and its required packages are
                   6724:          removed, preserving free disk space.</p>
                   6725: <p><span class="emphasis"><em>Beware that this target may deinstall
                   6726:          all packages installed on a system!</em></span></p>
1.75      rillig   6727: </dd>
                   6728: <dt><span class="term">bulk-install</span></dt>
                   6729: <dd>
1.88      wiz      6730: <p>Used during bulk-installs to install required
                   6731:          packages. If an up-to-date binary package is available,
1.270     leot     6732:          it will be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. If not,
1.110     hubertf  6733:          <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.87      wiz      6734:          but the installed binary won't be removed.</p>
1.88      wiz      6735: <p>A binary package is considered
1.128     wiz      6736:          <span class="quote">&#8220;<span class="quote">up-to-date</span>&#8221;</span> to be installed via
1.270     leot     6737:          <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> if:</p>
1.148     asau     6738: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      6739: <li class="listitem"><p>None of the package's files
1.88      wiz      6740:              (<code class="filename">Makefile</code>, ...) were modified
                   6741:              since it was built.</p></li>
1.128     wiz      6742: <li class="listitem"><p>None of the package's required (binary)
1.88      wiz      6743:              packages were modified since it was built.</p></li>
1.75      rillig   6744: </ul></div>
1.88      wiz      6745: <p><span class="emphasis"><em>Beware that this target may deinstall
                   6746:          all packages installed on a system!</em></span></p>
1.75      rillig   6747: </dd>
                   6748: </dl></div>
                   6749: </div>
                   6750: </div>
1.148     asau     6751: <div class="chapter">
1.75      rillig   6752: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   6753: <a name="tools"></a>Chapter 20. Tools needed for building or running</h2></div></div></div>
1.75      rillig   6754: <div class="toc">
                   6755: <p><b>Table of Contents</b></p>
1.210     leot     6756: <dl class="toc">
1.267     rillig   6757: <dt><span class="sect1"><a href="#pkgsrc-tools">20.1. Tools for pkgsrc builds</a></span></dt>
                   6758: <dt><span class="sect1"><a href="#package-tools">20.2. Tools needed by packages</a></span></dt>
                   6759: <dt><span class="sect1"><a href="#platform-tools">20.3. Tools provided by platforms</a></span></dt>
1.75      rillig   6760: </dl>
                   6761: </div>
1.87      wiz      6762: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75      rillig   6763: by pkgsrc and also for individual packages to define what commands
1.269     leot     6764: are needed for building a package (like <code class="varname">TOOL_DEPENDS</code>)
1.75      rillig   6765: or for later run-time of an installed packaged (such as
                   6766: <code class="varname">DEPENDS</code>).
                   6767: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87      wiz      6768: package will not be used.</p>
                   6769: <p>When building a package, the replacement tools are
1.75      rillig   6770: made available in a directory (as symlinks or wrapper scripts)
                   6771: that is early in the executable search path. Just like the buildlink
1.87      wiz      6772: system, this helps with consistent builds.</p>
                   6773: <p>A tool may be needed to help build a specific package. For example,
                   6774: perl, GNU make (gmake) or yacc may be needed.</p>
                   6775: <p>Also a tool may be needed, for example, because the native system's supplied
1.75      rillig   6776: tool may be inefficient for building a package with pkgsrc.
                   6777: For example, a package may need GNU awk, bison (instead of
1.87      wiz      6778: yacc) or a better sed.</p>
                   6779: <p>The tools used by a package can be listed by running
1.110     hubertf  6780: <span class="command"><strong>make show-tools</strong></span>.</p>
1.148     asau     6781: <div class="sect1">
1.75      rillig   6782: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   6783: <a name="pkgsrc-tools"></a>20.1. Tools for pkgsrc builds</h2></div></div></div>
1.87      wiz      6784: <p>The default set of tools used by pkgsrc is defined in
1.76      rillig   6785: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.110     hubertf  6786: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
                   6787: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.75      rillig   6788: These can be seen by running:
1.110     hubertf  6789: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.87      wiz      6790: <p>If a package needs a specific program to build
1.75      rillig   6791: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87      wiz      6792: to define the tools needed.</p>
1.75      rillig   6793: </div>
1.148     asau     6794: <div class="sect1">
1.75      rillig   6795: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   6796: <a name="package-tools"></a>20.2. Tools needed by packages</h2></div></div></div>
1.135     wiz      6797: <p>In the following examples, the :run means that it is needed at
                   6798: run-time (and becomes a DEPENDS).
1.75      rillig   6799: The default is a build dependency which can be set with
                   6800: :build. (So in this example, it is the same as gmake:build
1.87      wiz      6801: and pkg-config:build.)</p>
1.75      rillig   6802: <pre class="programlisting">
                   6803: USE_TOOLS+=     gmake perl:run pkg-config
                   6804: </pre>
1.87      wiz      6805: <p>When using the tools framework, a
1.75      rillig   6806: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   6807: which contains the full path to the appropriate tool. For example,
1.128     wiz      6808: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">&#8220;<span class="quote">/bin/bash</span>&#8221;</span>
1.87      wiz      6809: on Linux systems.</p>
                   6810: <p>If you always need a pkgsrc version of the
1.75      rillig   6811: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   6812: </p>
                   6813: </div>
1.148     asau     6814: <div class="sect1">
1.75      rillig   6815: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   6816: <a name="platform-tools"></a>20.3. Tools provided by platforms</h2></div></div></div>
1.87      wiz      6817: <p>When improving or porting pkgsrc to a new platform, have a look
1.75      rillig   6818: at (or create) the corresponding platform specific make file fragment under
1.76      rillig   6819: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75      rillig   6820: the name of the common tools. For example:</p>
                   6821: <pre class="programlisting">
                   6822: .if exists(/usr/bin/bzcat)
                   6823: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   6824: .elif exists(/usr/bin/bzip2)
                   6825: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   6826: .endif
1.69      rillig   6827: 
1.75      rillig   6828: TOOLS_PLATFORM.true?=           true                    # shell builtin
                   6829: </pre>
                   6830: </div>
                   6831: </div>
1.148     asau     6832: <div class="chapter">
1.75      rillig   6833: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   6834: <a name="fixes"></a>Chapter 21. Making your package work</h2></div></div></div>
1.75      rillig   6835: <div class="toc">
                   6836: <p><b>Table of Contents</b></p>
1.210     leot     6837: <dl class="toc">
1.267     rillig   6838: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
1.75      rillig   6839: <dd><dl>
1.267     rillig   6840: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">21.1.1. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
                   6841: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                   6842: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                   6843: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                   6844: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                   6845: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                   6846: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                   6847: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   6848: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                   6849: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   6850: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   6851: </dl></dd>
                   6852: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   6853: <dd><dl>
                   6854: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   6855: <dt><span class="sect2"><a href="#modified-distfiles-same-name">21.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
                   6856: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                   6857: </dl></dd>
                   6858: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   6859: <dd><dl>
                   6860: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                   6861: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   6862: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
                   6863: </dl></dd>
                   6864: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                   6865: <dd><dl>
                   6866: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                   6867: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
                   6868: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing perl scripts</a></span></dt>
                   6869: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
                   6870: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
                   6871: </dl></dd>
                   6872: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   6873: <dd><dl>
                   6874: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   6875: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
                   6876: <dt><span class="sect2"><a href="#undefined-reference">21.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span></a></span></dt>
                   6877: <dt><span class="sect2"><a href="#out-of-memory">21.5.4. Running out of memory</a></span></dt>
                   6878: </dl></dd>
                   6879: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   6880: <dd><dl>
                   6881: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                   6882: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                   6883: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                   6884: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                   6885: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   6886: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing perl modules</a></span></dt>
                   6887: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
                   6888: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
                   6889: <dt><span class="sect2"><a href="#gconf-data-files">21.6.9. Packages installing GConf data files</a></span></dt>
                   6890: <dt><span class="sect2"><a href="#scrollkeeper-data-files">21.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
                   6891: <dt><span class="sect2"><a href="#x11-fonts">21.6.11. Packages installing X11 fonts</a></span></dt>
                   6892: <dt><span class="sect2"><a href="#gtk2-modules">21.6.12. Packages installing GTK2 modules</a></span></dt>
                   6893: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.13. Packages installing SGML or XML data</a></span></dt>
                   6894: <dt><span class="sect2"><a href="#mime-database">21.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   6895: <dt><span class="sect2"><a href="#intltool">21.6.15. Packages using intltool</a></span></dt>
                   6896: <dt><span class="sect2"><a href="#startup-scripts">21.6.16. Packages installing startup scripts</a></span></dt>
                   6897: <dt><span class="sect2"><a href="#tex-packages">21.6.17. Packages installing TeX modules</a></span></dt>
                   6898: <dt><span class="sect2"><a href="#emulation-packages">21.6.18. Packages supporting running binaries in
1.87      wiz      6899:     emulation</a></span></dt>
1.267     rillig   6900: <dt><span class="sect2"><a href="#hicolor-theme">21.6.19. Packages installing hicolor theme icons</a></span></dt>
                   6901: <dt><span class="sect2"><a href="#desktop-files">21.6.20. Packages installing desktop files</a></span></dt>
1.75      rillig   6902: </dl></dd>
1.267     rillig   6903: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.75      rillig   6904: </dl>
                   6905: </div>
1.148     asau     6906: <div class="sect1">
1.75      rillig   6907: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   6908: <a name="general-operation"></a>21.1. General operation</h2></div></div></div>
1.78      rillig   6909: <p>One appealing feature of pkgsrc is that it runs on many
1.218     rillig   6910:   different platforms. As a result, it is important to ensure,
                   6911:   where possible, that packages in pkgsrc are portable. This
                   6912:   chapter mentions some particular details you should pay
                   6913:   attention to while working on pkgsrc.</p>
1.148     asau     6914: <div class="sect2">
1.78      rillig   6915: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   6916: <a name="pulling-vars-from-etc-mk.conf"></a>21.1.1. How to pull in user-settable variables from <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.93      rillig   6917: </h3></div></div></div>
1.78      rillig   6918: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87      wiz      6919:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110     hubertf  6920:     which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87      wiz      6921:     want to use those variables in the preprocessor directives of
1.270     leot     6922:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.87      wiz      6923:     <code class="literal">.for</code>), you need to include the file
                   6924:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   6925:     loads the user preferences.</p>
1.78      rillig   6926: <p>But note that some variables may not be completely defined
1.219     rillig   6927:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
                   6928:     included, as they may contain references to variables that are
                   6929:     not yet defined. In shell commands (the lines in
                   6930:     <code class="filename">Makefile</code> that are indented with a tab) this
                   6931:     is no problem, since variables are only expanded when they are
                   6932:     used. But in the preprocessor directives mentioned above and in
                   6933:     dependency lines (of the form <code class="literal">target:
                   6934:     dependencies</code>) the variables are expanded at load
                   6935:     time.</p>
1.148     asau     6936: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78      rillig   6937: <h3 class="title">Note</h3>
1.218     rillig   6938: <p>To check whether a variable can be used at load time,
                   6939:     run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.78      rillig   6940: </div>
                   6941: </div>
1.148     asau     6942: <div class="sect2">
1.78      rillig   6943: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   6944: <a name="user-interaction"></a>21.1.2. User interaction</h3></div></div></div>
1.88      wiz      6945: <p>Occasionally, packages require interaction from the user,
                   6946:     and this can be in a number of ways:</p>
1.148     asau     6947: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      6948: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87      wiz      6949:        interaction such as entering username/password or accepting a
                   6950:        license on a web page.</p></li>
1.128     wiz      6951: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88      wiz      6952:        passwords.</p></li>
1.128     wiz      6953: <li class="listitem"><p>help to configure the package before it is built</p></li>
                   6954: <li class="listitem"><p>help during the build process</p></li>
                   6955: <li class="listitem"><p>help during the installation of a package</p></li>
1.78      rillig   6956: </ul></div>
1.218     rillig   6957: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
                   6958:     variable to define which stages need interaction. This should be
                   6959:     done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.75      rillig   6960: <pre class="programlisting">
1.100     rillig   6961: INTERACTIVE_STAGE=      configure install
1.222     sevan    6962: </pre>
1.88      wiz      6963: <p>The user can then decide to skip this package by setting the
1.218     rillig   6964:     <code class="varname">BATCH</code> variable. Packages that require interaction
                   6965:     are also excluded from bulk builds.</p>
1.75      rillig   6966: </div>
1.148     asau     6967: <div class="sect2">
1.75      rillig   6968: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   6969: <a name="handling-licenses"></a>21.1.3. Handling licenses</h3></div></div></div>
1.222     sevan    6970: <p>Authors of software can choose the licence under which software
                   6971:     can be copied.  The Free Software Foundation has declared some
                   6972:     licenses "Free", and the Open Source Initiative has a definition of
                   6973:     "Open Source".</p>
                   6974: <p>By default, pkgsrc allows packages with Free or Open Source
                   6975:     licenses to be built.  To allow packages with other licenses to be
                   6976:     built as well, the pkgsrc user needs to add these licenses to the
                   6977:     <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Note
                   6978:     that this variable only affects which packages may be
                   6979:     <span class="emphasis"><em>built</em></span>, while the license terms often also
                   6980:     restrict the actual use of the package and its redistribution.</p>
1.98      wiz      6981: <p>One might want to only install packages with a BSD license,
1.218     rillig   6982:     or the GPL, and not the other.  The free licenses are added to the
1.222     sevan    6983:     default <code class="varname">ACCEPTABLE_LICENSES</code> variable.  The pkgsrc
1.121     jnemeth  6984:     user can override the default by setting the
                   6985:     <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.222     sevan    6986:     of "+=".  The licenses accepted by default are defined in the
                   6987:     <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
                   6988:     <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.78      rillig   6989: <p>The license tag mechanism is intended to address
1.87      wiz      6990:     copyright-related issues surrounding building, installing and
                   6991:     using a package, and not to address redistribution issues (see
                   6992:     <code class="varname">RESTRICTED</code> and
1.222     sevan    6993:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.121     jnemeth  6994:     Packages with redistribution restrictions should set these
                   6995:     tags.</p>
1.98      wiz      6996: <p>Denoting that a package may be copied according to a
                   6997:     particular license is done by placing the license in
1.87      wiz      6998:     <code class="filename">pkgsrc/licenses</code> and setting the
                   6999:     <code class="varname">LICENSE</code> variable to a string identifying the
1.250     leot     7000:     license, e.g. in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/xv/README.html" target="_top"><code class="filename">graphics/xv</code></a>:</p>
1.87      wiz      7001: <pre class="programlisting">
1.100     rillig   7002: LICENSE=        xv-license
1.222     sevan    7003: </pre>
1.87      wiz      7004: <p>When trying to build, the user will get a notice that the
1.98      wiz      7005:     package is covered by a license which has not been placed in the
                   7006:     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87      wiz      7007: <pre class="programlisting">
1.100     rillig   7008: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   7009: ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
                   7010: ===&gt;     To view the license, enter "/usr/bin/make show-license".
                   7011: ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
                   7012: ===&gt;     ACCEPTABLE_LICENSES+=xv-license
                   7013: *** Error code 1
1.222     sevan    7014: </pre>
1.110     hubertf  7015: <p>The license can be viewed with <span class="command"><strong>make
1.98      wiz      7016:     show-license</strong></span>, and if the user so chooses, the line
1.110     hubertf  7017:     printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98      wiz      7018:     convey to pkgsrc that it should not in the future fail because of
                   7019:     that license:</p>
1.78      rillig   7020: <pre class="programlisting">
1.100     rillig   7021: ACCEPTABLE_LICENSES+=xv-license
1.222     sevan    7022: </pre>
                   7023: <p>The use of <code class="varname">LICENSE=shareware</code>,
                   7024:     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
                   7025:     is deprecated because it does not crisply refer to a particular
                   7026:     license text.  Another problem with such usage is that it does not
                   7027:     enable a user to tell pkgsrc to proceed for a single package
                   7028:     without also telling pkgsrc to proceed for all packages with that
                   7029:     tag.</p>
                   7030: <div class="sect3">
                   7031: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   7032: <a name="new-license"></a>21.1.3.1. Adding a package with a new license</h4></div></div></div>
1.154     rodent   7033: <p>When adding a package with a new license, the following steps
                   7034:     are required:</p>
                   7035: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7036: <li class="listitem">
1.222     sevan    7037: <p>Check whether the license qualifies as Free or Open
                   7038:     Source by referencing <a class="ulink" href="http://www.gnu.org/licenses/license-list.en.html" target="_top">Various Licenses
                   7039:     and Comments about Them</a> and <a class="ulink" href="http://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
                   7040:     Open Source Initiative</a>.  If this is the case, the filename in
                   7041:     <code class="filename">pkgsrc/licenses/</code> does not need the
                   7042:     <code class="filename">-license</code> suffix, and the license name should be
                   7043:     added to:</p>
1.154     rodent   7044: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   7045: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in <code class="filename">pkgsrc/mk/license.mk</code></p></li>
                   7046: <li class="listitem"><p>default_acceptable_licenses in <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
                   7047: </ul></div>
                   7048: </li>
                   7049: <li class="listitem"><p>The license text should be added to <code class="filename">pkgsrc/licenses</code> for displaying.  A list of known licenses can be seen in this directory.</p></li>
                   7050: </ol></div>
1.222     sevan    7051: </div>
                   7052: <div class="sect3">
                   7053: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   7054: <a name="change-license"></a>21.1.3.2. Change to the license</h4></div></div></div>
1.98      wiz      7055: <p>When the license changes (in a way other than formatting),
1.222     sevan    7056:     make sure that the new license has a different name (e.g.,
1.98      wiz      7057:     append the version number if it exists, or the date).  Just
                   7058:     because a user told pkgsrc to build programs under a previous
                   7059:     version of a license does not mean that pkgsrc should build
1.99      rillig   7060:     programs under the new licenses.  The higher-level point is that
1.98      wiz      7061:     pkgsrc does not evaluate licenses for reasonableness; the only
                   7062:     test is a mechanistic test of whether a particular text has been
1.222     sevan    7063:     approved by either of two bodies (FSF or OSI).</p>
                   7064: </div>
1.75      rillig   7065: </div>
1.148     asau     7066: <div class="sect2">
1.75      rillig   7067: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7068: <a name="restricted-packages"></a>21.1.4. Restricted packages</h3></div></div></div>
1.75      rillig   7069: <p>Some licenses restrict how software may be re-distributed.
1.222     sevan    7070:     By declaring the restrictions, package tools can
1.98      wiz      7071:     automatically refrain from e.g. placing binary packages on FTP
                   7072:     sites.</p>
1.222     sevan    7073: <p>There are four possible restrictions, which are
1.98      wiz      7074:     the cross product of sources (distfiles) and binaries not being
                   7075:     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
                   7076:     language in any license, and because non-Free licenses tend to be
                   7077:     different from each other, pkgsrc adopts a definition of FTP and
1.222     sevan    7078:     CD-ROM.
                   7079: 
                   7080:     "FTP" means making the source or binary file available over the
                   7081:     Internet at no charge.
                   7082: 
                   7083:     "CD-ROM" means making the source or binary available on some kind of
                   7084:     media, together with other source and binary packages, which is sold
                   7085:     for a distribution charge.
1.98      wiz      7086:     </p>
                   7087: <p>In order to encode these restrictions, the package system
1.87      wiz      7088:     defines five make variables that can be set to note these
                   7089:     restrictions:</p>
1.148     asau     7090: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7091: <li class="listitem">
1.75      rillig   7092: <p><code class="varname">RESTRICTED</code></p>
                   7093: <p>This variable should be set whenever a restriction
1.87      wiz      7094:        exists (regardless of its kind).  Set this variable to a
1.98      wiz      7095:        string containing the reason for the restriction.  It should
                   7096:        be understood that those wanting to understand the restriction
                   7097:        will have to read the license, and perhaps seek advice of
                   7098:        counsel.</p>
1.75      rillig   7099: </li>
1.128     wiz      7100: <li class="listitem">
1.75      rillig   7101: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98      wiz      7102: <p>Binaries may not be placed on CD-ROM containing other
                   7103:        binary packages, for which a distribution charge may be made.
                   7104:        In this case, set this variable to
                   7105:        <code class="varname">${RESTRICTED}</code>.</p>
1.75      rillig   7106: </li>
1.128     wiz      7107: <li class="listitem">
1.75      rillig   7108: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98      wiz      7109: <p>Binaries may not made available on the Internet without
                   7110:        charge.  In this case, set this variable to
                   7111:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7112:        binary packages will not be included on ftp.NetBSD.org.</p>
1.75      rillig   7113: </li>
1.128     wiz      7114: <li class="listitem">
1.75      rillig   7115: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98      wiz      7116: <p>Distfiles may not be placed on CD-ROM, together with
                   7117:        other distfiles, for which a fee may be charged.  In this
                   7118:        case, set this variable to <code class="varname">${RESTRICTED}</code>.
                   7119:        </p>
1.75      rillig   7120: </li>
1.128     wiz      7121: <li class="listitem">
1.75      rillig   7122: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98      wiz      7123: <p>Distfiles may not made available via FTP at no charge.
                   7124:        In this case, set this variable to
                   7125:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7126:        the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75      rillig   7127: </li>
                   7128: </ul></div>
1.222     sevan    7129: <p>Please note that packages will be removed from pkgsrc when the
                   7130:     distfiles are not distributable and cannot be obtained for a period
                   7131:     of one full quarter branch. Packages with manual/interactive fetch
                   7132:     must have a maintainer and it is his/her responsibility to ensure
                   7133:     this.</p>
1.75      rillig   7134: </div>
1.148     asau     7135: <div class="sect2">
1.75      rillig   7136: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7137: <a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
1.75      rillig   7138: <p>Your package may depend on some other package being present
1.88      wiz      7139:     - and there are various ways of expressing this dependency.
                   7140:     pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
1.269     leot     7141:     <code class="varname">DEPENDS</code> and
                   7142:     <code class="varname">TOOL_DEPENDS</code> definitions, the
1.88      wiz      7143:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   7144:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   7145:     to handle dependencies, and which uses the variables named above.
1.267     rillig   7146:     See <a class="xref" href="#buildlink" title="Chapter 16. Buildlink methodology">Chapter 16, <i>Buildlink methodology</i></a> for more information.</p>
1.75      rillig   7147: <p>The basic difference between the two variables is as
1.87      wiz      7148:     follows: The <code class="varname">DEPENDS</code> definition registers
                   7149:     that pre-requisite in the binary package so it will be pulled in
                   7150:     when the binary package is later installed, whilst the
1.269     leot     7151:     <code class="varname">BUILD_DEPENDS</code> and <code class="varname">TOOL_DEPENDS</code>
                   7152:     definitions does not, marking a dependency that is only needed for
                   7153:     building the package.</p>
1.75      rillig   7154: <p>This means that if you only need a package present whilst
1.87      wiz      7155:     you are building, it should be noted as a
1.269     leot     7156:     <code class="varname">TOOL_DEPENDS</code> or
                   7157:     <code class="varname">BUILD_DEPENDS</code>.  When cross-compiling,
                   7158:     <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
                   7159:     packages, i.e. packages for the architecture where the package
                   7160:     is built;
                   7161:     <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
                   7162:     packages, i.e. packages for the architecture for which the package
                   7163:     is built.</p>
                   7164: <p>The format for <code class="varname">BUILD_DEPENDS</code>,
                   7165:     <code class="varname">DEPENDS</code> and <code class="varname">TOOL_DEPENDS</code>
                   7166:     definition is:</p>
1.75      rillig   7167: <pre class="programlisting">
1.100     rillig   7168: &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
1.222     sevan    7169: </pre>
1.128     wiz      7170: <p>Please note that the <span class="quote">&#8220;<span class="quote">pre-req-package-name</span>&#8221;</span>
1.87      wiz      7171:     may include any of the wildcard version numbers recognized by
1.270     leot     7172:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.128     wiz      7173: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7174: <li class="listitem">
1.75      rillig   7175: <p>If your package needs another package's binaries or
1.160     wiz      7176:        libraries to build and run, and if that package has a
1.87      wiz      7177:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75      rillig   7178: <pre class="programlisting">
1.100     rillig   7179: .include "../../graphics/jpeg/buildlink3.mk"
1.222     sevan    7180: </pre>
1.75      rillig   7181: </li>
1.128     wiz      7182: <li class="listitem">
1.160     wiz      7183: <p>If your package needs another package's binaries or
                   7184:        libraries only for building, and if that package has a
                   7185:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
                   7186: <pre class="programlisting">
                   7187: .include "../../graphics/jpeg/buildlink3.mk"
1.222     sevan    7188: </pre>
1.160     wiz      7189: <p>but set
                   7190:        <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
                   7191:        to make it a build dependency only. This case is rather
                   7192:        rare.</p>
                   7193: </li>
                   7194: <li class="listitem">
1.132     spz      7195: <p>If your package needs binaries from another package to build,
1.269     leot     7196:        use the <code class="varname">TOOL_DEPENDS</code> definition:</p>
1.75      rillig   7197: <pre class="programlisting">
1.269     leot     7198: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.222     sevan    7199: </pre>
1.75      rillig   7200: </li>
1.269     leot     7201: <li class="listitem"><p>If your package needs static libraries to link against, header
                   7202:        files to include, etc. from another package to build,
                   7203:        use the <code class="varname">BUILD_DEPENDS</code> definition.</p></li>
1.132     spz      7204: <li class="listitem"><p>If your package needs a library with which to link and
                   7205:        there is no <code class="filename">buildlink3.mk</code> file
                   7206:        available, create one. Using
                   7207:        <code class="varname">DEPENDS</code> won't be sufficient because the
                   7208:        include files and libraries will be hidden from the compiler.</p></li>
1.128     wiz      7209: <li class="listitem">
1.132     spz      7210: <p>If your package needs some executable to be able to run
                   7211:        correctly and if there's no
                   7212:        <code class="filename">buildlink3.mk</code> file, this is specified
                   7213:        using the <code class="varname">DEPENDS</code> variable. The
1.250     leot     7214:        <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/lyx/README.html" target="_top"><code class="filename">print/lyx</code></a> package needs to
1.242     wiz      7215:        be able to execute the latex binary from the tex-latex-bin package
1.132     spz      7216:        when it runs, and that is specified:</p>
1.75      rillig   7217: <pre class="programlisting">
1.242     wiz      7218: DEPENDS+=        tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.222     sevan    7219: </pre>
1.132     spz      7220: </li>
                   7221: <li class="listitem">
                   7222: <p>You can use wildcards in package dependencies. Note that
                   7223:        such wildcard dependencies are retained when creating binary
                   7224:        packages. The dependency is checked when installing the binary
                   7225:        package and any package which matches the pattern will be
                   7226:        used. Wildcard dependencies should be used with care.</p>
1.128     wiz      7227: <p>The <span class="quote">&#8220;<span class="quote">-[0-9]*</span>&#8221;</span> should be used instead of
                   7228:        <span class="quote">&#8220;<span class="quote">-*</span>&#8221;</span> to avoid potentially ambiguous matches
                   7229:        such as <span class="quote">&#8220;<span class="quote">tk-postgresql</span>&#8221;</span> matching a
                   7230:        <span class="quote">&#8220;<span class="quote">tk-*</span>&#8221;</span> <code class="varname">DEPENDS</code>.</p>
1.75      rillig   7231: <p>Wildcards can also be used to specify that a package
1.87      wiz      7232:        will only build against a certain minimum version of a
                   7233:        pre-requisite:</p>
1.75      rillig   7234: <pre class="programlisting">
1.132     spz      7235: DEPENDS+=       ImageMagick&gt;=6.0:../../graphics/ImageMagick
1.222     sevan    7236: </pre>
1.132     spz      7237: <p>This means that the package will build using version 6.0
                   7238:        of ImageMagick or newer. Such a dependency may be warranted
                   7239:        if, for example, the command line options of an executable
                   7240:        have changed.</p>
                   7241: <p>If you need to depend on minimum versions of libraries,
                   7242:        see the buildlink section of the pkgsrc guide.</p>
1.75      rillig   7243: <p>For security fixes, please update the package
1.267     rillig   7244:        vulnerabilities file. See <a class="xref" href="#security-handling" title="21.1.9. Handling packages with security problems">Section 21.1.9, &#8220;Handling packages with security problems&#8221;</a> for more
1.87      wiz      7245:        information.</p>
1.75      rillig   7246: </li>
                   7247: </ol></div>
                   7248: <p>If your package needs files from another package to build,
1.87      wiz      7249:     add the relevant distribution files to
                   7250:     <code class="varname">DISTFILES</code>, so they will be extracted
1.250     leot     7251:     automatically. See the <a href="https://cdn.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      7252:     (It relies on the jpeg sources being present in source form
                   7253:     during the build.)</p>
1.75      rillig   7254: </div>
1.148     asau     7255: <div class="sect2">
1.75      rillig   7256: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7257: <a name="conflicts"></a>21.1.6. Handling conflicts with other packages</h3></div></div></div>
1.75      rillig   7258: <p>Your package may conflict with other packages a user might
1.87      wiz      7259:     already have installed on his system, e.g. if your package
1.88      wiz      7260:     installs the same set of files as another package in the pkgsrc
1.190     wiz      7261:     tree or has the same <code class="varname">PKGNAME</code>.</p>
1.255     leot     7262: <p>For example, <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/libXaw3d/README.html" target="_top"><code class="filename">x11/libXaw3d</code></a>
                   7263:     and <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/Xaw-Xpm/README.html" target="_top"><code class="filename">x11/Xaw-Xpm</code></a>
                   7264:     install the same shared library, thus you set in
                   7265:     <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
                   7266: <pre class="programlisting">
                   7267: CONFLICTS=      Xaw-Xpm-[0-9]*
                   7268:     </pre>
                   7269: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
                   7270: <pre class="programlisting">
                   7271: CONFLICTS=      libXaw3d-[0-9]*
                   7272:     </pre>
1.270     leot     7273: <p><a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> is able to detect attempts to install packages
1.255     leot     7274:     that conflict with existing packages and abort. However, in many
                   7275:     situations this is too late in the process. Binary package managers
                   7276:     will not know about the conflict until they attempt to install the
                   7277:     package after already downloading it and all its dependencies.
                   7278:     Users may also waste time building a package and its dependencies
                   7279:     only to find out at the end that it conflicts with another package
                   7280:     they have installed.</p>
                   7281: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
                   7282:     should be added in all cases where it is known that packages conflict
                   7283:     with each other.  These <code class="varname">CONFLICTS</code> entries are
1.270     leot     7284:     exported in <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> files and consumed by binary package
1.255     leot     7285:     managers to inform users that packages cannot be installed onto
                   7286:     the target system.</p>
1.75      rillig   7287: </div>
1.148     asau     7288: <div class="sect2">
1.75      rillig   7289: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7290: <a name="not-building-packages"></a>21.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.75      rillig   7291: <p>There are several reasons why a package might be
1.88      wiz      7292:     instructed to not build under certain circumstances.  If the
1.87      wiz      7293:     package builds and runs on most platforms, the exceptions
1.193     dholland 7294:     should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>.  If
                   7295:     the package builds and runs on a small handful of platforms,
                   7296:     set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
                   7297:     Both <code class="varname">BROKEN_ON_PLATFORM</code> and
                   7298:     <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
                   7299:     (OS-version-platform) that can use glob-style
                   7300:     wildcards.</p>
                   7301: <p>If a package is not appropriate for some platforms (as
1.225     maya     7302:     opposed to merely broken), a different set of variables should be
1.193     dholland 7303:     used as this affects failure reporting and statistics.
                   7304:     If the package is appropriate for most platforms, the exceptions
1.87      wiz      7305:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
1.193     dholland 7306:     the package is appropriate for only a small handful of platforms
                   7307:     (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.87      wiz      7308:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   7309:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   7310:     (OS-version-platform) that can use glob-style
                   7311:     wildcards.</p>
1.88      wiz      7312: <p>Some packages are tightly bound to a specific version of an
1.250     leot     7313:     operating system, e.g. LKMs or <a href="https://cdn.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      7314:     backwards compatible with other versions of the OS, and should be
                   7315:     uploaded to a version specific directory on the FTP server.  Mark
                   7316:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.128     wiz      7317:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.  This variable is not currently used by any of
1.88      wiz      7318:     the package system internals, but may be used in the
                   7319:     future.</p>
1.75      rillig   7320: <p>If the package should be skipped (for example, because it
1.87      wiz      7321:     provides functionality already provided by the system), set
1.88      wiz      7322:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   7323:     the package should fail because some preconditions are not met,
                   7324:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87      wiz      7325:     message.</p>
1.75      rillig   7326: </div>
1.148     asau     7327: <div class="sect2">
1.75      rillig   7328: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7329: <a name="undeletable-packages"></a>21.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.75      rillig   7330: <p>To ensure that a package may not be deleted, once it has been
1.87      wiz      7331:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   7332:     be set in the package Makefile. This will be carried into any
                   7333:     binary package that is made from this pkgsrc entry. A
1.128     wiz      7334:     <span class="quote">&#8220;<span class="quote">preserved</span>&#8221;</span> package will
1.270     leot     7335:     not be deleted using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.128     wiz      7336:     <span class="quote">&#8220;<span class="quote">-f</span>&#8221;</span> option is used.</p>
1.75      rillig   7337: </div>
1.148     asau     7338: <div class="sect2">
1.75      rillig   7339: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7340: <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
1.75      rillig   7341: <p>When a vulnerability is found, this should be noted in
1.87      wiz      7342:     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.138     wiz      7343:     and after committing that file, ask pkgsrc-security@NetBSD.org to
                   7344:     update the file on ftp.NetBSD.org.</p>
1.75      rillig   7345: <p>After fixing the vulnerability by a patch, its
1.138     wiz      7346:     <code class="varname">PKGREVISION</code> should be increased (this is of
                   7347:     course not necessary if the problem is fixed by using a newer
                   7348:     release of the software), and the pattern in the
                   7349:     pkg-vulnerabilities file must be updated.</p>
1.75      rillig   7350: <p>Also, if the fix should be applied to the stable pkgsrc
1.87      wiz      7351:     branch, be sure to submit a pullup request!</p>
1.75      rillig   7352: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87      wiz      7353:     semi-automatically by a weekly cron job.</p>
1.75      rillig   7354: </div>
1.148     asau     7355: <div class="sect2">
1.75      rillig   7356: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7357: <a name="bumping-pkgrevision"></a>21.1.10. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.75      rillig   7358: <p>When making fixes to an existing package it can be useful
1.87      wiz      7359:     to change the version number in <code class="varname">PKGNAME</code>. To
                   7360:     avoid conflicting with future versions by the original author, a
1.128     wiz      7361:     <span class="quote">&#8220;<span class="quote">nb1</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">nb2</span>&#8221;</span>, ... suffix can be used
1.87      wiz      7362:     on package versions by setting <code class="varname">PKGREVISION=1</code>
1.128     wiz      7363:     (2, ...). The <span class="quote">&#8220;<span class="quote">nb</span>&#8221;</span> is treated like a
                   7364:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> by the package tools. e.g.</p>
1.87      wiz      7365: <pre class="programlisting">
1.100     rillig   7366: DISTNAME=       foo-17.42
                   7367: PKGREVISION=    9
1.222     sevan    7368: </pre>
1.75      rillig   7369: <p>will result in a <code class="varname">PKGNAME</code> of
1.128     wiz      7370:     <span class="quote">&#8220;<span class="quote">foo-17.42nb9</span>&#8221;</span>. If you want to use the original
                   7371:     value of <code class="varname">PKGNAME</code> without the <span class="quote">&#8220;<span class="quote">nbX</span>&#8221;</span>
1.87      wiz      7372:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   7373:     <code class="varname">PKGNAME_NOREV</code>.</p>
1.75      rillig   7374: <p>When a new release of the package is released, the
1.87      wiz      7375:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   7376:     minor release of the above package, things should be like:</p>
1.75      rillig   7377: <pre class="programlisting">
1.100     rillig   7378: DISTNAME=       foo-17.43
1.222     sevan    7379: </pre>
1.87      wiz      7380: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   7381:     non-trivial change in the resulting binary package.  Without a
                   7382:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   7383:     version installed has no way of knowing that their package is out
                   7384:     of date.  Thus, changes without increasing
                   7385:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   7386:     trivial that no reasonable person would want to upgrade", and this
                   7387:     is the rough test for when increasing
                   7388:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   7389:     changes that do not merit increasing
                   7390:     <code class="varname">PKGREVISION</code> are:</p>
1.148     asau     7391: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7392: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.114     jmcneill 7393:       <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.100     rillig   7394:       or comments in Makefile.</p></li>
1.128     wiz      7395: <li class="listitem"><p>
1.100     rillig   7396:       Changing build variables if the resulting binary package is the same.</p></li>
1.128     wiz      7397: <li class="listitem"><p>
1.100     rillig   7398:       Changing <code class="filename">DESCR</code>.</p></li>
1.128     wiz      7399: <li class="listitem"><p>
1.100     rillig   7400:       Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
                   7401: </ul></div>
1.87      wiz      7402: <p>Examples of changes that do merit an increase to
                   7403:     <code class="varname">PKGREVISION</code> include:</p>
1.148     asau     7404: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7405: <li class="listitem"><p>
1.100     rillig   7406:       Security fixes</p></li>
1.128     wiz      7407: <li class="listitem"><p>
1.100     rillig   7408:       Changes or additions to a patch file</p></li>
1.128     wiz      7409: <li class="listitem"><p>
1.100     rillig   7410:       Changes to the <code class="filename">PLIST</code></p></li>
1.128     wiz      7411: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.100     rillig   7412: </ul></div>
1.78      rillig   7413: <p>PKGREVISION must also be incremented when dependencies have ABI
                   7414:     changes.</p>
1.75      rillig   7415: </div>
1.148     asau     7416: <div class="sect2">
1.79      rillig   7417: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7418: <a name="fixes.subst"></a>21.1.11. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.79      rillig   7419: <p>When you want to replace the same text in multiple files
1.87      wiz      7420:     or when the replacement text varies, patches alone cannot help.
                   7421:     This is where the SUBST framework comes in. It provides an
                   7422:     easy-to-use interface for replacing text in files.
                   7423:     Example:</p>
                   7424: <pre class="programlisting">
1.100     rillig   7425: SUBST_CLASSES+=                 fix-paths
                   7426: SUBST_STAGE.fix-paths=          pre-configure
                   7427: SUBST_MESSAGE.fix-paths=        Fixing absolute paths.
                   7428: SUBST_FILES.fix-paths=          src/*.c
                   7429: SUBST_FILES.fix-paths+=         scripts/*.sh
                   7430: SUBST_SED.fix-paths=            -e 's,"/usr/local,"${PREFIX},g'
                   7431: SUBST_SED.fix-paths+=           -e 's,"/var/log,"${VARBASE}/log,g'
1.222     sevan    7432: </pre>
1.79      rillig   7433: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87      wiz      7434:     that are used to identify the different SUBST blocks that are
                   7435:     defined. The SUBST framework is heavily used by pkgsrc, so it is
                   7436:     important to always use the <code class="literal">+=</code> operator with
                   7437:     this variable. Otherwise some substitutions may be
                   7438:     skipped.</p>
1.79      rillig   7439: <p>The remaining variables of each SUBST block are
1.87      wiz      7440:     parameterized with the identifier from the first line
                   7441:     (<code class="literal">fix-paths</code> in this case.) They can be seen as
                   7442:     parameters to a function call.</p>
1.79      rillig   7443: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87      wiz      7444:     which the replacement will take place. All combinations of
                   7445:     <code class="literal">pre-</code>, <code class="literal">do-</code> and
                   7446:     <code class="literal">post-</code> together with a phase name are
                   7447:     possible, though only few are actually used. Most commonly used
                   7448:     are <code class="literal">post-patch</code> and
                   7449:     <code class="literal">pre-configure</code>. Of these two,
                   7450:     <code class="literal">pre-configure</code> should be preferred because
1.110     hubertf  7451:     then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.87      wiz      7452:     have the state after applying the patches but before making any
                   7453:     other changes. This is especially useful when you are debugging
                   7454:     a package in order to create new patches for it. Similarly,
                   7455:     <code class="literal">post-build</code> is preferred over
                   7456:     <code class="literal">pre-install</code>, because the install phase should
                   7457:     generally be kept as simple as possible. When you use
                   7458:     <code class="literal">post-build</code>, you have the same files in the
                   7459:     working directory that will be installed later, so you can check
                   7460:     if the substitution has succeeded.</p>
1.79      rillig   7461: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87      wiz      7462:     that is printed just before the substitution is done.</p>
1.79      rillig   7463: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87      wiz      7464:     globbing patterns that specifies the files in which the
                   7465:     substitution will take place. The patterns are interpreted
                   7466:     relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79      rillig   7467: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.270     leot     7468:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that specify the actual substitution. Every sed
1.87      wiz      7469:     command should be prefixed with <code class="literal">-e</code>, so that
                   7470:     all SUBST blocks look uniform.</p>
1.79      rillig   7471: <p>There are some more variables, but they are so seldomly
1.87      wiz      7472:     used that they are only documented in the
                   7473:     <code class="filename">mk/subst.mk</code> file.</p>
1.79      rillig   7474: </div>
1.75      rillig   7475: </div>
1.148     asau     7476: <div class="sect1">
1.75      rillig   7477: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   7478: <a name="fixes.fetch"></a>21.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.148     asau     7479: <div class="sect2">
1.75      rillig   7480: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7481: <a name="no-plain-download"></a>21.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.75      rillig   7482: <p>If you need to download from a dynamic URL you can set
1.110     hubertf  7483:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87      wiz      7484:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   7485:     with the name of each file to download as an argument, expecting
                   7486:     it to output the URL of the directory from which to download
1.250     leot     7487:     it. <a href="https://cdn.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      7488:     example of this usage.</p>
1.75      rillig   7489: <p>If the download can't be automated, because the user must
1.87      wiz      7490:     submit personal information to apply for a password, or must pay
                   7491:     for the source, or whatever, you can set
                   7492:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   7493:     displayed to the user before aborting the build. Example:</p>
                   7494: <pre class="programlisting">
1.100     rillig   7495: FETCH_MESSAGE=  "Please download the files"
                   7496: FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   7497: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.222     sevan    7498: </pre>
1.75      rillig   7499: </div>
1.148     asau     7500: <div class="sect2">
1.75      rillig   7501: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7502: <a name="modified-distfiles-same-name"></a>21.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.75      rillig   7503: <p>Sometimes authors of a software package make some
1.87      wiz      7504:     modifications after the software was released, and they put up a
                   7505:     new distfile without changing the package's version number. If a
                   7506:     package is already in pkgsrc at that time, the checksum will
                   7507:     no longer match. The contents of the new distfile should be
                   7508:     compared against the old one before changing anything, to make
                   7509:     sure the distfile was really updated on purpose, and that
                   7510:     no trojan horse or so crept in.
1.97      rillig   7511:     Please mention that the distfiles were compared and what was found
1.159     rodent   7512:     in your commit message.</p>
1.220     wiz      7513: <p>Then, the correct way to work around this is to set
                   7514:     <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
                   7515:     based on <code class="varname">PKGNAME_NOREV</code> (but take care with
                   7516:     python or ruby packages, where <code class="varname">PKGNAME</code> includes
                   7517:     a variable prefix). All <code class="varname">DISTFILES</code> and
1.93      rillig   7518:     <code class="varname">PATCHFILES</code> for this package will be put in that
1.267     rillig   7519:     subdirectory of the local distfiles directory. (See <a class="xref" href="#bumping-pkgrevision" title="21.1.10. How to handle incrementing versions when fixing an existing package">Section 21.1.10, &#8220;How to handle incrementing versions when fixing an existing package&#8221;</a> for more details.) In case this
1.87      wiz      7520:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.220     wiz      7521:     including the <code class="filename">nbX</code> suffix) or a date stamp can
                   7522:     be appended, like
                   7523:     <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.159     rodent   7524: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's name does not contain a version and the distfile is apt to change. In cases where the likelihood of this is very small, <code class="varname">DIST_SUBDIR</code> might not be required. Additionally, <code class="varname">DIST_SUBDIR</code> must not be removed unless the distfile name changes, even if a package is being moved or renamed.</p>
                   7525: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.87      wiz      7526:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   7527:     path in the filenames.
1.159     rodent   7528:     Also, increase the PKGREVISION if the installed package is different.
1.87      wiz      7529:     Furthermore, a mail to the package's authors seems appropriate
                   7530:     telling them that changing distfiles after releases without
                   7531:     changing the file names is not good practice.</p>
1.75      rillig   7532: </div>
1.199     tnn      7533: <div class="sect2">
                   7534: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7535: <a name="build.fetch.github"></a>21.2.3. Packages hosted on github.com</h3></div></div></div>
1.200     tnn      7536: <p>Helper methods exist for packages hosted on github.com which will often have distfile names that clash with other packages, for example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes from below:
                   7537:     </p>
1.199     tnn      7538: <div class="sect3">
                   7539: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   7540: <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
1.199     tnn      7541: <p>
                   7542:         If your distfile URL looks similar to <code class="literal">http://github.com/username/exampleproject/archive/v1.0.zip</code>, then you are packaging a tagged release.
                   7543:       </p>
                   7544: <pre class="programlisting">
                   7545: DISTNAME=       exampleproject-1.0
1.200     tnn      7546: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   7547: #GITHUB_PROJECT=        # can be omitted if same as DISTNAME
                   7548: GITHUB_TAG=     v${PKGVERSION_NOREV}
1.199     tnn      7549: EXTRACT_SUFX=   .zip
                   7550: </pre>
                   7551: </div>
                   7552: <div class="sect3">
                   7553: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   7554: <a name="build.fetch.github.commit"></a>21.2.3.2. Fetch based on a specific commit</h4></div></div></div>
1.199     tnn      7555: <p>
                   7556:         If your distfile URL looks similar to <code class="literal">http://github.com/example/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11.tar.gz</code>, then you are packaging a specific commit not tied to a release.
                   7557:       </p>
                   7558: <pre class="programlisting">
                   7559: DISTNAME=       example-1.0
1.217     jnemeth  7560: MASTER_SITES=   ${MASTER_SITE_GITHUB:=example/}
1.200     tnn      7561: #GITHUB_PROJECT=        # can be omitted if same as DISTNAME
                   7562: GITHUB_TAG=     988881adc9fc3655077dc2d4d757d480b5ea0e11
1.222     sevan    7563: </pre>
1.199     tnn      7564: </div>
                   7565: <div class="sect3">
                   7566: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   7567: <a name="build.fetch.github.release"></a>21.2.3.3. Fetch based on release</h4></div></div></div>
1.199     tnn      7568: <p>
                   7569:         If your distfile URL looks similar to <code class="literal">http://github.com/username/exampleproject/releases/download/rel-1.6/offensive-1.6.zip</code>, then you are packaging a release.
                   7570:       </p>
                   7571: <pre class="programlisting">
                   7572: DISTNAME=       offensive-1.6
1.200     tnn      7573: PKGNAME=        ${DISTNAME:S/offensive/proper/}
                   7574: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   7575: GITHUB_PROJECT= exampleproject
                   7576: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
                   7577: EXTRACT_SUFX=   .zip
1.222     sevan    7578: </pre>
1.199     tnn      7579: </div>
                   7580: </div>
1.75      rillig   7581: </div>
1.148     asau     7582: <div class="sect1">
1.75      rillig   7583: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   7584: <a name="fixes.configure"></a>21.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.148     asau     7585: <div class="sect2">
1.75      rillig   7586: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7587: <a name="fixes.libtool"></a>21.3.1. Shared libraries - libtool</h3></div></div></div>
1.75      rillig   7588: <p>pkgsrc supports many different machines, with different
1.87      wiz      7589:     object formats like a.out and ELF, and varying abilities to do
                   7590:     shared library and dynamic loading at all. To accompany this,
                   7591:     varying commands and options have to be passed to the
                   7592:     compiler, linker, etc. to get the Right Thing, which can be
                   7593:     pretty annoying especially if you don't have all the machines
                   7594:     at your hand to test things.  The
1.250     leot     7595:     <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/README.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
1.128     wiz      7596:     can help here, as it just <span class="quote">&#8220;<span class="quote">knows</span>&#8221;</span> how to build
1.87      wiz      7597:     both static and dynamic libraries from a set of source files,
                   7598:     thus being platform-independent.</p>
                   7599: <p>Here's how to use libtool in a package in seven simple
                   7600:     steps:</p>
1.128     wiz      7601: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7602: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87      wiz      7603:        Makefile.</p></li>
1.128     wiz      7604: <li class="listitem"><p>For library objects, use <span class="quote">&#8220;<span class="quote">${LIBTOOL} --mode=compile
                   7605:        ${CC}</span>&#8221;</span> in place of <span class="quote">&#8220;<span class="quote">${CC}</span>&#8221;</span>. You could even
1.87      wiz      7606:        add it to the definition of <code class="varname">CC</code>, if only
                   7607:        libraries are being built in a given Makefile. This one command
                   7608:        will build both PIC and non-PIC library objects, so you need not
                   7609:        have separate shared and non-shared library rules.</p></li>
1.128     wiz      7610: <li class="listitem">
1.75      rillig   7611: <p>For the linking of the library, remove any
1.128     wiz      7612:        <span class="quote">&#8220;<span class="quote">ar</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">ranlib</span>&#8221;</span>, and <span class="quote">&#8220;<span class="quote">ld
                   7613:        -Bshareable</span>&#8221;</span> commands, and instead use:</p>
1.75      rillig   7614: <pre class="programlisting">
1.100     rillig   7615: ${LIBTOOL} --mode=link \
                   7616:     ${CC} -o ${.TARGET:.a=.la} \
                   7617:         ${OBJS:.o=.lo} \
                   7618:         -rpath ${PREFIX}/lib \
                   7619:         -version-info major:minor
1.222     sevan    7620: </pre>
1.75      rillig   7621: <p>Note that the library is changed to have a
1.87      wiz      7622:        <code class="filename">.la</code> extension, and the objects are
                   7623:        changed to have a <code class="filename">.lo</code>
                   7624:        extension. Change <code class="varname">OBJS</code> as
                   7625:        necessary. This automatically creates all of the
                   7626:        <code class="filename">.a</code>,
                   7627:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   7628:        necessary) in the build directory. Be sure to include
1.128     wiz      7629:        <span class="quote">&#8220;<span class="quote">-version-info</span>&#8221;</span>, especially when major and
1.87      wiz      7630:        minor are zero, as libtool will otherwise strip off the
                   7631:        shared library version.</p>
1.75      rillig   7632: <p>From the libtool manual:</p>
                   7633: <pre class="programlisting">
1.100     rillig   7634: So, libtool library versions are described by three integers:
1.69      rillig   7635: 
1.100     rillig   7636: CURRENT
                   7637: The most recent interface number that this library implements.
1.69      rillig   7638: 
1.100     rillig   7639: REVISION
                   7640: The implementation number of the CURRENT interface.
1.69      rillig   7641: 
1.100     rillig   7642: AGE
                   7643: The difference between the newest and oldest interfaces that
                   7644: this library implements.  In other words, the library implements
                   7645: all the interface numbers in the range from number `CURRENT -
                   7646: AGE' to `CURRENT'.
1.1       grant    7647: 
1.100     rillig   7648: If two libraries have identical CURRENT and AGE numbers, then the
                   7649: dynamic linker chooses the library with the greater REVISION number.
1.222     sevan    7650: </pre>
1.128     wiz      7651: <p>The <span class="quote">&#8220;<span class="quote">-release</span>&#8221;</span> option will produce
1.87      wiz      7652:        different results for a.out and ELF (excluding symlinks)
                   7653:        in only one case. An ELF library of the form
1.128     wiz      7654:        <span class="quote">&#8220;<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;</span>
1.87      wiz      7655:        will have a symlink of
1.128     wiz      7656:        <span class="quote">&#8220;<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;</span>
1.87      wiz      7657:        on an a.out platform. This is handled
                   7658:        automatically.</p>
1.128     wiz      7659: <p>The <span class="quote">&#8220;<span class="quote">-rpath argument</span>&#8221;</span> is the install
1.87      wiz      7660:        directory of the library being built.</p>
1.76      rillig   7661: <p>In the <code class="filename">PLIST</code>, include only the
1.87      wiz      7662:        <code class="filename">.la</code> file, the other files will be
                   7663:        added automatically.</p>
1.75      rillig   7664: </li>
1.128     wiz      7665: <li class="listitem">
1.76      rillig   7666: <p>When linking shared object (<code class="filename">.so</code>)
1.270     leot     7667:        files, i.e. files that are loaded via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?dlopen+3.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.128     wiz      7668:        shared libraries, use <span class="quote">&#8220;<span class="quote">-module
                   7669:        -avoid-version</span>&#8221;</span> to prevent them getting version
1.87      wiz      7670:        tacked on.</p>
1.76      rillig   7671: <p>The <code class="filename">PLIST</code> file gets the
1.87      wiz      7672:        <code class="filename">foo.so</code> entry.</p>
1.75      rillig   7673: </li>
1.128     wiz      7674: <li class="listitem">
1.75      rillig   7675: <p>When linking programs that depend on these libraries
1.87      wiz      7676:        <span class="emphasis"><em>before</em></span> they are installed, preface
1.270     leot     7677:        the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cc+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">cc</span>(1)</span></a> or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with <span class="quote">&#8220;<span class="quote">${LIBTOOL}
1.128     wiz      7678:        --mode=link</span>&#8221;</span>, and it will find the correct
1.87      wiz      7679:        libraries (static or shared), but please be aware that
                   7680:        libtool will not allow you to specify a relative path in
1.128     wiz      7681:        -L (such as <span class="quote">&#8220;<span class="quote">-L../somelib</span>&#8221;</span>), because it
1.87      wiz      7682:        expects you to change that argument to be the
                   7683:        <code class="filename">.la</code> file. e.g.</p>
1.75      rillig   7684: <pre class="programlisting">
1.100     rillig   7685: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.222     sevan    7686: </pre>
1.75      rillig   7687: <p>should be changed to:</p>
                   7688: <pre class="programlisting">
1.100     rillig   7689: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.222     sevan    7690: </pre>
1.75      rillig   7691: <p>and it will do the right thing with the libraries.</p>
                   7692: </li>
1.128     wiz      7693: <li class="listitem">
1.270     leot     7694: <p>When installing libraries, preface the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
                   7695:        or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cp+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with <span class="quote">&#8220;<span class="quote">${LIBTOOL}
1.128     wiz      7696:        --mode=install</span>&#8221;</span>, and change the library name to
1.87      wiz      7697:        <code class="filename">.la</code>. e.g.</p>
1.75      rillig   7698: <pre class="programlisting">
1.126     jakllsch 7699: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.222     sevan    7700: </pre>
1.76      rillig   7701: <p>This will install the static <code class="filename">.a</code>,
1.87      wiz      7702:        shared library, any needed symlinks, and run
1.270     leot     7703:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ldconfig+8.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.75      rillig   7704: </li>
1.128     wiz      7705: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87      wiz      7706:        the <code class="filename">.la</code>
                   7707:        file (this is a change from previous behaviour).</p></li>
1.75      rillig   7708: </ol></div>
                   7709: </div>
1.148     asau     7710: <div class="sect2">
1.75      rillig   7711: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7712: <a name="using-libtool"></a>21.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75      rillig   7713: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87      wiz      7714:     package Makefile. This will override the package's own libtool
                   7715:     in most cases.  For older libtool using packages,  libtool is
                   7716:     made by ltconfig script during the do-configure step; you can
1.110     hubertf  7717:     check the libtool script location by doing <span class="command"><strong>make
1.87      wiz      7718:     configure; find work*/ -name libtool</strong></span>.</p>
1.75      rillig   7719: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87      wiz      7720:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
1.128     wiz      7721:     default, it is set to <span class="quote">&#8220;<span class="quote">libtool */libtool
                   7722:     */*/libtool</span>&#8221;</span>.  If this does not match the location of the
1.87      wiz      7723:     package's libtool script(s), set it as appropriate.</p>
1.76      rillig   7724: <p>If you do not need <code class="filename">*.a</code> static
1.87      wiz      7725:     libraries built and installed, then use
                   7726:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75      rillig   7727: <p>If your package makes use of the platform-independent library
1.87      wiz      7728:     for loading dynamic shared objects, that comes with libtool
                   7729:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   7730: <p>Some packages use libtool incorrectly so that the package
                   7731:     may not work or build in some circumstances. Some of the more
                   7732:     common errors are:</p>
1.148     asau     7733: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7734: <li class="listitem">
1.75      rillig   7735: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87      wiz      7736:        executable or library. This in itself isn't a problem if one of two things
                   7737:        has been done:</p>
1.128     wiz      7738: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7739: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87      wiz      7740:            <code class="filename">libfoo.la</code>, not
                   7741:            <code class="filename">foo.la</code></p></li>
1.128     wiz      7742: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75      rillig   7743: </ol></div>
                   7744: </li>
1.128     wiz      7745: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87      wiz      7746:        The function lt_dlinit() should be called and the macro
                   7747:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   7748:        executables.</p></li>
1.75      rillig   7749: </ul></div>
                   7750: </div>
1.148     asau     7751: <div class="sect2">
1.75      rillig   7752: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7753: <a name="autoconf-automake"></a>21.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75      rillig   7754: <p>If a package needs GNU autoconf or automake to be executed
1.87      wiz      7755:     to regenerate the configure script and Makefile.in makefile
                   7756:     templates, then they should be executed in a pre-configure
                   7757:     target.</p>
1.75      rillig   7758: <p>For packages that need only autoconf:</p>
                   7759: <pre class="programlisting">
1.100     rillig   7760: AUTOCONF_REQD=  2.50            # if default version is not good enough
                   7761: USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
                   7762: ...
1.1       grant    7763: 
1.100     rillig   7764: pre-configure:
                   7765:         cd ${WRKSRC} &amp;&amp; autoconf
1.1       grant    7766: 
1.100     rillig   7767: ...
1.222     sevan    7768: </pre>
1.75      rillig   7769: <p>and for packages that need automake and autoconf:</p>
                   7770: <pre class="programlisting">
1.100     rillig   7771: AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
                   7772: USE_TOOLS+=     automake        # use "automake14" for automake-1.4
                   7773: ...
                   7774: 
                   7775: pre-configure:
                   7776:         set -e; cd ${WRKSRC}; \
                   7777:         aclocal; autoheader; automake -a --foreign -i; autoconf
1.1       grant    7778: 
1.100     rillig   7779: ...
1.222     sevan    7780: </pre>
1.75      rillig   7781: <p>Packages which use GNU Automake will almost certainly
1.87      wiz      7782:     require GNU Make.</p>
1.75      rillig   7783: <p>There are times when the configure process makes
1.87      wiz      7784:     additional changes to the generated files, which then causes
                   7785:     the build process to try to re-execute the automake sequence.
                   7786:     This is prevented by touching various files in the configure
                   7787:     stage. If this causes problems with your package you can set
                   7788:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   7789:     Makefile.</p>
1.75      rillig   7790: </div>
                   7791: </div>
1.148     asau     7792: <div class="sect1">
1.75      rillig   7793: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   7794: <a name="programming-languages"></a>21.4. Programming languages</h2></div></div></div>
1.148     asau     7795: <div class="sect2">
1.87      wiz      7796: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7797: <a name="basic-programming-languages"></a>21.4.1. C, C++, and Fortran</h3></div></div></div>
1.87      wiz      7798: <p>Compilers for the C, C++, and Fortran languages comes with
                   7799:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   7800:     is written in C and will hide all other compilers (via the wrapper
1.267     rillig   7801:     framework, see <a class="xref" href="#buildlink" title="Chapter 16. Buildlink methodology">Chapter 16, <i>Buildlink methodology</i></a>).</p>
1.87      wiz      7802: <p>To declare which language's compiler a package needs, set
                   7803:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.128     wiz      7804:     currently are <span class="quote">&#8220;<span class="quote">c</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">c++</span>&#8221;</span>, and
                   7805:     <span class="quote">&#8220;<span class="quote">fortran</span>&#8221;</span> (and any combination).  The default is
                   7806:     <span class="quote">&#8220;<span class="quote">c</span>&#8221;</span>.  Packages using GNU configure scripts, even if
1.87      wiz      7807:     written in C++, usually need a C compiler for the configure
                   7808:     phase.</p>
                   7809: </div>
1.148     asau     7810: <div class="sect2">
1.87      wiz      7811: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7812: <a name="java-programming-language"></a>21.4.2. Java</h3></div></div></div>
1.87      wiz      7813: <p>If a program is written in Java, use the Java framework in
                   7814:     pkgsrc.  The package must include
                   7815:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   7816:     provides the following variables:</p>
1.148     asau     7817: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7818: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87      wiz      7819:       dependency on the JDK is added.  If
1.128     wiz      7820:       <code class="varname">USE_JAVA</code> is set to <span class="quote">&#8220;<span class="quote">run</span>&#8221;</span>, then
1.87      wiz      7821:       there is only a runtime dependency on the JDK.  The default is
1.128     wiz      7822:       <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, which also adds a build dependency on the
1.87      wiz      7823:       JDK.</p></li>
1.128     wiz      7824: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87      wiz      7825:       a package needs a Java2 implementation.  The supported values
1.128     wiz      7826:       are <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">1.4</span>&#8221;</span>, and
                   7827:       <span class="quote">&#8220;<span class="quote">1.5</span>&#8221;</span>.  <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> accepts any Java2
                   7828:       implementation, <span class="quote">&#8220;<span class="quote">1.4</span>&#8221;</span> insists on versions 1.4 or
                   7829:       above, and <span class="quote">&#8220;<span class="quote">1.5</span>&#8221;</span> only accepts versions 1.5 or
1.87      wiz      7830:       above. This variable is not set by default.</p></li>
1.130     wiz      7831: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
                   7832:       automatically set to the runtime location of the used Java
                   7833:       implementation dependency. It may be used to set
                   7834:       <code class="varname">JAVA_HOME</code> to a good value if the program
                   7835:       needs this variable to be defined.
                   7836:       </p></li>
1.87      wiz      7837: </ul></div>
                   7838: </div>
1.148     asau     7839: <div class="sect2">
1.87      wiz      7840: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7841: <a name="perl-scripts"></a>21.4.3. Packages containing perl scripts</h3></div></div></div>
1.87      wiz      7842: <p>If your package contains interpreted perl scripts, add
1.128     wiz      7843:     <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to the <code class="varname">USE_TOOLS</code> variable
1.87      wiz      7844:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   7845:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   7846:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.183     wiz      7847:     that you want adjusted. Every occurrence of
                   7848:     <code class="filename">*/bin/perl</code> in a she-bang line will be
                   7849:     replaced with the full path to the perl executable.</p>
1.87      wiz      7850: <p>If a particular version of perl is needed, set the
                   7851:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
1.128     wiz      7852:     default is <span class="quote">&#8220;<span class="quote">5.0</span>&#8221;</span>.</p>
1.267     rillig   7853: <p>See <a class="xref" href="#perl-modules" title="21.6.6. Packages installing perl modules">Section 21.6.6, &#8220;Packages installing perl modules&#8221;</a> for information
1.87      wiz      7854:     about handling perl modules.</p>
                   7855: </div>
1.148     asau     7856: <div class="sect2">
1.87      wiz      7857: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7858: <a name="shell-scripts"></a>21.4.4. Packages containing shell scripts</h3></div></div></div>
1.147     wiz      7859: <p><code class="varname">REPLACE_SH</code>,
                   7860:     <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
                   7861:     and <code class="varname">REPLACE_KSH</code> can be used to replace shell
                   7862:     hash bangs in files. Please use the appropriate one, prefering
                   7863:     <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.183     wiz      7864:     Each should contain a list of scripts, relative to
                   7865:     <code class="varname">WRKSRC</code>, that you want adjusted. Every
                   7866:     occurrence of the matching shell in a she-bang line will be
                   7867:     replaced with the full path to the shell executable.
1.147     wiz      7868:     When using <code class="varname">REPLACE_BASH</code>, don't forget to add
                   7869:     <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
                   7870: </div>
1.148     asau     7871: <div class="sect2">
1.147     wiz      7872: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7873: <a name="other-programming-languages"></a>21.4.5. Other programming languages</h3></div></div></div>
1.87      wiz      7874: <p>Currently, there is no special handling for other languages
                   7875:     in pkgsrc.  If a compiler package provides a
                   7876:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   7877:     just add a (build) dependency on the appropriate compiler
                   7878:     package.</p>
                   7879: </div>
                   7880: </div>
1.148     asau     7881: <div class="sect1">
1.87      wiz      7882: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   7883: <a name="fixes.build"></a>21.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77      rillig   7884: <p>The most common failures when building a package are that
                   7885:        some platforms do not provide certain header files, functions or
                   7886:        libraries, or they provide the functions in a library that the
                   7887:        original package author didn't know. To work around this, you
                   7888:        can rewrite the source code in most cases so that it does not
                   7889:        use the missing functions or provides a replacement function.</p>
1.148     asau     7890: <div class="sect2">
1.77      rillig   7891: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7892: <a name="fixes.build.cpp"></a>21.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77      rillig   7893: <p>If a package already comes with a GNU configure script, the
                   7894:        preferred way to fix the build failure is to change the
                   7895:        configure script, not the code. In the other cases, you can
                   7896:        utilize the C preprocessor, which defines certain macros
                   7897:        depending on the operating system and hardware architecture it
                   7898:        compiles for. These macros can be queried using for example
                   7899:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   7900:        system, hardware architecture and compiler has its own macro.
                   7901:        For example, if the macros <code class="varname">__GNUC__</code>,
                   7902:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   7903:        are all defined, you know that you are using NetBSD on an i386
                   7904:        compatible CPU, and your compiler is GCC.</p>
                   7905: <p>The list of the following macros for hardware and
                   7906:        operating system depends on the compiler that is used. For
                   7907:        example, if you want to conditionally compile code on Solaris,
                   7908:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   7909:        does not define it. Use <code class="varname">__sun</code> instead.</p>
1.148     asau     7910: <div class="sect3">
1.75      rillig   7911: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   7912: <a name="fixes.build.cpp.os"></a>21.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.75      rillig   7913: <p>To distinguish between 4.4 BSD-derived systems and the
                   7914:         rest of the world, you should use the following code.</p>
                   7915: <pre class="programlisting">
1.100     rillig   7916: #include &lt;sys/param.h&gt;
                   7917: #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
                   7918: /* BSD-specific code goes here */
                   7919: #else
                   7920: /* non-BSD-specific code goes here */
                   7921: #endif
1.75      rillig   7922: </pre>
1.77      rillig   7923: <p>If this distinction is not fine enough, you can also test
                   7924:        for the following macros.</p>
1.75      rillig   7925: <pre class="programlisting">
1.151     obache   7926: Cygwin      __CYGWIN__
                   7927: DragonFly   __DragonFly__
1.100     rillig   7928: FreeBSD     __FreeBSD__
1.151     obache   7929: Haiku       __HAIKU__
1.100     rillig   7930: Interix     __INTERIX
                   7931: IRIX        __sgi (TODO: get a definite source for this)
                   7932: Linux       linux, __linux, __linux__
1.193     dholland 7933: Mac OS X    __APPLE__
1.151     obache   7934: MirBSD      __MirBSD__ (__OpenBSD__ is also defined)
                   7935: Minix3      __minix
1.100     rillig   7936: NetBSD      __NetBSD__
                   7937: OpenBSD     __OpenBSD__
                   7938: Solaris     sun, __sun
1.75      rillig   7939: </pre>
                   7940: </div>
1.148     asau     7941: <div class="sect3">
1.75      rillig   7942: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   7943: <a name="fixes.build.cpp.arch"></a>21.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.75      rillig   7944: <pre class="programlisting">
1.100     rillig   7945: i386        i386, __i386, __i386__
                   7946: MIPS        __mips
                   7947: SPARC       sparc, __sparc
1.75      rillig   7948: </pre>
                   7949: </div>
1.148     asau     7950: <div class="sect3">
1.75      rillig   7951: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   7952: <a name="fixes.build.cpp.compiler"></a>21.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.75      rillig   7953: <pre class="programlisting">
1.100     rillig   7954: GCC         __GNUC__ (major version), __GNUC_MINOR__
                   7955: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
                   7956: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
                   7957: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75      rillig   7958: </pre>
                   7959: </div>
                   7960: </div>
1.148     asau     7961: <div class="sect2">
1.78      rillig   7962: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7963: <a name="compiler-bugs"></a>21.5.2. How to handle compiler bugs</h3></div></div></div>
1.78      rillig   7964: <p>Some source files trigger bugs in the compiler, based on
1.87      wiz      7965:         combinations of compiler version and architecture and almost
                   7966:         always relation to optimisation being enabled.  Common symptoms
                   7967:         are gcc internal errors or never finishing compiling a
1.78      rillig   7968:        file.</p>
                   7969: <p>Typically, a workaround involves testing the
                   7970:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   7971:         optimisation for that combination of file,
1.198     tnn      7972:        <code class="varname">MACHINE_ARCH</code> and compiler.</p>
                   7973: <p>This used to be a big problem in the past, but is rarely
                   7974:        needed now as compiler technology has matured. If you still need
                   7975:        to add a compiler specific workaround, please do so in the file
                   7976:        <code class="filename">hacks.mk</code> and describe the symptom and
                   7977:        compiler version as detailed as possible.</p>
1.78      rillig   7978: </div>
1.148     asau     7979: <div class="sect2">
1.78      rillig   7980: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7981: <a name="undefined-reference"></a>21.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span>
1.128     wiz      7982: </h3></div></div></div>
1.92      rillig   7983: <p>This error message often means that a package did not
1.78      rillig   7984:        link to a shared library it needs. The following functions are
                   7985:        known to cause this error message over and over.</p>
                   7986: <div class="informaltable">
1.216     tnn      7987: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.78      rillig   7988: <colgroup>
                   7989: <col>
                   7990: <col>
                   7991: <col>
                   7992: </colgroup>
                   7993: <thead><tr>
                   7994: <th>Function</th>
                   7995: <th>Library</th>
                   7996: <th>Affected platforms</th>
                   7997: </tr></thead>
                   7998: <tbody>
                   7999: <tr>
                   8000: <td>accept, bind, connect</td>
                   8001: <td>-lsocket</td>
                   8002: <td>Solaris</td>
                   8003: </tr>
                   8004: <tr>
                   8005: <td>crypt</td>
                   8006: <td>-lcrypt</td>
                   8007: <td>DragonFly, NetBSD</td>
                   8008: </tr>
                   8009: <tr>
                   8010: <td>dlopen, dlsym</td>
                   8011: <td>-ldl</td>
                   8012: <td>Linux</td>
                   8013: </tr>
                   8014: <tr>
                   8015: <td>gethost*</td>
                   8016: <td>-lnsl</td>
                   8017: <td>Solaris</td>
                   8018: </tr>
                   8019: <tr>
                   8020: <td>inet_aton</td>
                   8021: <td>-lresolv</td>
                   8022: <td>Solaris</td>
                   8023: </tr>
                   8024: <tr>
                   8025: <td>nanosleep, sem_*, timer_*</td>
                   8026: <td>-lrt</td>
                   8027: <td>Solaris</td>
                   8028: </tr>
                   8029: <tr>
                   8030: <td>openpty</td>
                   8031: <td>-lutil</td>
                   8032: <td>Linux</td>
                   8033: </tr>
                   8034: </tbody>
                   8035: </table>
                   8036: </div>
                   8037: <p>To fix these linker errors, it is often sufficient to say
1.87      wiz      8038:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   8039:     -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110     hubertf  8040:     <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87      wiz      8041:     bmake</strong></span>.</p>
1.148     asau     8042: <div class="sect3">
1.92      rillig   8043: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   8044: <a name="undefined-reference-sunpro"></a>21.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92      rillig   8045: <p>When you are using the SunPro compiler, there is another
                   8046: possibility. That compiler cannot handle the following code:</p>
                   8047: <pre class="programlisting">
1.100     rillig   8048: extern int extern_func(int);
1.93      rillig   8049: 
1.100     rillig   8050: static inline int
                   8051: inline_func(int x)
                   8052: {
1.92      rillig   8053:         return extern_func(x);
1.100     rillig   8054: }
1.93      rillig   8055: 
1.100     rillig   8056: int main(void)
                   8057: {
1.92      rillig   8058:         return 0;
1.100     rillig   8059: }
1.92      rillig   8060: </pre>
                   8061: <p>It generates the code for <code class="function">inline_func</code> even if
                   8062: that function is never used. This code then refers to
                   8063: <code class="function">extern_func</code>, which can usually not be resolved. To
                   8064: solve this problem you can try to tell the package to disable inlining
                   8065: of functions.</p>
                   8066: </div>
1.87      wiz      8067: </div>
1.148     asau     8068: <div class="sect2">
1.87      wiz      8069: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8070: <a name="out-of-memory"></a>21.5.4. Running out of memory</h3></div></div></div>
1.87      wiz      8071: <p>Sometimes packages fail to build because the compiler runs
                   8072:     into an operating system specific soft limit.  With the
                   8073:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.204     wiz      8074:     to unlimit the resources.  Currently, the allowed values are any combination of
                   8075:     <span class="quote">&#8220;<span class="quote">cputime</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">datasize</span>&#8221;</span>,
                   8076:     <span class="quote">&#8220;<span class="quote">memorysize</span>&#8221;</span>, and <span class="quote">&#8220;<span class="quote">stacksize</span>&#8221;</span>.
1.87      wiz      8077:     Setting this variable is similar to running the shell builtin
1.110     hubertf  8078:     <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87      wiz      8079:     segment size or maximum stack size of a process, respectively, to
                   8080:     their hard limits.</p>
1.78      rillig   8081: </div>
1.75      rillig   8082: </div>
1.148     asau     8083: <div class="sect1">
1.75      rillig   8084: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8085: <a name="fixes.install"></a>21.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.148     asau     8086: <div class="sect2">
1.75      rillig   8087: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8088: <a name="install-scripts"></a>21.6.1. Creating needed directories</h3></div></div></div>
1.110     hubertf  8089: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87      wiz      8090:     with some operating systems cannot create more than one
                   8091:     directory at a time. As such, you should call
                   8092:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   8093: <pre class="programlisting">
1.100     rillig   8094: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   8095: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.222     sevan    8096: </pre>
1.128     wiz      8097: <p>You can also just append <span class="quote">&#8220;<span class="quote"><code class="literal">dir1
                   8098:     dir2</code></span>&#8221;</span> to the
1.87      wiz      8099:     <code class="varname">INSTALLATION_DIRS</code> variable, which will
                   8100:     automatically do the right thing.</p>
1.75      rillig   8101: </div>
1.148     asau     8102: <div class="sect2">
1.75      rillig   8103: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8104: <a name="where-to-install-documentation"></a>21.6.2. Where to install documentation</h3></div></div></div>
1.83      wiz      8105: <p>In general, documentation should be installed into
1.87      wiz      8106:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8107:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
                   8108:     includes the version number of the package).</p>
1.84      wiz      8109: <p>Many modern packages using GNU autoconf allow to set the
1.87      wiz      8110:     directory where HTML documentation is installed with the
1.128     wiz      8111:     <span class="quote">&#8220;<span class="quote">--with-html-dir</span>&#8221;</span> option. Sometimes using this flag
1.87      wiz      8112:     is needed because otherwise the documentation ends up in
                   8113:     <code class="filename">${PREFIX}/share/doc/html</code> or other
                   8114:     places.</p>
                   8115: <p>An exception to the above is that library API documentation
1.250     leot     8116:     generated with the <a href="https://cdn.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      8117:     browsers (devhelp) should be left at their default location, which
                   8118:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   8119:     documentation can be recognized from files ending in
                   8120:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   8121:     (It is also acceptable to install such files in
                   8122:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8123:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   8124:     <code class="filename">.devhelp*</code> file must be directly in that
                   8125:     directory then, no additional subdirectory level is allowed in
                   8126:     this case. This is usually achieved by using
1.128     wiz      8127:     <span class="quote">&#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;</span>.
1.87      wiz      8128:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   8129:     though.)</p>
1.75      rillig   8130: </div>
1.148     asau     8131: <div class="sect2">
1.75      rillig   8132: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8133: <a name="installing-score-files"></a>21.6.3. Installing highscore files</h3></div></div></div>
1.75      rillig   8134: <p>Certain packages, most of them in the games category, install
1.87      wiz      8135:     a score file that allows all users on the system to record their
                   8136:     highscores.  In order for this to work, the binaries need to be
                   8137:     installed setgid and the score files owned by the appropriate
1.142     wiz      8138:     group and/or owner (traditionally the "games" user/group).  Set
                   8139:     <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.87      wiz      8140:     following variables, documented in more detail in
                   8141:     <code class="filename">mk/defaults/mk.conf</code>, control this
1.142     wiz      8142:     behaviour: <code class="varname">GAMEDATAMODE</code>,
                   8143:     <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.210     leot     8144:     <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
                   8145:     Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
                   8146:     <code class="varname">GAMEDATA_PERMS</code> and
                   8147:     <code class="varname">SETGID_GAMES_PERMS</code>.</p>
                   8148: <p>An example that illustrates some of the variables described above is
                   8149:     <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
                   8150:     used to properly set directory permissions of the directory where the
                   8151:     scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
                   8152:     dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
                   8153:     and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
                   8154:     binary:</p>
                   8155: <pre class="programlisting">
1.223     rillig   8156: USE_GAMESGROUP=         yes
1.210     leot     8157: 
1.223     rillig   8158: BUILD_DEFS+=            VARBASE
1.210     leot     8159: 
1.223     rillig   8160: OWN_DIRS_PERMS+=        ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
                   8161: REQD_FILES_PERMS+=      /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
                   8162: SPECIAL_PERMS+=         ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.222     sevan    8163: </pre>
1.210     leot     8164: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
                   8165:     <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
                   8166:     <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
                   8167:     needed to be accessed by setgid games and
                   8168:     <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.114     jmcneill 8169: <p>A package should therefore never hard code file ownership or
1.210     leot     8170:     access permissions but rely on <code class="varname">*_PERMS</code> as described above
                   8171:     or alternatively on <code class="varname">INSTALL_GAME</code>,
                   8172:     <code class="varname">INSTALL_GAME_DATA</code> and
                   8173:     <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.75      rillig   8174: </div>
1.148     asau     8175: <div class="sect2">
1.75      rillig   8176: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8177: <a name="destdir-support"></a>21.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114     jmcneill 8178: <p><code class="varname">DESTDIR</code> support means that a package
                   8179:     installs into a staging directory, not the final location of the
                   8180:     files. Then a binary package is created which can be used for
                   8181:     installation as usual. There are two ways: Either the package must
1.128     wiz      8182:     install as root (<span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span>) or the package can
                   8183:     install as non-root user (<span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>).</p>
1.148     asau     8184: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8185: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.224     leot     8186:       set to <span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>.
                   8187:       By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.145     wiz      8188:       is set to <span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span> to help catching more
                   8189:       potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.114     jmcneill 8190:       <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
                   8191:       the inclusion.</p></li>
1.128     wiz      8192: <li class="listitem"><p>All installation operations have to be prefixed with
1.103     wiz      8193:       <code class="filename">${DESTDIR}</code>.</p></li>
1.128     wiz      8194: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103     wiz      8195:       automatically. Many manual rules and pre/post-install often are
                   8196:       incorrect; fix them.</p></li>
1.128     wiz      8197: <li class="listitem"><p>If files are installed with special owner/group
1.118     imil     8198:       use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128     wiz      8199: <li class="listitem"><p>In general, packages should support
1.103     wiz      8200:       <code class="varname">UNPRIVILEGED</code> to be able to use
                   8201:       DESTDIR.</p></li>
                   8202: </ul></div>
                   8203: </div>
1.148     asau     8204: <div class="sect2">
1.103     wiz      8205: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8206: <a name="hardcoded-paths"></a>21.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87      wiz      8207: <p>Your package may also contain scripts with hardcoded paths to
                   8208:       other interpreters besides (or as well as) perl.  To correct the
                   8209:       full pathname to the script interpreter, you need to set the
                   8210:       following definitions in your <code class="filename">Makefile</code> (we
1.110     hubertf  8211:     shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87      wiz      8212: <pre class="programlisting">
1.100     rillig   8213: REPLACE_INTERPRETER+=   tcl
                   8214: REPLACE.tcl.old=        .*/bin/tclsh
                   8215: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   8216: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   8217: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.222     sevan    8218: </pre>
1.148     asau     8219: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   8220: <h3 class="title">Note</h3>
                   8221: <p>Before March 2006, these variables were called
1.87      wiz      8222:     <code class="varname">_REPLACE.*</code> and
                   8223:     <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75      rillig   8224: </div>
                   8225: </div>
1.148     asau     8226: <div class="sect2">
1.75      rillig   8227: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8228: <a name="perl-modules"></a>21.6.6. Packages installing perl modules</h3></div></div></div>
1.75      rillig   8229: <p>Makefiles of packages providing perl5 modules should include
1.87      wiz      8230:     the Makefile fragment
                   8231:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
1.110     hubertf  8232:     <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87      wiz      8233:     configuration for such modules as well as various hooks to tune
                   8234:     this configuration.  See comments in this file for
                   8235:     details.</p>
1.75      rillig   8236: <p>Perl5 modules will install into different places depending
1.87      wiz      8237:     on the version of perl used during the build process.  To
                   8238:     address this, pkgsrc will append lines to the
                   8239:     <code class="filename">PLIST</code> corresponding to the files listed in
                   8240:     the installed <code class="filename">.packlist</code> file generated by
                   8241:     most perl5 modules.  This is invoked by defining
                   8242:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.153     wiz      8243:     packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
                   8244:     (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
                   8245:     e.g.:</p>
1.75      rillig   8246: <pre class="programlisting">
1.153     wiz      8247: PERL5_PACKLIST= auto/Pg/.packlist
1.222     sevan    8248: </pre>
1.153     wiz      8249: <p>The perl5 config variables
                   8250:     <code class="varname">installarchlib</code>,
                   8251:     <code class="varname">installscript</code>,
                   8252:     <code class="varname">installvendorbin</code>,
                   8253:     <code class="varname">installvendorscript</code>,
                   8254:     <code class="varname">installvendorarch</code>,
                   8255:     <code class="varname">installvendorlib</code>,
                   8256:     <code class="varname">installvendorman1dir</code>, and
                   8257:     <code class="varname">installvendorman3dir</code> represent those
                   8258:     locations in which components of perl5 modules may be installed,
                   8259:     provided as variable with uppercase and prefixed with
                   8260:     <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
                   8261:     and may be used by perl5 packages that don't have a packlist.
                   8262:     These variables are also substituted for in the
                   8263:     <code class="filename">PLIST</code> as uppercase prefixed with
                   8264:     <code class="varname">PERL5_SUB_</code>.</p>
1.75      rillig   8265: </div>
1.148     asau     8266: <div class="sect2">
1.75      rillig   8267: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8268: <a name="faq.info-files"></a>21.6.7. Packages installing info files</h3></div></div></div>
1.75      rillig   8269: <p>Some packages install info files or use the
1.128     wiz      8270:     <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span>  or <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span>
1.87      wiz      8271:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   8272:     the package Makefile so that <code class="filename">INSTALL</code> and
                   8273:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   8274:     handle registration of the info files in the Info directory
1.128     wiz      8275:     file. The <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span> command used for the info
1.87      wiz      8276:     files registration is either provided by the system, or by a
                   8277:     special purpose package automatically added as dependency if
                   8278:     needed.</p>
1.75      rillig   8279: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87      wiz      8280:     <code class="filename">${PREFIX}</code> where info files are primarily
                   8281:     located. <code class="varname">PKGINFODIR</code> defaults to
1.128     wiz      8282:     <span class="quote">&#8220;<span class="quote">info</span>&#8221;</span> and can be overridden by the user.</p>
1.75      rillig   8283: <p>The info files for the package should be listed in the
1.87      wiz      8284:     package <code class="filename">PLIST</code>; however any split info files
                   8285:     need not be listed.</p>
1.128     wiz      8286: <p>A package which needs the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command
                   8287:     at build time must add <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> to
1.87      wiz      8288:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.128     wiz      8289:     version of the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command is needed it
1.87      wiz      8290:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   8291:     variable in the package <code class="filename">Makefile</code>. By
                   8292:     default, a minimum version of 3.12 is required. If the system
1.110     hubertf  8293:     does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87      wiz      8294:     does not match the required minimum, a build dependency on the
1.250     leot     8295:     <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/gtexinfo/README.html" target="_top"><code class="filename">devel/gtexinfo</code></a> package will
1.87      wiz      8296:     be added automatically.</p>
1.75      rillig   8297: <p>The build and installation process of the software provided
1.87      wiz      8298:     by the package should not use the
1.110     hubertf  8299:     <span class="command"><strong>install-info</strong></span> command as the registration of
1.87      wiz      8300:     info files is the task of the package
                   8301:     <code class="filename">INSTALL</code> script, and it must use the
1.110     hubertf  8302:     appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75      rillig   8303: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110     hubertf  8304:     overriding scripts for the <span class="command"><strong>install-info</strong></span> and
                   8305:     <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87      wiz      8306:     in <code class="varname">PATH</code>.</p>
1.110     hubertf  8307: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87      wiz      8308:     no effect except the logging of a message. The script overriding
1.110     hubertf  8309:     <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87      wiz      8310:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110     hubertf  8311:     <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75      rillig   8312: </div>
1.148     asau     8313: <div class="sect2">
1.75      rillig   8314: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8315: <a name="manpages"></a>21.6.8. Packages installing man pages</h3></div></div></div>
1.81      rillig   8316: <p>All packages that install manual pages should install them
1.87      wiz      8317:     into the same directory, so that there is one common place to look
                   8318:     for them. In pkgsrc, this place is
                   8319:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   8320:     should be used in packages. The default for
                   8321:     <code class="varname">PKGMANDIR</code> is
1.128     wiz      8322:     <span class="quote">&#8220;<span class="quote"><code class="filename">man</code></span>&#8221;</span>. Another often-used value
                   8323:     is <span class="quote">&#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;</span>.</p>
1.148     asau     8324: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   8325: <h3 class="title">Note</h3>
1.87      wiz      8326: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   8327:     is far from complete.</p>
1.75      rillig   8328: </div>
1.81      rillig   8329: <p>The <code class="filename">PLIST</code> files can just use
1.87      wiz      8330:     <code class="filename">man/</code> as the top level directory for the man
                   8331:     page file entries, and the pkgsrc framework will convert as
                   8332:     needed. In all other places, the correct
                   8333:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   8334: <p>Packages that are
                   8335:     configured with <code class="varname">GNU_CONFIGURE</code> set as
1.128     wiz      8336:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, by default will use the
1.87      wiz      8337:     <code class="filename">./configure</code>
                   8338:     --mandir switch to set where the man pages should be installed.
                   8339:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   8340:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   8341: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   8342:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.128     wiz      8343:     to <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>.
1.87      wiz      8344:     Or if the <code class="filename">./configure</code> script uses
                   8345:     a non-standard use of --mandir, you can set
                   8346:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.267     rillig   8347: <p>See <a class="xref" href="#manpage-compression" title="15.5. Man page compression">Section 15.5, &#8220;Man page compression&#8221;</a> for
1.87      wiz      8348:     information on installation of compressed manual pages.</p>
1.75      rillig   8349: </div>
1.148     asau     8350: <div class="sect2">
1.75      rillig   8351: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8352: <a name="gconf-data-files"></a>21.6.9. Packages installing GConf data files</h3></div></div></div>
1.87      wiz      8353: <p>If a package installs <code class="filename">.schemas</code> or
1.107     rillig   8354:     <code class="filename">.entries</code> files, used by GConf,
1.87      wiz      8355:     you need to take some extra steps to make sure they get registered
                   8356:     in the database:</p>
1.128     wiz      8357: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8358: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.87      wiz      8359:        instead of its <code class="filename">buildlink3.mk</code> file.  This
1.107     rillig   8360:        takes care of rebuilding the GConf database at installation and
1.87      wiz      8361:        deinstallation time, and tells the package where to install
1.107     rillig   8362:        GConf data files using some standard configure arguments.  It
1.87      wiz      8363:        also disallows any access to the database directly from the
                   8364:        package.</p></li>
1.128     wiz      8365: <li class="listitem"><p>Ensure that the package installs its
1.87      wiz      8366:        <code class="filename">.schemas</code> files under
                   8367:        <code class="filename">${PREFIX}/share/gconf/schemas</code>.  If they get
                   8368:        installed under <code class="filename">${PREFIX}/etc</code>, you will
                   8369:        need to manually patch the package.</p></li>
1.128     wiz      8370: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.87      wiz      8371:        directory, as they will be handled automatically.  See
1.267     rillig   8372:        <a class="xref" href="#faq.conf" title="10.13. How do I change the location of configuration files?">Section 10.13, &#8220;How do I change the location of configuration files?&#8221;</a> for more information.</p></li>
1.128     wiz      8373: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.87      wiz      8374:        your <code class="filename">Makefile</code> with a list of all
                   8375:        <code class="filename">.schemas</code> files installed by the package, if
                   8376:        any.  Names must not contain any directories in them.</p></li>
1.128     wiz      8377: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.87      wiz      8378:        your <code class="filename">Makefile</code> with a
                   8379:        list of all <code class="filename">.entries</code> files installed by the
                   8380:        package, if any. Names must not contain any directories in
                   8381:        them.</p></li>
1.75      rillig   8382: </ol></div>
                   8383: </div>
1.148     asau     8384: <div class="sect2">
1.75      rillig   8385: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8386: <a name="scrollkeeper-data-files"></a>21.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.87      wiz      8387: <p>If a package installs <code class="filename">.omf</code> files, used by
1.119     mishka   8388:     scrollkeeper/rarian, you need to take some extra steps to make sure they
1.87      wiz      8389:     get registered in the database:</p>
1.128     wiz      8390: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8391: <li class="listitem"><p>Include
1.119     mishka   8392:        <code class="filename">../../mk/omf-scrollkeeper.mk</code>
                   8393:        instead of rarian's <code class="filename">buildlink3.mk</code> file.  This
1.87      wiz      8394:        takes care of rebuilding the scrollkeeper database at
                   8395:        installation and deinstallation time, and disallows any access
                   8396:        to it directly from the package.</p></li>
1.128     wiz      8397: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87      wiz      8398:        <code class="filename">libdata/scrollkeeper</code> directory, as they
                   8399:        will be handled automatically.</p></li>
1.128     wiz      8400: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.119     mishka   8401:        the PLIST.  It will be handled by rarian. (<span class="command"><strong>make
                   8402:        print-PLIST</strong></span> does this automatically.)</p></li>
1.75      rillig   8403: </ol></div>
                   8404: </div>
1.148     asau     8405: <div class="sect2">
1.75      rillig   8406: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8407: <a name="x11-fonts"></a>21.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75      rillig   8408: <p>If a package installs font files, you will need to rebuild
1.87      wiz      8409:     the fonts database in the directory where they get installed at
                   8410:     installation and deinstallation time.  This can be automatically
                   8411:     done by using the pkginstall framework.</p>
1.75      rillig   8412: <p>You can list the directories where fonts are installed in the
1.87      wiz      8413:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   8414:     variables, where <em class="replaceable"><code>type</code></em> can be one of
1.128     wiz      8415:     <span class="quote">&#8220;<span class="quote">ttf</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">type1</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">x11</span>&#8221;</span>.
1.87      wiz      8416:     Also make sure that the database file
                   8417:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75      rillig   8418: <p>Note that you should not create new directories for fonts;
1.87      wiz      8419:     instead use the standard ones to avoid that the user needs to
                   8420:     manually configure his X server to find them.</p>
1.75      rillig   8421: </div>
1.148     asau     8422: <div class="sect2">
1.75      rillig   8423: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8424: <a name="gtk2-modules"></a>21.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75      rillig   8425: <p>If a package installs GTK2 immodules or loaders, you need to
1.87      wiz      8426:     take some extra steps to get them registered in the GTK2 database
                   8427:     properly:</p>
1.128     wiz      8428: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8429: <li class="listitem"><p>Include
1.87      wiz      8430:       <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
                   8431:       <code class="filename">buildlink3.mk</code> file.  This takes care of
                   8432:       rebuilding the database at installation and deinstallation time.</p></li>
1.128     wiz      8433: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.87      wiz      8434:       your package installs GTK2 immodules.</p></li>
1.128     wiz      8435: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.87      wiz      8436:       GTK2 loaders.</p></li>
1.128     wiz      8437: <li class="listitem">
1.87      wiz      8438: <p>Patch the package to not touch any of the GTK2
                   8439:       databases directly.  These are:</p>
1.148     asau     8440: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8441: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
                   8442: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75      rillig   8443: </ul></div>
                   8444: </li>
1.128     wiz      8445: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.87      wiz      8446:       any entries under the <code class="filename">libdata/gtk-2.0</code>
                   8447:       directory, as they will be handled automatically.</p></li>
1.75      rillig   8448: </ol></div>
                   8449: </div>
1.148     asau     8450: <div class="sect2">
1.75      rillig   8451: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8452: <a name="sgml-xml-data"></a>21.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75      rillig   8453: <p>If a package installs SGML or XML data files that need to be
1.87      wiz      8454:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   8455:     etc.), you need to take some extra steps:</p>
1.128     wiz      8456: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8457: <li class="listitem"><p>Include
1.87      wiz      8458:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   8459:        your <code class="filename">Makefile</code>, which takes care of
                   8460:        registering those files in system-wide catalogs at
                   8461:        installation and deinstallation time.</p></li>
1.128     wiz      8462: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87      wiz      8463:        any SGML catalogs installed by the package.</p></li>
1.128     wiz      8464: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87      wiz      8465:        any XML catalogs installed by the package.</p></li>
1.128     wiz      8466: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87      wiz      8467:        to be added to the SGML catalog.  These come in groups of
                   8468:        three strings; see xmlcatmgr(1) for more information
                   8469:        (specifically, arguments recognized by the 'add' action).
                   8470:        Note that you will normally not use this variable.</p></li>
1.128     wiz      8471: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87      wiz      8472:        to be added to the XML catalog.  These come in groups of three
                   8473:        strings; see xmlcatmgr(1) for more information (specifically,
                   8474:        arguments recognized by the 'add' action).  Note that you will
                   8475:        normally not use this variable.</p></li>
1.75      rillig   8476: </ol></div>
                   8477: </div>
1.148     asau     8478: <div class="sect2">
1.75      rillig   8479: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8480: <a name="mime-database"></a>21.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75      rillig   8481: <p>If a package provides extensions to the MIME database by
1.87      wiz      8482:     installing <code class="filename">.xml</code> files inside
                   8483:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   8484:     need to take some extra steps to ensure that the database is kept
                   8485:     consistent with respect to these new files:</p>
1.128     wiz      8486: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8487: <li class="listitem"><p>Include
1.87      wiz      8488:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   8489:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   8490:        this same directory, which is reserved for inclusion from
                   8491:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   8492:        care of rebuilding the MIME database at installation and
                   8493:        deinstallation time, and disallows any access to it directly
                   8494:        from the package.</p></li>
1.128     wiz      8495: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87      wiz      8496:        <code class="filename">share/mime</code> directory,
                   8497:        <span class="emphasis"><em>except</em></span> for files saved under
                   8498:        <code class="filename">share/mime/packages</code>.  The former are
                   8499:        handled automatically by
                   8500:        the update-mime-database program, but the latter are
                   8501:        package-dependent and must be removed by the package that
                   8502:        installed them in the first place.</p></li>
1.128     wiz      8503: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87      wiz      8504:        from the PLIST.  They will be handled by the shared-mime-info
                   8505:        package.</p></li>
1.75      rillig   8506: </ol></div>
                   8507: </div>
1.148     asau     8508: <div class="sect2">
1.75      rillig   8509: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8510: <a name="intltool"></a>21.6.15. Packages using intltool</h3></div></div></div>
1.93      rillig   8511: <p>If a package uses intltool during its build, add
                   8512:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87      wiz      8513:     which forces it to use the intltool package provided by pkgsrc,
                   8514:     instead of the one bundled with the distribution file.</p>
1.75      rillig   8515: <p>This tracks intltool's build-time dependencies and uses the
1.87      wiz      8516:     latest available version; this way, the package benefits of any
                   8517:     bug fixes that may have appeared since it was released.</p>
1.75      rillig   8518: </div>
1.148     asau     8519: <div class="sect2">
1.75      rillig   8520: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8521: <a name="startup-scripts"></a>21.6.16. Packages installing startup scripts</h3></div></div></div>
1.75      rillig   8522: <p>If a package contains a rc.d script, it won't be copied into
1.87      wiz      8523:     the startup directory by default, but you can enable it, by adding
                   8524:     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110     hubertf  8525:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87      wiz      8526:     into <code class="filename">/etc/rc.d</code> when a package is installed, and
                   8527:     it will automatically remove the scripts when the package is
                   8528:     deinstalled.</p>
1.75      rillig   8529: </div>
1.148     asau     8530: <div class="sect2">
1.75      rillig   8531: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8532: <a name="tex-packages"></a>21.6.17. Packages installing TeX modules</h3></div></div></div>
1.75      rillig   8533: <p>If a package installs TeX packages into the texmf tree,
1.87      wiz      8534:     the <code class="filename">ls-R</code> database of the tree needs to be
                   8535:     updated.</p>
1.148     asau     8536: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   8537: <h3 class="title">Note</h3>
1.125     wiz      8538: <p>Except the main TeX packages such as kpathsea,
1.87      wiz      8539:     packages should install files
1.125     wiz      8540:     into <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   8541:     not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75      rillig   8542: </div>
1.128     wiz      8543: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8544: <li class="listitem"><p>Include
1.125     wiz      8545:       <code class="filename">../../print/kpathsea/texmf.mk</code>.  This
1.87      wiz      8546:       takes care of rebuilding the <code class="filename">ls-R</code>
                   8547:       database at installation and deinstallation time.</p></li>
1.128     wiz      8548: <li class="listitem">
1.75      rillig   8549: <p>If your package installs files into a texmf
1.87      wiz      8550:       tree other than the one
1.125     wiz      8551:       at <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   8552:       set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87      wiz      8553:       trees that need database update.</p>
1.75      rillig   8554: <p>If your package also installs font map files that need
1.110     hubertf  8555:       to be registered using <span class="command"><strong>updmap</strong></span>,
1.136     dholland 8556:       include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.125     wiz      8557:       set <code class="varname">TEX_MAP_FILES</code> and/or
                   8558:       <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110     hubertf  8559:       such font map files.  Then <span class="command"><strong>updmap</strong></span> will
1.87      wiz      8560:       be run automatically at installation/deinstallation to
                   8561:       enable/disable font map files for TeX output
                   8562:       drivers.</p>
1.75      rillig   8563: </li>
1.128     wiz      8564: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87      wiz      8565:       databases are included in <code class="filename">PLIST</code>, as
1.136     dholland 8566:       they will be removed only by the kpathsea package.</p></li>
1.75      rillig   8567: </ol></div>
                   8568: </div>
1.148     asau     8569: <div class="sect2">
1.85      jmmv     8570: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8571: <a name="emulation-packages"></a>21.6.18. Packages supporting running binaries in
1.87      wiz      8572:     emulation</h3></div></div></div>
                   8573: <p>There are some packages that provide libraries and
                   8574:     executables for running binaries from a one operating system
                   8575:     on a different one (if the latter supports it).  One example
                   8576:     is running Linux binaries on NetBSD.</p>
1.250     leot     8577: <p>The <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>
1.87      wiz      8578:     helps in extracting and packaging Linux rpm packages.</p>
                   8579: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110     hubertf  8580:     avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87      wiz      8581:     if all libraries for each installed executable can be found by
                   8582:     the dynamic linker.  Since the standard dynamic linker is run,
                   8583:     this fails for emulation packages, because the libraries used
                   8584:     by the emulation are not in the standard directories.</p>
                   8585: </div>
1.148     asau     8586: <div class="sect2">
1.87      wiz      8587: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8588: <a name="hicolor-theme"></a>21.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.85      jmmv     8589: <p>If a package installs images under the
1.87      wiz      8590:     <code class="filename">share/icons/hicolor</code> and/or updates the
                   8591:     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
                   8592:     database, you need to take some extra steps to make sure that the
                   8593:     shared theme directory is handled appropriately and that the cache
                   8594:     database is rebuilt:</p>
1.128     wiz      8595: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8596: <li class="listitem"><p>Include
1.87      wiz      8597:        <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.128     wiz      8598: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.87      wiz      8599:        entry that refers to the theme cache.</p></li>
1.128     wiz      8600: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.85      jmmv     8601:          directories from the <code class="filename">share/icons/hicolor</code>
                   8602:          hierarchy because they will be handled automatically.</p></li>
                   8603: </ol></div>
                   8604: <p>The best way to verify that the PLIST is correct with
                   8605:       respect to the last two points is to regenerate it using
1.110     hubertf  8606:       <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.85      jmmv     8607: </div>
1.148     asau     8608: <div class="sect2">
1.85      jmmv     8609: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8610: <a name="desktop-files"></a>21.6.20. Packages installing desktop files</h3></div></div></div>
1.85      jmmv     8611: <p>If a package installs <code class="filename">.desktop</code> files
                   8612:       under <code class="filename">share/applications</code> and these include
1.159     rodent   8613:       MIME information (MimeType key), you need to take extra steps to
                   8614:       ensure that they are registered into the MIME database:</p>
1.128     wiz      8615: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8616: <li class="listitem"><p>Include
1.85      jmmv     8617:          <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.128     wiz      8618: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.85      jmmv     8619:          <code class="filename">share/applications/mimeinfo.cache</code> file.
                   8620:          It will be handled automatically.</p></li>
                   8621: </ol></div>
                   8622: <p>The best way to verify that the PLIST is correct with
1.110     hubertf  8623:       respect to the last point is to regenerate it using <span class="command"><strong>make
1.85      jmmv     8624:       print-PLIST</strong></span>.</p>
1.75      rillig   8625: </div>
                   8626: </div>
1.148     asau     8627: <div class="sect1">
1.87      wiz      8628: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8629: <a name="punting"></a>21.7. Marking packages as having problems</h2></div></div></div>
1.87      wiz      8630: <p>In some cases one does not have the time to solve a problem
1.125     wiz      8631:   immediately. In this case, one can plainly mark a package as broken.  For
                   8632:   this, one just sets the variable <code class="varname">BROKEN</code> to the
                   8633:   reason why the package is broken (similar to the
                   8634:   <code class="varname">RESTRICTED</code> variable).  A user trying to build
                   8635:   the package will immediately be shown this message, and the build
                   8636:   will not be even tried.</p>
                   8637: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.87      wiz      8638:   intervals.</p>
                   8639: </div>
1.75      rillig   8640: </div>
1.148     asau     8641: <div class="chapter">
1.75      rillig   8642: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   8643: <a name="debug"></a>Chapter 22. Debugging</h2></div></div></div>
1.88      wiz      8644: <p>To check out all the gotchas when building a package, here are
                   8645:   the steps that I do in order to get a package working.  Please note
                   8646:   this is basically the same as what was explained in the previous
                   8647:   sections, only with some debugging aids.</p>
1.148     asau     8648: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8649: <li class="listitem"><p>Be sure to set <code class="varname">PKG_DEVELOPER=yes</code> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></li>
                   8650: <li class="listitem">
1.250     leot     8651: <p>Install <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>,
1.88      wiz      8652:       create a directory for a new package, change into it, then run
1.110     hubertf  8653:       <span class="command"><strong>url2pkg</strong></span>:</p>
1.75      rillig   8654: <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>
                   8655: <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>
                   8656: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
                   8657: </li>
1.128     wiz      8658: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
                   8659: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
                   8660: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
                   8661: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.88      wiz      8662:       configure step to the package's
                   8663:       <code class="filename">Makefile</code>.</p></li>
1.128     wiz      8664: <li class="listitem">
1.75      rillig   8665: <p>Make the package compile, doing multiple rounds of</p>
                   8666: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   8667: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   8668: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
                   8669: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
                   8670: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
                   8671: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
                   8672: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88      wiz      8673: <p>Doing this step as non-root user will ensure that no files
                   8674:       are modified that shouldn't be, especially during the build
1.110     hubertf  8675:       phase.  <span class="command"><strong>mkpatches</strong></span>,
                   8676:       <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.250     leot     8677:       from the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>
1.88      wiz      8678:       package.</p>
1.75      rillig   8679: </li>
1.128     wiz      8680: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
1.267     rillig   8681:       necessary; see <a class="xref" href="#components.Makefile" title="13.1. Makefile">Section 13.1, &#8220;<code class="filename">Makefile</code>&#8221;</a>.</p></li>
1.128     wiz      8682: <li class="listitem">
1.76      rillig   8683: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75      rillig   8684: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   8685: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST &gt;PLIST</code></strong>
                   8686: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
                   8687: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   8688: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88      wiz      8689: <p>You usually need to be <code class="username">root</code> to do
                   8690:       this.  Look if there are any files left:</p>
1.75      rillig   8691: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   8692: <p>If this reveals any files that are missing in
1.88      wiz      8693:       <code class="filename">PLIST</code>, add them.</p>
1.75      rillig   8694: </li>
1.128     wiz      8695: <li class="listitem">
1.88      wiz      8696: <p>Now that the <code class="filename">PLIST</code> is OK, install the
                   8697:       package again and make a binary package:</p>
1.75      rillig   8698: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
                   8699: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
                   8700: </li>
1.128     wiz      8701: <li class="listitem">
1.75      rillig   8702: <p>Delete the installed package:</p>
1.88      wiz      8703: <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   8704: </li>
1.128     wiz      8705: <li class="listitem">
1.110     hubertf  8706: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.88      wiz      8707:       command, which shouldn't find anything now:</p>
1.75      rillig   8708: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   8709: </li>
1.128     wiz      8710: <li class="listitem">
1.75      rillig   8711: <p>Reinstall the binary package:</p>
1.93      rillig   8712: <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   8713: </li>
1.128     wiz      8714: <li class="listitem"><p>Play with it.  Make sure everything works.</p></li>
                   8715: <li class="listitem">
1.250     leot     8716: <p>Run <span class="command"><strong>pkglint</strong></span> from <a href="https://cdn.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      8717:       reports:</p>
1.75      rillig   8718: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
                   8719: </li>
1.267     rillig   8720: <li class="listitem"><p>Submit (or commit, if you have cvs access); see <a class="xref" href="#submit" title="Chapter 23. Submitting and Committing">Chapter 23, <i>Submitting and Committing</i></a>.</p></li>
1.75      rillig   8721: </ul></div>
                   8722: </div>
1.148     asau     8723: <div class="chapter">
1.75      rillig   8724: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   8725: <a name="submit"></a>Chapter 23. Submitting and Committing</h2></div></div></div>
1.75      rillig   8726: <div class="toc">
                   8727: <p><b>Table of Contents</b></p>
1.210     leot     8728: <dl class="toc">
1.267     rillig   8729: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                   8730: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   8731: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                   8732: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                   8733: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                   8734: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                   8735: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                   8736: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
1.75      rillig   8737: </dl>
                   8738: </div>
1.148     asau     8739: <div class="sect1">
1.75      rillig   8740: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8741: <a name="submitting-binary-packages"></a>23.1. Submitting binary packages</h2></div></div></div>
1.75      rillig   8742: <p>Our policy is that we accept binaries only from pkgsrc
                   8743:        developers to guarantee that the packages don't contain any
                   8744:        trojan horses etc. This is not to annoy anyone but rather to
                   8745:        protect our users! You're still free to put up your home-made
                   8746:        binary packages and tell the world where to get them. NetBSD
                   8747:        developers doing bulk builds and wanting to upload them please
1.267     rillig   8748:        see <a class="xref" href="#bulk" title="Chapter 8. Creating binary packages for everything in pkgsrc (bulk builds)">Chapter 8, <i>Creating binary packages for everything in pkgsrc (bulk
1.174     asau     8749: builds)</i></a>.</p>
1.75      rillig   8750: </div>
1.148     asau     8751: <div class="sect1">
1.75      rillig   8752: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8753: <a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75      rillig   8754: <p>First, check that your package is complete, compiles and
1.267     rillig   8755:        runs well; see <a class="xref" href="#debug" title="Chapter 22. Debugging">Chapter 22, <i>Debugging</i></a> and the rest of this
1.270     leot     8756:        document. Next, generate an uuencoded gzipped <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.82      rillig   8757:        archive that contains all files that make up the package.
1.87      wiz      8758:        Finally, send this package to the pkgsrc bug tracking system,
1.270     leot     8759:        either with the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.87      wiz      8760:        that, go to the web page
1.110     hubertf  8761:        <a class="ulink" href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.124     snj      8762:        which contains some instructions and a link to a form where you
                   8763:        can submit packages.  The
1.250     leot     8764:        <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/gtk-send-pr/README.html" target="_top"><code class="filename">sysutils/gtk-send-pr</code></a> package is
1.124     snj      8765:        also available as a substitute for either of the above two tools.
                   8766:        </p>
1.87      wiz      8767: <p>In the form of the problem report, the category should be
1.128     wiz      8768:        <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>, the synopsis should include the package name
1.87      wiz      8769:        and version number, and the description field should contain a
                   8770:        short description of your package (contents of the COMMENT
                   8771:        variable or DESCR file are OK). The uuencoded package data should
1.128     wiz      8772:        go into the <span class="quote">&#8220;<span class="quote">fix</span>&#8221;</span> field.</p>
1.75      rillig   8773: <p>If you want to submit several packages, please send a
                   8774:        separate PR for each one, it's easier for us to track things
                   8775:        that way.</p>
                   8776: <p>Alternatively, you can also import new packages into
1.128     wiz      8777:        pkgsrc-wip (<span class="quote">&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;</span>); see the
1.215     wiz      8778:        homepage at <a class="ulink" href="http://pkgsrc.org/wip/" target="_top">http://pkgsrc.org/wip/</a>
1.75      rillig   8779:        for details.</p>
                   8780: </div>
1.148     asau     8781: <div class="sect1">
1.75      rillig   8782: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8783: <a name="general-notes-for-changes"></a>23.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75      rillig   8784: <p>Please note all package additions, updates, moves, and
1.93      rillig   8785:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75      rillig   8786:        important to keep this file up to date and conforming to the
                   8787:        existing format, because it will be used by scripts to
1.110     hubertf  8788:        automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75      rillig   8789:        sites. Additionally, check the
1.76      rillig   8790:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75      rillig   8791:        for the package you updated or removed, in case it was mentioned
                   8792:        there.</p>
                   8793: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   8794:        bumped, the change should appear in
1.93      rillig   8795:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75      rillig   8796:        related or otherwise relevant. Mass bumps that result from a
                   8797:        dependency being updated should not be mentioned. In all other
                   8798:        cases it's the developer's decision.</p>
                   8799: <p>There is a make target that helps in creating proper
1.110     hubertf  8800:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span class="command"><strong>make
1.75      rillig   8801:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   8802:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93      rillig   8803:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75      rillig   8804:   file is up-to-date (to avoid having to resolve conflicts later-on)
1.110     hubertf  8805:   and then to <span class="command"><strong>cd</strong></span> to the package directory.  For
                   8806:   package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75      rillig   8807:   For new packages, or package moves or removals, set the
                   8808:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   8809:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110     hubertf  8810:   in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125     wiz      8811:   not the same as your NetBSD login name. The target also automatically
                   8812:   removes possibly existing entries for the package in the
                   8813:   <code class="filename">TODO</code> file. Don't forget to commit
1.174     asau     8814:   the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.126     jakllsch 8815:   If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125     wiz      8816:   a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
                   8817:   makes the cvs commands use the main repository.
                   8818:   </p>
1.75      rillig   8819: </div>
1.148     asau     8820: <div class="sect1">
1.75      rillig   8821: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8822: <a name="commit-messages"></a>23.4. Commit Messages</h2></div></div></div>
1.243     wiz      8823: <p>For several years, there have been mirrors of pkgsrc in
                   8824:   fossil, git, and hg. Standard practise when using these tools is to
                   8825:   make the first line of a commit message function as a summary that
                   8826:   can be read without the rest, such as is commonly done with "git log
                   8827:   --oneline". For this reason, we have the following guidelines for
                   8828:   pkgsrc commit messages:</p>
                   8829: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   8830: <li class="listitem"><p>Start the commit message with a line that explains the
1.244     wiz      8831:     big picture in 65 characters or less. When a commit is for one
1.243     wiz      8832:     package, include the name of the package. For updates, include the
                   8833:     version to which it is updated.</p></li>
                   8834: <li class="listitem"><p>Leave the next line empty.</p></li>
                   8835: <li class="listitem"><p>Then come the details for the commit (changes in that
                   8836:     package, reason for a change) and any relevant PRs. Wrap this
                   8837:     section.</p></li>
                   8838: </ul></div>
                   8839: <p>Here is an example:
                   8840:   </p>
                   8841: <pre class="programlisting">
                   8842:   libxslt: update to 1.0.30
                   8843: 
                   8844:   Changes since 1.0.29:
                   8845:   ...
                   8846:   </pre>
                   8847: <p>
                   8848:   </p>
                   8849: <p>Here is another example:
                   8850:   </p>
                   8851: <pre class="programlisting">
                   8852:   mk/bsd.pkg.mk: enable SSP by default on NetBSD
                   8853: 
                   8854:   (rationale)
                   8855:   </pre>
                   8856: <p>
                   8857:   </p>
                   8858: <p>Commit messages are final: no <span class="quote">&#8220;<span class="quote">cvs admin</span>&#8221;</span> is
                   8859:   allowed on the pkgsrc repository to change commit messages.</p>
                   8860: </div>
                   8861: <div class="sect1">
                   8862: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8863: <a name="committing-importing"></a>23.5. Committing: Adding a package to CVS</h2></div></div></div>
1.87      wiz      8864: <p>This section is only of interest for pkgsrc developers with write
1.140     wiz      8865:   access to the pkgsrc repository.</p>
                   8866: <p>When the package is finished, <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span> the files.
                   8867: Start by adding the directory and then files in the directory. Don't
                   8868: forget to add the new package to the category's
                   8869: <code class="filename">Makefile</code>. Make sure you don't forget any files;
                   8870: you can check by running <span class="quote">&#8220;<span class="quote">cvs status</span>&#8221;</span>. An example:</p>
                   8871: <pre class="programlisting">
                   8872: <code class="prompt">$</code> cd .../pkgsrc/category
                   8873: <code class="prompt">$</code> cvs add pkgname
                   8874: <code class="prompt">$</code> cd pkgname
                   8875: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
                   8876: <code class="prompt">$</code> cvs add patches/p*
                   8877: <code class="prompt">$</code> cvs status | less
1.141     wiz      8878: <code class="prompt">$</code> cvs commit
1.140     wiz      8879: <code class="prompt">$</code> cd ..
                   8880: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.141     wiz      8881: <code class="prompt">$</code> cvs commit Makefile
1.174     asau     8882: <code class="prompt">$</code> cd pkgname
1.182     jnemeth  8883: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.140     wiz      8884: </pre>
1.87      wiz      8885: <p>The commit message of the initial import should include part of the
1.76      rillig   8886:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87      wiz      8887:   what the package is/does.</p>
1.140     wiz      8888: <p>Also mention the new package in
                   8889: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
                   8890: <p>Previously, <span class="quote">&#8220;<span class="quote">cvs import</span>&#8221;</span> was suggested, but it was
                   8891: much easier to get wrong than <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span>.</p>
1.75      rillig   8892: </div>
1.148     asau     8893: <div class="sect1">
1.75      rillig   8894: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8895: <a name="updating-package"></a>23.6. Updating a package to a newer version</h2></div></div></div>
1.87      wiz      8896: <p>Please always put a concise, appropriate and relevant summary of the
1.75      rillig   8897:   changes between old and new versions into the commit log when updating
1.87      wiz      8898:   a package. There are various reasons for this:</p>
1.148     asau     8899: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8900: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87      wiz      8901:   or its information may be overwritten by newer information.</p></li>
1.128     wiz      8902: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87      wiz      8903:   repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128     wiz      8904: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75      rillig   8905:   repository is very useful for people who read the pkgsrc-changes mailing
                   8906:   list, so that they can make tactical decisions about when to upgrade
1.87      wiz      8907:   the package.</p></li>
1.75      rillig   8908: </ul></div>
1.87      wiz      8909: <p>Please also recognize that, just because a new version of a package
1.75      rillig   8910:   has been released, it should not automatically be upgraded in the CVS
                   8911:   repository.  We prefer to be conservative in the packages that are
                   8912:   included in pkgsrc - development or beta packages are not really the
                   8913:   best thing for most places in which pkgsrc is used. Please use your
                   8914:   judgement about what should go into pkgsrc, and bear in mind that
1.87      wiz      8915:   stability is to be preferred above new and possibly untested features.</p>
1.75      rillig   8916: </div>
1.148     asau     8917: <div class="sect1">
1.75      rillig   8918: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8919: <a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
1.122     reed     8920: <p>Renaming packages is not recommended.</p>
                   8921: <p>When renaming packages, be sure to fix any references to old name
                   8922:   in other Makefiles, options, buildlink files, etc.</p>
                   8923: <p>Also When renaming a package, please define
                   8924:   <code class="varname">SUPERSEDES</code> to the package name and dewey version
                   8925:   pattern(s) of the previous package name.
                   8926:   This may be repeated for multiple renames.
                   8927:   The new package would be an exact replacement.
                   8928: </p>
1.128     wiz      8929: <p>Note that <span class="quote">&#8220;<span class="quote">successor</span>&#8221;</span> in the
1.122     reed     8930:   CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
                   8931:   mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
                   8932:   not be an exact replacement but is a suggestion for the replaced
                   8933:   functionality.</p>
                   8934: </div>
1.148     asau     8935: <div class="sect1">
1.122     reed     8936: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8937: <a name="moving-package"></a>23.8. Moving a package in pkgsrc</h2></div></div></div>
1.122     reed     8938: <p>It is preferred that packages are not renamed or moved, but if needed
                   8939:   please follow these steps.
                   8940: </p>
1.128     wiz      8941: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8942: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
                   8943: <li class="listitem">
1.75      rillig   8944: <p>Remove all CVS dirs.</p>
1.87      wiz      8945: <p>Alternatively to the first two steps you can also do:</p>
1.75      rillig   8946: <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      8947: <p>and use that for further work.</p>
1.75      rillig   8948: </li>
1.128     wiz      8949: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
                   8950: <code class="varname">DEPENDS</code> paths that just did <span class="quote">&#8220;<span class="quote">../package</span>&#8221;</span>
                   8951: instead of <span class="quote">&#8220;<span class="quote">../../category/package</span>&#8221;</span>.</p></li>
                   8952: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122     reed     8953: <code class="varname">PREV_PKGPATH</code> to the previous category/package
                   8954: pathname.  The <code class="varname">PREV_PKGPATH</code> can be used by tools
                   8955: for doing an update using pkgsrc building; for example, it can
1.270     leot     8956: search the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
1.122     reed     8957: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
                   8958: new <code class="varname">PKGPATH</code> for that moved package.  Note that
                   8959: it may have multiple matches, so the tool should also check on the
                   8960: <code class="varname">PKGBASE</code> too.  The <code class="varname">PREV_PKGPATH</code>
                   8961: probably has no value unless <code class="varname">SUPERSEDES</code> is not
                   8962: set, i.e.  <code class="varname">PKGBASE</code> stays the same.  </p></li>
1.128     wiz      8963: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75      rillig   8964: place.</p></li>
1.128     wiz      8965: <li class="listitem">
1.75      rillig   8966: <p>Check if any package depends on it:
                   8967: </p>
                   8968: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   8969: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   8970: </li>
1.128     wiz      8971: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
                   8972: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
                   8973: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   8974: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
                   8975: <li class="listitem">
1.75      rillig   8976: <p>Commit the changed and removed files:</p>
                   8977: <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      8978: <p>(and any packages from step 5, of course).</p>
1.75      rillig   8979: </li>
                   8980: </ol></div>
                   8981: </div>
                   8982: </div>
1.148     asau     8983: <div class="chapter">
1.75      rillig   8984: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   8985: <a name="devfaq"></a>Chapter 24. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   8986: <p>This section contains the answers to questions that may
                   8987:        arise when you are writing a package. If you don't find your
                   8988:        question answered here, first have a look in the other chapters,
                   8989:        and if you still don't have the answer, ask on the
                   8990:        <code class="literal">pkgsrc-users</code> mailing list.</p>
1.148     asau     8991: <div class="qandaset">
1.273   ! brook    8992: <a name="idp140232492973624"></a><dl>
1.267     rillig   8993: <dt>24.1. <a href="#devfaq.makeflags">What is the difference between
1.75      rillig   8994:        MAKEFLAGS, .MAKEFLAGS and
                   8995:        MAKE_FLAGS?</a>
                   8996: </dt>
1.267     rillig   8997: <dt>24.2. <a href="#devfaq.make">What is the difference between
1.75      rillig   8998:        MAKE, GMAKE and
                   8999:        MAKE_PROGRAM?</a>
                   9000: </dt>
1.267     rillig   9001: <dt>24.3. <a href="#devfaq.cc">What is the difference between
1.75      rillig   9002:        CC, PKG_CC and
                   9003:        PKGSRC_COMPILER?</a>
                   9004: </dt>
1.267     rillig   9005: <dt>24.4. <a href="#devfaq.bl3flags">What is the difference between
1.75      rillig   9006:        BUILDLINK_LDFLAGS,
                   9007:        BUILDLINK_LDADD and
                   9008:        BUILDLINK_LIBS?</a>
                   9009: </dt>
1.267     rillig   9010: <dt>24.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75      rillig   9011:        VARNAME=BUILDLINK_PREFIX.foo
                   9012:        say it's empty?</a>
                   9013: </dt>
1.267     rillig   9014: <dt>24.6. <a href="#devfaq.master_sites">What does
1.78      rillig   9015:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   9016:        don't understand the := inside
                   9017:        it.</a>
                   9018: </dt>
1.267     rillig   9019: <dt>24.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78      rillig   9020:        developers?</a>
                   9021: </dt>
1.267     rillig   9022: <dt>24.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80      rillig   9023:        documentation?</a>
                   9024: </dt>
1.267     rillig   9025: <dt>24.9. <a href="#devfaq.too-much-time">I have a little time to kill.  What shall I
1.92      rillig   9026: do?</a>
                   9027: </dt>
1.75      rillig   9028: </dl>
1.148     asau     9029: <table border="0" style="width: 100%;">
                   9030: <colgroup>
1.75      rillig   9031: <col align="left" width="1%">
1.128     wiz      9032: <col>
1.148     asau     9033: </colgroup>
1.75      rillig   9034: <tbody>
1.148     asau     9035: <tr class="question">
1.75      rillig   9036: <td align="left" valign="top">
1.273   ! brook    9037: <a name="devfaq.makeflags"></a><a name="idp140232492974296"></a><p><b>24.1.</b></p>
1.75      rillig   9038: </td>
                   9039: <td align="left" valign="top"><p>What is the difference between
                   9040:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   9041:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   9042: </tr>
                   9043: <tr class="answer">
1.91      rillig   9044: <td align="left" valign="top"></td>
1.75      rillig   9045: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.270     leot     9046:        to the pkgsrc-internal invocations of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.75      rillig   9047:        <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
                   9048:        the <code class="varname">MAKE_PROGRAM</code> when building the
                   9049:        package. [FIXME: What is .MAKEFLAGS for?]</p></td>
                   9050: </tr>
1.148     asau     9051: <tr class="question">
1.75      rillig   9052: <td align="left" valign="top">
1.273   ! brook    9053: <a name="devfaq.make"></a><a name="idp140232492978760"></a><p><b>24.2.</b></p>
1.75      rillig   9054: </td>
                   9055: <td align="left" valign="top"><p>What is the difference between
                   9056:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   9057:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   9058: </tr>
                   9059: <tr class="answer">
1.91      rillig   9060: <td align="left" valign="top"></td>
1.75      rillig   9061: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.270     leot     9062:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.75      rillig   9063:        infrastructure. <code class="varname">GMAKE</code> is the path to GNU
                   9064:        Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
                   9065:        use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
                   9066:        Make program that is used for building the
                   9067:        package.</p></td>
                   9068: </tr>
1.148     asau     9069: <tr class="question">
1.75      rillig   9070: <td align="left" valign="top">
1.273   ! brook    9071: <a name="devfaq.cc"></a><a name="idp140232492983736"></a><p><b>24.3.</b></p>
1.75      rillig   9072: </td>
                   9073: <td align="left" valign="top"><p>What is the difference between
                   9074:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   9075:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   9076: </tr>
                   9077: <tr class="answer">
1.91      rillig   9078: <td align="left" valign="top"></td>
1.75      rillig   9079: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
                   9080:        compiler, which can be configured by the pkgsrc user.
                   9081:        <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
                   9082:        <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
                   9083:        path to a compiler, but the type of compiler that should be
1.76      rillig   9084:        used. See <code class="filename">mk/compiler.mk</code> for more
1.75      rillig   9085:        information about the latter variable.</p></td>
                   9086: </tr>
1.148     asau     9087: <tr class="question">
1.75      rillig   9088: <td align="left" valign="top">
1.273   ! brook    9089: <a name="devfaq.bl3flags"></a><a name="idp140232492988648"></a><p><b>24.4.</b></p>
1.75      rillig   9090: </td>
                   9091: <td align="left" valign="top"><p>What is the difference between
                   9092:        <code class="varname">BUILDLINK_LDFLAGS</code>,
                   9093:        <code class="varname">BUILDLINK_LDADD</code> and
                   9094:        <code class="varname">BUILDLINK_LIBS</code>?</p></td>
                   9095: </tr>
                   9096: <tr class="answer">
1.91      rillig   9097: <td align="left" valign="top"></td>
1.75      rillig   9098: <td align="left" valign="top"><p>[FIXME]</p></td>
                   9099: </tr>
1.148     asau     9100: <tr class="question">
1.75      rillig   9101: <td align="left" valign="top">
1.273   ! brook    9102: <a name="devfaq.bl3prefix"></a><a name="idp140232492991272"></a><p><b>24.5.</b></p>
1.75      rillig   9103: </td>
1.110     hubertf  9104: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75      rillig   9105:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   9106:        say it's empty?</p></td>
                   9107: </tr>
                   9108: <tr class="answer">
1.91      rillig   9109: <td align="left" valign="top"></td>
1.75      rillig   9110: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.128     wiz      9111:        available in the <span class="quote">&#8220;<span class="quote">wrapper</span>&#8221;</span> phase and later. To
                   9112:        <span class="quote">&#8220;<span class="quote">simulate</span>&#8221;</span> the wrapper phase, append
1.110     hubertf  9113:        <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75      rillig   9114:        command.</p></td>
                   9115: </tr>
1.148     asau     9116: <tr class="question">
1.78      rillig   9117: <td align="left" valign="top">
1.273   ! brook    9118: <a name="devfaq.master_sites"></a><a name="idp140232492995144"></a><p><b>24.6.</b></p>
1.78      rillig   9119: </td>
                   9120: <td align="left" valign="top"><p>What does
1.220     wiz      9121:        <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   9122:        don't understand the <code class="code">:=</code> inside
1.78      rillig   9123:        it.</p></td>
                   9124: </tr>
                   9125: <tr class="answer">
1.91      rillig   9126: <td align="left" valign="top"></td>
1.220     wiz      9127: <td align="left" valign="top"><p>The <code class="code">:=</code> is not really an
                   9128:        assignment operator, although it looks like it.
1.78      rillig   9129:        Instead, it is a degenerate form of
1.220     wiz      9130:        <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.270     leot     9131:        which is documented in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which is
1.220     wiz      9132:        commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.78      rillig   9133:        case of <code class="varname">MASTER_SITE_*</code>,
                   9134:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   9135:        <em class="replaceable"><code>new_string</code></em> is
1.220     wiz      9136:        <code class="code">package/</code>. That's where the
                   9137:        <code class="code">:</code> and the <code class="code">=</code> fall
1.78      rillig   9138:        together.</p></td>
                   9139: </tr>
1.148     asau     9140: <tr class="question">
1.78      rillig   9141: <td align="left" valign="top">
1.273   ! brook    9142: <a name="devfaq.mailinglists"></a><a name="idp140232493002824"></a><p><b>24.7.</b></p>
1.78      rillig   9143: </td>
                   9144: <td align="left" valign="top"><p>Which mailing lists are there for package
                   9145:        developers?</p></td>
                   9146: </tr>
                   9147: <tr class="answer">
1.91      rillig   9148: <td align="left" valign="top"></td>
1.148     asau     9149: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.110     hubertf  9150: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
1.78      rillig   9151: <dd><p>This is a list for technical discussions related
                   9152:        to pkgsrc development, e.g. soliciting feedback for changes to
                   9153:        pkgsrc infrastructure, proposed new features, questions related
                   9154:        to porting pkgsrc to a new platform, advice for maintaining a
                   9155:        package, patches that affect many packages, help requests moved
                   9156:        from pkgsrc-users when an infrastructure bug is found,
                   9157:        etc.</p></dd>
1.110     hubertf  9158: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
1.78      rillig   9159: <dd><p>All bug reports in category "pkg" sent with
1.270     leot     9160:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.78      rillig   9161:        directly; use one of the other mailing
                   9162:        lists.</p></dd>
                   9163: </dl></div></td>
                   9164: </tr>
1.148     asau     9165: <tr class="question">
1.80      rillig   9166: <td align="left" valign="top">
1.273   ! brook    9167: <a name="devfaq.documentation"></a><a name="idp140232493007736"></a><p><b>24.8.</b></p>
1.80      rillig   9168: </td>
                   9169: <td align="left" valign="top"><p>Where is the pkgsrc
                   9170:        documentation?</p></td>
                   9171: </tr>
                   9172: <tr class="answer">
1.91      rillig   9173: <td align="left" valign="top"></td>
1.80      rillig   9174: <td align="left" valign="top">
                   9175: <p>There are many places where you can find
                   9176:        documentation about pkgsrc:</p>
1.148     asau     9177: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9178: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80      rillig   9179:        of chapters that explain large parts of pkgsrc, but some
                   9180:        chapters tend to be outdated. Which ones they are is hard to
                   9181:        say.</p></li>
1.128     wiz      9182: <li class="listitem"><p>On the mailing list archives (see <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>), you can find discussions
1.80      rillig   9183:        about certain features, announcements of new parts of the pkgsrc
                   9184:        infrastructure and sometimes even announcements that a certain
                   9185:        feature has been marked as obsolete. The benefit here is that
                   9186:        each message has a date appended to it.</p></li>
1.128     wiz      9187: <li class="listitem"><p>Many of the files in the
1.80      rillig   9188:        <code class="filename">mk/</code> directory start with a comment that
                   9189:        describes the purpose of the file and how it can be used by the
1.92      rillig   9190:        pkgsrc user and package authors. An easy way to find this
1.110     hubertf  9191:        documentation is to run <span class="command"><strong>bmake
1.92      rillig   9192:        help</strong></span>.</p></li>
1.128     wiz      9193: <li class="listitem"><p>The CVS log messages are a rich source of
1.80      rillig   9194:        information, but they tend to be highly abbreviated, especially
                   9195:        for actions that occur often. Some contain a detailed
                   9196:        description of what has changed, but they are geared towards the
                   9197:        other pkgsrc developers, not towards an average pkgsrc user.
                   9198:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   9199:        don't know what has been before, these messages may not be worth
                   9200:        too much to you.</p></li>
1.128     wiz      9201: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">&#8220;<span class="quote">implicitly
                   9202:        documented</span>&#8221;</span>, that is the documentation exists only in the
1.80      rillig   9203:        mind of the developer who wrote the code. To get this
1.110     hubertf  9204:        information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80      rillig   9205:        to see who has written it and ask on the
                   9206:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   9207:        find your questions later (see above). To be sure that the
                   9208:        developer in charge reads the mail, you may CC him or
                   9209:        her.</p></li>
                   9210: </ul></div>
                   9211: </td>
                   9212: </tr>
1.148     asau     9213: <tr class="question">
1.92      rillig   9214: <td align="left" valign="top">
1.273   ! brook    9215: <a name="devfaq.too-much-time"></a><a name="idp140232493016584"></a><p><b>24.9.</b></p>
1.92      rillig   9216: </td>
                   9217: <td align="left" valign="top"><p>I have a little time to kill.  What shall I
                   9218: do?</p></td>
                   9219: </tr>
                   9220: <tr class="answer">
                   9221: <td align="left" valign="top"></td>
                   9222: <td align="left" valign="top">
1.93      rillig   9223: <p>This is not really an FAQ yet, but here's the answer
1.92      rillig   9224: anyway.</p>
1.148     asau     9225: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9226: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.250     leot     9227:     <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a> package).  It
1.92      rillig   9228:     will tell you about newer versions of installed packages that are
                   9229:     available, but not yet updated in pkgsrc.</p></li>
1.128     wiz      9230: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.126     jakllsch 9231:     &mdash; it contains a list of suggested new packages and a list of
1.92      rillig   9232:     cleanups and enhancements for pkgsrc that would be nice to
                   9233:     have.</p></li>
1.128     wiz      9234: <li class="listitem"><p>Review packages for which review was requested on
1.180     wiz      9235:     the <a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
1.92      rillig   9236:     mailing list.</p></li>
                   9237: </ul></div>
                   9238: </td>
                   9239: </tr>
1.75      rillig   9240: </tbody>
                   9241: </table>
                   9242: </div>
                   9243: </div>
1.148     asau     9244: <div class="chapter">
1.85      jmmv     9245: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   9246: <a name="gnome"></a>Chapter 25. GNOME packaging and porting</h2></div></div></div>
1.85      jmmv     9247: <div class="toc">
                   9248: <p><b>Table of Contents</b></p>
1.210     leot     9249: <dl class="toc">
1.267     rillig   9250: <dt><span class="sect1"><a href="#meta-packages">25.1. Meta packages</a></span></dt>
                   9251: <dt><span class="sect1"><a href="#new-package">25.2. Packaging a GNOME application</a></span></dt>
                   9252: <dt><span class="sect1"><a href="#full-update">25.3. Updating GNOME to a newer version</a></span></dt>
                   9253: <dt><span class="sect1"><a href="#patching">25.4. Patching guidelines</a></span></dt>
1.85      jmmv     9254: </dl>
                   9255: </div>
1.110     hubertf  9256: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.85      jmmv     9257: site</a>:</p>
                   9258: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   9259:   environment, an intuitive and attractive desktop for users, and the
                   9260:   GNOME development platform, an extensive framework for building
                   9261:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   9262: <p>pkgsrc provides a seamless way to automatically build and install
                   9263: a complete GNOME environment <span class="emphasis"><em>under many different
                   9264: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   9265: the most advanced build and packaging systems for GNOME due to its
                   9266: included technologies buildlink3, the wrappers and tools framework and
                   9267: automatic configuration file management.  Lots of efforts are put into
                   9268: achieving a completely clean deinstallation of installed software
                   9269: components.</p>
1.110     hubertf  9270: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.85      jmmv     9271: the above also means that great efforts are put into making GNOME work
1.110     hubertf  9272: under this operating system.  Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.85      jmmv     9273: pkgsrc as its preferred packaging system, contributing lots of
                   9274: portability fixes to make GNOME build and install under it.</p>
                   9275: <p>This chapter is aimed at pkgsrc developers and other people
                   9276: interested in helping our GNOME porting and packaging efforts.  It
                   9277: provides instructions on how to manage the existing packages and some
                   9278: important information regarding their internals.</p>
1.148     asau     9279: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.85      jmmv     9280: <h3 class="title">We need your help!</h3>
                   9281: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
                   9282:   and GNOME and are willing to learn new exciting stuff, please jump
1.110     hubertf  9283:   straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.85      jmmv     9284:   work</a> list!  There is still a long way to go to get a
                   9285:   fully-functional GNOME desktop under NetBSD and we need your help to
                   9286:   achieve it!</p>
                   9287: </div>
1.148     asau     9288: <div class="sect1">
1.85      jmmv     9289: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9290: <a name="meta-packages"></a>25.1. Meta packages</h2></div></div></div>
1.85      jmmv     9291: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.148     asau     9292: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250     leot     9293: <li class="listitem"><p><a href="https://cdn.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     9294:     the core GNOME desktop environment.  It only includes the necessary
                   9295:     bits to get it to boot correctly, although it may lack important
                   9296:     functionality for daily operation.  The idea behind this package is
                   9297:     to let end users build their own configurations on top of this one,
                   9298:     first installing this meta package to achieve a functional setup and
                   9299:     then adding individual applications.</p></li>
1.250     leot     9300: <li class="listitem"><p><a href="https://cdn.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     9301:     complete installation of the GNOME platform and desktop as defined
                   9302:     by the GNOME project; this is based on the components distributed in
                   9303:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   9304:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   9305:     official FTP server.  Developer-only tools found in those
                   9306:     directories are not installed unless required by some other
                   9307:     component to work properly.  Similarly, packages from the bindings
                   9308:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   9309:     in unless required as a dependency for an end-user component.  This
1.250     leot     9310:     package "extends" <a href="https://cdn.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>
                   9311: <li class="listitem"><p><a href="https://cdn.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     9312:     Installs all the tools required to build a GNOME component when
                   9313:     fetched from the CVS repository.  These are required to let the
1.110     hubertf  9314:     <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.85      jmmv     9315: </ul></div>
                   9316: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   9317: sorted in a way that eases updates: a package may depend on other
                   9318: packages listed before it but not on any listed after it.  It is very
                   9319: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   9320: change it to alphabetical sorting!</em></span></p>
                   9321: </div>
1.148     asau     9322: <div class="sect1">
1.85      jmmv     9323: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9324: <a name="new-package"></a>25.2. Packaging a GNOME application</h2></div></div></div>
1.85      jmmv     9325: <p>Almost all GNOME applications are written in C and use a common
                   9326: set of tools as their build system.  Things get different with the new
                   9327: bindings to other languages (such as Python), but the following will
                   9328: give you a general idea on the minimum required tools:</p>
1.148     asau     9329: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9330: <li class="listitem">
1.85      jmmv     9331: <p>Almost all GNOME applications use the GNU Autotools as their
                   9332:     build system.  As a general rule you will need to tell this to your
                   9333:     package:</p>
1.100     rillig   9334: <pre class="programlisting">
                   9335: GNU_CONFIGURE=yes
1.85      jmmv     9336: USE_LIBTOOL=yes
1.100     rillig   9337: USE_TOOLS+=gmake
                   9338: </pre>
1.85      jmmv     9339: </li>
1.128     wiz      9340: <li class="listitem">
1.85      jmmv     9341: <p>If the package uses pkg-config to detect dependencies, add this
                   9342:     tool to the list of required utilities:</p>
1.222     sevan    9343: <pre class="programlisting">
                   9344: USE_TOOLS+=pkg-config
                   9345: </pre>
1.250     leot     9346: <p>Also use <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/verifypc/README.html" target="_top"><code class="filename">pkgtools/verifypc</code></a> at
1.85      jmmv     9347:     the end of the build process to ensure that you did not miss to
                   9348:     specify any dependency in your package and that the version
                   9349:     requirements are all correct.</p>
                   9350: </li>
1.128     wiz      9351: <li class="listitem"><p>If the package uses intltool, be sure to add
1.93      rillig   9352:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85      jmmv     9353:     to handle dependencies and to force the package to use the latest
                   9354:     available version.</p></li>
1.128     wiz      9355: <li class="listitem">
1.85      jmmv     9356: <p>If the package uses gtk-doc (a documentation generation
                   9357:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   9358:     tool is rather big and the distfile should come with pregenerated
                   9359:     documentation anyway; if it does not, it is a bug that you ought to
                   9360:     report.  For such packages you should disable gtk-doc (unless it is
1.89      rillig   9361:     the default):</p>
1.222     sevan    9362: <pre class="programlisting">
                   9363: CONFIGURE_ARGS+=--disable-gtk-doc
                   9364: </pre>
1.89      rillig   9365: <p>The default location of installed HTML files
                   9366:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   9367:     and should not be changed unless the package insists on installing
                   9368:     them somewhere else.  Otherwise programs as
1.110     hubertf  9369:     <span class="command"><strong>devhelp</strong></span> will not be able to open them.  You can
1.89      rillig   9370:     do that with an entry similar to:</p>
1.222     sevan    9371: <pre class="programlisting">
                   9372: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
                   9373: </pre>
1.85      jmmv     9374: </li>
                   9375: </ul></div>
                   9376: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   9377: files under the installation prefix to maintain databases.  In this
                   9378: context, shared means that those exact same directories and files are
                   9379: used among several different packages, leading to conflicts in the
                   9380: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   9381: handle the most common cases, so you have to forget about using
                   9382: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   9383: omitting shared files from them.  If you find yourself doing those,
                   9384: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   9385: <p>The following table lists the common situations that result in
                   9386: using shared directories or files.  For each of them, the appropriate
                   9387: solution is given.  After applying the solution be sure to
                   9388: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.110     hubertf  9389: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.85      jmmv     9390: <div class="table">
1.267     rillig   9391: <a name="plist-handling"></a><p class="title"><b>Table 25.1. PLIST handling for GNOME packages</b></p>
1.216     tnn      9392: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
1.85      jmmv     9393: <colgroup>
                   9394: <col>
                   9395: <col>
                   9396: </colgroup>
                   9397: <thead><tr>
                   9398: <th>If the package...</th>
                   9399: <th>Then...</th>
                   9400: </tr></thead>
                   9401: <tbody>
                   9402: <tr>
                   9403: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.267     rillig   9404: <td>See <a class="xref" href="#scrollkeeper-data-files" title="21.6.10. Packages installing scrollkeeper/rarian data files">Section 21.6.10, &#8220;Packages installing scrollkeeper/rarian data files&#8221;</a>.</td>
1.85      jmmv     9405: </tr>
                   9406: <tr>
                   9407: <td>Installs icons under the
                   9408:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   9409:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.267     rillig   9410: <td>See <a class="xref" href="#hicolor-theme" title="21.6.19. Packages installing hicolor theme icons">Section 21.6.19, &#8220;Packages installing hicolor theme icons&#8221;</a>.</td>
1.85      jmmv     9411: </tr>
                   9412: <tr>
                   9413: <td>Installs files under
                   9414:         <code class="filename">share/mime/packages</code>.</td>
1.267     rillig   9415: <td>See <a class="xref" href="#mime-database" title="21.6.14. Packages installing extensions to the MIME database">Section 21.6.14, &#8220;Packages installing extensions to the MIME database&#8221;</a>.</td>
1.85      jmmv     9416: </tr>
                   9417: <tr>
                   9418: <td>Installs <code class="filename">.desktop</code> files under
                   9419:         <code class="filename">share/applications</code> and these include MIME
                   9420:         information.</td>
1.267     rillig   9421: <td>See <a class="xref" href="#desktop-files" title="21.6.20. Packages installing desktop files">Section 21.6.20, &#8220;Packages installing desktop files&#8221;</a>.</td>
1.85      jmmv     9422: </tr>
                   9423: </tbody>
1.91      rillig   9424: </table></div>
1.85      jmmv     9425: </div>
1.91      rillig   9426: <br class="table-break">
1.85      jmmv     9427: </div>
1.148     asau     9428: <div class="sect1">
1.85      jmmv     9429: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9430: <a name="full-update"></a>25.3. Updating GNOME to a newer version</h2></div></div></div>
1.85      jmmv     9431: <p>When seeing GNOME as a whole, there are two kinds of
                   9432: updates:</p>
1.148     asau     9433: <div class="variablelist"><dl class="variablelist">
1.85      jmmv     9434: <dt><span class="term">Major update</span></dt>
                   9435: <dd>
                   9436: <p>Given that there is still a very long way for GNOME 3 (if it
                   9437:       ever appears), we consider a major update one that goes from a
                   9438:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   9439:       where <code class="literal">Y</code> is even and greater than
                   9440:       <code class="literal">X</code>.  These are hard to achieve because they
                   9441:       introduce lots of changes in the components' code and almost all
                   9442:       GNOME distfiles are updated to newer versions.  Some of them can
                   9443:       even break API and ABI compatibility with the previous major
                   9444:       version series.  As a result, the update needs to be done all at
                   9445:       once to minimize breakage.</p>
                   9446: <p>A major update typically consists of around 80 package
                   9447:       updates and the addition of some new ones.</p>
                   9448: </dd>
                   9449: <dt><span class="term">Minor update</span></dt>
                   9450: <dd>
                   9451: <p>We consider a minor update one that goes from a
                   9452:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   9453:       one where <code class="literal">Y</code> is greater than
                   9454:       <code class="literal">X</code>.  These are easy to achieve because they do
                   9455:       not update all GNOME components, can be done in an incremental way
                   9456:       and do not break API nor ABI compatibility.</p>
                   9457: <p>A minor update typically consists of around 50 package
                   9458:       updates, although the numbers here may vary a lot.</p>
                   9459: </dd>
                   9460: </dl></div>
                   9461: <p>In order to update the GNOME components in pkgsrc to a new stable
                   9462: release (either major or minor), the following steps should be
                   9463: followed:</p>
1.128     wiz      9464: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9465: <li class="listitem">
1.85      jmmv     9466: <p>Get a list of all the tarballs that form the new release by
                   9467:     using the following commands.  These will leave the full list of the
1.120     snj      9468:     components' distfiles into the <code class="filename">list.txt</code>
1.85      jmmv     9469:     file:</p>
1.88      wiz      9470: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85      jmmv     9471:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   9472:     awk '{ print $9 }' &gt;list.txt</code></strong>
1.88      wiz      9473: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85      jmmv     9474:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   9475:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
                   9476: </li>
1.128     wiz      9477: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.85      jmmv     9478:     bump their version to the release you are updating them to.  The
                   9479:     three meta packages should be always consistent with versioning.
                   9480:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   9481:     in them.</p></li>
1.128     wiz      9482: <li class="listitem">
1.85      jmmv     9483: <p>For each meta package, update all its
                   9484:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   9485:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   9486:     newer version (even if found in the FTP) because the meta packages
                   9487:     are supposed to list the exact versions that form a specific GNOME
                   9488:     release.  Exceptions are permitted here if a newer version solves a
                   9489:     serious issue in the overall desktop experience; these typically
                   9490:     come in the form of a revision bump in pkgsrc, not in newer versions
                   9491:     from the developers.</p>
                   9492: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   9493:     should be updated to the latest version available (if found in
                   9494:     pkgsrc).  This is the case, for example, of the dependencies on the
1.250     leot     9495:     GNU Autotools in the <a href="https://cdn.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     9496: </li>
1.128     wiz      9497: <li class="listitem">
1.85      jmmv     9498: <p>Generate a patch from the modified meta packages and extract the
                   9499:     list of "new" lines.  This will provide you an outline on what
                   9500:     packages need to be updated in pkgsrc and in what order:</p>
1.93      rillig   9501: <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     9502: </li>
1.128     wiz      9503: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.85      jmmv     9504:     installed packages and start over from scratch at this point.</p></li>
1.128     wiz      9505: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.85      jmmv     9506:     of <code class="filename">todo.txt</code> and update the packages listed in
                   9507:     it in order.  For major desktop updates none of these should be
1.93      rillig   9508:     committed until the entire set is completed because there are chances
1.85      jmmv     9509:     of breaking not-yet-updated packages.</p></li>
1.128     wiz      9510: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.85      jmmv     9511:     the tree one by one with appropriate log messages.  At the end,
                   9512:     commit the three meta package updates and all the corresponding
                   9513:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
                   9514:     <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>
                   9515: </ol></div>
                   9516: </div>
1.148     asau     9517: <div class="sect1">
1.85      jmmv     9518: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9519: <a name="patching"></a>25.4. Patching guidelines</h2></div></div></div>
1.85      jmmv     9520: <p>GNOME is a very big component in pkgsrc which approaches 100
                   9521: packages.  Please, it is very important that you always, always,
                   9522: <span class="strong"><strong>always</strong></span> feed back any portability
1.267     rillig   9523: fixes you do to a GNOME package to the mainstream developers (see <a class="xref" href="#components.patches.feedback" title="13.3.5. Feedback to the author">Section 13.3.5, &#8220;Feedback to the author&#8221;</a>).  This is the only way to get
1.85      jmmv     9524: their attention on portability issues and to ensure that future versions
                   9525: can be built out-of-the box on NetBSD.  The less custom patches in
                   9526: pkgsrc, the easier further updates are.  Those developers in charge of
                   9527: issuing major GNOME updates will be grateful if you do that.</p>
1.110     hubertf  9528: <p>The most common places to report bugs are the <a class="ulink" href="http://bugzilla.gnome.org/" target="_top">GNOME's Bugzilla</a> and the <a class="ulink" href="http://bugzilla.freedesktop.org/" target="_top">freedesktop.org's
1.85      jmmv     9529: Bugzilla</a>.  Not all components use these to track bugs, but most
                   9530: of them do.  Do not be short on your reports: always provide detailed
                   9531: explanations of the current failure, how it can be improved to achieve
                   9532: maximum portability and, if at all possible, provide a patch against CVS
                   9533: head.  The more verbose you are, the higher chances of your patch being
                   9534: accepted.</p>
                   9535: <p>Also, please avoid using preprocessor magic to fix portability
                   9536: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   9537: GNOME to their operating system, the official GNOME sources are now
                   9538: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   9539: and similar macros.  This hurts portability.  Please see our patching
1.267     rillig   9540: guidelines (<a class="xref" href="#components.patches.guidelines" title="13.3.4. Patching guidelines">Section 13.3.4, &#8220;Patching guidelines&#8221;</a>) for more
1.85      jmmv     9541: details.</p>
                   9542: </div>
                   9543: </div>
1.75      rillig   9544: </div>
1.148     asau     9545: <div class="part">
1.75      rillig   9546: <div class="titlepage"><div><div><h1 class="title">
                   9547: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.148     asau     9548: <div class="partintro">
1.75      rillig   9549: <div></div>
                   9550: <p>This part of the guide deals with everything
                   9551:        from the infrastructure that is behind the interfaces described
                   9552:        in the developer's guide. A casual package maintainer should not
                   9553:        need anything from this part.</p>
                   9554: <div class="toc">
                   9555: <p><b>Table of Contents</b></p>
1.210     leot     9556: <dl class="toc">
1.267     rillig   9557: <dt><span class="chapter"><a href="#infr.design">26. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig   9558: <dd><dl>
1.267     rillig   9559: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
                   9560: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
                   9561: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.75      rillig   9562: <dd><dl>
1.267     rillig   9563: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
                   9564: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.75      rillig   9565: </dl></dd>
1.267     rillig   9566: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
                   9567: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   9568: <dd><dl>
1.267     rillig   9569: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
                   9570: <dt><span class="sect2"><a href="#infr.design.intf.action">26.5.2. Actions taken on behalf of parameters</a></span></dt>
1.81      rillig   9571: </dl></dd>
1.267     rillig   9572: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.81      rillig   9573: <dd><dl>
1.267     rillig   9574: <dt><span class="sect2"><a href="#infr.order.prefs">26.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
                   9575: <dt><span class="sect2"><a href="#infr.order.pkg">26.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75      rillig   9576: </dl></dd>
                   9577: </dl></dd>
1.267     rillig   9578: <dt><span class="chapter"><a href="#regression">27. Regression tests</a></span></dt>
1.75      rillig   9579: <dd><dl>
1.267     rillig   9580: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
                   9581: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.75      rillig   9582: <dd><dl>
1.267     rillig   9583: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
                   9584: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.75      rillig   9585: </dl></dd>
                   9586: </dl></dd>
1.267     rillig   9587: <dt><span class="chapter"><a href="#porting">28. Porting pkgsrc</a></span></dt>
                   9588: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">28.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.75      rillig   9589: </dl>
                   9590: </div>
                   9591: </div>
1.148     asau     9592: <div class="chapter">
1.75      rillig   9593: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   9594: <a name="infr.design"></a>Chapter 26. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75      rillig   9595: <div class="toc">
                   9596: <p><b>Table of Contents</b></p>
1.210     leot     9597: <dl class="toc">
1.267     rillig   9598: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
                   9599: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
                   9600: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.81      rillig   9601: <dd><dl>
1.267     rillig   9602: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
                   9603: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.81      rillig   9604: </dl></dd>
1.267     rillig   9605: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
                   9606: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   9607: <dd><dl>
1.267     rillig   9608: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
                   9609: <dt><span class="sect2"><a href="#infr.design.intf.action">26.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75      rillig   9610: </dl></dd>
1.267     rillig   9611: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.75      rillig   9612: <dd><dl>
1.267     rillig   9613: <dt><span class="sect2"><a href="#infr.order.prefs">26.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
                   9614: <dt><span class="sect2"><a href="#infr.order.pkg">26.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75      rillig   9615: </dl></dd>
                   9616: </dl>
                   9617: </div>
                   9618: <p>The pkgsrc infrastructure consists of many small Makefile
                   9619:        fragments. Each such fragment needs a properly specified
                   9620:        interface. This chapter explains how such an interface looks
                   9621:        like.</p>
1.148     asau     9622: <div class="sect1">
1.75      rillig   9623: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9624: <a name="infr.vardef"></a>26.1. The meaning of variable definitions</h2></div></div></div>
1.81      rillig   9625: <p>Whenever a variable is defined in the pkgsrc
                   9626:        infrastructure, the location and the way of definition provide
                   9627:        much information about the intended use of that variable.
                   9628:        Additionally, more documentation may be found in a header
                   9629:        comment or in this pkgsrc guide.</p>
                   9630: <p>A special file is
                   9631:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   9632:        variables that are intended to be user-defined. They are either
                   9633:        defined using the <code class="literal">?=</code> operator or they are
                   9634:        left undefined because defining them to anything would
1.128     wiz      9635:        effectively mean <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. All these variables may be
1.81      rillig   9636:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   9637:        file.</p>
                   9638: <p>Outside this file, the following conventions apply:
                   9639:        Variables that are defined using the <code class="literal">?=</code>
                   9640:        operator may be overridden by a package.</p>
                   9641: <p>Variables that are defined using the <code class="literal">=</code>
                   9642:        operator may be used read-only at run-time.</p>
                   9643: <p>Variables whose name starts with an underscore must not be
                   9644:        accessed outside the pkgsrc infrastructure at all. They may
                   9645:        change without further notice.</p>
1.148     asau     9646: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81      rillig   9647: <h3 class="title">Note</h3>
                   9648: <p>These conventions are currently not applied
                   9649:        consistently to the complete pkgsrc
                   9650:        infrastructure.</p>
                   9651: </div>
                   9652: </div>
1.148     asau     9653: <div class="sect1">
1.81      rillig   9654: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9655: <a name="infr.vardef.problems"></a>26.2. Avoiding problems before they arise</h2></div></div></div>
1.81      rillig   9656: <p>All variables that contain lists of things should default
                   9657:        to being empty. Two examples that do not follow this rule are
                   9658:        <code class="varname">USE_LANGUAGES</code> and
                   9659:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   9660:        modified using the <code class="literal">+=</code> operator in package
                   9661:        <code class="filename">Makefile</code>s (or other files included by
                   9662:        them), since there is no guarantee whether the variable is
                   9663:        already set or not, and what its value is. In the case of
1.128     wiz      9664:        <code class="varname">DISTFILES</code>, the packages <span class="quote">&#8220;<span class="quote">know</span>&#8221;</span>
1.81      rillig   9665:        the default value and just define it as in the following
                   9666:        example.</p>
                   9667: <pre class="programlisting">
1.100     rillig   9668: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81      rillig   9669: </pre>
                   9670: <p>Because of the selection of this default value, the same
                   9671:        value appears in many package Makefiles. Similarly for
                   9672:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.128     wiz      9673:        value (<span class="quote">&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;</span>) is so short that it
1.81      rillig   9674:        doesn't stand out. Nevertheless it is mentioned in many
                   9675:        files.</p>
                   9676: </div>
1.148     asau     9677: <div class="sect1">
1.81      rillig   9678: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9679: <a name="infr.var"></a>26.3. Variable evaluation</h2></div></div></div>
1.148     asau     9680: <div class="sect2">
1.75      rillig   9681: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9682: <a name="infr.var.load"></a>26.3.1. At load time</h3></div></div></div>
1.75      rillig   9683: <p>Variable evaluation takes place either at load time or at
                   9684:        runtime, depending on the context in which they occur. The
                   9685:        contexts where variables are evaluated at load time are:</p>
1.148     asau     9686: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9687: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75      rillig   9688:        and <code class="literal">!=</code> operators,</p></li>
1.128     wiz      9689: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75      rillig   9690:        <code class="literal">.for</code>,</p></li>
1.128     wiz      9691: <li class="listitem"><p>Dependency lines.</p></li>
1.75      rillig   9692: </ul></div>
                   9693: <p>A special exception are references to the iteration
                   9694:        variables of <code class="literal">.for</code> loops, which are expanded
                   9695:        inline, no matter in which context they appear.</p>
                   9696: <p>As the values of variables may change during load time,
                   9697:        care must be taken not to evaluate them by accident. Typical
                   9698:        examples for variables that should not be evaluated at load time
                   9699:        are <code class="varname">DEPENDS</code> and
                   9700:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   9701:        clear, here is an example:</p>
                   9702: <pre class="programlisting">
1.100     rillig   9703: CONFIGURE_ARGS=         # none
                   9704: CFLAGS=                 -O
                   9705: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
1.1       grant    9706: 
1.100     rillig   9707: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
1.1       grant    9708: 
1.100     rillig   9709: CFLAGS+=                -Wall
1.222     sevan    9710: </pre>
1.75      rillig   9711: <p>This code shows how the use of the <code class="literal">:=</code>
                   9712:        operator can quickly lead to unexpected results. The first
                   9713:        paragraph is fairly common code. The second paragraph evaluates
                   9714:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   9715:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   9716:        <code class="literal">-Wall</code> is appended to the
                   9717:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   9718:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   9719:        paragraphs from above typically occur in completely unrelated
                   9720:        files.</p>
                   9721: </div>
1.148     asau     9722: <div class="sect2">
1.75      rillig   9723: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9724: <a name="infr.var.run"></a>26.3.2. At runtime</h3></div></div></div>
1.75      rillig   9725: <p>After all the files have been loaded, the values of the
                   9726:        variables cannot be changed anymore. Variables that are used in
                   9727:        the shell commands are expanded at this point.</p>
                   9728: </div>
                   9729: </div>
1.148     asau     9730: <div class="sect1">
1.75      rillig   9731: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9732: <a name="infr.varspec"></a>26.4. How can variables be specified?</h2></div></div></div>
1.78      rillig   9733: <p>There are many ways in which the definition and use of a
1.218     rillig   9734:        variable can be restricted in order to detect bugs and violations
                   9735:        of the (mostly unwritten) policies. A package can be checked with
                   9736:        <code class="literal">pkglint -Wall</code> to see whether it meets these
                   9737:        rules.</p>
1.78      rillig   9738: </div>
1.148     asau     9739: <div class="sect1">
1.78      rillig   9740: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9741: <a name="infr.design.intf"></a>26.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76      rillig   9742: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75      rillig   9743:        of the following classes. Cases where a file falls into more
                   9744:        than one class should be avoided as it often leads to subtle
                   9745:        bugs.</p>
1.148     asau     9746: <div class="sect2">
1.75      rillig   9747: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9748: <a name="infr.design.intf.proc"></a>26.5.1. Procedures with parameters</h3></div></div></div>
1.75      rillig   9749: <p>In a traditional imperative programming language some of
1.76      rillig   9750:        the <code class="filename">.mk</code> files could be described as
1.126     jakllsch 9751:        procedures. They take some input parameters and&mdash;after
                   9752:        inclusion&mdash;provide a result in output parameters. Since all
1.76      rillig   9753:        variables in <code class="filename">Makefile</code>s have global scope
1.75      rillig   9754:        care must be taken not to use parameter names that have already
                   9755:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   9756:        bad choice for a parameter name.</p>
                   9757: <p>Procedures are completely evaluated at preprocessing time.
                   9758:        That is, when calling a procedure all input parameters must be
                   9759:        completely resolvable. For example,
                   9760:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   9761:        parameter since it is very likely that further text will be
                   9762:        added after calling the procedure, which would effectively apply
                   9763:        the procedure to only a part of the variable. Also, references
1.218     rillig   9764:        to other variables will be modified after calling the
1.75      rillig   9765:        procedure.</p>
                   9766: <p>A procedure can declare its output parameters either as
                   9767:        suitable for use in preprocessing directives or as only
                   9768:        available at runtime. The latter alternative is for variables
                   9769:        that contain references to other runtime variables.</p>
                   9770: <p>Procedures shall be written such that it is possible to
                   9771:        call the procedure more than once. That is, the file must not
                   9772:        contain multiple-inclusion guards.</p>
                   9773: <p>Examples for procedures are
1.76      rillig   9774:        <code class="filename">mk/bsd.options.mk</code> and
                   9775:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75      rillig   9776:        that the parameters are evaluated at load time, they should be
                   9777:        assigned using the <code class="literal">:=</code> operator, which should
                   9778:        be used only for this purpose.</p>
                   9779: </div>
1.148     asau     9780: <div class="sect2">
1.75      rillig   9781: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9782: <a name="infr.design.intf.action"></a>26.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75      rillig   9783: <p>Action files take some input parameters and may define
                   9784:        runtime variables. They shall not define loadtime variables.
                   9785:        There are action files that are included implicitly by the
                   9786:        pkgsrc infrastructure, while other must be included
                   9787:        explicitly.</p>
                   9788: <p>An example for action files is
1.76      rillig   9789:        <code class="filename">mk/subst.mk</code>.</p>
1.75      rillig   9790: </div>
                   9791: </div>
1.148     asau     9792: <div class="sect1">
1.81      rillig   9793: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9794: <a name="infr.order"></a>26.6. The order in which files are loaded</h2></div></div></div>
1.81      rillig   9795: <p>Package <code class="filename">Makefile</code>s usually consist of
                   9796:        a set of variable definitions, and include the file
                   9797:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   9798:        Before that, they may also include various other
                   9799:        <code class="filename">*.mk</code> files if they need to query the
                   9800:        availability of certain features like the type of compiler or
                   9801:        the X11 implementation. Due to the heavy use of preprocessor
                   9802:        directives like <code class="literal">.if</code> and
                   9803:        <code class="literal">.for</code>, the order in which the files are loaded
                   9804:        matters.</p>
                   9805: <p>This section describes at which point the various files
                   9806:        are loaded and gives reasons for that order.</p>
1.148     asau     9807: <div class="sect2">
1.81      rillig   9808: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9809: <a name="infr.order.prefs"></a>26.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93      rillig   9810: </h3></div></div></div>
                   9811: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81      rillig   9812:        is to define some essential variables like
                   9813:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   9814:        <code class="varname">MACHINE_ARCH</code>.</p>
                   9815: <p>Then, the user settings are loaded from the file specified
1.110     hubertf  9816:        in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.104     rillig   9817:        After that, those variables
1.81      rillig   9818:        that have not been overridden by the user are loaded from
                   9819:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   9820: <p>After the user settings, the system settings and platform
                   9821:        settings are loaded, which may override the user
                   9822:        settings.</p>
                   9823: <p>Then, the tool definitions are loaded. The tool wrappers
                   9824:        are not yet in effect. This only happens when building a
                   9825:        package, so the proper variables must be used instead of the
                   9826:        direct tool names.</p>
                   9827: <p>As the last steps, some essential variables from the
                   9828:        wrapper and the package system flavor are loaded, as well as the
                   9829:        variables that have been cached in earlier phases of a package
                   9830:        build.</p>
                   9831: </div>
1.148     asau     9832: <div class="sect2">
1.81      rillig   9833: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9834: <a name="infr.order.pkg"></a>26.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93      rillig   9835: </h3></div></div></div>
1.81      rillig   9836: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   9837: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   9838:        loaded, which fill default values for those variables that have
1.93      rillig   9839:        not been defined by the package. These variables may later
1.81      rillig   9840:        be used even in unrelated files.</p>
                   9841: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   9842:        provides the target <code class="literal">error-check</code> that is added
                   9843:        as a special dependency to all other targets that use
                   9844:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   9845:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   9846: <p>Then, the package-specific hacks from
                   9847:        <code class="filename">hacks.mk</code> are included.</p>
                   9848: <p>Then, various other files follow. Most of them don't have
                   9849:        any dependencies on what they need to have included before or
                   9850:        after them, though some do.</p>
                   9851: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   9852:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   9853:        restricts the use of these variables to all the files that have
                   9854:        been included before. Appearances in later files will be
                   9855:        silently ignored.</p>
                   9856: <p>Then, the files for the main targets are included, in the
                   9857:        order of later execution, though the actual order should not
                   9858:        matter.</p>
                   9859: <p>At last, some more files are included that don't set any
                   9860:        interesting variables but rather just define make targets to be
                   9861:        executed.</p>
                   9862: </div>
                   9863: </div>
1.75      rillig   9864: </div>
1.148     asau     9865: <div class="chapter">
1.75      rillig   9866: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   9867: <a name="regression"></a>Chapter 27. Regression tests</h2></div></div></div>
1.75      rillig   9868: <div class="toc">
                   9869: <p><b>Table of Contents</b></p>
1.210     leot     9870: <dl class="toc">
1.267     rillig   9871: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
                   9872: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.75      rillig   9873: <dd><dl>
1.267     rillig   9874: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
                   9875: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.75      rillig   9876: </dl></dd>
                   9877: </dl>
                   9878: </div>
                   9879: <p>The pkgsrc infrastructure consists of a large codebase,
                   9880:        and there are many corners where every little bit of a file is
                   9881:        well thought out, making pkgsrc likely to fail as soon as
                   9882:        anything is changed near those parts. To prevent most changes
                   9883:        from breaking anything, a suite of regression tests should go
                   9884:        along with every important part of the pkgsrc infrastructure.
                   9885:        This chapter describes how regression tests work in pkgsrc and
                   9886:        how you can add new tests.</p>
1.148     asau     9887: <div class="sect1">
1.75      rillig   9888: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9889: <a name="regression.run"></a>27.1. Running the regression tests</h2></div></div></div>
1.250     leot     9890: <p>You first need to install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_regress/README.html" target="_top"><code class="filename">pkgtools/pkg_regress</code></a> package, which
1.110     hubertf  9891:        provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75      rillig   9892:        can simply run that command, which will run all tests in the
1.76      rillig   9893:        <code class="filename">regress</code> category.</p>
1.75      rillig   9894: </div>
1.148     asau     9895: <div class="sect1">
1.75      rillig   9896: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9897: <a name="regression.new"></a>27.2. Adding a new regression test</h2></div></div></div>
1.76      rillig   9898: <p>Every directory in the <code class="filename">regress</code>
                   9899:        category that contains a file called <code class="filename">spec</code>
1.75      rillig   9900:        is considered a regression test. This file is a shell program
1.110     hubertf  9901:        that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75      rillig   9902:        The following functions can be overridden to suit your
                   9903:        needs.</p>
1.148     asau     9904: <div class="sect2">
1.75      rillig   9905: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9906: <a name="regression.fun.override"></a>27.2.1. Overridable functions</h3></div></div></div>
1.218     rillig   9907: <p>These functions do not take any parameters. Although they
                   9908:        are called in <span class="quote">&#8220;<span class="quote">set -e</span>&#8221;</span> mode, they don't stop at the
                   9909:        first failing command. See <a class="ulink" href="http://stackoverflow.com/q/4072984" target="_top">this StackOverflow
                   9910:        question</a> for details.</p>
1.148     asau     9911: <div class="variablelist"><dl class="variablelist">
1.218     rillig   9912: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.75      rillig   9913: <dd><p>This function prepares the environment for the
                   9914:        test. By default it does nothing.</p></dd>
1.218     rillig   9915: <dt><span class="term"><code class="varname">do_test</code></span></dt>
                   9916: <dd>
                   9917: <p>This function runs the actual test. By default,
1.75      rillig   9918:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   9919:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   9920:        error messages into the file
1.218     rillig   9921:        <code class="varname">TEST_OUTFILE</code>.</p>
                   9922: <p>When defining this function, make sure that all output that
                   9923:        needs to be checked is written to the correct output file.
                   9924:        Example:</p>
                   9925: <pre class="programlisting">
                   9926: do_test() {
1.223     rillig   9927:         echo "Example output"
1.218     rillig   9928: } 1&gt;$TEST_OUTFILE 2&gt;&amp;1
                   9929: </pre>
                   9930: </dd>
                   9931: <dt><span class="term"><code class="varname">check_result</code></span></dt>
                   9932: <dd>
                   9933: <p>This function is run after the test and is
1.75      rillig   9934:        typically used to compare the actual output from the one that is
                   9935:        expected. It can make use of the various helper functions from
1.218     rillig   9936:        the next section. Example:</p>
                   9937: <pre class="programlisting">
                   9938: check_result() {
1.223     rillig   9939:         exit_status 0
                   9940:         output_require "Example"
                   9941:         output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
                   9942:         output_prohibit "no such file or directory"
1.218     rillig   9943: }
                   9944: </pre>
                   9945: </dd>
                   9946: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.75      rillig   9947: <dd><p>This function cleans everything up after the
                   9948:        test has been run. By default it does nothing.</p></dd>
                   9949: </dl></div>
                   9950: </div>
1.148     asau     9951: <div class="sect2">
1.75      rillig   9952: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9953: <a name="regression.fun.helper"></a>27.2.2. Helper functions</h3></div></div></div>
1.148     asau     9954: <div class="variablelist"><dl class="variablelist">
1.218     rillig   9955: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.75      rillig   9956: <dd><p>This function compares the exitcode of the
1.218     rillig   9957:        <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.75      rillig   9958:        If they differ, the test will fail.</p></dd>
1.218     rillig   9959: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
                   9960: <dd>
                   9961: <p>This function checks for each of its parameters
                   9962:        if the output from <span class="command"><strong>do_test</strong></span> matches the
1.75      rillig   9963:        extended regular expression. If it does not, the test will
1.218     rillig   9964:        fail. Example:</p>
                   9965: <pre class="programlisting">
1.219     rillig   9966: output_require "looks fine"
                   9967: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
1.218     rillig   9968: </pre>
                   9969: </dd>
1.75      rillig   9970: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
                   9971: <dd><p>This function checks for each of its parameters
1.110     hubertf  9972:        if the output from <span class="command"><strong>do_test()</strong></span> does
1.75      rillig   9973:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   9974:        If any of the regular expressions matches, the test will
                   9975:        fail.</p></dd>
                   9976: </dl></div>
                   9977: </div>
                   9978: </div>
                   9979: </div>
1.148     asau     9980: <div class="chapter">
1.75      rillig   9981: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   9982: <a name="porting"></a>Chapter 28. Porting pkgsrc</h2></div></div></div>
1.75      rillig   9983: <div class="toc">
                   9984: <p><b>Table of Contents</b></p>
1.267     rillig   9985: <dl class="toc"><dt><span class="sect1"><a href="#porting.opsys">28.1. Porting pkgsrc to a new operating system</a></span></dt></dl>
1.75      rillig   9986: </div>
                   9987: <p>The pkgsrc system has already been ported to many
                   9988:        operating systems, hardware architectures and compilers. This
                   9989:        chapter explains the necessary steps to make pkgsrc even more
                   9990:        portable.</p>
1.148     asau     9991: <div class="sect1">
1.75      rillig   9992: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9993: <a name="porting.opsys"></a>28.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75      rillig   9994: <p>To port pkgsrc to a new operating system (called
                   9995:        <code class="literal">MyOS</code> in this example), you need to touch the
                   9996:        following files:</p>
1.148     asau     9997: <div class="variablelist"><dl class="variablelist">
1.93      rillig   9998: <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   9999: <dd><p>This file contains some basic definitions, for
                   10000:        example the name of the C
                   10001:        compiler.</p></dd>
1.76      rillig   10002: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75      rillig   10003: <dd><p>Insert code that defines the variables
                   10004:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
                   10005:        <code class="varname">LOWER_OS_VERSION</code>,
                   10006:        <code class="varname">LOWER_VENDOR</code>,
                   10007:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   10008:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   10009:        appear in this file.</p></dd>
1.93      rillig   10010: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10011: <dd><p>This file contains the platform-specific
                   10012:        definitions that are used by pkgsrc. Start by copying one of the
                   10013:        other files and edit it to your
                   10014:        needs.</p></dd>
1.93      rillig   10015: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10016: <dd><p>This file defines the paths to all the tools
                   10017:        that are needed by one or the other package in pkgsrc, as well
                   10018:        as by pkgsrc itself. Find out where these tools are on your
                   10019:        platform and add them.</p></dd>
                   10020: </dl></div>
                   10021: <p>Now, you should be able to build some basic packages, like
1.250     leot     10022:        <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/perl5/README.html" target="_top"><code class="filename">lang/perl5</code></a>, <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/README.html" target="_top"><code class="filename">shells/bash</code></a>.</p>
1.75      rillig   10023: </div>
                   10024: </div>
                   10025: </div>
1.148     asau     10026: <div class="appendix">
                   10027: <div class="titlepage"><div><div><h1 class="title">
                   10028: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.75      rillig   10029: <div class="toc">
                   10030: <p><b>Table of Contents</b></p>
1.210     leot     10031: <dl class="toc">
1.75      rillig   10032: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   10033: <dd><dl>
                   10034: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   10035: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   10036: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.128     wiz      10037: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span></a></span></dt>
1.75      rillig   10038: </dl></dd>
                   10039: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   10040: </dl>
                   10041: </div>
                   10042: <p>We checked to find a piece of software that wasn't in the packages
                   10043:     collection, and picked GNU bison. Quite why someone would want to have
1.110     hubertf  10044:     <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75      rillig   10045:     present in the tree is beyond us, but it's useful for the purposes of
                   10046:     this exercise.</p>
1.148     asau     10047: <div class="sect1">
1.75      rillig   10048: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10049: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.148     asau     10050: <div class="sect2">
1.75      rillig   10051: <div class="titlepage"><div><div><h3 class="title">
                   10052: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
                   10053: <pre class="programlisting">
1.100     rillig   10054: # $NetBSD$
                   10055: #
1.1       grant    10056: 
1.100     rillig   10057: DISTNAME=       bison-1.25
                   10058: CATEGORIES=     devel
                   10059: MASTER_SITES=   ${MASTER_SITE_GNU}
1.1       grant    10060: 
1.136     dholland 10061: MAINTAINER=     pkgsrc-users@NetBSD.org
1.100     rillig   10062: HOMEPAGE=       http://www.gnu.org/software/bison/bison.html
                   10063: COMMENT=        GNU yacc clone
1.1       grant    10064: 
1.100     rillig   10065: GNU_CONFIGURE=  yes
1.152     wiz      10066: INFO_FILES=     yes
1.1       grant    10067: 
1.100     rillig   10068: .include "../../mk/bsd.pkg.mk"
1.1       grant    10069: </pre>
1.75      rillig   10070: </div>
1.148     asau     10071: <div class="sect2">
1.75      rillig   10072: <div class="titlepage"><div><div><h3 class="title">
                   10073: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
                   10074: <pre class="programlisting">
1.100     rillig   10075: GNU version of yacc.  Can make re-entrant parsers, and numerous other
1.270     leot     10076: improvements.  Why you would want this when Berkeley <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?yacc+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.100     rillig   10077: of the NetBSD source tree is beyond me.
1.1       grant    10078: </pre>
1.75      rillig   10079: </div>
1.148     asau     10080: <div class="sect2">
1.75      rillig   10081: <div class="titlepage"><div><div><h3 class="title">
                   10082: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
                   10083: <pre class="programlisting">
1.100     rillig   10084: @comment $NetBSD$
                   10085: bin/bison
                   10086: man/man1/bison.1.gz
                   10087: share/bison.simple
                   10088: share/bison.hairy
1.1       grant    10089: </pre>
1.75      rillig   10090: </div>
1.148     asau     10091: <div class="sect2">
1.75      rillig   10092: <div class="titlepage"><div><div><h3 class="title">
1.110     hubertf  10093: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.93      rillig   10094: </h3></div></div></div>
1.75      rillig   10095: <p>The NetBSD package system comes with
1.250     leot     10096:         <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.75      rillig   10097:        which helps to check the contents of these
                   10098:        files. After installation it is quite easy to use, just change to the
                   10099:        directory of the package you wish to examine and execute
1.110     hubertf  10100:        <span class="command"><strong>pkglint</strong></span>:</p>
1.75      rillig   10101: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
                   10102: looks fine.</pre>
                   10103: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.110     hubertf  10104:        more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.75      rillig   10105:        -Wall</strong></span> for a very thorough check.</p>
                   10106: </div>
                   10107: </div>
1.148     asau     10108: <div class="sect1">
1.75      rillig   10109: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10110: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
                   10111: <p>Create the directory where the package lives,
                   10112:       plus any auxiliary directories:</p>
                   10113: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   10114: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   10115: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   10116: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76      rillig   10117: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.267     rillig   10118:       <code class="filename">PLIST</code> (see <a class="xref" href="#components" title="Chapter 13. Package components - files, directories and contents">Chapter 13, <i>Package components - files, directories and contents</i></a>)
1.75      rillig   10119:       then continue with fetching the distfile:</p>
                   10120: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1       grant    10121: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   10122: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   10123: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10124: ftp: Error retrieving file: 500 Internal error
                   10125: 
                   10126: &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   10127: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10128: ftp: Error retrieving file: 500 Internal error
                   10129: 
                   10130: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   10131: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75      rillig   10132: Successfully retrieved file.</pre>
                   10133: <p>Generate the checksum of the distfile into
1.76      rillig   10134:       <code class="filename">distinfo</code>:</p>
1.88      wiz      10135: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75      rillig   10136: <p>Now compile:</p>
                   10137: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10138: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10139: ===&gt;  Extracting for bison-1.25
                   10140: ===&gt;  Patching for bison-1.25
                   10141: ===&gt;   Ignoring empty patch directory
                   10142: ===&gt;  Configuring for bison-1.25
                   10143: creating cache ./config.cache
                   10144: checking for gcc... cc
                   10145: checking whether we are using GNU C... yes
                   10146: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   10147: checking how to run the C preprocessor... cc -E
                   10148: checking for minix/config.h... no
                   10149: checking for POSIXized ISC... no
                   10150: checking whether cross-compiling... no
                   10151: checking for ANSI C header files... yes
                   10152: checking for string.h... yes
                   10153: checking for stdlib.h... yes
                   10154: checking for memory.h... yes
                   10155: checking for working const... yes
                   10156: checking for working alloca.h... no
                   10157: checking for alloca... yes
                   10158: checking for strerror... yes
                   10159: updating cache ./config.cache
                   10160: creating ./config.status
                   10161: creating Makefile
                   10162: ===&gt;  Building for bison-1.25
                   10163: 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
                   10164: 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
                   10165: 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
                   10166: 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
                   10167: 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   10168: 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    10169: 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
                   10170: 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
                   10171: 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
                   10172: 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
                   10173: 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
                   10174: 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
                   10175: 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
                   10176: 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
                   10177: 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
                   10178: 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
                   10179: 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
                   10180: 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
                   10181: 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
                   10182: 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
                   10183: 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
                   10184: 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
                   10185: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   10186: rm -f bison.s1
1.75      rillig   10187: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   10188: <p>Everything seems OK, so install the files:</p>
                   10189: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10190: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10191: ===&gt;  Installing for bison-1.25
                   10192: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   10193: rm -f /usr/pkg/bin/bison
                   10194: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   10195: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   10196: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   10197: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   10198: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   10199: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   10200: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75      rillig   10201: ===&gt;  Registering installation for bison-1.25</pre>
                   10202: <p>You can now use bison, and also - if you decide so - remove it with
1.110     hubertf  10203:       <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75      rillig   10204:       binary package, do this now:</p>
                   10205: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10206: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10207: ===&gt;  Building package for bison-1.25
                   10208: Creating package bison-1.25.tgz
                   10209: Registering depends:.
1.75      rillig   10210: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   10211: <p>Now that you don't need the source and object files
                   10212:       any more, clean up:</p>
                   10213: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   10214: ===&gt;  Cleaning for bison-1.25</pre>
                   10215: </div>
                   10216: </div>
1.148     asau     10217: <div class="appendix">
                   10218: <div class="titlepage"><div><div><h1 class="title">
                   10219: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.75      rillig   10220: <div class="toc">
                   10221: <p><b>Table of Contents</b></p>
1.210     leot     10222: <dl class="toc">
1.75      rillig   10223: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                   10224: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                   10225: </dl>
                   10226: </div>
1.148     asau     10227: <div class="sect1">
1.75      rillig   10228: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10229: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
                   10230: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10231: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10232: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   10233: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   10234: =&gt; [172219 bytes]
                   10235: Connected to ftp.plig.net.
                   10236: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   10237: 331 Guest login ok, send your complete e-mail address as password.
                   10238: 230-You are user #5 of 500 simultaneous users allowed.
                   10239: 230-
1.68      rillig   10240: 230-  ___ _             _ _
                   10241: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
1.1       grant    10242: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   10243: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   10244: 230-         |_|   |_|     |___|         |___|
                   10245: 230-
                   10246: 230-** Welcome to ftp.plig.org **
                   10247: 230-
                   10248: 230-Please note that all transfers from this FTP site are logged. If you
                   10249: 230-do not like this, please disconnect now.
                   10250: 230-
1.120     snj      10251: 230-This archive is available via
1.1       grant    10252: 230-
                   10253: 230-HTTP:  http://ftp.plig.org/
                   10254: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   10255: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   10256: 230-
                   10257: 230-Please email comments, bug reports and requests for packages to be
1.68      rillig   10258: 230-mirrored to ftp-admin@plig.org.
1.1       grant    10259: 230-
                   10260: 230-
                   10261: 230 Logged in anonymously.
                   10262: Remote system type is UNIX.
                   10263: Using binary mode to transfer files.
                   10264: 200 Type okay.
                   10265: 250 "/pub" is new cwd.
                   10266: 250-"/pub/figlet" is new cwd.
                   10267: 250-
                   10268: 250-Welcome to the figlet archive at ftp.figlet.org
1.68      rillig   10269: 250-
1.75      rillig   10270: 250-   ftp://ftp.figlet.org/pub/figlet/
1.1       grant    10271: 250-
                   10272: 250-The official FIGlet web page is:
1.75      rillig   10273: 250-   http://www.figlet.org/
1.1       grant    10274: 250-
                   10275: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   10276: 250-contribute a font or something else, you can email us.
1.68      rillig   10277: 250
1.1       grant    10278: 250 "/pub/figlet/program" is new cwd.
                   10279: 250 "/pub/figlet/program/unix" is new cwd.
                   10280: local: figlet221.tar.gz remote: figlet221.tar.gz
                   10281: 502 Unimplemented command.
                   10282: 227 Entering Passive Mode (195,40,6,41,246,104)
                   10283: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   10284: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   10285: 226 Transfer completed.
                   10286: 172219 bytes received in 00:02 (75.99 KB/s)
                   10287: 221 Goodbye.
                   10288: =&gt; Checksum OK for figlet221.tar.gz.
                   10289: ===&gt; Extracting for figlet-2.2.1nb2
                   10290: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   10291: ===&gt; Patching for figlet-2.2.1nb2
                   10292: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   10293: ===&gt; Overriding tools for figlet-2.2.1nb2
                   10294: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   10295: ===&gt; Configuring for figlet-2.2.1nb2
                   10296: ===&gt; Building for figlet-2.2.1nb2
                   10297: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   10298: chmod a+x figlet
                   10299: gcc -O2 -o chkfont chkfont.c
                   10300: =&gt; Unwrapping files-to-be-installed.
1.14      xtraeme  10301: <code class="prompt">#</code>
1.75      rillig   10302: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10303: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10304: ===&gt; Installing for figlet-2.2.1nb2
                   10305: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   10306: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   10307: mkdir -p /usr/pkg/share/figlet
                   10308: cp figlet /usr/pkg/bin
                   10309: cp chkfont /usr/pkg/bin
                   10310: chmod 555 figlist showfigfonts
                   10311: cp figlist /usr/pkg/bin
                   10312: cp showfigfonts /usr/pkg/bin
                   10313: cp fonts/*.flf /usr/pkg/share/figlet
                   10314: cp fonts/*.flc /usr/pkg/share/figlet
                   10315: cp figlet.6 /usr/pkg/man/man6
                   10316: ===&gt; Registering installation for figlet-2.2.1nb2
1.75      rillig   10317: <code class="prompt">#</code></pre>
                   10318: </div>
1.148     asau     10319: <div class="sect1">
1.75      rillig   10320: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10321: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
                   10322: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10323: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10324: ===&gt; Packaging figlet-2.2.1nb2
                   10325: ===&gt; Building binary package for figlet-2.2.1nb2
                   10326: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   10327: Using SrcDir value of /usr/pkg
1.68      rillig   10328: Registering depends:.
1.75      rillig   10329: <code class="prompt">#</code></pre>
                   10330: </div>
                   10331: </div>
1.148     asau     10332: <div class="appendix">
                   10333: <div class="titlepage"><div><div><h1 class="title">
                   10334: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.76      rillig   10335: <div class="toc">
                   10336: <p><b>Table of Contents</b></p>
1.210     leot     10337: <dl class="toc">
1.128     wiz      10338: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                   10339: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                   10340: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                   10341: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                   10342: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
1.261     leot     10343: <code class="filename">stable</code>,
1.128     wiz      10344: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   10345: source packages</a></span></dt>
                   10346: </dl>
                   10347: </div>
                   10348: <p>As in other big projects, the directory layout of pkgsrc
                   10349:        is quite complex for newbies. This chapter explains where you
                   10350:        find things on the FTP server. The base directory on
1.110     hubertf  10351:        <code class="filename">ftp.NetBSD.org</code> is <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top"><code class="filename">/pub/pkgsrc/</code></a>.
1.89      rillig   10352:        On other servers it may be different, but inside this directory,
                   10353:        everything should look the same, no matter on which server you
                   10354:        are. This directory contains some subdirectories, which are
                   10355:        explained below.</p>
1.148     asau     10356: <div class="sect1">
1.76      rillig   10357: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10358: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.76      rillig   10359: <p>The directory <code class="filename">distfiles</code> contains lots
                   10360:        of archive files from all pkgsrc packages, which are mirrored
                   10361:        here. The subdirectories are called after their package names
                   10362:        and are used when the distributed files have names that don't
                   10363:        explicitly contain a version number or are otherwise too generic
                   10364:        (for example <code class="filename">release.tar.gz</code>).</p>
                   10365: </div>
1.148     asau     10366: <div class="sect1">
1.76      rillig   10367: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10368: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.76      rillig   10369: <p>This directory contains things that individual pkgsrc
                   10370:        developers find worth publishing.</p>
                   10371: </div>
1.148     asau     10372: <div class="sect1">
1.76      rillig   10373: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10374: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.102     rillig   10375: <p>This directory contains binary packages for the various
                   10376:        platforms that are supported by pkgsrc.
                   10377:        Each subdirectory is of the form <em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>OSVERSION_TAG</code></em>. The meaning of these variables is:</p>
1.148     asau     10378: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10379: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.109     rillig   10380:        operating system for which the packages have been built. The
1.110     hubertf  10381:        name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.109     rillig   10382:        command, so it may differ from the one you are used to
                   10383:        hear.</p></li>
1.128     wiz      10384: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.108     rillig   10385:        architecture of the platform for which the packages have been
1.110     hubertf  10386:        built. It also includes the <code class="varname">ABI</code> (Application
                   10387:        Binary Interface) for platforms that have several of
                   10388:        them.</p></li>
1.128     wiz      10389: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.108     rillig   10390:        the operating system. For version numbers that change often (for
                   10391:        example NetBSD-current), the often-changing part should be
                   10392:        replaced with an <code class="literal">x</code>, for example
                   10393:        <code class="literal">4.99.x</code>.</p></li>
1.128     wiz      10394: <li class="listitem"><p><code class="varname">TAG</code> is either
1.126     jakllsch 10395:        <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.108     rillig   10396:        for a stable branch, or <code class="literal">head</code> for packages
                   10397:        built from the HEAD branch. The latter should only be used when
                   10398:        the packages are updated on a regular basis. Otherwise the date
                   10399:        from checking out pkgsrc should be appended, for example
                   10400:        <code class="literal">head_20071015</code>.</p></li>
1.102     rillig   10401: </ul></div>
                   10402: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
                   10403:        can quickly click through the directories on the
                   10404:        server and find the best binary packages for their machines. Since they
                   10405:        usually know the operating system and the hardware architecture, OPSYS
                   10406:        and ARCH are placed first. After these choices, they can select the
                   10407:        best combination of OSVERSION and TAG together, since it is usually the
                   10408:        case that packages stay compatible between different version of the
                   10409:        operating system.</p>
                   10410: <p>In each of these directories, there is a
                   10411:        whole binary packages collection for a specific platform. It has a directory called
1.76      rillig   10412:        <code class="filename">All</code> which contains all binary packages.
                   10413:        Besides that, there are various category directories that
                   10414:        contain symbolic links to the real binary packages.</p>
                   10415: </div>
1.148     asau     10416: <div class="sect1">
1.76      rillig   10417: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10418: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108     rillig   10419: <p>Here are the reports from bulk builds, for those who want
                   10420:        to fix packages that didn't build on some of the platforms. The
1.128     wiz      10421:        structure of subdirectories should look like the one in <a class="xref" href="#ftp-packages" title="C.3. packages: Binary packages">Section C.3, &#8220;<code class="filename">packages</code>: Binary packages&#8221;</a>.</p>
1.108     rillig   10422: </div>
1.148     asau     10423: <div class="sect1">
1.108     rillig   10424: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10425: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
1.261     leot     10426: <code class="filename">stable</code>,
1.126     jakllsch 10427: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   10428: source packages</h2></div></div></div>
1.128     wiz      10429: <p>These directories contain the <span class="quote">&#8220;<span class="quote">real</span>&#8221;</span> pkgsrc,
1.76      rillig   10430:        that is the files that define how to create binary packages from
                   10431:        source archives.</p>
1.262     leot     10432: <p>Each of the <code class="filename">current</code>,
                   10433:        <code class="filename">stable</code> and
                   10434:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   10435:        directories share the same structure.  They each contain a
                   10436:        <code class="filename">pkgsrc</code> directory and
                   10437:        <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.76      rillig   10438: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89      rillig   10439:        snapshot of the CVS repository, which is updated regularly. The
1.262     leot     10440:        file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
                   10441:        as the directory, ready to be downloaded as a whole.</p>
                   10442: <p>The <code class="filename">current</code> directory contains files
                   10443:        related to the HEAD branch of the CVS repository.
                   10444:        In this directory there is an additional file called
                   10445:        <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
                   10446:        all pkgsrc <code class="filename">README</code>s with information about
                   10447:        categories and packages.
                   10448:        </p>
                   10449: <p>The <code class="filename">stable</code> directory is a symlink to
                   10450:        the latest 
                   10451:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
                   10452:        </p>
                   10453: <p>The
                   10454:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
                   10455:        directories contain files related to the 
                   10456:        <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   10457:        stable branch of the CVS repository. In these directories there is
                   10458:        an additional file called
                   10459:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em>.tar.{bz,gz,xz}</code>,
1.76      rillig   10460:        which contains the state of pkgsrc when it was branched.</p>
                   10461: </div>
1.75      rillig   10462: </div>
1.148     asau     10463: <div class="appendix">
                   10464: <div class="titlepage"><div><div><h1 class="title">
1.267     rillig   10465: <a name="help-topics"></a>Appendix D. Help topics</h1></div></div></div>
                   10466: <p>
                   10467:        The following list contains all help topics that are available
                   10468:        when running <span class="command"><strong>bmake help topic=:index</strong></span>.
                   10469: </p>
1.269     leot     10470: <table border="0" summary="Simple list" class="simplelist">
                   10471: <tr>
                   10472: <td>#!</td>
                   10473: <td>-lintl</td>
                   10474: </tr>
                   10475: <tr>
                   10476: <td>64bit</td>
                   10477: <td>ABI</td>
                   10478: </tr>
                   10479: <tr>
                   10480: <td>ACCEPTABLE_LICENSES</td>
                   10481: <td>ACROREAD_FONTPATH</td>
                   10482: </tr>
                   10483: <tr>
                   10484: <td>ADDITIONAL</td>
                   10485: <td>AFAIK</td>
                   10486: </tr>
                   10487: <tr>
                   10488: <td>AIX</td>
                   10489: <td>ALLOW_VULNERABLE_PACKAGES</td>
                   10490: </tr>
                   10491: <tr>
                   10492: <td>ALL_ENV</td>
1.273   ! brook    10493: <td>ALTERNATIVES_SRC</td>
1.269     leot     10494: </tr>
                   10495: <tr>
                   10496: <td>AMANDA_TMP</td>
1.273   ! brook    10497: <td>AMANDA_USER</td>
1.269     leot     10498: </tr>
                   10499: <tr>
                   10500: <td>AMANDA_VAR</td>
1.273   ! brook    10501: <td>APACHE_GROUP</td>
1.269     leot     10502: </tr>
                   10503: <tr>
                   10504: <td>APACHE_MODULE_NAME</td>
1.273   ! brook    10505: <td>APACHE_MODULE_SRC</td>
1.269     leot     10506: </tr>
                   10507: <tr>
                   10508: <td>APACHE_MODULE_SRCDIR</td>
1.273   ! brook    10509: <td>APACHE_PKG_PREFIX</td>
1.269     leot     10510: </tr>
                   10511: <tr>
                   10512: <td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
1.273   ! brook    10513: <td>APACHE_SUEXEC_DOCROOT</td>
1.269     leot     10514: </tr>
                   10515: <tr>
                   10516: <td>APACHE_USER</td>
1.273   ! brook    10517: <td>APPEND_ABI</td>
1.269     leot     10518: </tr>
                   10519: <tr>
                   10520: <td>APPEND_ELF</td>
1.273   ! brook    10521: <td>ARLA_CACHE</td>
1.269     leot     10522: </tr>
                   10523: <tr>
                   10524: <td>AUDIT_PACKAGES_FLAGS</td>
1.273   ! brook    10525: <td>AUTOCONF_REQD</td>
1.269     leot     10526: </tr>
                   10527: <tr>
                   10528: <td>AUTOMAKE_OVERRIDE</td>
1.273   ! brook    10529: <td>AUTOMAKE_REQD</td>
1.269     leot     10530: </tr>
                   10531: <tr>
                   10532: <td>AUTO_MKDIRS</td>
1.273   ! brook    10533: <td>BDB185_DEFAULT</td>
1.269     leot     10534: </tr>
                   10535: <tr>
                   10536: <td>BDBBASE</td>
1.273   ! brook    10537: <td>BDB_ACCEPTED</td>
1.269     leot     10538: </tr>
                   10539: <tr>
                   10540: <td>BDB_DEFAULT</td>
1.273   ! brook    10541: <td>BDB_LIBS</td>
1.269     leot     10542: </tr>
                   10543: <tr>
                   10544: <td>BDB_TYPE</td>
1.273   ! brook    10545: <td>BIND_DIR</td>
1.269     leot     10546: </tr>
                   10547: <tr>
                   10548: <td>BIND_GROUP</td>
1.273   ! brook    10549: <td>BIND_USER</td>
1.269     leot     10550: </tr>
                   10551: <tr>
                   10552: <td>BINPKG_SITES</td>
1.273   ! brook    10553: <td>BIN_INSTALL_FLAGS</td>
1.269     leot     10554: </tr>
                   10555: <tr>
                   10556: <td>BISON_PKGDATADIR</td>
                   10557: <td>BOOTSTRAP_DEPENDS</td>
                   10558: </tr>
                   10559: <tr>
                   10560: <td>BOOTSTRAP_SETUPTOOLS</td>
                   10561: <td>BROKEN</td>
                   10562: </tr>
                   10563: <tr>
                   10564: <td>BROKEN_EXCEPT_ON_PLATFORM</td>
                   10565: <td>BROKEN_ON_PLATFORM</td>
                   10566: </tr>
                   10567: <tr>
                   10568: <td>BSDSRCDIR</td>
                   10569: <td>BSDXSRCDIR</td>
                   10570: </tr>
                   10571: <tr>
                   10572: <td>BSD_MAKE_ENV</td>
                   10573: <td>BUILDLINK_AUTO_DIRS</td>
                   10574: </tr>
                   10575: <tr>
                   10576: <td>BUILDLINK_AUTO_VARS</td>
                   10577: <td>BUILDLINK_CFLAGS</td>
                   10578: </tr>
                   10579: <tr>
                   10580: <td>BUILDLINK_CONTENTS_FILTER</td>
                   10581: <td>BUILDLINK_CPPFLAGS</td>
                   10582: </tr>
                   10583: <tr>
                   10584: <td>BUILDLINK_DEPMETHOD</td>
                   10585: <td>BUILDLINK_FILES</td>
                   10586: </tr>
                   10587: <tr>
                   10588: <td>BUILDLINK_FILES_CMD</td>
                   10589: <td>BUILDLINK_FNAME_TRANSFORM</td>
                   10590: </tr>
                   10591: <tr>
                   10592: <td>BUILDLINK_LDFLAGS</td>
                   10593: <td>BUILDLINK_LIBS</td>
                   10594: </tr>
                   10595: <tr>
                   10596: <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
                   10597: <td>BUILDLINK_PKGNAME</td>
                   10598: </tr>
                   10599: <tr>
                   10600: <td>BUILDLINK_PREFIX</td>
                   10601: <td>BUILDLINK_RPATHDIRS</td>
                   10602: </tr>
                   10603: <tr>
                   10604: <td>BUILDLINK_TREE</td>
                   10605: <td>BUILD_DEFS</td>
                   10606: </tr>
                   10607: <tr>
                   10608: <td>BUILD_DEFS_EFFECTS</td>
                   10609: <td>BUILD_DEPENDS</td>
                   10610: </tr>
                   10611: <tr>
                   10612: <td>BUILD_DIRS</td>
                   10613: <td>BUILD_ENV_SHELL</td>
                   10614: </tr>
                   10615: <tr>
                   10616: <td>BUILD_MAKE_CMD</td>
                   10617: <td>BUILD_MAKE_FLAGS</td>
                   10618: </tr>
                   10619: <tr>
                   10620: <td>BUILD_TARGET</td>
                   10621: <td>BUILTIN_FIND_FILES</td>
                   10622: </tr>
                   10623: <tr>
                   10624: <td>BUILTIN_FIND_FILES_VAR</td>
                   10625: <td>BUILTIN_FIND_GREP</td>
                   10626: </tr>
                   10627: <tr>
                   10628: <td>BUILTIN_FIND_HEADERS</td>
                   10629: <td>BUILTIN_FIND_HEADERS_VAR</td>
                   10630: </tr>
                   10631: <tr>
                   10632: <td>BUILTIN_PKG</td>
                   10633: <td>BUILTIN_TEST_CURSES_DEFINES</td>
                   10634: </tr>
                   10635: <tr>
                   10636: <td>BUILTIN_TEST_CURSES_FUNCS</td>
                   10637: <td>BUILTIN_VERSION_SCRIPT</td>
                   10638: </tr>
                   10639: <tr>
                   10640: <td>BUILTIN_X11_TYPE</td>
                   10641: <td>BUILTIN_X11_VERSION</td>
                   10642: </tr>
                   10643: <tr>
                   10644: <td>CACTI_GROUP</td>
                   10645: <td>CACTI_USER</td>
                   10646: </tr>
                   10647: <tr>
                   10648: <td>CANNA_GROUP</td>
                   10649: <td>CANNA_USER</td>
                   10650: </tr>
                   10651: <tr>
                   10652: <td>CAT</td>
                   10653: <td>CCACHE_BASE</td>
                   10654: </tr>
                   10655: <tr>
                   10656: <td>CCACHE_DIR</td>
                   10657: <td>CCACHE_LOGFILE</td>
                   10658: </tr>
                   10659: <tr>
                   10660: <td>CC_VERSION</td>
                   10661: <td>CC_VERSION_STRING</td>
                   10662: </tr>
                   10663: <tr>
                   10664: <td>CDRECORD_CONF</td>
                   10665: <td>CDROM_PKG_URL_DIR</td>
                   10666: </tr>
                   10667: <tr>
                   10668: <td>CDROM_PKG_URL_HOST</td>
1.273   ! brook    10669: <td>CHECK_FAKEHOME</td>
1.269     leot     10670: </tr>
                   10671: <tr>
                   10672: <td>CHECK_FILES</td>
1.273   ! brook    10673: <td>CHECK_FILES_SKIP</td>
1.269     leot     10674: </tr>
                   10675: <tr>
                   10676: <td>CHECK_FILES_STRICT</td>
1.273   ! brook    10677: <td>CHECK_HEADERS</td>
1.269     leot     10678: </tr>
                   10679: <tr>
                   10680: <td>CHECK_HEADERS_SKIP</td>
1.273   ! brook    10681: <td>CHECK_INTERPRETER</td>
1.269     leot     10682: </tr>
                   10683: <tr>
                   10684: <td>CHECK_INTERPRETER_SKIP</td>
1.273   ! brook    10685: <td>CHECK_PERMS</td>
1.269     leot     10686: </tr>
                   10687: <tr>
                   10688: <td>CHECK_PERMS_AUTOFIX</td>
1.273   ! brook    10689: <td>CHECK_PERMS_SKIP</td>
1.269     leot     10690: </tr>
                   10691: <tr>
                   10692: <td>CHECK_PORTABILITY</td>
1.273   ! brook    10693: <td>CHECK_PORTABILITY_SKIP</td>
1.269     leot     10694: </tr>
                   10695: <tr>
                   10696: <td>CHECK_RELRO</td>
1.273   ! brook    10697: <td>CHECK_RELRO_SKIP</td>
1.269     leot     10698: </tr>
                   10699: <tr>
                   10700: <td>CHECK_RELRO_SUPPORTED</td>
1.273   ! brook    10701: <td>CHECK_SHLIBS</td>
1.269     leot     10702: </tr>
                   10703: <tr>
                   10704: <td>CHECK_SHLIBS_BLACKLIST</td>
1.273   ! brook    10705: <td>CHECK_SHLIBS_SKIP</td>
1.269     leot     10706: </tr>
                   10707: <tr>
                   10708: <td>CHECK_SHLIBS_SUPPORTED</td>
1.273   ! brook    10709: <td>CHECK_SSP</td>
1.269     leot     10710: </tr>
                   10711: <tr>
                   10712: <td>CHECK_SSP_SKIP</td>
1.273   ! brook    10713: <td>CHECK_SSP_SUPPORTED</td>
1.269     leot     10714: </tr>
                   10715: <tr>
                   10716: <td>CHECK_STRIPPED</td>
1.273   ! brook    10717: <td>CHECK_STRIPPED_SKIP</td>
1.269     leot     10718: </tr>
                   10719: <tr>
                   10720: <td>CHECK_WRKREF</td>
1.273   ! brook    10721: <td>CHECK_WRKREF_EXTRA_DIRS</td>
1.269     leot     10722: </tr>
                   10723: <tr>
                   10724: <td>CHECK_WRKREF_SKIP</td>
1.273   ! brook    10725: <td>CLAMAV_DBDIR</td>
1.269     leot     10726: </tr>
                   10727: <tr>
                   10728: <td>CLAMAV_GROUP</td>
1.273   ! brook    10729: <td>CLAMAV_USER</td>
1.269     leot     10730: </tr>
                   10731: <tr>
                   10732: <td>CLANGBASE</td>
1.273   ! brook    10733: <td>CLEANDEPENDS</td>
1.269     leot     10734: </tr>
                   10735: <tr>
                   10736: <td>CMAKE_DEPENDENCIES_REWRITE</td>
1.273   ! brook    10737: <td>CMAKE_INSTALL_PREFIX</td>
1.269     leot     10738: </tr>
                   10739: <tr>
                   10740: <td>CMAKE_MODULE_PATH_OVERRIDE</td>
1.273   ! brook    10741: <td>CMAKE_PKGSRC_BUILD_FLAGS</td>
1.269     leot     10742: </tr>
                   10743: <tr>
                   10744: <td>CMAKE_PREFIX_PATH</td>
                   10745: <td>CMAKE_USE_GNU_INSTALL_DIRS</td>
                   10746: </tr>
                   10747: <tr>
                   10748: <td>COMPILER_RPATH_FLAG</td>
                   10749: <td>COMPILER_USE_SYMLINKS</td>
                   10750: </tr>
                   10751: <tr>
                   10752: <td>CONFIGURE_ARGS</td>
                   10753: <td>CONFIGURE_DIRS</td>
                   10754: </tr>
                   10755: <tr>
                   10756: <td>CONFIGURE_ENV</td>
                   10757: <td>CONFIGURE_HAS_INFODIR</td>
                   10758: </tr>
                   10759: <tr>
                   10760: <td>CONFIGURE_HAS_MANDIR</td>
                   10761: <td>CONFIGURE_SCRIPT</td>
                   10762: </tr>
                   10763: <tr>
                   10764: <td>CONFIG_SHELL</td>
                   10765: <td>CONFIG_SHELL_FLAGS</td>
                   10766: </tr>
                   10767: <tr>
                   10768: <td>CONF_FILES</td>
                   10769: <td>CONF_FILES_MODE</td>
                   10770: </tr>
                   10771: <tr>
                   10772: <td>CONF_FILES_PERMS</td>
                   10773: <td>CONSERVER_DEFAULTHOST</td>
                   10774: </tr>
                   10775: <tr>
                   10776: <td>CONSERVER_DEFAULTPORT</td>
                   10777: <td>CP</td>
                   10778: </tr>
                   10779: <tr>
                   10780: <td>CPP</td>
                   10781: <td>CPP_PRECOMP_FLAGS</td>
                   10782: </tr>
                   10783: <tr>
                   10784: <td>CREATE_WRKDIR_SYMLINK</td>
                   10785: <td>CROSSBASE</td>
                   10786: </tr>
                   10787: <tr>
                   10788: <td>CTFCONVERT</td>
                   10789: <td>CTF_FILES_SKIP</td>
                   10790: </tr>
                   10791: <tr>
                   10792: <td>CTF_SUPPORTED</td>
                   10793: <td>CTYPE</td>
                   10794: </tr>
                   10795: <tr>
                   10796: <td>CUPS_GROUP</td>
                   10797: <td>CUPS_SYSTEM_GROUPS</td>
                   10798: </tr>
                   10799: <tr>
                   10800: <td>CUPS_USER</td>
                   10801: <td>CURSES_DEFAULT</td>
                   10802: </tr>
                   10803: <tr>
                   10804: <td>CURSES_TYPE</td>
1.273   ! brook    10805: <td>CXX</td>
1.269     leot     10806: </tr>
                   10807: <tr>
                   10808: <td>CYRUS_GROUP</td>
1.273   ! brook    10809: <td>CYRUS_IDLE</td>
1.269     leot     10810: </tr>
                   10811: <tr>
                   10812: <td>CYRUS_USER</td>
1.273   ! brook    10813: <td>DAEMONTOOLS_GROUP</td>
1.269     leot     10814: </tr>
                   10815: <tr>
                   10816: <td>DAEMONTOOLS_LOG_USER</td>
1.273   ! brook    10817: <td>DBUS_GROUP</td>
1.269     leot     10818: </tr>
                   10819: <tr>
                   10820: <td>DBUS_USER</td>
1.273   ! brook    10821: <td>DEFANG_GROUP</td>
1.269     leot     10822: </tr>
                   10823: <tr>
                   10824: <td>DEFANG_USER</td>
1.273   ! brook    10825: <td>DEFAULT_ACCEPTABLE_LICENSES</td>
1.269     leot     10826: </tr>
                   10827: <tr>
                   10828: <td>DEFAULT_DISTFILES</td>
1.273   ! brook    10829: <td>DEFAULT_IRC_SERVER</td>
1.269     leot     10830: </tr>
                   10831: <tr>
                   10832: <td>DEFAULT_SERIAL_DEVICE</td>
1.273   ! brook    10833: <td>DEF_UMASK</td>
1.269     leot     10834: </tr>
                   10835: <tr>
                   10836: <td>DEINSTALLDEPENDS</td>
1.273   ! brook    10837: <td>DEINSTALL_SRC</td>
1.269     leot     10838: </tr>
                   10839: <tr>
                   10840: <td>DEINSTALL_TEMPLATES</td>
1.273   ! brook    10841: <td>DELAYED_ERROR_MSG</td>
1.269     leot     10842: </tr>
                   10843: <tr>
                   10844: <td>DELAYED_WARNING_MSG</td>
1.273   ! brook    10845: <td>DEPENDS</td>
1.269     leot     10846: </tr>
                   10847: <tr>
                   10848: <td>DEPENDS_TARGET</td>
1.273   ! brook    10849: <td>DEPENDS_TYPE</td>
1.269     leot     10850: </tr>
                   10851: <tr>
                   10852: <td>DESTDIR</td>
1.273   ! brook    10853: <td>DESTDIR_VARNAME</td>
1.269     leot     10854: </tr>
                   10855: <tr>
                   10856: <td>DIALER_GROUP</td>
1.273   ! brook    10857: <td>DIGEST_REQD</td>
1.269     leot     10858: </tr>
                   10859: <tr>
                   10860: <td>DISTDIR</td>
1.273   ! brook    10861: <td>DISTFILES</td>
1.269     leot     10862: </tr>
                   10863: <tr>
                   10864: <td>DISTINFO_FILE</td>
1.273   ! brook    10865: <td>DISTNAME</td>
1.269     leot     10866: </tr>
                   10867: <tr>
                   10868: <td>DIST_PATH</td>
1.273   ! brook    10869: <td>DIST_SUBDIR</td>
1.269     leot     10870: </tr>
                   10871: <tr>
                   10872: <td>DJBDNS_AXFR_USER</td>
1.273   ! brook    10873: <td>DJBDNS_CACHE_USER</td>
1.269     leot     10874: </tr>
                   10875: <tr>
                   10876: <td>DJBDNS_DJBDNS_GROUP</td>
1.273   ! brook    10877: <td>DJBDNS_LOG_USER</td>
1.269     leot     10878: </tr>
                   10879: <tr>
                   10880: <td>DJBDNS_RBL_USER</td>
1.273   ! brook    10881: <td>DJBDNS_TINY_USER</td>
1.269     leot     10882: </tr>
                   10883: <tr>
                   10884: <td>DLOPEN_REQUIRE_PTHREADS</td>
1.273   ! brook    10885: <td>DL_AUTO_VARS</td>
1.269     leot     10886: </tr>
                   10887: <tr>
                   10888: <td>DL_CFLAGS</td>
1.273   ! brook    10889: <td>DL_LDFLAGS</td>
1.269     leot     10890: </tr>
                   10891: <tr>
                   10892: <td>DL_LIBS</td>
1.273   ! brook    10893: <td>DNS</td>
1.269     leot     10894: </tr>
                   10895: <tr>
                   10896: <td>DOWNLOADED_DISTFILE</td>
1.273   ! brook    10897: <td>DT_LAYOUT</td>
1.269     leot     10898: </tr>
                   10899: <tr>
                   10900: <td>DYNAMIC_SITES_CMD</td>
1.273   ! brook    10901: <td>DYNAMIC_SITES_SCRIPT</td>
1.269     leot     10902: </tr>
                   10903: <tr>
                   10904: <td>ECHO</td>
1.273   ! brook    10905: <td>ECHO_N</td>
1.269     leot     10906: </tr>
                   10907: <tr>
                   10908: <td>ELK_GUI</td>
1.273   ! brook    10909: <td>EMACS_TYPE</td>
1.269     leot     10910: </tr>
                   10911: <tr>
                   10912: <td>EMULDIR</td>
1.273   ! brook    10913: <td>EMULSUBDIR</td>
1.269     leot     10914: </tr>
                   10915: <tr>
                   10916: <td>EMULSUBDIRSLASH</td>
1.273   ! brook    10917: <td>EMUL_ARCH</td>
1.269     leot     10918: </tr>
                   10919: <tr>
                   10920: <td>EMUL_DISTRO</td>
1.273   ! brook    10921: <td>EMUL_EXEC_FMT</td>
1.269     leot     10922: </tr>
                   10923: <tr>
                   10924: <td>EMUL_IS_NATIVE</td>
1.273   ! brook    10925: <td>EMUL_MODULES</td>
1.269     leot     10926: </tr>
                   10927: <tr>
                   10928: <td>EMUL_OPSYS</td>
1.273   ! brook    10929: <td>EMUL_PKG_FMT</td>
1.269     leot     10930: </tr>
                   10931: <tr>
                   10932: <td>EMUL_PLATFORM</td>
1.273   ! brook    10933: <td>EMUL_PLATFORMS</td>
1.269     leot     10934: </tr>
                   10935: <tr>
                   10936: <td>EMUL_PREFER</td>
1.273   ! brook    10937: <td>EMUL_REQD</td>
1.269     leot     10938: </tr>
                   10939: <tr>
                   10940: <td>EMUL_TYPE</td>
1.273   ! brook    10941: <td>ERROR_MSG</td>
1.269     leot     10942: </tr>
                   10943: <tr>
                   10944: <td>EXIM_GROUP</td>
1.273   ! brook    10945: <td>EXIM_USER</td>
1.269     leot     10946: </tr>
                   10947: <tr>
                   10948: <td>EXPORT_SYMBOLS_LDFLAGS</td>
1.273   ! brook    10949: <td>EXTRACTOR</td>
1.269     leot     10950: </tr>
                   10951: <tr>
                   10952: <td>EXTRACT_CMD</td>
1.273   ! brook    10953: <td>EXTRACT_CMD_DEFAULT</td>
1.269     leot     10954: </tr>
                   10955: <tr>
                   10956: <td>EXTRACT_DIR</td>
1.273   ! brook    10957: <td>EXTRACT_ELEMENTS</td>
1.269     leot     10958: </tr>
                   10959: <tr>
                   10960: <td>EXTRACT_ENV</td>
1.273   ! brook    10961: <td>EXTRACT_ONLY</td>
1.269     leot     10962: </tr>
                   10963: <tr>
                   10964: <td>EXTRACT_OPTS</td>
1.273   ! brook    10965: <td>EXTRACT_SUFX</td>
1.269     leot     10966: </tr>
                   10967: <tr>
                   10968: <td>EXTRACT_USING</td>
1.273   ! brook    10969: <td>FAILOVER_FETCH</td>
1.269     leot     10970: </tr>
                   10971: <tr>
                   10972: <td>FAIL_MSG</td>
1.273   ! brook    10973: <td>FAKE_NCURSES</td>
1.269     leot     10974: </tr>
                   10975: <tr>
                   10976: <td>FAM</td>
1.273   ! brook    10977: <td>FAM_ACCEPTED</td>
1.269     leot     10978: </tr>
                   10979: <tr>
                   10980: <td>FAM_DEFAULT</td>
1.273   ! brook    10981: <td>FAM_SERVER</td>
1.269     leot     10982: </tr>
                   10983: <tr>
                   10984: <td>FCPATH</td>
1.273   ! brook    10985: <td>FEATURE_CPPFLAGS</td>
1.269     leot     10986: </tr>
                   10987: <tr>
                   10988: <td>FEATURE_LDFLAGS</td>
1.273   ! brook    10989: <td>FEATURE_LIBS</td>
1.269     leot     10990: </tr>
                   10991: <tr>
                   10992: <td>FETCH_AFTER_ARGS</td>
1.273   ! brook    10993: <td>FETCH_BEFORE_ARGS</td>
1.269     leot     10994: </tr>
                   10995: <tr>
                   10996: <td>FETCH_CMD</td>
1.273   ! brook    10997: <td>FETCH_OUTPUT_ARGS</td>
1.269     leot     10998: </tr>
                   10999: <tr>
                   11000: <td>FETCH_PROXY</td>
1.273   ! brook    11001: <td>FETCH_RESUME_ARGS</td>
1.269     leot     11002: </tr>
                   11003: <tr>
                   11004: <td>FETCH_USING</td>
1.273   ! brook    11005: <td>FILES_SUBST</td>
1.269     leot     11006: </tr>
                   11007: <tr>
                   11008: <td>FILES_SUBST_SED</td>
1.273   ! brook    11009: <td>FIX_SYSTEM_HEADERS</td>
1.269     leot     11010: </tr>
                   11011: <tr>
                   11012: <td>FLUXBOX_USE_GNOME</td>
1.273   ! brook    11013: <td>FLUXBOX_USE_KDE</td>
1.269     leot     11014: </tr>
                   11015: <tr>
                   11016: <td>FLUXBOX_USE_XFT</td>
                   11017: <td>FLUXBOX_USE_XINERAMA</td>
                   11018: </tr>
                   11019: <tr>
                   11020: <td>FONTS_DIRS</td>
                   11021: <td>FONTS_VERBOSE</td>
                   11022: </tr>
                   11023: <tr>
                   11024: <td>FOO_HACKS_MK</td>
                   11025: <td>FOX_USE_XUNICODE</td>
                   11026: </tr>
                   11027: <tr>
                   11028: <td>FREEWNN_GROUP</td>
                   11029: <td>FREEWNN_USER</td>
                   11030: </tr>
                   11031: <tr>
                   11032: <td>FTP_PKG_URL_DIR</td>
                   11033: <td>FTP_PKG_URL_HOST</td>
                   11034: </tr>
                   11035: <tr>
                   11036: <td>GAMEDATAMODE</td>
                   11037: <td>GAMEDATA_PERMS</td>
                   11038: </tr>
                   11039: <tr>
                   11040: <td>GAMEDIRMODE</td>
                   11041: <td>GAMEDIR_PERMS</td>
                   11042: </tr>
                   11043: <tr>
                   11044: <td>GAMEGRP</td>
                   11045: <td>GAMEMODE</td>
                   11046: </tr>
                   11047: <tr>
                   11048: <td>GAMEOWN</td>
                   11049: <td>GAMES_GROUP</td>
                   11050: </tr>
                   11051: <tr>
                   11052: <td>GAMES_USER</td>
                   11053: <td>GCC</td>
                   11054: </tr>
                   11055: <tr>
                   11056: <td>GCCBASE</td>
                   11057: <td>GCC_REQD</td>
                   11058: </tr>
                   11059: <tr>
                   11060: <td>GCC_VERSION_SUFFIX</td>
                   11061: <td>GEM_BUILD</td>
                   11062: </tr>
                   11063: <tr>
                   11064: <td>GEM_CLEANBUILD</td>
                   11065: <td>GEM_CLEANBUILD_EXTENSIONS</td>
                   11066: </tr>
                   11067: <tr>
                   11068: <td>GEM_DOCDIR</td>
                   11069: <td>GEM_EXTSDIR</td>
                   11070: </tr>
                   11071: <tr>
                   11072: <td>GEM_HOME</td>
                   11073: <td>GEM_LIBDIR</td>
                   11074: </tr>
                   11075: <tr>
                   11076: <td>GEM_NAME</td>
                   11077: <td>GEM_PATH</td>
                   11078: </tr>
                   11079: <tr>
                   11080: <td>GEM_SPECFILE</td>
                   11081: <td>GENERATE_PLIST</td>
                   11082: </tr>
                   11083: <tr>
                   11084: <td>GHOSTSCRIPT_REQD</td>
                   11085: <td>GITHUB_PROJECT</td>
                   11086: </tr>
                   11087: <tr>
                   11088: <td>GITHUB_RELEASE</td>
                   11089: <td>GITHUB_TAG</td>
                   11090: </tr>
                   11091: <tr>
                   11092: <td>GITHUB_TYPE</td>
1.273   ! brook    11093: <td>GNU</td>
1.269     leot     11094: </tr>
                   11095: <tr>
                   11096: <td>GNU_CONFIGURE</td>
1.273   ! brook    11097: <td>GNU_CONFIGURE_INFODIR</td>
1.269     leot     11098: </tr>
                   11099: <tr>
                   11100: <td>GNU_CONFIGURE_MANDIR</td>
1.273   ! brook    11101: <td>GNU_CONFIGURE_STRICT</td>
1.269     leot     11102: </tr>
                   11103: <tr>
                   11104: <td>GODEP_REDIRECTS</td>
1.273   ! brook    11105: <td>GO_BUILD_PATTERN</td>
1.269     leot     11106: </tr>
                   11107: <tr>
                   11108: <td>GO_DEPS</td>
1.273   ! brook    11109: <td>GO_DIST_BASE</td>
1.269     leot     11110: </tr>
                   11111: <tr>
                   11112: <td>GO_SRCPATH</td>
1.273   ! brook    11113: <td>GROUP_SPECIFIC_PKGS</td>
1.269     leot     11114: </tr>
                   11115: <tr>
                   11116: <td>GRUB_NETWORK_CARDS</td>
1.273   ! brook    11117: <td>GRUB_PRESET_COMMAND</td>
1.269     leot     11118: </tr>
                   11119: <tr>
                   11120: <td>GRUB_SCAN_ARGS</td>
1.273   ! brook    11121: <td>GZIP</td>
1.269     leot     11122: </tr>
                   11123: <tr>
                   11124: <td>HASKELL_COMPILER</td>
1.273   ! brook    11125: <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
1.269     leot     11126: </tr>
                   11127: <tr>
                   11128: <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
1.273   ! brook    11129: <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
1.269     leot     11130: </tr>
                   11131: <tr>
                   11132: <td>HAS_CONFIGURE</td>
                   11133: <td>HEADER_TEMPLATES</td>
                   11134: </tr>
                   11135: <tr>
                   11136: <td>HOST_PKGTOOLS_ARGS</td>
                   11137: <td>HOST_SPECIFIC_PKGS</td>
                   11138: </tr>
                   11139: <tr>
                   11140: <td>HOWL_GROUP</td>
                   11141: <td>HOWL_USER</td>
                   11142: </tr>
                   11143: <tr>
                   11144: <td>ICCBASE</td>
                   11145: <td>ICECAST_CHROOTDIR</td>
                   11146: </tr>
                   11147: <tr>
                   11148: <td>ICON_THEMES</td>
                   11149: <td>IDOBASE</td>
                   11150: </tr>
                   11151: <tr>
                   11152: <td>IGNORE_CCACHE</td>
                   11153: <td>IGNORE_INFO_DIRS</td>
                   11154: </tr>
                   11155: <tr>
                   11156: <td>IGNORE_INTERACTIVE_FETCH</td>
                   11157: <td>IMAKE</td>
                   11158: </tr>
                   11159: <tr>
                   11160: <td>IMAKEOPTS</td>
                   11161: <td>IMAKE_MAKE</td>
                   11162: </tr>
                   11163: <tr>
                   11164: <td>IMAKE_MANINSTALL</td>
                   11165: <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
                   11166: </tr>
                   11167: <tr>
                   11168: <td>IMDICTDIR</td>
                   11169: <td>INCOMPAT_CURSES</td>
                   11170: </tr>
                   11171: <tr>
                   11172: <td>INFO_DIR</td>
                   11173: <td>INFO_FILES</td>
                   11174: </tr>
                   11175: <tr>
                   11176: <td>INFO_FILES_VERBOSE</td>
                   11177: <td>INFO_MSG</td>
                   11178: </tr>
                   11179: <tr>
                   11180: <td>INIT_SYSTEM</td>
                   11181: <td>INN_DATA_DIR</td>
                   11182: </tr>
                   11183: <tr>
                   11184: <td>INN_GROUP</td>
                   11185: <td>INN_USER</td>
                   11186: </tr>
                   11187: <tr>
                   11188: <td>INSTALLATION_DIRS</td>
                   11189: <td>INSTALLATION_DIRS_FROM_PLIST</td>
                   11190: </tr>
                   11191: <tr>
                   11192: <td>INSTALL_ENV</td>
                   11193: <td>INSTALL_SH_OVERRIDE</td>
                   11194: </tr>
                   11195: <tr>
                   11196: <td>INSTALL_SRC</td>
                   11197: <td>INSTALL_TEMPLATES</td>
                   11198: </tr>
                   11199: <tr>
                   11200: <td>INSTALL_UNSTRIPPED</td>
                   11201: <td>IRCD_HYBRID_IRC_GROUP</td>
                   11202: </tr>
                   11203: <tr>
                   11204: <td>IRCD_HYBRID_IRC_USER</td>
                   11205: <td>IRCD_HYBRID_MAXCONN</td>
                   11206: </tr>
                   11207: <tr>
                   11208: <td>IRCD_HYBRID_NICLEN</td>
                   11209: <td>IRCD_HYBRID_SYSLOG_EVENTS</td>
                   11210: </tr>
                   11211: <tr>
                   11212: <td>IRCD_HYBRID_SYSLOG_FACILITY</td>
                   11213: <td>IRCD_HYBRID_TOPICLEN</td>
                   11214: </tr>
                   11215: <tr>
                   11216: <td>IRIX</td>
                   11217: <td>IRRD_USE_PGP</td>
                   11218: </tr>
                   11219: <tr>
                   11220: <td>JABBERD_GROUP</td>
                   11221: <td>JABBERD_LOGDIR</td>
                   11222: </tr>
                   11223: <tr>
                   11224: <td>JABBERD_PIDDIR</td>
                   11225: <td>JABBERD_SPOOLDIR</td>
                   11226: </tr>
                   11227: <tr>
                   11228: <td>JABBERD_USER</td>
                   11229: <td>JAKARTA_HOME</td>
                   11230: </tr>
                   11231: <tr>
                   11232: <td>JAVA_BINPREFIX</td>
                   11233: <td>JAVA_CLASSPATH</td>
                   11234: </tr>
                   11235: <tr>
                   11236: <td>JAVA_HOME</td>
                   11237: <td>JAVA_LD_LIBRARY_PATH</td>
                   11238: </tr>
                   11239: <tr>
                   11240: <td>JAVA_NAME</td>
                   11241: <td>JAVA_UNLIMIT</td>
                   11242: </tr>
                   11243: <tr>
                   11244: <td>JAVA_WRAPPERS</td>
                   11245: <td>JPEG_ACCEPTED</td>
                   11246: </tr>
                   11247: <tr>
                   11248: <td>JPEG_DEFAULT</td>
                   11249: <td>KERBEROS</td>
                   11250: </tr>
                   11251: <tr>
                   11252: <td>KERMIT_SUID_UUCP</td>
                   11253: <td>KJS_USE_PCRE</td>
                   11254: </tr>
                   11255: <tr>
                   11256: <td>KNEWS_DOMAIN_FILE</td>
                   11257: <td>KNEWS_DOMAIN_NAME</td>
                   11258: </tr>
                   11259: <tr>
                   11260: <td>KRB5_ACCEPTED</td>
                   11261: <td>KRB5_DEFAULT</td>
                   11262: </tr>
                   11263: <tr>
                   11264: <td>LANGUAGES</td>
1.272     brook    11265: <td>LATEX2HTML_ICONPATH</td>
1.271     brook    11266: </tr>
                   11267: <tr>
                   11268: <td>LDCONFIG_ADD_CMD</td>
1.272     brook    11269: <td>LDCONFIG_REMOVE_CMD</td>
1.269     leot     11270: </tr>
                   11271: <tr>
1.271     brook    11272: <td>LEAFNODE_DATA_DIR</td>
1.272     brook    11273: <td>LEAFNODE_GROUP</td>
1.269     leot     11274: </tr>
                   11275: <tr>
1.271     brook    11276: <td>LEAFNODE_USER</td>
1.272     brook    11277: <td>LIBDVDCSS_HOMEPAGE</td>
1.269     leot     11278: </tr>
                   11279: <tr>
1.271     brook    11280: <td>LIBDVDCSS_MASTER_SITES</td>
1.272     brook    11281: <td>LIBRSVG_TYPE</td>
1.269     leot     11282: </tr>
                   11283: <tr>
1.271     brook    11284: <td>LIBTOOL</td>
1.272     brook    11285: <td>LIBTOOLIZE_PLIST</td>
1.270     leot     11286: </tr>
                   11287: <tr>
1.271     brook    11288: <td>LIBTOOL_M4_OVERRIDE</td>
1.272     brook    11289: <td>LIBUSB_TYPE</td>
1.269     leot     11290: </tr>
                   11291: <tr>
1.271     brook    11292: <td>LICENSE</td>
1.272     brook    11293: <td>LINKER_RPATH_FLAG</td>
1.269     leot     11294: </tr>
                   11295: <tr>
1.271     brook    11296: <td>LINK_RPATH_FLAG</td>
1.273   ! brook    11297: <td>LINUX_LOCALES</td>
1.269     leot     11298: </tr>
                   11299: <tr>
1.272     brook    11300: <td>LOCALBASE</td>
1.273   ! brook    11301: <td>LOCALBASE_LOCKTYPE</td>
1.269     leot     11302: </tr>
                   11303: <tr>
1.272     brook    11304: <td>LOCALPATCHES</td>
1.273   ! brook    11305: <td>LOVE_DATA</td>
1.269     leot     11306: </tr>
                   11307: <tr>
1.272     brook    11308: <td>LOVE_GAME</td>
1.273   ! brook    11309: <td>LOVE_VERSION</td>
1.269     leot     11310: </tr>
                   11311: <tr>
1.272     brook    11312: <td>LP64PLATFORMS</td>
1.273   ! brook    11313: <td>MACHINE_PLATFORM</td>
1.269     leot     11314: </tr>
                   11315: <tr>
1.272     brook    11316: <td>MAILAGENT_DOMAIN</td>
1.273   ! brook    11317: <td>MAILAGENT_EMAIL</td>
1.269     leot     11318: </tr>
                   11319: <tr>
1.272     brook    11320: <td>MAILAGENT_FQDN</td>
1.273   ! brook    11321: <td>MAILAGENT_ORGANIZATION</td>
1.269     leot     11322: </tr>
                   11323: <tr>
1.272     brook    11324: <td>MAJORDOMO_HOMEDIR</td>
                   11325: <td>MAKEINFO_ARGS</td>
1.269     leot     11326: </tr>
                   11327: <tr>
1.271     brook    11328: <td>MAKE_DIRS</td>
1.272     brook    11329: <td>MAKE_DIRS_PERMS</td>
1.269     leot     11330: </tr>
                   11331: <tr>
1.271     brook    11332: <td>MAKE_ENV</td>
1.272     brook    11333: <td>MAKE_FILE</td>
1.269     leot     11334: </tr>
                   11335: <tr>
1.271     brook    11336: <td>MAKE_FLAGS</td>
1.272     brook    11337: <td>MAKE_JOBS</td>
1.269     leot     11338: </tr>
                   11339: <tr>
1.271     brook    11340: <td>MAKE_JOBS_SAFE</td>
1.272     brook    11341: <td>MAKE_PROGRAM</td>
1.269     leot     11342: </tr>
                   11343: <tr>
1.271     brook    11344: <td>MANINSTALL</td>
1.272     brook    11345: <td>MANZ</td>
1.269     leot     11346: </tr>
                   11347: <tr>
1.271     brook    11348: <td>MASTER_SITES</td>
1.272     brook    11349: <td>MASTER_SITE_BACKUP</td>
1.269     leot     11350: </tr>
                   11351: <tr>
1.271     brook    11352: <td>MASTER_SITE_CYGWIN</td>
1.272     brook    11353: <td>MASTER_SITE_GNOME</td>
1.269     leot     11354: </tr>
                   11355: <tr>
1.271     brook    11356: <td>MASTER_SITE_GNU</td>
1.272     brook    11357: <td>MASTER_SITE_LOCAL</td>
1.269     leot     11358: </tr>
                   11359: <tr>
1.271     brook    11360: <td>MASTER_SITE_MOZILLA</td>
1.272     brook    11361: <td>MASTER_SITE_OPENOFFICE</td>
1.269     leot     11362: </tr>
                   11363: <tr>
1.271     brook    11364: <td>MASTER_SITE_OVERRIDE</td>
1.272     brook    11365: <td>MASTER_SITE_PERL_CPAN</td>
1.269     leot     11366: </tr>
                   11367: <tr>
1.271     brook    11368: <td>MASTER_SITE_SUNSITE</td>
1.272     brook    11369: <td>MASTER_SITE_SUSE</td>
1.269     leot     11370: </tr>
                   11371: <tr>
1.271     brook    11372: <td>MASTER_SITE_TEX_CTAN</td>
1.272     brook    11373: <td>MASTER_SITE_XCONTRIB</td>
1.269     leot     11374: </tr>
                   11375: <tr>
1.271     brook    11376: <td>MASTER_SITE_XEMACS</td>
1.272     brook    11377: <td>MASTER_SORT</td>
1.269     leot     11378: </tr>
                   11379: <tr>
1.271     brook    11380: <td>MASTER_SORT_RANDOM</td>
1.272     brook    11381: <td>MASTER_SORT_REGEX</td>
1.269     leot     11382: </tr>
                   11383: <tr>
1.271     brook    11384: <td>MECAB_CHARSET</td>
1.272     brook    11385: <td>MEDIATOMB_GROUP</td>
1.269     leot     11386: </tr>
                   11387: <tr>
1.271     brook    11388: <td>MEDIATOMB_USER</td>
1.272     brook    11389: <td>MIPSPROBASE</td>
1.269     leot     11390: </tr>
                   11391: <tr>
1.271     brook    11392: <td>MIREDO_GROUP</td>
1.272     brook    11393: <td>MIREDO_USER</td>
1.269     leot     11394: </tr>
                   11395: <tr>
1.271     brook    11396: <td>MISSING_FEATURES</td>
1.272     brook    11397: <td>MKDIR</td>
1.269     leot     11398: </tr>
                   11399: <tr>
1.271     brook    11400: <td>MLDONKEY_GROUP</td>
1.272     brook    11401: <td>MLDONKEY_HOME</td>
1.269     leot     11402: </tr>
                   11403: <tr>
1.271     brook    11404: <td>MLDONKEY_USER</td>
1.272     brook    11405: <td>MONOTONE_GROUP</td>
1.269     leot     11406: </tr>
                   11407: <tr>
1.271     brook    11408: <td>MONOTONE_USER</td>
1.272     brook    11409: <td>MOTIFBASE</td>
1.269     leot     11410: </tr>
                   11411: <tr>
1.271     brook    11412: <td>MOTIF_TYPE</td>
1.272     brook    11413: <td>MOTIF_TYPE_DEFAULT</td>
1.269     leot     11414: </tr>
                   11415: <tr>
1.271     brook    11416: <td>MPI_TYPE</td>
1.272     brook    11417: <td>MSGFMT_STRIP_MSGCTXT</td>
1.269     leot     11418: </tr>
                   11419: <tr>
1.271     brook    11420: <td>MSGFMT_STRIP_MSGID_PLURAL</td>
1.272     brook    11421: <td>MTOOLS_ENABLE_FLOPPYD</td>
1.269     leot     11422: </tr>
                   11423: <tr>
1.271     brook    11424: <td>MUST</td>
1.272     brook    11425: <td>MV</td>
1.269     leot     11426: </tr>
                   11427: <tr>
1.271     brook    11428: <td>MYSQL_CHARSET</td>
1.272     brook    11429: <td>MYSQL_DATADIR</td>
1.269     leot     11430: </tr>
                   11431: <tr>
1.271     brook    11432: <td>MYSQL_EXTRA_CHARSET</td>
1.272     brook    11433: <td>MYSQL_GROUP</td>
1.269     leot     11434: </tr>
                   11435: <tr>
1.271     brook    11436: <td>MYSQL_PKGSRCDIR</td>
1.272     brook    11437: <td>MYSQL_USER</td>
1.269     leot     11438: </tr>
                   11439: <tr>
1.271     brook    11440: <td>MYSQL_VERSIONS_ACCEPTED</td>
1.272     brook    11441: <td>MYSQL_VERSION_DEFAULT</td>
1.269     leot     11442: </tr>
                   11443: <tr>
1.271     brook    11444: <td>NAGIOSCMD_GROUP</td>
1.272     brook    11445: <td>NAGIOSDIR</td>
1.269     leot     11446: </tr>
                   11447: <tr>
1.271     brook    11448: <td>NAGIOS_GROUP</td>
1.272     brook    11449: <td>NAGIOS_USER</td>
1.269     leot     11450: </tr>
                   11451: <tr>
1.271     brook    11452: <td>NATIVE_APPEND_ABI</td>
1.272     brook    11453: <td>NATIVE_APPEND_ELF</td>
1.269     leot     11454: </tr>
                   11455: <tr>
1.271     brook    11456: <td>NATIVE_EXEC_FMT</td>
1.272     brook    11457: <td>NATIVE_MACHINE_PLATFORM</td>
1.269     leot     11458: </tr>
                   11459: <tr>
1.271     brook    11460: <td>NATIVE_OBJECT_FMT</td>
1.272     brook    11461: <td>NBPAX_PROGRAM_PREFIX</td>
1.269     leot     11462: </tr>
                   11463: <tr>
1.271     brook    11464: <td>NETBSD_LOGIN_NAME</td>
1.272     brook    11465: <td>NMH_EDITOR</td>
1.269     leot     11466: </tr>
                   11467: <tr>
1.271     brook    11468: <td>NMH_MTA</td>
1.272     brook    11469: <td>NMH_PAGER</td>
1.269     leot     11470: </tr>
                   11471: <tr>
1.271     brook    11472: <td>NOLOGIN</td>
1.272     brook    11473: <td>NONZERO_FILESIZE_P</td>
1.269     leot     11474: </tr>
                   11475: <tr>
1.271     brook    11476: <td>NOTE</td>
1.272     brook    11477: <td>NOT_FOR_PLATFORM</td>
1.269     leot     11478: </tr>
                   11479: <tr>
1.271     brook    11480: <td>NOT_PAX_ASLR_SAFE</td>
1.272     brook    11481: <td>NOT_PAX_MPROTECT_SAFE</td>
1.269     leot     11482: </tr>
                   11483: <tr>
1.271     brook    11484: <td>NO_BUILD</td>
1.272     brook    11485: <td>NO_CHECKSUM</td>
1.269     leot     11486: </tr>
                   11487: <tr>
1.271     brook    11488: <td>NO_CONFIGURE</td>
1.272     brook    11489: <td>NO_SKIP</td>
1.269     leot     11490: </tr>
                   11491: <tr>
1.271     brook    11492: <td>NS_PREFERRED</td>
1.272     brook    11493: <td>NULLMAILER_GROUP</td>
1.269     leot     11494: </tr>
                   11495: <tr>
1.271     brook    11496: <td>NULLMAILER_USER</td>
1.272     brook    11497: <td>OASIS</td>
1.269     leot     11498: </tr>
                   11499: <tr>
1.271     brook    11500: <td>OASIS_BUILD_ARGS</td>
1.272     brook    11501: <td>OBJHOSTNAME</td>
1.269     leot     11502: </tr>
                   11503: <tr>
1.271     brook    11504: <td>OBJMACHINE</td>
1.272     brook    11505: <td>OCAML_FINDLIB_DIRS</td>
1.269     leot     11506: </tr>
                   11507: <tr>
1.271     brook    11508: <td>OCAML_FINDLIB_REGISTER</td>
1.272     brook    11509: <td>OCAML_FINDLIB_REGISTER_VERBOSE</td>
1.269     leot     11510: </tr>
                   11511: <tr>
1.271     brook    11512: <td>OCAML_SITELIBDIR</td>
1.272     brook    11513: <td>OCAML_TOPKG_DOCDIR</td>
1.269     leot     11514: </tr>
                   11515: <tr>
1.271     brook    11516: <td>OCAML_USE_DUNE</td>
1.272     brook    11517: <td>OCAML_USE_FINDLIB</td>
1.269     leot     11518: </tr>
                   11519: <tr>
1.271     brook    11520: <td>OCAML_USE_JBUILDER</td>
1.272     brook    11521: <td>OCAML_USE_OASIS</td>
1.269     leot     11522: </tr>
                   11523: <tr>
1.271     brook    11524: <td>OCAML_USE_OASIS_DYNRUN</td>
1.272     brook    11525: <td>OCAML_USE_OPAM</td>
1.269     leot     11526: </tr>
                   11527: <tr>
1.271     brook    11528: <td>OCAML_USE_OPT_COMPILER</td>
1.272     brook    11529: <td>OCAML_USE_TOPKG</td>
1.269     leot     11530: </tr>
                   11531: <tr>
1.271     brook    11532: <td>OMF</td>
1.272     brook    11533: <td>ONLY_FOR_COMPILER</td>
1.269     leot     11534: </tr>
                   11535: <tr>
1.271     brook    11536: <td>ONLY_FOR_PLATFORM</td>
1.272     brook    11537: <td>OPENSSH_CHROOT</td>
1.269     leot     11538: </tr>
                   11539: <tr>
1.271     brook    11540: <td>OPENSSH_GROUP</td>
1.272     brook    11541: <td>OPENSSH_USER</td>
1.269     leot     11542: </tr>
                   11543: <tr>
1.271     brook    11544: <td>OPSYS</td>
1.272     brook    11545: <td>OPSYS_EMULDIR</td>
1.269     leot     11546: </tr>
                   11547: <tr>
1.271     brook    11548: <td>OSS_TYPE</td>
1.272     brook    11549: <td>OSX</td>
1.269     leot     11550: </tr>
                   11551: <tr>
1.271     brook    11552: <td>OSX_TOLERATE_SDK_SKEW</td>
1.272     brook    11553: <td>OS_VARIANT</td>
1.269     leot     11554: </tr>
                   11555: <tr>
1.271     brook    11556: <td>OS_VERSION</td>
1.272     brook    11557: <td>OTF_FONTS_DIR</td>
1.269     leot     11558: </tr>
                   11559: <tr>
1.271     brook    11560: <td>OVERRIDE_DIRDEPTH</td>
1.272     brook    11561: <td>OVERRIDE_GEMSPEC</td>
1.269     leot     11562: </tr>
                   11563: <tr>
1.271     brook    11564: <td>OVERRIDE_GNU_CONFIG_SCRIPTS</td>
1.273   ! brook    11565: <td>OWN_DIRS</td>
1.269     leot     11566: </tr>
                   11567: <tr>
1.272     brook    11568: <td>OWN_DIRS_PERMS</td>
1.273   ! brook    11569: <td>P4GROUP</td>
1.269     leot     11570: </tr>
                   11571: <tr>
1.272     brook    11572: <td>P4PORT</td>
1.273   ! brook    11573: <td>P4ROOT</td>
1.269     leot     11574: </tr>
                   11575: <tr>
1.272     brook    11576: <td>P4USER</td>
1.273   ! brook    11577: <td>PACKAGES</td>
1.269     leot     11578: </tr>
                   11579: <tr>
1.272     brook    11580: <td>PALMOS_DEFAULT_SDK</td>
1.273   ! brook    11581: <td>PAMBASE</td>
1.269     leot     11582: </tr>
                   11583: <tr>
1.272     brook    11584: <td>PAM_DEFAULT</td>
1.273   ! brook    11585: <td>PAPERSIZE</td>
1.269     leot     11586: </tr>
                   11587: <tr>
1.272     brook    11588: <td>PASSIVE_FETCH</td>
1.273   ! brook    11589: <td>PATCHDIR</td>
1.269     leot     11590: </tr>
                   11591: <tr>
1.272     brook    11592: <td>PATCHFILES</td>
1.273   ! brook    11593: <td>PATCH_ARGS</td>
1.269     leot     11594: </tr>
                   11595: <tr>
1.272     brook    11596: <td>PATCH_DEBUG</td>
1.273   ! brook    11597: <td>PATCH_DIST_ARGS</td>
1.269     leot     11598: </tr>
                   11599: <tr>
1.272     brook    11600: <td>PATCH_DIST_CAT</td>
1.273   ! brook    11601: <td>PATCH_DIST_STRIP</td>
1.269     leot     11602: </tr>
                   11603: <tr>
1.272     brook    11604: <td>PATCH_FUZZ_FACTOR</td>
1.273   ! brook    11605: <td>PATCH_STRIP</td>
1.269     leot     11606: </tr>
                   11607: <tr>
1.272     brook    11608: <td>PATH</td>
1.271     brook    11609: <td>PCCBASE</td>
1.269     leot     11610: </tr>
                   11611: <tr>
1.272     brook    11612: <td>PEAR_CMD</td>
1.273   ! brook    11613: <td>PEAR_LIB</td>
1.269     leot     11614: </tr>
                   11615: <tr>
1.272     brook    11616: <td>PEAR_PACKAGE_XML</td>
1.273   ! brook    11617: <td>PERL5</td>
1.269     leot     11618: </tr>
                   11619: <tr>
1.272     brook    11620: <td>PERL5_CONFIGURE</td>
1.273   ! brook    11621: <td>PERL5_CONFIGURE_DIRS</td>
1.269     leot     11622: </tr>
                   11623: <tr>
1.272     brook    11624: <td>PERL5_LDFLAGS</td>
1.273   ! brook    11625: <td>PERL5_LICENSE</td>
1.269     leot     11626: </tr>
                   11627: <tr>
1.272     brook    11628: <td>PERL5_MODULE_TYPE</td>
1.273   ! brook    11629: <td>PERL5_PACKLIST</td>
1.269     leot     11630: </tr>
                   11631: <tr>
1.272     brook    11632: <td>PERL5_PACKLIST_DIR</td>
1.273   ! brook    11633: <td>PERL5_PERLBASE</td>
1.269     leot     11634: </tr>
                   11635: <tr>
1.272     brook    11636: <td>PERL5_SITEBASE</td>
1.273   ! brook    11637: <td>PERL5_USE_PACKLIST</td>
1.269     leot     11638: </tr>
                   11639: <tr>
1.272     brook    11640: <td>PERL5_VENDORBASE</td>
1.273   ! brook    11641: <td>PFCTL</td>
1.269     leot     11642: </tr>
                   11643: <tr>
1.272     brook    11644: <td>PFVAR_H</td>
1.273   ! brook    11645: <td>PF_VERSION</td>
1.269     leot     11646: </tr>
                   11647: <tr>
1.272     brook    11648: <td>PGGROUP</td>
1.273   ! brook    11649: <td>PGHOME</td>
1.269     leot     11650: </tr>
                   11651: <tr>
1.272     brook    11652: <td>PGPKGSRCDIR</td>
1.273   ! brook    11653: <td>PGSQL_TYPE</td>
1.269     leot     11654: </tr>
                   11655: <tr>
1.272     brook    11656: <td>PGSQL_VERSIONS_ACCEPTED</td>
1.273   ! brook    11657: <td>PGSQL_VERSION_DEFAULT</td>
1.269     leot     11658: </tr>
                   11659: <tr>
1.272     brook    11660: <td>PGUSER</td>
1.273   ! brook    11661: <td>PG_LIB_EXT</td>
1.269     leot     11662: </tr>
                   11663: <tr>
1.272     brook    11664: <td>PHP</td>
1.273   ! brook    11665: <td>PHPCOMMON_MK</td>
1.269     leot     11666: </tr>
                   11667: <tr>
1.272     brook    11668: <td>PHPPKGSRCDIR</td>
1.273   ! brook    11669: <td>PHP_BASE_VERS</td>
1.269     leot     11670: </tr>
                   11671: <tr>
1.272     brook    11672: <td>PHP_CHECK_INSTALLED</td>
1.273   ! brook    11673: <td>PHP_EXTENSION_DIR</td>
1.269     leot     11674: </tr>
                   11675: <tr>
1.272     brook    11676: <td>PHP_INITIAL_TEENY</td>
1.273   ! brook    11677: <td>PHP_PKG_PREFIX</td>
1.269     leot     11678: </tr>
                   11679: <tr>
1.272     brook    11680: <td>PHP_VERSION</td>
1.273   ! brook    11681: <td>PHP_VERSIONS_ACCEPTED</td>
1.269     leot     11682: </tr>
                   11683: <tr>
1.272     brook    11684: <td>PHP_VERSIONS_INCOMPATIBLE</td>
1.273   ! brook    11685: <td>PHP_VERSION_DEFAULT</td>
1.269     leot     11686: </tr>
                   11687: <tr>
1.272     brook    11688: <td>PHP_VERSION_REQD</td>
1.273   ! brook    11689: <td>PILRC_USE_GTK</td>
1.269     leot     11690: </tr>
                   11691: <tr>
1.272     brook    11692: <td>PKGCONFIG_BASE</td>
1.273   ! brook    11693: <td>PKGCONFIG_FILE</td>
1.269     leot     11694: </tr>
                   11695: <tr>
1.272     brook    11696: <td>PKGCONFIG_OVERRIDE</td>
1.273   ! brook    11697: <td>PKGCONFIG_OVERRIDE_STAGE</td>
1.269     leot     11698: </tr>
                   11699: <tr>
1.272     brook    11700: <td>PKGDIR</td>
1.273   ! brook    11701: <td>PKGGNUDIR</td>
1.269     leot     11702: </tr>
                   11703: <tr>
1.272     brook    11704: <td>PKGINFODIR</td>
1.273   ! brook    11705: <td>PKGLOCALEDIR</td>
1.269     leot     11706: </tr>
                   11707: <tr>
1.272     brook    11708: <td>PKGMANDIR</td>
1.273   ! brook    11709: <td>PKGNAME</td>
1.269     leot     11710: </tr>
                   11711: <tr>
1.272     brook    11712: <td>PKGNAME_REQD</td>
1.273   ! brook    11713: <td>PKGPATH</td>
1.269     leot     11714: </tr>
                   11715: <tr>
1.270     leot     11716: <td>PKGREVISION</td>
1.273   ! brook    11717: <td>PKGSRC_CHANGES</td>
1.269     leot     11718: </tr>
                   11719: <tr>
1.270     leot     11720: <td>PKGSRC_COMPILER</td>
1.273   ! brook    11721: <td>PKGSRC_KEEP_BIN_PKGS</td>
1.269     leot     11722: </tr>
                   11723: <tr>
1.270     leot     11724: <td>PKGSRC_LOCKTYPE</td>
1.273   ! brook    11725: <td>PKGSRC_MAKE_ENV</td>
1.269     leot     11726: </tr>
                   11727: <tr>
1.270     leot     11728: <td>PKGSRC_MESSAGE_RECIPIENTS</td>
1.273   ! brook    11729: <td>PKGSRC_MKPIE</td>
1.269     leot     11730: </tr>
                   11731: <tr>
1.270     leot     11732: <td>PKGSRC_MKREPRO</td>
1.273   ! brook    11733: <td>PKGSRC_RUN_TEST</td>
1.269     leot     11734: </tr>
                   11735: <tr>
1.270     leot     11736: <td>PKGSRC_SETENV</td>
1.273   ! brook    11737: <td>PKGSRC_SLEEPSECS</td>
1.269     leot     11738: </tr>
                   11739: <tr>
1.270     leot     11740: <td>PKGSRC_TODO</td>
1.273   ! brook    11741: <td>PKGSRC_USE_CTF</td>
1.269     leot     11742: </tr>
                   11743: <tr>
1.270     leot     11744: <td>PKGSRC_USE_FORTIFY</td>
1.273   ! brook    11745: <td>PKGSRC_USE_RELRO</td>
1.269     leot     11746: </tr>
                   11747: <tr>
1.270     leot     11748: <td>PKGSRC_USE_SSP</td>
1.273   ! brook    11749: <td>PKGSRC_USE_STACK_CHECK</td>
1.269     leot     11750: </tr>
                   11751: <tr>
1.270     leot     11752: <td>PKGTASKS_DATAFILE</td>
1.273   ! brook    11753: <td>PKGTOOLS_ARGS</td>
1.269     leot     11754: </tr>
                   11755: <tr>
1.270     leot     11756: <td>PKGTOOLS_ENV</td>
1.273   ! brook    11757: <td>PKG_ALTERNATIVES</td>
1.269     leot     11758: </tr>
                   11759: <tr>
1.270     leot     11760: <td>PKG_APACHE</td>
1.273   ! brook    11761: <td>PKG_APACHE_ACCEPTED</td>
1.269     leot     11762: </tr>
                   11763: <tr>
1.270     leot     11764: <td>PKG_APACHE_DEFAULT</td>
1.273   ! brook    11765: <td>PKG_BEST_EXISTS</td>
1.269     leot     11766: </tr>
                   11767: <tr>
1.270     leot     11768: <td>PKG_BUILD_OPTIONS</td>
1.273   ! brook    11769: <td>PKG_COMPRESSION</td>
1.269     leot     11770: </tr>
                   11771: <tr>
1.270     leot     11772: <td>PKG_CONFIG</td>
1.273   ! brook    11773: <td>PKG_CONFIG_PERMS</td>
1.269     leot     11774: </tr>
                   11775: <tr>
1.270     leot     11776: <td>PKG_CREATE_USERGROUP</td>
1.273   ! brook    11777: <td>PKG_DB_TMPDIR</td>
1.269     leot     11778: </tr>
                   11779: <tr>
1.270     leot     11780: <td>PKG_DEBUG_LEVEL</td>
1.273   ! brook    11781: <td>PKG_DEFAULT_OPTIONS</td>
1.269     leot     11782: </tr>
                   11783: <tr>
1.270     leot     11784: <td>PKG_DESTDIR_SUPPORT</td>
1.273   ! brook    11785: <td>PKG_DEVELOPER</td>
1.269     leot     11786: </tr>
                   11787: <tr>
1.270     leot     11788: <td>PKG_DISABLED_OPTIONS</td>
1.273   ! brook    11789: <td>PKG_FATAL_ERRORS</td>
1.269     leot     11790: </tr>
                   11791: <tr>
1.270     leot     11792: <td>PKG_FC</td>
1.273   ! brook    11793: <td>PKG_FILELIST_CMD</td>
1.269     leot     11794: </tr>
                   11795: <tr>
1.270     leot     11796: <td>PKG_GECOS</td>
1.273   ! brook    11797: <td>PKG_GID</td>
1.269     leot     11798: </tr>
                   11799: <tr>
1.270     leot     11800: <td>PKG_GROUPS</td>
1.273   ! brook    11801: <td>PKG_GROUPS_VARS</td>
1.269     leot     11802: </tr>
                   11803: <tr>
1.270     leot     11804: <td>PKG_HOME</td>
1.273   ! brook    11805: <td>PKG_INIT_SCRIPTS</td>
1.269     leot     11806: </tr>
                   11807: <tr>
1.270     leot     11808: <td>PKG_JAVA_HOME</td>
1.273   ! brook    11809: <td>PKG_JVM</td>
1.269     leot     11810: </tr>
                   11811: <tr>
1.270     leot     11812: <td>PKG_JVMS_ACCEPTED</td>
1.273   ! brook    11813: <td>PKG_JVM_DEFAULT</td>
1.269     leot     11814: </tr>
                   11815: <tr>
1.270     leot     11816: <td>PKG_LEGACY_OPTIONS</td>
1.273   ! brook    11817: <td>PKG_LIBTOOL</td>
1.269     leot     11818: </tr>
                   11819: <tr>
1.270     leot     11820: <td>PKG_OPTIONS</td>
1.273   ! brook    11821: <td>PKG_OPTIONS_DEPRECATED_WARNINGS</td>
1.269     leot     11822: </tr>
                   11823: <tr>
1.270     leot     11824: <td>PKG_OPTIONS_LEGACY_OPTS</td>
1.273   ! brook    11825: <td>PKG_OPTIONS_LEGACY_VARS</td>
1.269     leot     11826: </tr>
                   11827: <tr>
1.270     leot     11828: <td>PKG_OPTIONS_NONEMPTY_SETS</td>
1.273   ! brook    11829: <td>PKG_OPTIONS_OPTIONAL_GROUPS</td>
1.269     leot     11830: </tr>
                   11831: <tr>
1.270     leot     11832: <td>PKG_OPTIONS_REQUIRED_GROUPS</td>
1.273   ! brook    11833: <td>PKG_OPTIONS_VAR</td>
1.269     leot     11834: </tr>
                   11835: <tr>
1.270     leot     11836: <td>PKG_PHP</td>
1.273   ! brook    11837: <td>PKG_PHP_MAJOR_VERS</td>
1.269     leot     11838: </tr>
                   11839: <tr>
1.270     leot     11840: <td>PKG_PHP_VERSION</td>
1.273   ! brook    11841: <td>PKG_RCD_SCRIPTS</td>
1.269     leot     11842: </tr>
                   11843: <tr>
1.270     leot     11844: <td>PKG_REFCOUNT_DBDIR</td>
1.273   ! brook    11845: <td>PKG_REGISTER_SHELLS</td>
1.269     leot     11846: </tr>
                   11847: <tr>
1.270     leot     11848: <td>PKG_RESUME_TRANSFERS</td>
1.273   ! brook    11849: <td>PKG_SHELL</td>
1.269     leot     11850: </tr>
                   11851: <tr>
1.270     leot     11852: <td>PKG_SUGGESTED_OPTIONS</td>
1.273   ! brook    11853: <td>PKG_SUPPORTED_OPTIONS</td>
1.269     leot     11854: </tr>
                   11855: <tr>
1.270     leot     11856: <td>PKG_SYSCONFBASE</td>
1.273   ! brook    11857: <td>PKG_SYSCONFBASEDIR</td>
1.269     leot     11858: </tr>
                   11859: <tr>
1.270     leot     11860: <td>PKG_SYSCONFDIR</td>
1.273   ! brook    11861: <td>PKG_SYSCONFDIR_PERMS</td>
1.269     leot     11862: </tr>
                   11863: <tr>
1.270     leot     11864: <td>PKG_SYSCONFSUBDIR</td>
1.273   ! brook    11865: <td>PKG_SYSCONFVAR</td>
1.269     leot     11866: </tr>
                   11867: <tr>
1.270     leot     11868: <td>PKG_TOOLS_BIN</td>
1.273   ! brook    11869: <td>PKG_UID</td>
1.269     leot     11870: </tr>
                   11871: <tr>
1.270     leot     11872: <td>PKG_UPDATE_FONTS_DB</td>
1.273   ! brook    11873: <td>PKG_USERS</td>
1.269     leot     11874: </tr>
                   11875: <tr>
1.270     leot     11876: <td>PKG_USERS_VARS</td>
1.273   ! brook    11877: <td>PKG_VERBOSE</td>
1.269     leot     11878: </tr>
                   11879: <tr>
1.270     leot     11880: <td>PLIST</td>
1.273   ! brook    11881: <td>PLIST_AWK</td>
1.269     leot     11882: </tr>
                   11883: <tr>
1.270     leot     11884: <td>PLIST_AWK_ENV</td>
1.273   ! brook    11885: <td>PLIST_SRC</td>
1.269     leot     11886: </tr>
                   11887: <tr>
1.270     leot     11888: <td>PLIST_SUBST</td>
1.273   ! brook    11889: <td>PLIST_TYPE</td>
1.269     leot     11890: </tr>
                   11891: <tr>
1.270     leot     11892: <td>PLIST_VARS</td>
1.273   ! brook    11893: <td>POPTOP_USE_MPPE</td>
1.269     leot     11894: </tr>
                   11895: <tr>
1.270     leot     11896: <td>POST_FETCH_HOOK</td>
1.273   ! brook    11897: <td>PREFER</td>
1.269     leot     11898: </tr>
                   11899: <tr>
1.270     leot     11900: <td>PREFER_NATIVE</td>
1.273   ! brook    11901: <td>PREFER_NATIVE_PTHREADS</td>
1.269     leot     11902: </tr>
                   11903: <tr>
1.270     leot     11904: <td>PREFER_PKGSRC</td>
1.273   ! brook    11905: <td>PREFIX</td>
1.269     leot     11906: </tr>
                   11907: <tr>
1.270     leot     11908: <td>PREPEND_PATH</td>
1.273   ! brook    11909: <td>PRE_ROOT_CMD</td>
1.269     leot     11910: </tr>
                   11911: <tr>
1.270     leot     11912: <td>PRIVILEGED_STAGES</td>
1.273   ! brook    11913: <td>PS</td>
1.269     leot     11914: </tr>
                   11915: <tr>
1.270     leot     11916: <td>PTHREAD_AUTO_VARS</td>
1.273   ! brook    11917: <td>PTHREAD_CFLAGS</td>
1.269     leot     11918: </tr>
                   11919: <tr>
1.270     leot     11920: <td>PTHREAD_LDFLAGS</td>
1.273   ! brook    11921: <td>PTHREAD_LIBS</td>
1.269     leot     11922: </tr>
                   11923: <tr>
1.270     leot     11924: <td>PTHREAD_OPTS</td>
1.273   ! brook    11925: <td>PTHREAD_TYPE</td>
1.269     leot     11926: </tr>
                   11927: <tr>
1.270     leot     11928: <td>PVM_SSH</td>
1.273   ! brook    11929: <td>PYPKGPREFIX</td>
1.269     leot     11930: </tr>
                   11931: <tr>
1.270     leot     11932: <td>PYTHON_FOR_BUILD_ONLY</td>
1.273   ! brook    11933: <td>PYTHON_SELF_CONFLICT</td>
1.269     leot     11934: </tr>
                   11935: <tr>
1.270     leot     11936: <td>PYTHON_VERSIONED_DEPENDENCIES</td>
1.273   ! brook    11937: <td>PYTHON_VERSIONS_ACCEPTED</td>
1.269     leot     11938: </tr>
                   11939: <tr>
1.270     leot     11940: <td>PYTHON_VERSIONS_INCOMPATIBLE</td>
1.273   ! brook    11941: <td>PYTHON_VERSION_DEFAULT</td>
1.269     leot     11942: </tr>
                   11943: <tr>
1.270     leot     11944: <td>PYTHON_VERSION_REQD</td>
1.273   ! brook    11945: <td>PYVERSSUFFIX</td>
1.269     leot     11946: </tr>
                   11947: <tr>
1.270     leot     11948: <td>PY_NO_EGG</td>
1.273   ! brook    11949: <td>QMAILDIR</td>
1.269     leot     11950: </tr>
                   11951: <tr>
1.270     leot     11952: <td>QMAIL_ALIAS_USER</td>
1.273   ! brook    11953: <td>QMAIL_DAEMON_USER</td>
1.269     leot     11954: </tr>
                   11955: <tr>
1.270     leot     11956: <td>QMAIL_LOG_USER</td>
1.273   ! brook    11957: <td>QMAIL_NOFILES_GROUP</td>
1.269     leot     11958: </tr>
                   11959: <tr>
1.270     leot     11960: <td>QMAIL_PASSWD_USER</td>
1.273   ! brook    11961: <td>QMAIL_QMAIL_GROUP</td>
1.269     leot     11962: </tr>
                   11963: <tr>
1.270     leot     11964: <td>QMAIL_QUEUE_DIR</td>
1.273   ! brook    11965: <td>QMAIL_QUEUE_EXTRA</td>
1.269     leot     11966: </tr>
                   11967: <tr>
1.270     leot     11968: <td>QMAIL_QUEUE_USER</td>
1.273   ! brook    11969: <td>QMAIL_REMOTE_USER</td>
1.269     leot     11970: </tr>
                   11971: <tr>
1.270     leot     11972: <td>QMAIL_ROOT_USER</td>
1.273   ! brook    11973: <td>QMAIL_SEND_USER</td>
1.269     leot     11974: </tr>
                   11975: <tr>
1.270     leot     11976: <td>QPOPPER_FAC</td>
1.273   ! brook    11977: <td>QPOPPER_SPOOL_DIR</td>
1.269     leot     11978: </tr>
                   11979: <tr>
1.270     leot     11980: <td>QPOPPER_USER</td>
1.273   ! brook    11981: <td>RAKE_NAME</td>
1.269     leot     11982: </tr>
                   11983: <tr>
1.270     leot     11984: <td>RASMOL_DEPTH</td>
1.273   ! brook    11985: <td>RCD_SCRIPTS</td>
1.269     leot     11986: </tr>
                   11987: <tr>
1.270     leot     11988: <td>RCD_SCRIPTS_DIR</td>
1.273   ! brook    11989: <td>RCD_SCRIPTS_EXAMPLEDIR</td>
1.269     leot     11990: </tr>
                   11991: <tr>
1.270     leot     11992: <td>RCD_SCRIPTS_MODE</td>
1.273   ! brook    11993: <td>RCD_SCRIPTS_SHELL</td>
1.269     leot     11994: </tr>
                   11995: <tr>
1.270     leot     11996: <td>RCD_SCRIPT_SRC</td>
                   11997: <td>RDOC</td>
1.269     leot     11998: </tr>
                   11999: <tr>
                   12000: <td>READLINE_DEFAULT</td>
1.270     leot     12001: <td>READLINE_TYPE</td>
1.269     leot     12002: </tr>
                   12003: <tr>
                   12004: <td>REAL_ROOT_GROUP</td>
1.270     leot     12005: <td>REAL_ROOT_USER</td>
1.269     leot     12006: </tr>
                   12007: <tr>
                   12008: <td>RECURSIVE_MAKE</td>
1.270     leot     12009: <td>RELAY_CTRL_DIR</td>
1.269     leot     12010: </tr>
                   12011: <tr>
                   12012: <td>REPLACE_AWK</td>
1.270     leot     12013: <td>REPLACE_BASH</td>
1.269     leot     12014: </tr>
                   12015: <tr>
                   12016: <td>REPLACE_CSH</td>
1.270     leot     12017: <td>REPLACE_KSH</td>
1.269     leot     12018: </tr>
                   12019: <tr>
                   12020: <td>REPLACE_PERL</td>
1.270     leot     12021: <td>REPLACE_PERL6</td>
1.269     leot     12022: </tr>
                   12023: <tr>
                   12024: <td>REPLACE_PYTHON</td>
1.270     leot     12025: <td>REPLACE_RUBY</td>
1.269     leot     12026: </tr>
                   12027: <tr>
                   12028: <td>REPLACE_RUBY_DIRS</td>
1.270     leot     12029: <td>REPLACE_RUBY_PAT</td>
1.269     leot     12030: </tr>
                   12031: <tr>
                   12032: <td>REPLACE_SH</td>
1.270     leot     12033: <td>REPLACE_TEXLUA</td>
1.269     leot     12034: </tr>
                   12035: <tr>
                   12036: <td>REQD_DIRS</td>
1.270     leot     12037: <td>REQD_DIRS_PERMS</td>
1.269     leot     12038: </tr>
                   12039: <tr>
                   12040: <td>REQD_FILES</td>
1.270     leot     12041: <td>REQD_FILES_MODE</td>
1.269     leot     12042: </tr>
                   12043: <tr>
                   12044: <td>REQD_FILES_PERMS</td>
1.270     leot     12045: <td>RESOLV_AUTO_VARS</td>
1.269     leot     12046: </tr>
                   12047: <tr>
                   12048: <td>RESOLV_LDFLAGS</td>
1.270     leot     12049: <td>RESOLV_LIBS</td>
1.269     leot     12050: </tr>
                   12051: <tr>
                   12052: <td>RM</td>
1.270     leot     12053: <td>ROOT_CMD</td>
1.269     leot     12054: </tr>
                   12055: <tr>
                   12056: <td>ROOT_GROUP</td>
1.270     leot     12057: <td>ROOT_USER</td>
1.269     leot     12058: </tr>
                   12059: <tr>
                   12060: <td>RPCGEN</td>
1.270     leot     12061: <td>RPM</td>
1.269     leot     12062: </tr>
                   12063: <tr>
                   12064: <td>RPM2PKG_PLIST</td>
1.270     leot     12065: <td>RPM2PKG_PREFIX</td>
1.269     leot     12066: </tr>
                   12067: <tr>
                   12068: <td>RPM2PKG_STAGE</td>
1.270     leot     12069: <td>RPM2PKG_STRIP</td>
1.269     leot     12070: </tr>
                   12071: <tr>
                   12072: <td>RPM2PKG_SUBPREFIX</td>
1.270     leot     12073: <td>RPMFILES</td>
1.269     leot     12074: </tr>
                   12075: <tr>
                   12076: <td>RPMIGNOREPATH</td>
1.270     leot     12077: <td>RPM_DB_PREFIX</td>
1.269     leot     12078: </tr>
                   12079: <tr>
                   12080: <td>RSSH_CVS_PATH</td>
1.270     leot     12081: <td>RSSH_RDIST_PATH</td>
1.269     leot     12082: </tr>
                   12083: <tr>
                   12084: <td>RSSH_RSYNC_PATH</td>
1.270     leot     12085: <td>RSSH_SCP_PATH</td>
1.269     leot     12086: </tr>
                   12087: <tr>
                   12088: <td>RSSH_SFTP_SERVER_PATH</td>
1.270     leot     12089: <td>RUBY</td>
1.269     leot     12090: </tr>
                   12091: <tr>
                   12092: <td>RUBYGEM</td>
1.270     leot     12093: <td>RUBYGEM_NAME</td>
1.269     leot     12094: </tr>
                   12095: <tr>
                   12096: <td>RUBYGEM_OPTIONS</td>
1.270     leot     12097: <td>RUBY_ABI_VERSION</td>
1.269     leot     12098: </tr>
                   12099: <tr>
                   12100: <td>RUBY_ARCH</td>
1.270     leot     12101: <td>RUBY_ARCHINC</td>
1.269     leot     12102: </tr>
                   12103: <tr>
                   12104: <td>RUBY_ARCHLIB</td>
1.270     leot     12105: <td>RUBY_BASE</td>
1.269     leot     12106: </tr>
                   12107: <tr>
                   12108: <td>RUBY_BASERIDIR</td>
1.270     leot     12109: <td>RUBY_BUILD_RDOC</td>
1.269     leot     12110: </tr>
                   12111: <tr>
                   12112: <td>RUBY_BUILD_RI</td>
1.270     leot     12113: <td>RUBY_DLEXT</td>
1.269     leot     12114: </tr>
                   12115: <tr>
                   12116: <td>RUBY_DOC</td>
1.270     leot     12117: <td>RUBY_DYNAMIC_DIRS</td>
1.269     leot     12118: </tr>
                   12119: <tr>
                   12120: <td>RUBY_EG</td>
1.270     leot     12121: <td>RUBY_ENCODING_ARG</td>
1.269     leot     12122: </tr>
                   12123: <tr>
                   12124: <td>RUBY_EXTCONF</td>
1.270     leot     12125: <td>RUBY_EXTCONF_CHECK</td>
1.269     leot     12126: </tr>
                   12127: <tr>
                   12128: <td>RUBY_EXTCONF_DEBUG</td>
1.270     leot     12129: <td>RUBY_EXTCONF_MAKEFILE</td>
1.269     leot     12130: </tr>
                   12131: <tr>
                   12132: <td>RUBY_GEM_BASE</td>
1.270     leot     12133: <td>RUBY_INC</td>
1.269     leot     12134: </tr>
                   12135: <tr>
                   12136: <td>RUBY_LIB</td>
1.270     leot     12137: <td>RUBY_LIB_BASE</td>
1.269     leot     12138: </tr>
                   12139: <tr>
                   12140: <td>RUBY_NAME</td>
1.270     leot     12141: <td>RUBY_NOVERSION</td>
1.269     leot     12142: </tr>
                   12143: <tr>
                   12144: <td>RUBY_PKGPREFIX</td>
1.270     leot     12145: <td>RUBY_RAILS</td>
1.269     leot     12146: </tr>
                   12147: <tr>
                   12148: <td>RUBY_RAILS42_VERSION</td>
1.270     leot     12149: <td>RUBY_RAILS51_VERSION</td>
1.269     leot     12150: </tr>
                   12151: <tr>
                   12152: <td>RUBY_RAILS52_VERSION</td>
1.270     leot     12153: <td>RUBY_RAILS_ACCEPTED</td>
1.269     leot     12154: </tr>
                   12155: <tr>
                   12156: <td>RUBY_RAILS_DEFAULT</td>
1.270     leot     12157: <td>RUBY_RAILS_REQD</td>
1.269     leot     12158: </tr>
                   12159: <tr>
                   12160: <td>RUBY_RAILS_STRICT_DEP</td>
1.270     leot     12161: <td>RUBY_RIDIR</td>
1.269     leot     12162: </tr>
                   12163: <tr>
                   12164: <td>RUBY_SETUP</td>
1.270     leot     12165: <td>RUBY_SHLIB</td>
1.269     leot     12166: </tr>
                   12167: <tr>
                   12168: <td>RUBY_SHLIBALIAS</td>
1.270     leot     12169: <td>RUBY_SHLIBVER</td>
1.269     leot     12170: </tr>
                   12171: <tr>
                   12172: <td>RUBY_SIMPLE_INSTALL</td>
1.270     leot     12173: <td>RUBY_SITEARCHLIB</td>
1.269     leot     12174: </tr>
                   12175: <tr>
                   12176: <td>RUBY_SITELIB</td>
1.270     leot     12177: <td>RUBY_SITELIB_BASE</td>
1.269     leot     12178: </tr>
                   12179: <tr>
                   12180: <td>RUBY_SITERIDIR</td>
1.270     leot     12181: <td>RUBY_SLEXT</td>
1.269     leot     12182: </tr>
                   12183: <tr>
                   12184: <td>RUBY_SRCDIR</td>
1.270     leot     12185: <td>RUBY_STATICLIB</td>
1.269     leot     12186: </tr>
                   12187: <tr>
                   12188: <td>RUBY_SUFFIX</td>
1.270     leot     12189: <td>RUBY_SYSRIDIR</td>
1.269     leot     12190: </tr>
                   12191: <tr>
                   12192: <td>RUBY_USE_PTHREAD</td>
1.270     leot     12193: <td>RUBY_VENDORARCHLIB</td>
1.269     leot     12194: </tr>
                   12195: <tr>
                   12196: <td>RUBY_VENDORLIB</td>
1.270     leot     12197: <td>RUBY_VENDORLIB_BASE</td>
1.269     leot     12198: </tr>
                   12199: <tr>
                   12200: <td>RUBY_VER</td>
1.270     leot     12201: <td>RUBY_VERSION</td>
1.269     leot     12202: </tr>
                   12203: <tr>
                   12204: <td>RUBY_VERSIONS_ACCEPTED</td>
1.270     leot     12205: <td>RUBY_VERSION_DEFAULT</td>
1.269     leot     12206: </tr>
                   12207: <tr>
                   12208: <td>RUBY_VERSION_REQD</td>
1.270     leot     12209: <td>RUBY_VER_DIR</td>
1.269     leot     12210: </tr>
                   12211: <tr>
                   12212: <td>RUN</td>
1.270     leot     12213: <td>RUN_LDCONFIG</td>
1.269     leot     12214: </tr>
                   12215: <tr>
                   12216: <td>SAWFISH_THEMES</td>
1.270     leot     12217: <td>SCO</td>
1.269     leot     12218: </tr>
                   12219: <tr>
                   12220: <td>SCREWS_GROUP</td>
1.270     leot     12221: <td>SCREWS_USER</td>
1.269     leot     12222: </tr>
                   12223: <tr>
                   12224: <td>SCRIPTS_ENV</td>
1.270     leot     12225: <td>SCROLLKEEPER_DATADIR</td>
1.269     leot     12226: </tr>
                   12227: <tr>
                   12228: <td>SCROLLKEEPER_REBUILDDB</td>
1.270     leot     12229: <td>SCROLLKEEPER_UPDATEDB</td>
1.269     leot     12230: </tr>
                   12231: <tr>
                   12232: <td>SDIST_PAWD</td>
1.270     leot     12233: <td>SERIAL_DEVICES</td>
1.269     leot     12234: </tr>
                   12235: <tr>
                   12236: <td>SETGIDGAME</td>
1.270     leot     12237: <td>SETGID_GAMES_PERMS</td>
1.269     leot     12238: </tr>
                   12239: <tr>
                   12240: <td>SETUID_ROOT_PERMS</td>
1.270     leot     12241: <td>SH</td>
1.269     leot     12242: </tr>
                   12243: <tr>
                   12244: <td>SHLIB</td>
1.273   ! brook    12245: <td>SIGN_PACKAGES</td>
1.269     leot     12246: </tr>
                   12247: <tr>
1.270     leot     12248: <td>SILC_CLIENT_WITH_PERL</td>
1.273   ! brook    12249: <td>SITE_SPECIFIC_PKGS</td>
1.269     leot     12250: </tr>
                   12251: <tr>
1.270     leot     12252: <td>SKIP_DEPENDS</td>
1.273   ! brook    12253: <td>SKIP_PORTABILITY_CHECK</td>
1.269     leot     12254: </tr>
                   12255: <tr>
1.270     leot     12256: <td>SMF_INSTANCES</td>
1.273   ! brook    12257: <td>SMF_MANIFEST</td>
1.269     leot     12258: </tr>
                   12259: <tr>
1.270     leot     12260: <td>SMF_METHODS</td>
1.273   ! brook    12261: <td>SMF_METHOD_SHELL</td>
1.269     leot     12262: </tr>
                   12263: <tr>
1.270     leot     12264: <td>SMF_METHOD_SRC</td>
1.273   ! brook    12265: <td>SMF_NAME</td>
1.269     leot     12266: </tr>
                   12267: <tr>
1.270     leot     12268: <td>SMF_PREFIX</td>
1.273   ! brook    12269: <td>SMF_SRCDIR</td>
1.269     leot     12270: </tr>
                   12271: <tr>
1.270     leot     12272: <td>SNIPROXY_GROUP</td>
1.273   ! brook    12273: <td>SNIPROXY_USER</td>
1.269     leot     12274: </tr>
                   12275: <tr>
1.270     leot     12276: <td>SOURCE_BUFFSIZE</td>
1.273   ! brook    12277: <td>SPECIAL_PERMS</td>
1.269     leot     12278: </tr>
                   12279: <tr>
1.270     leot     12280: <td>SPECIFIC_PKGS</td>
1.273   ! brook    12281: <td>SSH_SUID</td>
1.269     leot     12282: </tr>
                   12283: <tr>
1.270     leot     12284: <td>SSYNC_PAWD</td>
1.273   ! brook    12285: <td>STEP_MSG</td>
1.269     leot     12286: </tr>
                   12287: <tr>
1.270     leot     12288: <td>STRIP</td>
1.273   ! brook    12289: <td>STRIP_DBG</td>
1.269     leot     12290: </tr>
                   12291: <tr>
1.270     leot     12292: <td>STRIP_DEBUG</td>
1.273   ! brook    12293: <td>STRIP_DEBUG_SUPPORTED</td>
1.269     leot     12294: </tr>
                   12295: <tr>
1.270     leot     12296: <td>STRIP_FILES_SKIP</td>
1.273   ! brook    12297: <td>SU</td>
1.269     leot     12298: </tr>
                   12299: <tr>
1.270     leot     12300: <td>SUBDIR</td>
1.273   ! brook    12301: <td>SUBST_CLASSES</td>
1.269     leot     12302: </tr>
                   12303: <tr>
1.270     leot     12304: <td>SUBST_FILES</td>
1.273   ! brook    12305: <td>SUBST_FILTER_CMD</td>
1.269     leot     12306: </tr>
                   12307: <tr>
1.270     leot     12308: <td>SUBST_MESSAGE</td>
1.273   ! brook    12309: <td>SUBST_SED</td>
1.269     leot     12310: </tr>
                   12311: <tr>
1.270     leot     12312: <td>SUBST_SHOW_DIFF</td>
1.273   ! brook    12313: <td>SUBST_SKIP_TEXT_CHECK</td>
1.269     leot     12314: </tr>
                   12315: <tr>
1.270     leot     12316: <td>SUBST_STAGE</td>
1.273   ! brook    12317: <td>SUBST_VARS</td>
1.269     leot     12318: </tr>
                   12319: <tr>
1.270     leot     12320: <td>SUNWSPROBASE</td>
1.273   ! brook    12321: <td>SUSE_PREFER</td>
1.269     leot     12322: </tr>
                   12323: <tr>
1.270     leot     12324: <td>SU_CMD</td>
1.273   ! brook    12325: <td>TERMCAP_TYPE</td>
1.269     leot     12326: </tr>
                   12327: <tr>
1.270     leot     12328: <td>TERMINFO_DEFAULT</td>
1.273   ! brook    12329: <td>TERMINFO_TYPE</td>
1.269     leot     12330: </tr>
                   12331: <tr>
1.270     leot     12332: <td>TEST</td>
1.273   ! brook    12333: <td>TEST_DEPENDS</td>
1.269     leot     12334: </tr>
                   12335: <tr>
1.270     leot     12336: <td>TEST_DIRS</td>
1.273   ! brook    12337: <td>TEST_ENV</td>
1.269     leot     12338: </tr>
                   12339: <tr>
1.270     leot     12340: <td>TEST_MAKE_CMD</td>
1.273   ! brook    12341: <td>TEST_MAKE_FLAGS</td>
1.269     leot     12342: </tr>
                   12343: <tr>
1.270     leot     12344: <td>TEST_TARGET</td>
1.273   ! brook    12345: <td>TEXLIVE_IGNORE_PATTERNS</td>
1.269     leot     12346: </tr>
                   12347: <tr>
1.270     leot     12348: <td>TEXLIVE_REV</td>
1.273   ! brook    12349: <td>TEXMFSITE</td>
1.269     leot     12350: </tr>
                   12351: <tr>
1.270     leot     12352: <td>TEX_FORMATS</td>
1.273   ! brook    12353: <td>TEX_HYPHEN_DAT</td>
1.269     leot     12354: </tr>
                   12355: <tr>
1.270     leot     12356: <td>TEX_HYPHEN_DEF</td>
1.273   ! brook    12357: <td>TEX_TEXMF_DIRS</td>
1.269     leot     12358: </tr>
                   12359: <tr>
1.270     leot     12360: <td>THTTPD_LOG_FACILITY</td>
1.273   ! brook    12361: <td>TO</td>
1.269     leot     12362: </tr>
                   12363: <tr>
1.270     leot     12364: <td>TOOLS_ALIASES</td>
1.273   ! brook    12365: <td>TOOLS_ARGS</td>
1.269     leot     12366: </tr>
                   12367: <tr>
1.270     leot     12368: <td>TOOLS_BROKEN</td>
1.273   ! brook    12369: <td>TOOLS_CMD</td>
1.269     leot     12370: </tr>
                   12371: <tr>
1.270     leot     12372: <td>TOOLS_CREATE</td>
1.273   ! brook    12373: <td>TOOLS_DIR</td>
1.269     leot     12374: </tr>
                   12375: <tr>
1.270     leot     12376: <td>TOOLS_FAIL</td>
1.273   ! brook    12377: <td>TOOLS_GNU_MISSING</td>
1.269     leot     12378: </tr>
                   12379: <tr>
1.270     leot     12380: <td>TOOLS_LDCONFIG</td>
1.273   ! brook    12381: <td>TOOLS_NOOP</td>
1.269     leot     12382: </tr>
                   12383: <tr>
1.270     leot     12384: <td>TOOLS_PATH</td>
1.273   ! brook    12385: <td>TOOLS_SCRIPT</td>
1.269     leot     12386: </tr>
                   12387: <tr>
1.270     leot     12388: <td>TOOL_DEPENDS</td>
                   12389: <td>TTF_FONTS_DIR</td>
1.269     leot     12390: </tr>
                   12391: <tr>
                   12392: <td>TYPE</td>
1.270     leot     12393: <td>UAC_REQD_EXECS</td>
1.269     leot     12394: </tr>
                   12395: <tr>
                   12396: <td>UCSPI_SSL_GROUP</td>
1.270     leot     12397: <td>UCSPI_SSL_USER</td>
1.269     leot     12398: </tr>
                   12399: <tr>
                   12400: <td>UNLIMIT_RESOURCES</td>
1.270     leot     12401: <td>UNPRIVILEGED</td>
1.269     leot     12402: </tr>
                   12403: <tr>
                   12404: <td>UNPRIVILEGED_GROUP</td>
1.270     leot     12405: <td>UNPRIVILEGED_GROUPS</td>
1.269     leot     12406: </tr>
                   12407: <tr>
                   12408: <td>UNPRIVILEGED_USER</td>
1.270     leot     12409: <td>UNWRAP_FILES</td>
1.269     leot     12410: </tr>
                   12411: <tr>
                   12412: <td>UNWRAP_PATTERNS</td>
1.270     leot     12413: <td>UPDATE_GEMSPEC</td>
1.269     leot     12414: </tr>
                   12415: <tr>
                   12416: <td>UPDATE_TARGET</td>
1.270     leot     12417: <td>URI</td>
1.269     leot     12418: </tr>
                   12419: <tr>
                   12420: <td>USA</td>
1.270     leot     12421: <td>USERGROUP_PHASE</td>
1.269     leot     12422: </tr>
                   12423: <tr>
                   12424: <td>USERPPP_GROUP</td>
1.270     leot     12425: <td>USER_SPECIFIC_PKGS</td>
1.269     leot     12426: </tr>
                   12427: <tr>
                   12428: <td>USE_ABI_DEPENDS</td>
1.270     leot     12429: <td>USE_APR</td>
1.269     leot     12430: </tr>
                   12431: <tr>
                   12432: <td>USE_BSD_MAKEFILE</td>
1.270     leot     12433: <td>USE_BUILTIN</td>
1.269     leot     12434: </tr>
                   12435: <tr>
                   12436: <td>USE_CROSS_COMPILE</td>
1.270     leot     12437: <td>USE_CURSES</td>
1.269     leot     12438: </tr>
                   12439: <tr>
                   12440: <td>USE_CWRAPPERS</td>
1.270     leot     12441: <td>USE_DB185</td>
1.269     leot     12442: </tr>
                   12443: <tr>
                   12444: <td>USE_FEATURES</td>
1.270     leot     12445: <td>USE_GAMESGROUP</td>
1.269     leot     12446: </tr>
                   12447: <tr>
                   12448: <td>USE_GCC_RUNTIME</td>
1.270     leot     12449: <td>USE_IMAKE</td>
1.269     leot     12450: </tr>
                   12451: <tr>
                   12452: <td>USE_JAVA</td>
1.270     leot     12453: <td>USE_JAVA2</td>
1.269     leot     12454: </tr>
                   12455: <tr>
                   12456: <td>USE_LANGUAGES</td>
1.270     leot     12457: <td>USE_LIBTOOL</td>
1.269     leot     12458: </tr>
                   12459: <tr>
                   12460: <td>USE_NATIVE_GCC</td>
1.270     leot     12461: <td>USE_NETBSD_REPO</td>
1.269     leot     12462: </tr>
                   12463: <tr>
                   12464: <td>USE_PKGSRC_GCC</td>
1.270     leot     12465: <td>USE_PKGSRC_GCC_RUNTIME</td>
1.269     leot     12466: </tr>
                   12467: <tr>
                   12468: <td>USE_PKGTASKS</td>
1.270     leot     12469: <td>USE_RUBY_EXTCONF</td>
1.269     leot     12470: </tr>
                   12471: <tr>
                   12472: <td>USE_RUBY_INSTALL</td>
1.270     leot     12473: <td>USE_RUBY_SETUP</td>
1.269     leot     12474: </tr>
                   12475: <tr>
                   12476: <td>USE_RUBY_SETUP_PKG</td>
1.270     leot     12477: <td>USE_TOOLS</td>
1.269     leot     12478: </tr>
                   12479: <tr>
                   12480: <td>UUCP_GROUP</td>
1.270     leot     12481: <td>UUCP_USER</td>
1.269     leot     12482: </tr>
                   12483: <tr>
                   12484: <td>VARBASE</td>
1.270     leot     12485: <td>VARNAME</td>
1.269     leot     12486: </tr>
                   12487: <tr>
                   12488: <td>VIM_EXTRA_OPTS</td>
1.270     leot     12489: <td>WARNING_MSG</td>
1.269     leot     12490: </tr>
                   12491: <tr>
                   12492: <td>WCALC_CGIDIR</td>
1.270     leot     12493: <td>WCALC_CGIPATH</td>
1.269     leot     12494: </tr>
                   12495: <tr>
                   12496: <td>WCALC_HTMLDIR</td>
1.270     leot     12497: <td>WCALC_HTMLPATH</td>
1.269     leot     12498: </tr>
                   12499: <tr>
                   12500: <td>WDM_MANAGERS</td>
1.270     leot     12501: <td>WRAPPER_REORDER_CMDS</td>
1.269     leot     12502: </tr>
                   12503: <tr>
                   12504: <td>WRKDIR</td>
1.270     leot     12505: <td>WRKDIR_BASENAME</td>
1.269     leot     12506: </tr>
                   12507: <tr>
                   12508: <td>WRKDIR_LOCKTYPE</td>
1.270     leot     12509: <td>WRKLOG</td>
1.269     leot     12510: </tr>
                   12511: <tr>
                   12512: <td>WRKOBJDIR</td>
1.270     leot     12513: <td>WRKSRC</td>
1.269     leot     12514: </tr>
                   12515: <tr>
                   12516: <td>WXGTK_ACCEPTED</td>
1.270     leot     12517: <td>WXGTK_DEFAULT</td>
1.269     leot     12518: </tr>
                   12519: <tr>
                   12520: <td>X10_PORT</td>
1.270     leot     12521: <td>X11</td>
1.269     leot     12522: </tr>
                   12523: <tr>
                   12524: <td>X11BASE</td>
1.270     leot     12525: <td>X11_PKGSRCDIR</td>
1.269     leot     12526: </tr>
                   12527: <tr>
                   12528: <td>X11_TYPE</td>
1.270     leot     12529: <td>X509_CERTIFICATE</td>
1.269     leot     12530: </tr>
                   12531: <tr>
                   12532: <td>X509_KEY</td>
1.270     leot     12533: <td>XAW_TYPE</td>
1.269     leot     12534: </tr>
                   12535: <tr>
                   12536: <td>XLOCK_DEFAULT_MODE</td>
1.270     leot     12537: <td>XMKMF_FLAGS</td>
1.269     leot     12538: </tr>
                   12539: <tr>
                   12540: <td>XXX</td>
1.273   ! brook    12541: <td>YES</td>
1.269     leot     12542: </tr>
                   12543: <tr>
1.270     leot     12544: <td>ZERO_FILESIZE_P</td>
1.273   ! brook    12545: <td>ZSH_STATIC</td>
1.269     leot     12546: </tr>
                   12547: <tr>
1.270     leot     12548: <td>__stdc__</td>
1.273   ! brook    12549: <td>_vargroups</td>
1.269     leot     12550: </tr>
                   12551: <tr>
1.270     leot     12552: <td>add</td>
1.273   ! brook    12553: <td>all</td>
1.269     leot     12554: </tr>
                   12555: <tr>
1.270     leot     12556: <td>alternatives</td>
1.273   ! brook    12557: <td>aslr</td>
1.269     leot     12558: </tr>
                   12559: <tr>
1.270     leot     12560: <td>asprintf</td>
1.273   ! brook    12561: <td>autoconf</td>
1.269     leot     12562: </tr>
                   12563: <tr>
1.272     brook    12564: <td>automake</td>
1.273   ! brook    12565: <td>autoreconf</td>
1.271     brook    12566: </tr>
                   12567: <tr>
1.272     brook    12568: <td>awk</td>
1.273   ! brook    12569: <td>bash</td>
1.269     leot     12570: </tr>
                   12571: <tr>
1.272     brook    12572: <td>big-endian</td>
1.273   ! brook    12573: <td>bin-install</td>
1.269     leot     12574: </tr>
                   12575: <tr>
1.270     leot     12576: <td>binpkg-list</td>
1.273   ! brook    12577: <td>bootstrap-depends</td>
1.269     leot     12578: </tr>
                   12579: <tr>
1.270     leot     12580: <td>broken</td>
1.273   ! brook    12581: <td>broken_on_platform</td>
1.269     leot     12582: </tr>
                   12583: <tr>
1.270     leot     12584: <td>build</td>
1.273   ! brook    12585: <td>build-env</td>
1.269     leot     12586: </tr>
                   12587: <tr>
1.270     leot     12588: <td>buildlink-directories</td>
1.273   ! brook    12589: <td>buildlink-oss-soundcard-h</td>
1.269     leot     12590: </tr>
                   12591: <tr>
1.270     leot     12592: <td>c</td>
1.273   ! brook    12593: <td>c++</td>
1.269     leot     12594: </tr>
                   12595: <tr>
1.270     leot     12596: <td>ccache</td>
1.273   ! brook    12597: <td>cce</td>
1.269     leot     12598: </tr>
                   12599: <tr>
1.270     leot     12600: <td>cdefs</td>
1.273   ! brook    12601: <td>changes</td>
1.269     leot     12602: </tr>
                   12603: <tr>
1.270     leot     12604: <td>changes-entry</td>
1.273   ! brook    12605: <td>changes-entry-noupdate</td>
1.269     leot     12606: </tr>
                   12607: <tr>
1.270     leot     12608: <td>check</td>
1.273   ! brook    12609: <td>check-clean</td>
1.269     leot     12610: </tr>
                   12611: <tr>
1.270     leot     12612: <td>check-files</td>
1.273   ! brook    12613: <td>check-files-clean</td>
1.269     leot     12614: </tr>
                   12615: <tr>
1.270     leot     12616: <td>check-vulnerable</td>
1.273   ! brook    12617: <td>checksum</td>
1.269     leot     12618: </tr>
                   12619: <tr>
1.270     leot     12620: <td>checksum-phase</td>
1.273   ! brook    12621: <td>clean</td>
1.269     leot     12622: </tr>
                   12623: <tr>
1.270     leot     12624: <td>clean-depends</td>
1.273   ! brook    12625: <td>cleandir</td>
1.269     leot     12626: </tr>
                   12627: <tr>
1.270     leot     12628: <td>commit</td>
1.273   ! brook    12629: <td>commit-changes-entry</td>
1.269     leot     12630: </tr>
                   12631: <tr>
1.270     leot     12632: <td>compact</td>
1.273   ! brook    12633: <td>compiler</td>
1.269     leot     12634: </tr>
                   12635: <tr>
1.270     leot     12636: <td>conf</td>
1.273   ! brook    12637: <td>config.guess</td>
1.269     leot     12638: </tr>
                   12639: <tr>
1.270     leot     12640: <td>config.sub</td>
1.273   ! brook    12641: <td>configuration</td>
1.269     leot     12642: </tr>
                   12643: <tr>
1.270     leot     12644: <td>configure</td>
1.273   ! brook    12645: <td>configure-help</td>
1.269     leot     12646: </tr>
                   12647: <tr>
1.270     leot     12648: <td>configure_args</td>
1.273   ! brook    12649: <td>cputime</td>
1.269     leot     12650: </tr>
                   12651: <tr>
1.270     leot     12652: <td>create-usergroup</td>
1.273   ! brook    12653: <td>csh</td>
1.269     leot     12654: </tr>
                   12655: <tr>
1.270     leot     12656: <td>ctf</td>
                   12657: <td>debug</td>
1.269     leot     12658: </tr>
                   12659: <tr>
                   12660: <td>declaration</td>
1.270     leot     12661: <td>declare</td>
1.269     leot     12662: </tr>
                   12663: <tr>
                   12664: <td>defined</td>
1.270     leot     12665: <td>depend</td>
1.269     leot     12666: </tr>
                   12667: <tr>
                   12668: <td>dependencies</td>
1.270     leot     12669: <td>depends</td>
1.269     leot     12670: </tr>
                   12671: <tr>
                   12672: <td>depends-checksum</td>
1.270     leot     12673: <td>depends-fetch</td>
1.269     leot     12674: </tr>
                   12675: <tr>
                   12676: <td>deps</td>
1.270     leot     12677: <td>describe</td>
1.269     leot     12678: </tr>
                   12679: <tr>
                   12680: <td>destdir</td>
1.270     leot     12681: <td>distclean</td>
1.269     leot     12682: </tr>
                   12683: <tr>
                   12684: <td>distinfo</td>
1.270     leot     12685: <td>dl</td>
1.269     leot     12686: </tr>
                   12687: <tr>
                   12688: <td>dlopen</td>
1.270     leot     12689: <td>do-build</td>
1.269     leot     12690: </tr>
                   12691: <tr>
                   12692: <td>do-buildlink</td>
1.270     leot     12693: <td>do-clean</td>
1.269     leot     12694: </tr>
                   12695: <tr>
                   12696: <td>do-configure-post-hook</td>
1.270     leot     12697: <td>do-extract</td>
1.269     leot     12698: </tr>
                   12699: <tr>
                   12700: <td>do-fetch</td>
1.273   ! brook    12701: <td>emul</td>
1.269     leot     12702: </tr>
                   12703: <tr>
1.270     leot     12704: <td>emulation</td>
1.273   ! brook    12705: <td>emulator</td>
1.269     leot     12706: </tr>
                   12707: <tr>
1.270     leot     12708: <td>endian</td>
1.273   ! brook    12709: <td>enomem</td>
1.269     leot     12710: </tr>
                   12711: <tr>
1.270     leot     12712: <td>err</td>
1.273   ! brook    12713: <td>errx</td>
1.269     leot     12714: </tr>
                   12715: <tr>
1.270     leot     12716: <td>etc</td>
1.273   ! brook    12717: <td>feature</td>
1.269     leot     12718: </tr>
                   12719: <tr>
1.270     leot     12720: <td>features</td>
1.273   ! brook    12721: <td>fetch</td>
1.269     leot     12722: </tr>
                   12723: <tr>
1.270     leot     12724: <td>fetch-list</td>
1.273   ! brook    12725: <td>follows</td>
1.269     leot     12726: </tr>
                   12727: <tr>
1.270     leot     12728: <td>forbids</td>
1.273   ! brook    12729: <td>form</td>
1.269     leot     12730: </tr>
                   12731: <tr>
1.270     leot     12732: <td>format</td>
1.273   ! brook    12733: <td>fortify</td>
1.269     leot     12734: </tr>
                   12735: <tr>
1.270     leot     12736: <td>fortify_source</td>
                   12737: <td>friend</td>
1.269     leot     12738: </tr>
                   12739: <tr>
                   12740: <td>from</td>
1.270     leot     12741: <td>fts</td>
1.269     leot     12742: </tr>
                   12743: <tr>
                   12744: <td>fts_close</td>
1.270     leot     12745: <td>fts_open</td>
1.269     leot     12746: </tr>
                   12747: <tr>
                   12748: <td>fts_read</td>
1.270     leot     12749: <td>fts_set</td>
1.269     leot     12750: </tr>
                   12751: <tr>
                   12752: <td>full</td>
1.270     leot     12753: <td>gcc</td>
1.269     leot     12754: </tr>
                   12755: <tr>
                   12756: <td>getopt_long</td>
1.270     leot     12757: <td>getprogname</td>
1.269     leot     12758: </tr>
                   12759: <tr>
                   12760: <td>gettext</td>
1.273   ! brook    12761: <td>github</td>
1.269     leot     12762: </tr>
                   12763: <tr>
1.270     leot     12764: <td>glob</td>
1.273   ! brook    12765: <td>gnu</td>
1.269     leot     12766: </tr>
                   12767: <tr>
1.270     leot     12768: <td>gnu_configure_strict</td>
1.273   ! brook    12769: <td>go</td>
1.269     leot     12770: </tr>
                   12771: <tr>
1.270     leot     12772: <td>go-deps</td>
1.273   ! brook    12773: <td>golang</td>
1.269     leot     12774: </tr>
                   12775: <tr>
1.270     leot     12776: <td>guess-license</td>
1.273   ! brook    12777: <td>hashbang</td>
1.269     leot     12778: </tr>
                   12779: <tr>
1.270     leot     12780: <td>heimdal</td>
1.269     leot     12781: <td>help</td>
                   12782: </tr>
                   12783: <tr>
                   12784: <td>imake</td>
1.270     leot     12785: <td>increment</td>
1.269     leot     12786: </tr>
                   12787: <tr>
                   12788: <td>interp</td>
1.270     leot     12789: <td>interpreter</td>
1.269     leot     12790: </tr>
                   12791: <tr>
                   12792: <td>intl</td>
1.270     leot     12793: <td>iso</td>
1.269     leot     12794: </tr>
                   12795: <tr>
                   12796: <td>kerberos</td>
1.270     leot     12797: <td>krb</td>
1.269     leot     12798: </tr>
                   12799: <tr>
                   12800: <td>krb5</td>
1.270     leot     12801: <td>ksh</td>
1.269     leot     12802: </tr>
                   12803: <tr>
                   12804: <td>latex</td>
1.272     brook    12805: <td>libnbcompat</td>
1.271     brook    12806: </tr>
                   12807: <tr>
                   12808: <td>libs</td>
1.272     brook    12809: <td>libtool</td>
1.269     leot     12810: </tr>
                   12811: <tr>
1.271     brook    12812: <td>licence</td>
1.272     brook    12813: <td>license</td>
1.269     leot     12814: </tr>
                   12815: <tr>
1.271     brook    12816: <td>lintl</td>
1.272     brook    12817: <td>little-endian</td>
1.269     leot     12818: </tr>
                   12819: <tr>
1.271     brook    12820: <td>lock</td>
1.272     brook    12821: <td>locking</td>
1.269     leot     12822: </tr>
                   12823: <tr>
1.271     brook    12824: <td>lvalue</td>
1.272     brook    12825: <td>make</td>
1.269     leot     12826: </tr>
                   12827: <tr>
1.271     brook    12828: <td>makesum</td>
1.272     brook    12829: <td>memory</td>
1.269     leot     12830: </tr>
                   12831: <tr>
1.272     brook    12832: <td>meta</td>
1.273   ! brook    12833: <td>meta-package</td>
1.269     leot     12834: </tr>
                   12835: <tr>
1.272     brook    12836: <td>meta_package</td>
1.273   ! brook    12837: <td>mit-krb5</td>
1.269     leot     12838: </tr>
                   12839: <tr>
1.270     leot     12840: <td>mk.conf</td>
1.273   ! brook    12841: <td>mount</td>
1.269     leot     12842: </tr>
                   12843: <tr>
1.270     leot     12844: <td>mprotect</td>
1.273   ! brook    12845: <td>mremap</td>
1.269     leot     12846: </tr>
                   12847: <tr>
1.270     leot     12848: <td>nb</td>
1.273   ! brook    12849: <td>nbcompat</td>
1.269     leot     12850: </tr>
                   12851: <tr>
1.270     leot     12852: <td>no</td>
1.273   ! brook    12853: <td>obstack</td>
1.269     leot     12854: </tr>
                   12855: <tr>
1.270     leot     12856: <td>obstack_ptr_grow</td>
1.273   ! brook    12857: <td>occurs</td>
1.269     leot     12858: </tr>
                   12859: <tr>
1.270     leot     12860: <td>only</td>
1.273   ! brook    12861: <td>options</td>
1.269     leot     12862: </tr>
                   12863: <tr>
1.272     brook    12864: <td>options.mk</td>
1.273   ! brook    12865: <td>order</td>
1.271     brook    12866: </tr>
                   12867: <tr>
1.272     brook    12868: <td>override</td>
1.273   ! brook    12869: <td>override-intltool</td>
1.269     leot     12870: </tr>
                   12871: <tr>
1.272     brook    12872: <td>override-message-intltool</td>
1.273   ! brook    12873: <td>package</td>
1.269     leot     12874: </tr>
                   12875: <tr>
1.272     brook    12876: <td>parallel</td>
1.273   ! brook    12877: <td>partial</td>
1.269     leot     12878: </tr>
                   12879: <tr>
1.272     brook    12880: <td>path</td>
1.273   ! brook    12881: <td>pax</td>
1.269     leot     12882: </tr>
                   12883: <tr>
1.272     brook    12884: <td>paxctl</td>
1.273   ! brook    12885: <td>pbulk-index</td>
1.269     leot     12886: </tr>
                   12887: <tr>
1.272     brook    12888: <td>pc</td>
1.273   ! brook    12889: <td>perl</td>
1.269     leot     12890: </tr>
                   12891: <tr>
1.272     brook    12892: <td>perl5</td>
1.273   ! brook    12893: <td>perms</td>
1.269     leot     12894: </tr>
                   12895: <tr>
1.272     brook    12896: <td>php</td>
1.273   ! brook    12897: <td>pkg-build-options</td>
1.269     leot     12898: </tr>
                   12899: <tr>
1.272     brook    12900: <td>pkg-config</td>
1.273   ! brook    12901: <td>pkg_build_options</td>
1.269     leot     12902: </tr>
                   12903: <tr>
1.272     brook    12904: <td>platform</td>
1.273   ! brook    12905: <td>plist</td>
1.269     leot     12906: </tr>
                   12907: <tr>
1.272     brook    12908: <td>post-extract</td>
1.273   ! brook    12909: <td>post-fetch</td>
1.269     leot     12910: </tr>
                   12911: <tr>
1.272     brook    12912: <td>post-wrapper</td>
1.273   ! brook    12913: <td>pre-configure</td>
1.269     leot     12914: </tr>
                   12915: <tr>
1.272     brook    12916: <td>pre-extract</td>
1.273   ! brook    12917: <td>pre-fetch</td>
1.269     leot     12918: </tr>
                   12919: <tr>
1.272     brook    12920: <td>print-go-deps</td>
1.273   ! brook    12921: <td>print-plist</td>
1.269     leot     12922: </tr>
                   12923: <tr>
1.272     brook    12924: <td>print-summary-data</td>
1.273   ! brook    12925: <td>privileged-install-hook</td>
1.269     leot     12926: </tr>
                   12927: <tr>
1.272     brook    12928: <td>pypi</td>
1.273   ! brook    12929: <td>python</td>
1.269     leot     12930: </tr>
                   12931: <tr>
1.272     brook    12932: <td>readme-all</td>
1.273   ! brook    12933: <td>regcomp</td>
1.269     leot     12934: </tr>
                   12935: <tr>
1.272     brook    12936: <td>relro</td>
1.273   ! brook    12937: <td>rename</td>
1.269     leot     12938: </tr>
                   12939: <tr>
1.272     brook    12940: <td>reorder</td>
1.273   ! brook    12941: <td>replace</td>
1.269     leot     12942: </tr>
                   12943: <tr>
1.272     brook    12944: <td>replace_interpreter</td>
1.273   ! brook    12945: <td>reproducible</td>
1.269     leot     12946: </tr>
                   12947: <tr>
1.272     brook    12948: <td>resolv</td>
1.273   ! brook    12949: <td>root</td>
1.269     leot     12950: </tr>
                   12951: <tr>
1.272     brook    12952: <td>ruby</td>
1.273   ! brook    12953: <td>setenv</td>
1.269     leot     12954: </tr>
                   12955: <tr>
1.272     brook    12956: <td>setgid</td>
1.273   ! brook    12957: <td>setprogname</td>
1.269     leot     12958: </tr>
                   12959: <tr>
1.272     brook    12960: <td>setuid</td>
1.273   ! brook    12961: <td>sh</td>
1.269     leot     12962: </tr>
                   12963: <tr>
1.272     brook    12964: <td>show</td>
1.273   ! brook    12965: <td>show-all</td>
1.269     leot     12966: </tr>
                   12967: <tr>
1.272     brook    12968: <td>show-build-defs</td>
1.273   ! brook    12969: <td>show-depends</td>
1.269     leot     12970: </tr>
                   12971: <tr>
1.272     brook    12972: <td>show-deps</td>
1.273   ! brook    12973: <td>show-distfiles</td>
1.269     leot     12974: </tr>
                   12975: <tr>
1.272     brook    12976: <td>show-downlevel</td>
1.273   ! brook    12977: <td>show-subdir-var</td>
1.269     leot     12978: </tr>
                   12979: <tr>
1.272     brook    12980: <td>show-tools</td>
1.273   ! brook    12981: <td>show-var</td>
1.269     leot     12982: </tr>
                   12983: <tr>
1.272     brook    12984: <td>show-vars</td>
1.273   ! brook    12985: <td>snprintf</td>
1.269     leot     12986: </tr>
                   12987: <tr>
1.272     brook    12988: <td>ssp</td>
1.273   ! brook    12989: <td>st_mode</td>
1.269     leot     12990: </tr>
                   12991: <tr>
1.272     brook    12992: <td>stage-install</td>
1.273   ! brook    12993: <td>strip</td>
1.269     leot     12994: </tr>
                   12995: <tr>
1.273   ! brook    12996: <td>strnlen</td>
1.270     leot     12997: <td>strong</td>
1.269     leot     12998: </tr>
                   12999: <tr>
                   13000: <td>subst</td>
1.273   ! brook    13001: <td>sun</td>
1.269     leot     13002: </tr>
                   13003: <tr>
1.270     leot     13004: <td>sunpro</td>
1.269     leot     13005: <td>sunwspro</td>
                   13006: </tr>
                   13007: <tr>
                   13008: <td>test</td>
1.270     leot     13009: <td>tex</td>
1.269     leot     13010: </tr>
                   13011: <tr>
                   13012: <td>texlive</td>
1.270     leot     13013: <td>tmp</td>
1.269     leot     13014: </tr>
                   13015: <tr>
                   13016: <td>tool</td>
1.270     leot     13017: <td>tools</td>
1.269     leot     13018: </tr>
                   13019: <tr>
                   13020: <td>tools-libtool-m4-override</td>
1.270     leot     13021: <td>type</td>
1.269     leot     13022: </tr>
                   13023: <tr>
                   13024: <td>ulimit</td>
1.270     leot     13025: <td>undefined</td>
1.269     leot     13026: </tr>
                   13027: <tr>
                   13028: <td>undo-replace</td>
1.270     leot     13029: <td>unlimit</td>
1.269     leot     13030: </tr>
                   13031: <tr>
                   13032: <td>unprivileged</td>
1.270     leot     13033: <td>unprivileged-install-hook</td>
1.269     leot     13034: </tr>
                   13035: <tr>
                   13036: <td>unstripped</td>
1.270     leot     13037: <td>update</td>
1.269     leot     13038: </tr>
                   13039: <tr>
                   13040: <td>upload</td>
1.270     leot     13041: <td>upload-distfiles</td>
1.269     leot     13042: </tr>
                   13043: <tr>
                   13044: <td>usage</td>
1.270     leot     13045: <td>use_tools</td>
1.269     leot     13046: </tr>
                   13047: <tr>
                   13048: <td>user</td>
1.270     leot     13049: <td>utimes</td>
1.269     leot     13050: </tr>
                   13051: <tr>
                   13052: <td>vasprintf</td>
1.270     leot     13053: <td>verbose</td>
1.269     leot     13054: </tr>
                   13055: <tr>
                   13056: <td>vsnprintf</td>
1.270     leot     13057: <td>warn</td>
1.269     leot     13058: </tr>
                   13059: <tr>
                   13060: <td>warning</td>
1.270     leot     13061: <td>warnings</td>
1.269     leot     13062: </tr>
                   13063: <tr>
                   13064: <td>warnx</td>
1.270     leot     13065: <td>weak</td>
1.269     leot     13066: </tr>
                   13067: <tr>
                   13068: <td>work</td>
1.270     leot     13069: <td>wrapper</td>
1.269     leot     13070: </tr>
                   13071: <tr>
                   13072: <td>yes</td>
1.270     leot     13073: <td> </td>
1.269     leot     13074: </tr>
                   13075: </table>
1.267     rillig   13076: </div>
                   13077: <div class="appendix">
                   13078: <div class="titlepage"><div><div><h1 class="title">
                   13079: <a name="editing"></a>Appendix E. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.75      rillig   13080: <div class="toc">
                   13081: <p><b>Table of Contents</b></p>
1.210     leot     13082: <dl class="toc">
1.267     rillig   13083: <dt><span class="sect1"><a href="#targets">E.1. Make targets</a></span></dt>
                   13084: <dt><span class="sect1"><a href="#procedure">E.2. Procedure</a></span></dt>
1.75      rillig   13085: </dl>
                   13086: </div>
1.79      rillig   13087: <p>This section contains information on editing the pkgsrc
                   13088:        guide itself.</p>
1.148     asau     13089: <div class="sect1">
1.75      rillig   13090: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   13091: <a name="targets"></a>E.1. Make targets</h2></div></div></div>
1.79      rillig   13092: <p>The pkgsrc guide's source code is stored in
                   13093:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   13094:        are created from it:</p>
1.148     asau     13095: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      13096: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   13097: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
                   13098: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/" target="_top">http://www.NetBSD.org/docs/pkgsrc/</a></p></li>
                   13099: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf</a>:
1.79      rillig   13100:        The PDF version of the pkgsrc guide.</p></li>
1.128     wiz      13101: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps</a>:
1.79      rillig   13102:        PostScript version of the pkgsrc guide.</p></li>
1.75      rillig   13103: </ul></div>
                   13104: </div>
1.148     asau     13105: <div class="sect1">
1.75      rillig   13106: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   13107: <a name="procedure"></a>E.2. Procedure</h2></div></div></div>
1.79      rillig   13108: <p>The procedure to edit the pkgsrc guide is:</p>
1.128     wiz      13109: <div class="procedure"><ol class="procedure" type="1">
1.148     asau     13110: <li class="step"><p>Make sure you have the packages needed to
1.83      wiz      13111:        regenerate the pkgsrc guide (and other XML-based NetBSD
1.151     obache   13112:        documentation) installed. These are automatically installed when
1.250     leot     13113:        you install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/pkgsrc-guide-tools/README.html" target="_top"><code class="filename">meta-pkgs/pkgsrc-guide-tools</code></a> package.</p></li>
1.148     asau     13114: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79      rillig   13115:        right directory. All further steps will take place
                   13116:        here.</p></li>
1.148     asau     13117: <li class="step"><p>Edit the XML file(s) in
1.79      rillig   13118:        <code class="filename">files/</code>.</p></li>
1.148     asau     13119: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79      rillig   13120:        guide for valid XML and to build the final output files. If you
                   13121:        get any errors at this stage, you can just edit the files, as
                   13122:        there are only symbolic links in the working directory, pointing
                   13123:        to the files in <code class="filename">files/</code>.</p></li>
1.148     asau     13124: <li class="step"><p><span class="command"><strong>(cd files &amp;&amp; cvs
1.79      rillig   13125:        commit)</strong></span></p></li>
1.148     asau     13126: <li class="step"><p>Run <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span> to
1.79      rillig   13127:        regenerate the output files with the proper RCS
                   13128:        Ids.</p></li>
1.148     asau     13129: <li class="step">
1.110     hubertf  13130: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91      rillig   13131:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                   13132:        <code class="filename">htdocs</code>.</p>
1.148     asau     13133: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.91      rillig   13134: <h3 class="title">Note</h3>
                   13135: <p>If you have added, removed or renamed some chapters,
1.110     hubertf  13136:        you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
                   13137:        <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91      rillig   13138:        directory.</p>
                   13139: </div>
                   13140: </li>
1.79      rillig   13141: </ol></div>
1.75      rillig   13142: </div>
                   13143: </div>
                   13144: </div></body>
1.1       grant    13145: </html>

CVSweb <webmaster@jp.NetBSD.org>